concurrent_iterable 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db124cfc0000f8709d040a3e6f2d912181bcc66c
+  data.tar.gz: 917fed7924d40719ba88f8a0542e6ceded7f814e
+SHA512:
+  metadata.gz: fd7638ce41bb638bf208bae4904bd2bd4d8b6e79ab4bdff155f4f5ec4c7c8cf63cf9a30901b8a85923c87a41f398839e8c9796a06f2bdfaa58e2048618b0d8bb
+  data.tar.gz: 917ad8795a7d9d6e2ad7fb84c7a01437a94dfe3df5c00776d72d121a13ee046a1748df1d535315e516d311c45ac92939c237521884dda897dfadc6d18660951d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+## Version 0.4.0
+
+_2019-11-14_
+
+* [a48df3a](https://github.com/tcollier/concurrent_iterable/commit/a48df3ae1e9054ca6c853a18e91e029eb1e5cff0) - Add `#any?`
+* [5f5dcd1](https://github.com/tcollier/concurrent_iterable/commit/5f5dcd17e3d962c3ede7e3ed58a24ae87dc9887b) - Add `#all?`
+* [6480c27](https://github.com/tcollier/concurrent_iterable/commit/6480c27718bd30ad982b4e1eede1ecdbf8845516) - Add `#select`
+
+## Version 0.3.0
+
+_2019-11-14_
+
+* [132851e](https://github.com/tcollier/concurrent_iterable/commit/132851e684810eb550d5bfb5e7bfcd1e5aded28f) - Add `#detect`
+
+## Version 0.2.0
+
+_2019-11-14_
+
+* [17a33ac](https://github.com/tcollier/concurrent_iterable/commit/17a33ac27fd8a6316de4a9de96dc141fd7c47816) - Add `#map`
+
+## Version 0.1.0
+
+_2019-11-14_
+
+* [e17f6f8](https://github.com/tcollier/concurrent_iterable/commit/e17f6f8ce3a31e6a94d658b7b3f09c9ef45ac0b8) - Initial release with `#each`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at collier@apartmentlist.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tom Collier
+
+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,104 @@
+[![Build Status](https://travis-ci.com/tcollier/concurrent_iterable.svg?branch=master)](https://travis-ci.com/tcollier/concurrent_iterable)
+
+# ConcurrentIterable
+
+Concurrently iterate through an iterable object
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'concurrent_iterable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install concurrent_iterable
+
+## Usage
+
+### Initializer
+
+Wrap any iterable (e.g. `Array`, `Hash`, or `Set`) in a `ConcurrentIterable::Iterator`
+instance to expose the standard enumerable methods that evaluate concurrently
+
+### Methods
+
+The following iterable/enumerable methods are available
+
+##### `#all?(&block)`
+
+##### `#any?(&block)`
+
+##### `#detect(&block)`
+
+##### `#each(&block)`
+
+##### `#map(&block)`
+
+##### `#select(&block)`
+
+### Examples
+
+```ruby
+def fetch_resource(remote_id)
+  # slow operation to fetch resource over the network
+end
+
+def remote_operation(resource, action)
+  # other slow operator to perform a remote action on the resource
+end
+
+remote_ids = [1, 2, 3]
+
+ids_iterator = ConcurrentIterable::Iterator.new(remote_ids)
+resources = ids_iterator.map(&method(:fetch_resource))
+
+resources_iterator = ConcurrentIterable::Iterator.new(resources)
+resources_iterator.each { |resource| remote_operation(resource, :publish) }
+```
+
+### Configuration
+
+You can set the configuration globally
+
+```ruby
+ConcurrentIterable.configure do |config|
+  config.concurrency = 15
+end
+```
+
+Or on a case-by-case basis, this overrides the global setting.
+
+```ruby
+ConcurrentIterable::Iterator.new(remote_ids, concurrency: 25).map { ... }
+```
+
+#### `concurrency`
+
+_Defaults to 10_
+
+The number of items in the iterable that are evaluated in the given block concurrently.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/concurrent_iterable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ConcurrentIterable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/concurrent_iterable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'concurrent_iterable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/concurrent_iterable.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'concurrent_iterable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'concurrent_iterable'
+  spec.version       = ConcurrentIterable::VERSION
+  spec.authors       = ['Tom Collier']
+  spec.email         = ['collier@apartmentlist.com']
+
+  spec.summary       = %q{Concurrently evaluate items in an iterable}
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'concurrent-ruby', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/concurrent_iterable.rb

@@ -0,0 +1,15 @@
+require 'concurrent_iterable/config'
+require 'concurrent_iterable/iterator'
+require 'concurrent_iterable/version'
+
+module ConcurrentIterable
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/concurrent_iterable/config.rb

@@ -0,0 +1,11 @@
+module ConcurrentIterable
+  class Config
+    DEFAULT_CONCURRENCY = 10
+
+    attr_accessor :concurrency
+
+    def initialize(concurrency: DEFAULT_CONCURRENCY)
+      @concurrency = concurrency
+    end
+  end
+end

data/lib/concurrent_iterable/iterator.rb

@@ -0,0 +1,104 @@
+require 'concurrent'
+
+module ConcurrentIterable
+  class Iterator
+    def initialize(iterable, concurrency: ConcurrentIterable.config.concurrency)
+      @iterable = iterable
+      @concurrency = concurrency
+      @executor = Concurrent::FixedThreadPool.new(concurrency)
+    end
+
+    def each(&block)
+      iterable.each_slice(concurrency).each do |group|
+        group.length.times.map do |index|
+          Concurrent::Promises.future(executor) { yield group[index] }
+        end.each(&:wait!)
+      end
+    end
+
+    def map(&block)
+      result = Concurrent::Array.new(iterable.length)
+      iterable.each_slice(concurrency).each.with_index do |group, group_index|
+        group.length.times.map do |index|
+          Concurrent::Promises.future(executor) do
+            result_index = group_index * concurrency + index
+            result[result_index] = yield group[index]
+          end
+        end.each(&:wait!)
+      end
+      result
+    end
+
+    def detect(&block)
+      result = nil
+      iterable.each_slice(concurrency).each.with_index do |group, group_index|
+        results = Concurrent::Array.new(group.length)
+        group.length.times.map do |index|
+          Concurrent::Promises.future(executor) do
+            results[index] = yield group[index]
+          end
+        end.each(&:wait!)
+        found_index = results.index(&:itself)
+        if found_index
+          result = iterable[group_index * concurrency + found_index]
+          break
+        end
+      end
+      result
+    end
+
+    def select(&block)
+      results = []
+      iterable.each_slice(concurrency).each do |group|
+        group_evals = Concurrent::Array.new(group.length)
+        group.length.times.map do |index|
+          Concurrent::Promises.future(executor) do
+            group_evals[index] = yield group[index]
+          end
+        end.each(&:wait!)
+        group_evals.each.with_index do |eval, index|
+          results << group[index] if eval
+        end
+      end
+      results
+    end
+
+    def all?(&block)
+      missing = false
+      iterable.each_slice(concurrency).each.with_index do |group, group_index|
+        results = Concurrent::Array.new(group.length)
+        group.length.times.map do |index|
+          Concurrent::Promises.future(executor) do
+            results[index] = yield group[index]
+          end
+        end.each(&:wait!)
+        if results.index { |result| !result }
+          missing = true
+          break
+        end
+      end
+      !missing
+    end
+
+    def any?(&block)
+      found = false
+      iterable.each_slice(concurrency).each.with_index do |group, group_index|
+        results = Concurrent::Array.new(group.length)
+        group.length.times.map do |index|
+          Concurrent::Promises.future(executor) do
+            results[index] = yield group[index]
+          end
+        end.each(&:wait!)
+        if results.index(&:itself)
+          found = true
+          break
+        end
+      end
+      found
+    end
+
+    private
+
+    attr_reader :iterable, :concurrency, :executor
+  end
+end

data/lib/concurrent_iterable/version.rb

@@ -0,0 +1,3 @@
+module ConcurrentIterable
+  VERSION = '0.4.0'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: concurrent_iterable
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Tom Collier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: 
+email:
+- collier@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- concurrent_iterable.gemspec
+- lib/concurrent_iterable.rb
+- lib/concurrent_iterable/config.rb
+- lib/concurrent_iterable/iterator.rb
+- lib/concurrent_iterable/version.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.6.14
+signing_key: 
+specification_version: 4
+summary: Concurrently evaluate items in an iterable
+test_files: []