Initial commit

Author: shyouhei

.gitignore

@@ -0,0 +1,11 @@
+/vendor/
+/.bundle/
+/Gemfile.lock
+/.yardoc
+/.ruby-version
+.DS_Store
+coverage
+doc
+pkg
+*.swp
+*~

.rubocop.yml

@@ -0,0 +1,140 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-25 17:20:37 +0900 using RuboCop version 0.33.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+  RunRailsCops: false
+  DisplayCopNames: true
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - '*.gemspec'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'
+
+# Offense count: 1
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Exclude:
+    - 'test/**/*'
+    - '*.gemspec'
+
+# Offense count: 8
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 128
+
+# Offense count: 29
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: true
+  EnforcedStyle: semantic
+  Exclude:
+    - 'test/**/*'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+Style/CaseIndentation:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords.
+Style/CommentAnnotation:
+  Enabled: false
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'test/**/*'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/ExtraSpacing:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Exclude:
+    - 'lib/sized_parallel/pool.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ElseAlignment:
+  Exclude:
+    - 'lib/sized_parallel/pool.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Offense count: 5
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineIfThen:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Enabled: false
+
+# Offense count: 13
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false
+
+# Offense count: 16
+# Cop supports --auto-correct.
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/WhileUntilDo:
+  Exclude:
+    - 'lib/sized_parallel/pool.rb'

.yardopts

@@ -0,0 +1,4 @@
+--markup=markdown
+--charset utf-8
+--readme README.md
+lib/**/*.rb

Gemfile

@@ -0,0 +1,25 @@
+#! /your/favourite/path/to/bundler
+# -*- mode: ruby; coding: utf-8; indent-tabs-mode: nil; ruby-indent-level 2 -*-
+
+# Copyright (c) 2015 Urabe, Shyouhei
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction,  including without limitation the rights
+# to use,  copy, modify,  merge, publish,  distribute, sublicense,  and/or sell
+# copies  of the  Software,  and to  permit  persons to  whom  the Software  is
+# furnished to do so, subject to the following conditions:
+#
+#         The above copyright notice and this permission notice shall be
+#         included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY  KIND, EXPRESS OR
+# IMPLIED,  INCLUDING BUT  NOT LIMITED  TO THE  WARRANTIES OF  MERCHANTABILITY,
+# FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO  EVENT SHALL THE
+# AUTHORS  OR COPYRIGHT  HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES OR  OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+source 'https://rubygems.org'
+gemspec require: false

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Urabe, Shyouhei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and  associated documentation files (the "Software"),  to deal in
+the Software  without restriction, including  without limitation the  rights to
+use, copy, modify,  merge, publish, distribute, sublicense,  and/or sell copies
+of the Software, and to permit persons  to whom the Software is furnished to do
+so, subject to the following conditions:
+
+         The above copyright notice and this permission notice shall be
+         included in all copies or substantial portions of the Software.
+
+THE SOFTWARE  IS PROVIDED  "AS IS",  WITHOUT WARRANTY OF  ANY KIND,  EXPRESS OR
+IMPLIED,  INCLUDING  BUT NOT  LIMITED  TO  THE WARRANTIES  OF  MERCHANTABILITY,
+FITNESS FOR  A PARTICULAR PURPOSE  AND NONINFRINGEMENT.  IN NO EVENT  SHALL THE
+AUTHORS  OR  COPYRIGHT HOLDERS  BE  LIABLE  FOR  ANY  CLAIM, DAMAGES  OR  OTHER
+LIABILITY, WHETHER IN  AN ACTION OF CONTRACT, TORT OR  OTHERWISE, ARISING FROM,
+OUT OF OR IN  CONNECTION WITH THE SOFTWARE OR THE USE OR  OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+This library lets you have a bunch of inter-dependent tasks run in parallel, but not all together.  Much like `make -j4` runs at most 4 tasks at once.
+
+### Detailed usage
+
+This library has only one intuitive usage.  First create a `SizedParallel` instance.
+
+    sp = SizedParallel.new 65535
+
+Omit the argument to use the active CPU count (default).
+
+Then add your series of jobs.
+
+    128.times {
+      sp.start {
+          Resolv.getaddress 'www.ruby-lang.org'
+      }.then { |addr|
+          Net::HTTP.get addr, '/'
+      }.then { |html|
+          Nokogiri::HTML html
+      }
+    }
+
+In the example above 128 concurrent name resolution are registered.  Then for each resolved address, HTTP query is registered (in parallel).  And lastly the response HTML is registered to parse (also in parallel).
+
+Those jobs are not triggered yet.  In order to do so you call a wait for the object.
+
+    sp.wait
+
+This blocks, until all the registered jobs finish either gracefully or unexpectedly.
+
+### Restrictions
+
+This library is written in pure ruby so ultra portable by nature, but requires at least version 2.2 or higher (or compatible alternatives) because Etc.nproessors is mandatory.

Rakefile

@@ -0,0 +1,59 @@
+#! /your/favourite/path/to/rake
+# -*- mode: ruby; coding: utf-8; indent-tabs-mode: nil; ruby-indent-level 2 -*-
+
+# Copyright (c) 2015 Urabe, Shyouhei
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction,  including without limitation the rights
+# to use,  copy, modify,  merge, publish,  distribute, sublicense,  and/or sell
+# copies  of the  Software,  and to  permit  persons to  whom  the Software  is
+# furnished to do so, subject to the following conditions:
+#
+#         The above copyright notice and this permission notice shall be
+#         included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY  KIND, EXPRESS OR
+# IMPLIED,  INCLUDING BUT  NOT LIMITED  TO THE  WARRANTIES OF  MERCHANTABILITY,
+# FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO  EVENT SHALL THE
+# AUTHORS  OR COPYRIGHT  HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES OR  OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup :development
+require 'rake'
+require 'yard'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+YARD::Rake::YardocTask.new
+RuboCop::RakeTask.new
+
+task default: :test
+task spec: :test
+desc "run tests"
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb'] - ['test/test_helper.rb']
+end
+
+desc "a la rails console"
+task :console do
+  require_relative 'lib/sized_parallel'
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+task c: :console
+
+desc "pry console"
+task :pry do
+  require_relative 'lib/sized_parallel'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

lib/sized_parallel.rb

@@ -0,0 +1,93 @@
+#! /your/favourite/path/to/ruby
+# -*- mode: ruby; coding: utf-8; indent-tabs-mode: nil; ruby-indent-level 2 -*-
+
+# Copyright (c) 2015 Urabe, Shyouhei
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction,  including without limitation the rights
+# to use,  copy, modify,  merge, publish,  distribute, sublicense,  and/or sell
+# copies  of the  Software,  and to  permit  persons to  whom  the Software  is
+# furnished to do so, subject to the following conditions:
+#
+#         The above copyright notice and this permission notice shall be
+#         included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE  IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY  KIND, EXPRESS OR
+# IMPLIED,  INCLUDING BUT  NOT LIMITED  TO THE  WARRANTIES OF  MERCHANTABILITY,
+# FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO  EVENT SHALL THE
+# AUTHORS  OR COPYRIGHT  HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES OR  OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'etc'
+require 'thread'
+
+# SizedParallel is a `make -j4` -like experience.  When you do
+#
+#     sp = SizedParallel.new
+#     1024.times do |i|
+#        sp.start { printf("1: %d\n", i); sleep 1 }
+#          .then  { printf("2: %d\n", i); sleep 1 }
+#          .then  { printf("3: %d\n", i); sleep 1 }
+#     end
+#     sp.wait
+#
+# You  see  bunch  of  things  run  in parallel,  but  all  the  2s  are  after
+# corresponding 1s, and 3s are after 2s.
+class SizedParallel
+
+  # Creates a set of execution.  If a  block is given, evaluates that block and
+  # wait for self, i.e:
+  #
+  #     SizedParallel.new do |sp|
+  #       ...
+  #     end
+  #
+  # is a shorthand for:
+  #
+  #     sp = SizedParallel.new
+  #     begin
+  #       ...
+  #     ensure
+  #       sp.wait
+  #     end
+  #
+  # @param      [Integer]       n  parallelizm.
+  # @yieldparam [SizedParallel] self
+  def initialize n = Etc.nprocessors
+    if defined? yield then
+      Pool.new n do |p|
+        @p = p
+        yield self
+      end
+    else
+      @p = Pool.new n
+    end
+  end
+
+  # Starts a series of execution.
+  # @note       (see Pool#process)
+  # @param      (see Pool#process)
+  # @yieldparam (see Pool#process)
+  # @return     [Task]             a `then`-able.
+  # @raise      [ArgumentError]    when no block is given.
+  def start *argv
+    raise ArgumentError, 'no block given' unless defined? yield
+    Task.new @p do
+      yield(*argv)
+    end
+  end
+
+  # Waits for tasks.  It blocks until all the jobs are done.
+  # @return [SizedParallel] self
+  def wait
+    @p.wait
+    return self
+  end
+end
+
+require_relative 'sized_parallel/version'
+require_relative 'sized_parallel/pool'
+require_relative 'sized_parallel/task'