parallax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 265d1dfafb3c018cd20546237fdfc939825fe54219853c0b72eaa6d73b7ec909
+  data.tar.gz: 5805b869b639d6b48a115056a532c1f72841611502ded3d2a99385edcea6347f
+SHA512:
+  metadata.gz: e39236287fe4004b5d28026d63d925093a98dda0679ea0c6fb4708fd41d26e102ee7f01ee00ee76c17b6a25b44c8034e86efecfb9d72e9edc0a55d40e03c1fce
+  data.tar.gz: 01eb6f9e6d7cd0ac47783aae793144687f39daed896ce4d81f88306723b6ebec89c78330fc5c081ab0e96c5aa413f480a29c174960dc5a653d2e8edbd125fb10

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.0

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 parallax.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    parallax (0.1.0)
+      activesupport
+      msgpack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    msgpack (1.2.4)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  parallax!
+  rainbow
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.0

data/README.md

@@ -0,0 +1,86 @@
+# Parallax
+
+Parallax gem is a quick and simple framework to Ruby IPC and multi-core parallel execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parallax'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parallax
+
+## Usage
+
+You can use this gem in many ways.
+
+To execute parallel code with an array of elements, divide the elements in N groups and execute each chunk in one forked process.
+
+```ruby
+array = [ 'running', 'code', 'in', 'parallel' ]
+
+Parallax.execute array do |worker, array_chunk|
+  array_chunk.each do |element|
+    worker.send :log, "[#{worker.index}] #{element}"
+  end
+end
+
+# Example output with 4 cores:
+#   [1] code
+#   [3] parallel
+#   [0] running
+#   [2] in
+```
+
+If you need inter-process communication, this can be done by calling `worker.send` and passing a list of arguments. The args are serialized and passed via IO pipe to a `collector` object, which is by default an instance of `Parallax::Collector` class. The collector then parses the args and treats them like a method call where the first arg is the name of the method. In the example above, the collectors calls the `log` method which prints the second arg. Of course you can specify your own collector, as long as it responds to a `collect(*args)` method.
+
+```ruby
+class MyCollector
+  def receive(*args)
+    puts "Custom collector is receiving: #{args.inspect}"
+  end
+end
+
+array = [ 'running', 'code', 'in', 'parallel' ]
+
+Parallax.execute array, collector: MyCollector do |worker, array_chunk|
+  array_chunk.each do |element|
+    worker.send "[#{worker.index}] #{element}"
+  end
+end
+
+# Example output with 4 cores:
+#   Custom collector is receiving: ["[1] code"]
+#   Custom collector is receiving: ["[3] parallel"]
+#   Custom collector is receiving: ["[0] running"]
+#   Custom collector is receiving: ["[2] in"]
+```
+
+The collector object is returned by the `Parallax.execute` method, so if you need to store each worker processed data you can use the `worker.store` method or implement it in your own custom collector.
+
+Other options you can pass to execute are:
+* `processes`: the number of processes in which parallelize the execution.      Defaults to `Etc.nprocessors` (which is equal to the number of cores of the current running machine).
+
+Methods available for a `worker` object, which are collected in the `collector` object:
+* `log(message)`: prints a message in stdout.
+* `store(object)`: stores an object with timestamp and worker index.
+* `rescue(error)`: rescues an error from a worker and raises the same error in the collector.
+* `close`: closes worker communication with the collector.
+
+## 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/Pluvie/parallax.

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 "parallax"
+
+# 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/parallax/collector.rb

@@ -0,0 +1,48 @@
+module Parallax
+  class Collector
+    
+    attr_accessor :workers_count
+    attr_accessor :workers_data
+    attr_accessor :closed_workers_count
+    attr_accessor :receiving_stream
+    attr_accessor :sending_stream
+
+    def initialize(workers_count)
+      @workers_count = workers_count
+      @closed_workers_count = 0
+      @receiving_stream, @sending_stream = IO.pipe
+      @workers_data = []
+    end
+
+    def collect
+      worker_index, method, *arguments = eval(@receiving_stream.gets.chomp)
+      self.send method, worker_index, *arguments
+    end
+
+    def log(worker_index, message)
+      puts message
+    end
+
+    def store(worker_index, object)
+      workers_data.push [ Time.now, worker_index, object ]
+    end
+
+    def rescue(worker_index, error_class, error_message)
+      raise error_class, "Worker #{worker_index} Error: #{error_message}"
+    end
+
+    def close_worker(worker_index)
+      @closed_workers_count += 1
+    end
+
+    def all_workers_terminated?
+      @closed_workers_count >= @workers_count
+    end
+
+    def close
+      @receiving_stream.close
+      @sending_stream.close
+    end
+    
+  end
+end

data/lib/parallax/version.rb

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

data/lib/parallax/worker.rb

@@ -0,0 +1,37 @@
+module Parallax
+  class Worker
+
+    attr_accessor :receiver
+    attr_accessor :index
+
+    def initialize(receiver, index)
+      @receiver = receiver
+      @index = index
+    end
+
+    def pack(*args)
+      [ self.index, *args ].inspect
+    end
+
+    def send(*args)
+      @receiver.sending_stream.puts pack(*args)
+    end
+
+    def log(message)
+      @receiver.sending_stream.puts pack(:log, message)
+    end
+
+    def store(object)
+      @receiver.sending_stream.puts pack(:store, object)
+    end
+
+    def rescue(error)
+      @receiver.sending_stream.puts pack(:rescue, error.class, error.message)
+    end
+
+    def close
+      @receiver.sending_stream.puts pack(:close_worker)
+    end
+
+  end
+end

data/lib/parallax.rb

@@ -0,0 +1,46 @@
+require 'active_support/core_ext/array'
+
+require 'parallax/version'
+require 'parallax/collector'
+require 'parallax/worker'
+
+module Parallax
+
+  class << self
+  
+    ##
+    # Divides the given elements in groups of N and executes
+    # each chunk in parallel with the given block.
+    #
+    # @param [Array] elements processing elements.
+    # @param [Hash] options secondary options.
+    #
+    # @return [Collector] all processes output collector.
+    def execute(elements, options = {}, &block)
+      processes = options[:processes] || Etc.nprocessors
+
+      collector = Parallax::Collector.new(processes)
+      elements_chunks = elements.in_groups(processes, false)
+      processes.times do |worker_index|
+        Process.fork do
+          begin
+            worker = Parallax::Worker.new(collector, worker_index)
+            yield worker, elements_chunks[worker_index]
+          rescue StandardError => error
+            worker.rescue error
+          ensure
+            worker.close
+          end
+        end
+      end
+      
+      until collector.all_workers_terminated?
+        collector.collect
+      end
+      collector.close
+      collector
+    end
+
+  end
+
+end

data/parallax.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "parallax/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "parallax"
+  spec.version       = Parallax::VERSION
+  spec.authors       = ["Francesco Ballardin"]
+  spec.email         = ["francesco.ballardin@develonproject.com"]
+
+  spec.summary       = %q{Enhances Ruby inter-process communication, to boost your parallel code execution.}
+  spec.description   = %q{Enhances Ruby inter-process communication, to boost your parallel code execution.}
+  spec.homepage      = "https://github.com/Pluvie/ruby-parallax"
+
+  # 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 "msgpack"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rainbow"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: parallax
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Ballardin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  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: activesupport
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rainbow
+  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: Enhances Ruby inter-process communication, to boost your parallel code
+  execution.
+email:
+- francesco.ballardin@develonproject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/parallax.rb
+- lib/parallax/collector.rb
+- lib/parallax/version.rb
+- lib/parallax/worker.rb
+- parallax.gemspec
+homepage: https://github.com/Pluvie/ruby-parallax
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Enhances Ruby inter-process communication, to boost your parallel code execution.
+test_files: []