together 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b73278ba2777147e2ab5b22777701d6a6c2187c2
+  data.tar.gz: 5ae31441b1d63bfdbee822daa5237645895a6a30
+SHA512:
+  metadata.gz: a8a700106acf1b5a01316e99e3a7d33fb9651a4f7bf3048b73b92d94022c1b46691295d0e0ee2b6ac3e5d743bb12654868c2a98503d6c5b8f0b15424b9940ef6
+  data.tar.gz: 519151911abd3b976f15b5c1bb536d548968794006fe47822af2f416ca6e19dc3c4e14a05d493d7abfaf5ae858b8dae99632399ffebd051ae06dac3564cb0c5e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in together.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    together (0.1.0)
+      mandate
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mandate (0.1.2)
+    metaclass (0.0.4)
+    minitest (5.11.3)
+    mocha (1.5.0)
+      metaclass (~> 0.0.1)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  mocha
+  rake (~> 10.0)
+  together!
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,84 @@
+# Together
+
+Together helps you execute parallel code easily in different threads. It works particuarly well with the [Mandate](https://github.com/iHiD/mandate) gem.
+
+## Usage
+
+Together takes any objects that have `call` methods and executes them in parallel.
+
+```
+Together.(
+  Proc.new { :foo },
+  Proc.new { :bar }
+)
+
+# => [:foo, :bar]
+```
+
+Together has the following settings which can be passed into the method call:
+- `timeout: 1`: How long before timing out?
+- `raise_exceptions: true`: Raise any exceptions that happen in any of the sub-calls. If set to `false`, this will not raise exceptions but instead store them in an array called `exceptions`.
+
+e.g.
+```
+Together.(
+  Proc.new { :foo },
+  timeout: 2,
+  raise_exceptions: false
+)
+```
+
+### Notes
+
+The `timeout` param is applied from the moment the Together function is executed. Therefore the first thread gets a tiny amount longer to execute than the last. This is a deliberate decision.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'together'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install together
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
+
+Firstly, thank you!! :heart::sparkling_heart::heart:
+
+We'd love to have you involved. Please read our [contributing guide](https://github.com/iHiD/together/tree/master/CONTRIBUTING.md) for information on how to get stuck in.
+
+### Contributors
+
+This project is managed by [Jeremy Walker](http://ihid.co.uk).
+
+## Licence
+
+Copyright (C) 2017 Jeremy Walker
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the MIT License.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+MIT License for more details.
+
+A copy of the MIT License is available in [LICENCE.md](https://github.com/iHiD/together/blob/master/LICENCE.md)
+along with this program.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "together"
+
+# 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/lib/together.rb

@@ -0,0 +1,18 @@
+require 'mandate'
+
+require "together/version"
+require "together/exceptions"
+
+require "together/results"
+require "together/executor"
+
+module Together
+  def self.call(*mandates,
+                timeout: 1,
+                raise_exceptions: true)
+
+    Executor.(mandates,
+              timeout: timeout,
+              raise_exceptions: raise_exceptions)
+  end
+end

data/lib/together/exceptions.rb

@@ -0,0 +1,4 @@
+module Together
+  class TimeoutError < RuntimeError
+  end
+end

data/lib/together/executor.rb

@@ -0,0 +1,60 @@
+module Together
+  class Executor
+    include Mandate
+
+    attr_reader :mandates, :timeout_time, :raise_exceptions,
+                :threads,
+                :results, :exceptions
+
+    # Timeout is in seconds
+    def initialize(mandates,
+                   timeout: ,
+                   raise_exceptions: )
+      @mandates = mandates
+      @timeout_time = Time.now.to_f + timeout
+      @raise_exceptions = raise_exceptions
+
+      @results = Results.new(mandates.size)
+      @threads = []
+    end
+
+    def call
+      execute_mandates
+      wait_for_threads
+      results
+    end
+
+    private
+
+    def execute_mandates
+      mandates.each.with_index do |mandate, i|
+        @threads << Thread.new do
+          begin
+            @results[i] = mandate.()
+          rescue => e
+            @results.exceptions[i] = e
+          end
+        end
+      end
+    end
+
+    def wait_for_threads
+      while Time.now.to_f < timeout_time
+
+        # It is important to check for exceptions before
+        # checking to see if anything is finished else we hit
+        # a race condition.
+        if raise_exceptions && !results.exceptions.all?(&:nil?)
+          raise results.exceptions.find{|e|!e.nil?}
+        end
+
+        return true unless threads.any?(&:alive?)
+
+        sleep(0.001)
+      end
+
+      raise TimeoutError.new
+    end
+  end
+end
+

data/lib/together/results.rb

@@ -0,0 +1,14 @@
+module Together
+  class Results < Array
+
+    attr_reader :exceptions
+    def initialize(size, *args)
+      super(size, *args)
+      @exceptions = Array.new(size)
+    end
+
+    def success?
+      @exceptions.all?(&:nil?)
+    end
+  end
+end

data/lib/together/version.rb

@@ -0,0 +1,3 @@
+module Together
+  VERSION = "0.1.0"
+end

data/together.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "together/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "together"
+  spec.version       = Together::VERSION
+  spec.authors       = ["Jeremy Walker"]
+  spec.email         = ["jez.walker@gmail.com"]
+
+  spec.summary       = %q{A simple parallelizer for Ruby}
+  spec.description   = %q{A simple parallelizer for Ruby}
+  spec.homepage      = "https://github.com/iHiD/together"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mandate"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: together
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Walker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mandate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple parallelizer for Ruby
+email:
+- jez.walker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/together.rb
+- lib/together/exceptions.rb
+- lib/together/executor.rb
+- lib/together/results.rb
+- lib/together/version.rb
+- together.gemspec
+homepage: https://github.com/iHiD/together
+licenses: []
+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.13
+signing_key: 
+specification_version: 4
+summary: A simple parallelizer for Ruby
+test_files: []
+has_rdoc: