enumerator_concurrent 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGE1OGJhNzFmZDI1NDJjMjE0NTQ5ZGM5N2I2MTQzMjVhMzIzY2I3Mw==
+  data.tar.gz: !binary |-
+    ZTBjY2IwNWY0ZDJjNjc2MGExMDY1YTM3ODQzNmY1Mjg2MGRiMjc2OQ==
+SHA512:
+  metadata.gz: !binary |-
+    MGRjYzc1NGNiNDU1ZmJkMDM2YmZhNmNkY2M5ZmMwNzU4YmY0NjYyZmU3YTZh
+    MTdjNjM5ZWRlYWE0M2MzNDkzODZlZGI2ZDU3YjY3Y2E3OTRjOTE3NjIxMjRl
+    OWVjOGE3NzAyMTZiOTViMmQwNThkMTQ1OTY2NTQ5ZmJkOThmYmM=
+  data.tar.gz: !binary |-
+    ODQ1ZGNiYTY5ZTMwYTk2ZTdjNDViZmJhMDY0ZGQwODVhNzgyNTRhZTFhNTYy
+    NjRjNDk2NjI2Yjk3MjM1OWMwN2ZiMWFlMjYxMTJhMzE3NDQ4NGVhOTIzNDdh
+    NTQ3MjI2NDQyNTQ1Njk1ZTAyYzk3NTRmOTJhZTEyOGE5ZjRlMzA=

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_store
+*.swp
+*.gem

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- jruby-19mode
+- rbx-2
+- ruby-head
+- jruby-head
+deploy:
+  provider: rubygems
+  api_key:
+    secure: kaHhG0D7M5ImRK0AoO5UsdcAKRtms57Mix6lzJIK+tYADnDQFRGDTZ/odUYkwup5dwW1zX/GkehEee6zEvmxnwgQz3+qAf4NSR7lqSzvD5Q4ZssLt6tw2jEmKijG/0MUTGojtPidPcR/wDpsxDdasBvxuFTObaLTTdATCiy2wRM=
+  gem: enumerator_concurrent
+  on:
+    all_branches: true
+    tags: true
+    repo: doodzik/enumerator_concurrent

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 doodzik
+
+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,73 @@
+# enumerator_concurrent
+[![Build Status](https://travis-ci.org/doodzik/enumerator_concurrent.svg?branch=master)](https://travis-ci.org/doodzik/enumerator_concurrent)
+[![Stories in Ready](https://badge.waffle.io/doodzik/enumerator_concurrent.svg?label=ready&title=Ready)](http://waffle.io/doodzik/enumerator_concurrent)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumerator_concurrent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerator-concurrent
+
+## Usage
+
+```ruby
+  # Enumerator::Concurrent inherits from Array
+  require 'enumerator_concurrent'
+
+  # every iteration is run in an own thread
+  [1,2,3,4].concurrent.each { |x| x*2 }
+  # => [2,4,6,8]
+
+  # specify how many threads should deal with the Enumerable.
+  queued = [1,2,3,4].concurrent.threads(2)
+
+  # doesn't preserve the structure
+  queued.each { |x| x*2 }
+  # => [1,2,3,4]
+
+  # preserves the structure
+  queued.map { |x| x*2 }
+  # => [2,4,6,8]
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/doodzik/enumerator-concurrent/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
+
+
+## License (MIT)
+
+Copyright (c) 2014 Frederik Dudzik
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+RuboCop::RakeTask.new
+
+desc 'Run tests and rubocop'
+task default: [:rubocop, :test]

data/benchmark/benchmark.rb

@@ -0,0 +1,2 @@
+require 'benchmark'
+require 'enumerator_concurrent'

data/enumerator_concurrent.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumerator_concurrent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'enumerator_concurrent'
+  spec.version       = EnumeratorConcurrent::VERSION
+  spec.authors       = ['doodzik']
+  spec.email         = ['frederik.dudzik@gmail.com']
+  spec.summary       = 'Implements a concurrent each'
+  spec.description   = 'for each iteration a new thread is started.'\
+                       'Then the started threads are joind'
+  spec.homepage      = 'https://github.com/doodzik/enumerator_concurrent.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\u0000")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_development_dependency 'rubocop', '~> 0.27'
+end

data/lib/enumerator_concurrent/queued.rb

@@ -0,0 +1,59 @@
+# Namespace
+module EnumeratorConcurrent
+  # Enumerator with thread count speciyfied to handle loop
+  class Queued < Array
+    # @param arr [Array]
+    # @param thread_count [Int] how many thread should be handle the Enumarator
+    def initialize(arr, thread_count)
+      @thread_count = 0...thread_count
+      @queue = Queue.new
+      @arr = arr
+      super(arr)
+    end
+
+    # @yield [x] element in array
+    # @return [self]
+    def each
+      @arr.each { |x| @queue.push x }
+      init_workers do
+        pop_queue do |x|
+          yield(x)
+        end
+      end
+      self
+    end
+
+    # @yield [x] element in self
+    # @return [Array] with modified values
+    def map
+      return_value = []
+      @arr.map.with_index { |x, i| @queue.push(i => x) }
+      init_workers do
+        pop_queue do |x|
+          key, value = x.first
+          return_value[key] = yield(value)
+        end
+      end
+      return_value
+    end
+
+    private
+
+    # @yield run block in specified Thread count
+    def init_workers
+      to_join = @thread_count.map do
+        Thread.new do
+          yield
+        end
+      end
+      to_join.map(&:join)
+    end
+
+    # @yield [x] poped element from the queue
+    def pop_queue
+      loop { yield(@queue.pop(true)) }
+    rescue ThreadError => e
+      p e unless e.message == 'queue empty'
+    end
+  end
+end

data/lib/enumerator_concurrent/threaded.rb

@@ -0,0 +1,29 @@
+# Implements a Concurrent Each
+module EnumeratorConcurrent
+  # Each Iteration in an own Thread. Less overhead then Queued
+  class Threaded < Array
+    # @param &block [Block] takes a block an passes it to each_to_thread
+    # @return [Array] as the standard each does
+    def each(&block)
+      each_to_thread(&block).join_threads
+    end
+
+    # joins a list of threads and returns the threads value
+    # @return [Array<thread.join.value>]
+    def join_threads
+      Threaded.new map { |x| x.join.value }
+    end
+
+    # initializes for every iteration a new Thread
+    # @return [Array<thread>] Array of Thread instances
+    def each_to_thread
+      Threaded.new map { |x| Thread.new { yield(x) } }
+    end
+
+    # @param thread_workers [Int] number of threads running. defaults to four
+    # @return [Enumerator::ConcurrentQueue]
+    def threads(thread_workers)
+      Queued.new self, thread_workers
+    end
+  end
+end

data/lib/enumerator_concurrent/version.rb

@@ -0,0 +1,6 @@
+# Change the version and
+# add an tagged commit with -a flag
+# to auto deploy to rubygems
+module EnumeratorConcurrent
+  VERSION = '0.0.1'
+end

data/lib/enumerator_concurrent.rb

@@ -0,0 +1,12 @@
+require 'enumerator_concurrent/version'
+require 'enumerator_concurrent/threaded'
+require 'enumerator_concurrent/queued'
+
+# opens Array class and adds concurrent method
+class Array
+  # @return [Enumerator::Concurrent] instance of Enumerator::Concurrent
+  #     initialized with self
+  def concurrent
+    EnumeratorConcurrent::Threaded.new(self)
+  end
+end

data/test/test_enumerator_concurrent.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'enumerator_concurrent'
+
+# test implementation of the lib
+class EnumeratorConcurrentTest < Minitest::Test
+  def test_extended_array
+    assert_equal(EnumeratorConcurrent::Threaded, [].concurrent.class)
+    assert_equal([1, 2, 3], [1, 2, 3].concurrent)
+  end
+
+  def test_extended_concrrent_with_threads
+    cq = EnumeratorConcurrent::Queued.new [1, 2, 3, 4], 2
+    assert_equal([1, 2, 3, 4].concurrent.threads(2), cq)
+  end
+end

data/test/test_enumerator_concurrent_queued.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'enumerator_concurrent/queued'
+
+# Test for EnumeratorQueued
+class EnumeratorConcurrentQueuedTest < Minitest::Test
+  def test_map_workers
+    cq = EnumeratorConcurrent::Queued.new [1, 2, 3, 4], 2
+    assert_equal([2, 4, 6, 8], cq.map { |x| x * 2 })
+  end
+
+  def test_each_workers
+    cq = EnumeratorConcurrent::Queued.new [1, 2, 3, 4], 2
+    result = 0
+    result1 = cq.each { |x| result += x  }
+    assert_equal([1, 2, 3, 4], result1)
+    assert_equal(10, result)
+  end
+
+  def test_init_workers
+    cq = EnumeratorConcurrent::Queued.new [], 2
+    result1, result2 = cq.send(:init_workers) {}
+    assert result1.is_a? Thread
+    assert result2.is_a? Thread
+  end
+end

data/test/test_enumerator_oncurrent_threaded.rb

@@ -0,0 +1,51 @@
+require 'minitest/autorun'
+require 'enumerator_concurrent/threaded'
+
+# Mock for thread to see if thread was invoked
+class ThreadMock
+  attr_reader :joined, :valued
+  @joined = false
+  @value = false
+
+  def join
+    @joined = true
+    self
+  end
+
+  def value
+    @valued = true
+    self
+  end
+end
+
+# test Threaded
+class EnumeratorConcurrentTest < Minitest::Test
+  def test_creates_list_of_threads
+    threaded = EnumeratorConcurrent::Threaded.new([2, 3])
+    thread1, thread2 = threaded.each_to_thread do |x|
+      x + 10
+    end
+
+    assert(thread1.is_a? Thread)
+    assert(thread2.is_a? Thread)
+    assert_equal(thread1.value, 12)
+    assert_equal(thread2.value, 13)
+  end
+
+  def test_joining_threads
+    threads = [ThreadMock.new, ThreadMock.new]
+    t1, t2 = EnumeratorConcurrent::Threaded.new(threads).join_threads
+    assert(t1.joined)
+    assert(t1.valued)
+    assert(t2.joined)
+    assert(t2.valued)
+  end
+
+  def test_each
+    values = [3, 2]
+    ec = EnumeratorConcurrent::Threaded.new(values)
+    t1, t2 = ec.each { |x| x + 2 }
+    assert_equal(t1, 5)
+    assert_equal(t2, 4)
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: enumerator_concurrent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- doodzik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.27'
+description: for each iteration a new thread is started.Then the started threads are
+  joind
+email:
+- frederik.dudzik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .hound.yml
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/benchmark.rb
+- enumerator_concurrent.gemspec
+- lib/enumerator_concurrent.rb
+- lib/enumerator_concurrent/queued.rb
+- lib/enumerator_concurrent/threaded.rb
+- lib/enumerator_concurrent/version.rb
+- test/test_enumerator_concurrent.rb
+- test/test_enumerator_concurrent_queued.rb
+- test/test_enumerator_oncurrent_threaded.rb
+homepage: https://github.com/doodzik/enumerator_concurrent.git
+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: Implements a concurrent each
+test_files:
+- test/test_enumerator_concurrent.rb
+- test/test_enumerator_concurrent_queued.rb
+- test/test_enumerator_oncurrent_threaded.rb