pmap 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18142e8b4288995523855dca836e2e5a68626842
-  data.tar.gz: 1c434f5d568b3b3c49443f0297034fb53d8daaa2
+  metadata.gz: 0eeba30c0921e39d013d4a2cd58c00ecd1c50e69
+  data.tar.gz: 5422d1dabc31a8fb65329bc35a2dd671ccf8a24e
 SHA512:
-  metadata.gz: 3ff6f9af2481e06d4c909549fcfba4ebbff7dfefbbfbac7ec9526970173a589c9bb072b602d27466dae7b644571affb8114f3a2e66c81cda67ab994d7b59ab25
-  data.tar.gz: 8f15a3213ea2ebacc0392e584db12444fa95696b60a955d579ccb36961a4f4f4ccf9a4c497b5a00b7635bd946bf96997ace6902f987f33021cbbd60daa73143b
+  metadata.gz: d7321a043d56bd25f3c14b8219226c4381ccc96d5c5605708205a9b8acb56b019c5b80425ba6631272677496ef78a5525e2c1c7a8134a5424a0c050ea55bab55
+  data.tar.gz: 8f189ffaf99cf4f3d7cc7b7e97c204d63375714073559f0cbf2861e55e32e63fdfa9457bc0c79302f323ee307aa9e783100e4f5f6f945007abd2952974db3184

data/.travis.yml

@@ -5,10 +5,11 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.3
-  - 2.2.0-preview1
+  - 2.1.6
+  - 2.2.2
   - jruby-18mode
   - jruby-19mode
+  - jruby-9.0.0.0
   - jruby-head
   - rbx-2
   - ree
@@ -16,4 +17,5 @@ rvm:
 matrix:
   allow_failures:
     - rvm: jruby-head
+    - rvm: rbx-2
     - rvm: ruby-head

data/CODE_OF_CONDUCT.md

@@ -1,32 +1,50 @@
 # Contributor Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect
-all people who contribute through reporting issues, posting feature
-requests, updating documentation, submitting pull requests or patches,
-and other activities.
-
-We are committed to making participation in this project a
-harassment-free experience for everyone, regardless of level of
-experience, gender, gender identity and expression, sexual
-orientation, disability, personal appearance, body size, race, age, or
-religion.
-
-Examples of unacceptable behavior by participants include the use of
-sexual language or imagery, derogatory comments or personal attacks,
-trolling, public or private harassment, insults, or other
-unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit,
-or reject comments, commits, code, wiki edits, issues, and other
-contributions that are not aligned to this Code of Conduct. Project
-maintainers who do not follow the Code of Conduct may be removed from
-the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior
-may be reported by opening an issue or contacting one or more of the
-project maintainers.
-
-This Code of Conduct is adapted from the
-[Contributor Covenant](http://contributor-covenant.org),
-version 1.0.0, available at
-[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bruce.adams@acm.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,11 +1,12 @@
 pmap [![Build Status](https://secure.travis-ci.org/bruceadams/pmap.png)](http://travis-ci.org/bruceadams/pmap) [![Code Climate](https://codeclimate.com/github/bruceadams/pmap.png)](https://codeclimate.com/github/bruceadams/pmap)
 ====
 
-This Ruby gem adds two methods to any Enumerable (notably including
+This Ruby gem adds three methods to any Enumerable (notably including
 any Array). The two added methods are:
 
 * _pmap_ parallel map
 * _peach_ parallel each
+* _peach_with_index_ parallel each_with_index
 
 Threading in Ruby has limitations.
 ----------------------------------
@@ -32,11 +33,6 @@ Ruby threads means the requests will be issued very quickly, well
 before the responses start coming back. As responses come back, they
 will be processed as they arrive.
 
-Thread Count
-----------------
-
-The thread count defaults to 64 and is set based on `$pmap_default_thread_count`.
-
 Example
 -------
 
@@ -54,3 +50,19 @@ get_quote ranges averages 0.5 seconds.
     # This will take about half a second;
     # however long the single slowest response took.
     stock_quotes = stock_symbols.pmap {|s| get_quote(s)}
+    
+Thread Count
+------------
+
+The thread count defaults to 64 and is set based on `$pmap_default_thread_count`.
+
+You can also set the thread count per call by passing it as an argument to the `pmap` and `peach` methods.
+
+    # Use the default thread count (64)
+    (1..128).peach { |i| sleep 1 } # Takes 2 seconds
+    
+    # Use a thread count of 128
+    (1..128).peach(128) { |i| sleep 1 } # Takes 1 second
+    
+    # Use a thread count of 2
+    (1..128).peach(2) { |i| sleep 1 } # Takes 64 seconds

data/lib/pmap.rb

@@ -1,58 +1,54 @@
 require 'thread' unless defined?(Mutex)
+require "pmap/thread_pool"
 
 # Global variable for the default thread pool size.
 $pmap_default_thread_count ||= 64
 
 module PMap
-  class DummyOutput
-    def []=(idx, val)
-    end
-  end
-
   def self.included(base)
     base.class_eval do
-      # Parallel "map" for any Enumerable.
+
+      # Public: Parallel "map" for any Enumerable.
+      #
+      # thread_count - maximum number of threads to create (optional)
+      #
       # Requires a block of code to run for each Enumerable item.
-      # [thread_count] is number of threads to create. Optional.
+      #
       def pmap(thread_count=nil, &proc)
-        in_array = self.to_a        # I'm not sure how expensive this is...
-        out_array = Array.new(in_array.size)
-        process_core(thread_count, in_array, out_array, &proc)
-        out_array
-      end
-
-      def process_core(thread_count, in_array, out_array, &proc)
-        thread_count = thread_count(thread_count, in_array)
-        size = in_array.size
-
-        semaphore = Mutex.new
-        index = -1                  # Our use of index is protected by semaphore
-
-        threads = (0...thread_count).map {
-          Thread.new {
-            i = nil
-            while (semaphore.synchronize {i = (index += 1)}; i < size)
-              out_array[i] = yield(in_array[i])
-            end
-          }
-        }
-        threads.each {|t| t.join}
+        Array.new.tap do |result|
+          peach_with_index(thread_count) do |item, index|
+            result[index] = proc.call(item)
+          end
+        end
       end
-      private :process_core
 
-      def thread_count(user_requested_count, items)
-        user_requested_count ||= $pmap_default_thread_count
-        raise ArgumentError, "thread_count must be at least one." unless
-          user_requested_count.respond_to?(:>=) && user_requested_count >= 1
-        [user_requested_count, items.size].min
+      # Public: Parallel "each" for any Enumerable.
+      #
+      # thread_count - maximum number of threads to create (optional)
+      #
+      # Requires a block of code to run for each Enumerable item.
+      #
+      def peach(thread_count=nil, &proc)
+        peach_with_index(thread_count) do |item, index|
+          proc.call(item)
+        end
+        self
       end
-      private :thread_count
 
-      # Parallel "each" for any Enumerable.
+      # Public: Parallel each_with_index for any Enumerable
+      #
+      # thread_count - maximum number of threads to create (optional)
+      #
       # Requires a block of code to run for each Enumerable item.
-      # [thread_count] is number of threads to create. Optional.
-      def peach(thread_count=nil, &proc)
-        process_core(thread_count, self.to_a, DummyOutput.new, &proc)
+      #
+      def peach_with_index(thread_count=nil, &proc)
+        thread_count ||= $pmap_default_thread_count
+        pool = ThreadPool.new(thread_count)
+
+        each_with_index do |item, index|
+          pool.schedule(item, index, &proc)
+        end
+        pool.shutdown
         self
       end
     end

data/lib/pmap/thread_pool.rb

@@ -0,0 +1,65 @@
+# Internal: A thread pool for managing the threads used by the pmap functions
+#
+# Example:
+#
+#   pool = PMap::ThreadPool.new(16)
+#   array.each do |item|
+#     pool.schedule do
+#       item.some_io_intense_operation
+#     end
+#   end
+#
+#   pool.shutdown
+#
+module PMap
+  class ThreadPool
+
+    # Public: Initializes a new thread pool
+    #
+    # max - the maximum number of threads to spawn
+    #
+    def initialize(max)
+      raise ArgumentError, "max must be at least one." unless
+        max.respond_to?(:>=) && max >= 1
+
+      @max = max
+      @jobs = Queue.new
+      @workers = []
+    end
+
+    # Public: Schedules a new job to run in a thread
+    #
+    # *args - any arguments that will be passed to the block
+    # &job  - the block that will be executed on the thread
+    #
+    def schedule(*args, &job)
+      @jobs << [job, args]
+      spawn_worker if @workers.size < @max
+    end
+
+    # Public: Shuts down the thread pool and waits for any running threads to
+    #         complete
+    #
+    def shutdown
+      @workers.size.times do
+        @jobs << :stop_working
+      end
+      @workers.each(&:join)
+    end
+
+    private
+
+    # Private: Spawns a new thread to work on the scheduled jobs
+    #
+    def spawn_worker
+      thread = Thread.new do
+        while (command = @jobs.pop) != :stop_working
+          job, args = command
+          job.call(*args)
+        end
+      end
+
+      @workers << thread
+    end
+  end
+end

data/lib/pmap/version.rb

@@ -1,3 +1,3 @@
 module Pmap
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/pmap.gemspec

@@ -6,8 +6,9 @@ Gem::Specification.new do |s|
   s.name        = 'pmap'
   s.version     = Pmap::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Bruce Adams', 'Jake Goulding']
-  s.email       = ['bruce.adams@acm.org', 'jake.goulding@gmail.com']
+  s.license     = 'Apache-2.0'
+  s.authors     = ['Bruce Adams', 'Jake Goulding', 'David Biehl']
+  s.email       = ['bruce.adams@acm.org', 'jake.goulding@gmail.com', 'me@davidbiehl.com']
   s.homepage    = 'https://github.com/bruceadams/pmap'
   s.summary     = %q{Add parallel methods into Enumerable: pmap and peach}
   s.description = %q{Add parallel methods into Enumerable: pmap and peach}

data/test/pmap_test.rb

@@ -60,4 +60,15 @@ class Pmap_Test < Test::Unit::TestCase
     assert(elapsed >= 2, 'Limited threads too fast: %.1f seconds' % elapsed)
     assert(elapsed <  3, 'Parallel sleeps too slow: %.1f seconds' % elapsed)
   end
+
+  def test_peach_with_index
+    subject = ["a", "b", "c"]
+    output  = []
+
+    subject.peach_with_index do |letter, index|
+      output << [letter, index]
+    end
+
+    assert_equal([["a", 0], ["b", 1], ["c", 2]].sort, output.sort)
+  end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pmap
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Bruce Adams
 - Jake Goulding
+- David Biehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2015-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -29,6 +30,7 @@ description: 'Add parallel methods into Enumerable: pmap and peach'
 email:
 - bruce.adams@acm.org
 - jake.goulding@gmail.com
+- me@davidbiehl.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -41,11 +43,13 @@ files:
 - README.md
 - Rakefile
 - lib/pmap.rb
+- lib/pmap/thread_pool.rb
 - lib/pmap/version.rb
 - pmap.gemspec
 - test/pmap_test.rb
 homepage: https://github.com/bruceadams/pmap
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -63,8 +67,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: 'Add parallel methods into Enumerable: pmap and peach'
-test_files: []
+test_files:
+- test/pmap_test.rb