concurrent-enumerable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b71e49425a4a524961128fa383bf319a58fe45c6
+  data.tar.gz: f620d882c9b5a35c40eefc82ca003dae94dcc0c1
+SHA512:
+  metadata.gz: 57254b26ad28fcf85350f75a10dd7025b95ad664dfdfae3f7d4b0ee0ed48c206eb2158121a8b9e64aafac6ec8db2e447210ad24607e0efb6de07c7f38fd2547d
+  data.tar.gz: 34c26ea94f43045885c1a4e1b33c0ef9c155d1da653dd6357f433009c55c8d252cd3ed93c4ae408966250b64424594c49a698deab4b950aa96ce829fff7ff8a0

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  Exclude:
+    - concurrent-enumerable.gemspec
+    - lib/concurrent-enumerable.rb
+
+Documentation:
+  Enabled: false
+
+Eval:
+  Exclude:
+    - spec/spec_helper.rb
+
+MethodLength:
+  Max: 20

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in concurrent_enumerable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sebastian Edwards
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,31 @@
+# ConcurrentEnumerable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'concurrent_enumerable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install concurrent_enumerable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/concurrent_enumerable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/concurrent-enumerable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'concurrent_enumerable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'concurrent-enumerable'
+  spec.version       = ConcurrentEnumerable::VERSION
+  spec.authors       = ['Sebastian Edwards']
+  spec.email         = ['me@sebastianedwards.co.nz']
+  spec.summary       = 'Run enumerable operations in parallel'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 0.8.0'
+end

data/lib/concurrent-enumerable.rb

@@ -0,0 +1,9 @@
+require 'concurrent'
+require 'delegate'
+
+require 'concurrent_enumerable/core_ext'
+require 'concurrent_enumerable/enumerable_interface'
+require 'concurrent_enumerable/parallel'
+require 'concurrent_enumerable/version'
+
+module ConcurrentEnumerable; end

data/lib/concurrent_enumerable/core_ext.rb

@@ -0,0 +1,9 @@
+module Enumerable
+  def parallel(opts = {})
+    ConcurrentEnumerable::Parallel.new(self, opts)
+  end
+
+  def serial
+    self
+  end
+end

data/lib/concurrent_enumerable/enumerable_interface.rb

@@ -0,0 +1,35 @@
+module ConcurrentEnumerable
+  module EnumerableInterface
+    module_function
+
+    def use(runner, methods)
+      enumerable_methods = Enumerable.instance_methods.map(&:to_s)
+      enumerable_methods << 'each'
+      methods.each do |method|
+        next unless enumerable_methods.include?(method)
+        class_eval <<-RUBY
+        def #{method}(*args, &block)
+          #{runner}(:#{method}, *args, &block)
+        end
+        RUBY
+      end
+    end
+
+    private :use
+
+    use :run_in_threads, %w(
+      all? any? count detect find find_index max_by min_by minmax_by none?
+      one? partition
+    )
+
+    use :run_in_threads_return_original, %w(
+      cycle each each_cons each_entry each_slice each_with_index enum_cons
+      enum_slice enum_with_index reverse_each zip
+    )
+
+    use :run_in_threads_return_parallel, %w(
+      collect collect_concat drop_while find_all flat_map grep group_by map
+      reject select sort sort_by take_while zip
+    )
+  end
+end

data/lib/concurrent_enumerable/parallel.rb

@@ -0,0 +1,58 @@
+module ConcurrentEnumerable
+  class Parallel < SimpleDelegator
+    include EnumerableInterface
+
+    protected :__getobj__, :__setobj__
+
+    def initialize(list, opts = {})
+      super list
+      @opts = opts
+      @executor = Concurrent::OptionsParser.get_executor_from(opts) || \
+                  Concurrent.configuration.global_task_pool
+    end
+
+    def parallel
+      self
+    end
+
+    def serial
+      __getobj__
+    end
+
+    protected
+
+    def run_in_threads(method, *args, &block)
+      if block
+        latch = Concurrent::CountDownLatch.new(size)
+
+        results = Array.new(size)
+
+        index = Concurrent::AtomicFixnum.new(-1)
+
+        __getobj__.each do |item|
+          i = index.increment
+
+          @executor.post do
+            results[i] = yield(item)
+            latch.count_down
+          end
+        end
+
+        latch.wait
+        results.send(method, *args) { |value| value }
+      else
+        send method, *args
+      end
+    end
+
+    def run_in_threads_return_original(method, *args, &block)
+      run_in_threads(method, *args, &block)
+
+      self
+    end
+
+    def run_in_threads_return_parallel(method, *args, &block)
+      Parallel.new run_in_threads(method, *args, &block), @opts
+    end
+  end
+end

data/lib/concurrent_enumerable/version.rb

@@ -0,0 +1,3 @@
+module ConcurrentEnumerable
+  VERSION = '0.0.1'
+end

data/spec/lib/concurrent_enumerable/core_ext_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe Enumerable do
+  describe '#parallel' do
+    it 'should return a parallel instance' do
+      expect([].parallel).to be_a Parallel
+    end
+  end
+end

data/spec/lib/concurrent_enumerable/parallel_spec.rb

@@ -0,0 +1,65 @@
+require 'benchmark'
+
+RSpec.describe Parallel do
+  describe '#any? (parallelizable, value-returning)' do
+    it 'should produce the correct result' do
+      result = Parallel.new([1, 2, 3]).any? { |x| x == 3 }
+
+      expect(result).to be_truthy
+    end
+
+    it 'should run given block in parallel' do
+      time = Benchmark.measure do
+        Parallel.new([1, 2, 3]).any? { sleep 0.1 }
+      end
+
+      expect(time.real).to be < 0.2
+    end
+  end
+
+  describe '#each (parallelizable, self-returning)' do
+    it 'should produce the correct result' do
+      result = Parallel.new([1, 2, 3]).each { |x| x * 2 }
+
+      expect(result).to eq [1, 2, 3]
+    end
+
+    it 'should run given block in parallel' do
+      time = Benchmark.measure do
+        Parallel.new([1, 2, 3]).each { sleep 0.1 }
+      end
+
+      expect(time.real).to be < 0.2
+    end
+  end
+
+  describe '#map (parallelizable, Parallel-returning)' do
+    it 'should produce the correct result' do
+      result = Parallel.new([1, 2, 3]).map { |x| x * 2 }
+
+      expect(result).to eq [2, 4, 6]
+    end
+
+    it 'should run given block in parallel' do
+      time = Benchmark.measure do
+        Parallel.new([1, 2, 3]).map { sleep 0.1 }
+      end
+
+      expect(time.real).to be < 0.2
+    end
+
+    it 'should return a Parallel' do
+      result = Parallel.new([1, 2, 3]).map { |x| x * 2 }
+
+      expect(result).to be_a Parallel
+    end
+  end
+
+  describe '#reduce (non-parallelizable)' do
+    it 'should produce the correct result' do
+      result = Parallel.new([1, 2, 3]).reduce { |a, e| a + e }
+
+      expect(result).to eq 6
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+
+require 'concurrent-enumerable'
+
+ConcurrentEnumerable.constants.each do |const|
+  eval "#{const} = ConcurrentEnumerable::#{const}"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: concurrent-enumerable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sebastian Edwards
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: ''
+email:
+- me@sebastianedwards.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- concurrent-enumerable.gemspec
+- lib/concurrent-enumerable.rb
+- lib/concurrent_enumerable/core_ext.rb
+- lib/concurrent_enumerable/enumerable_interface.rb
+- lib/concurrent_enumerable/parallel.rb
+- lib/concurrent_enumerable/version.rb
+- spec/lib/concurrent_enumerable/core_ext_spec.rb
+- spec/lib/concurrent_enumerable/parallel_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Run enumerable operations in parallel
+test_files:
+- spec/lib/concurrent_enumerable/core_ext_spec.rb
+- spec/lib/concurrent_enumerable/parallel_spec.rb
+- spec/spec_helper.rb