multi_process 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ed246c253f6ea4749f55ee0fecb88362b14f4ee
-  data.tar.gz: 3dc45356e8af8de981bf7aa55ba01e15d0e94af5
+  metadata.gz: b79dfed9809a87ffa684f477aa18f52ab0874998
+  data.tar.gz: a2499bf8685aaa502893af7848d7de805e104e5a
 SHA512:
-  metadata.gz: a1d41519fa0047ed43402b2999183dcf5a38f75a1ed21081d81c3720877c4186d60fc66e845050bc28a4b3e1d9d2edae05f68cc4e57376a5e1601dd0adf5d471
-  data.tar.gz: b12e9cd8912107d2e0cf63401c7c11dbd0a20c92573ecf5a1c9191e8191dcccecaba7742049f85d5ee49b64e3b39b576ded43e903ca7417528c98c1bb5b9f3b6
+  metadata.gz: 12f8ae434f79b4168460722d3cff268ae2b230084e89ff000e9c758a3d8f625d47bf3a7d0a8169db4e2e6df36e61e1e0920f8192c89cdb526a814f4d3789d07d
+  data.tar.gz: 10e081ebeb820e7563fd9c91c50c962216283c7cee939da51b8adbcc74e49d72d983e6df9e4415c71f6b383e4ebaa5e8069b3968fdbff76b9e17e2a1fce19f0a

data/README.md

@@ -1,6 +1,6 @@
 # MultiProcess
 
-Handle multiple processes.
+Handle multiple processes. Ruby >= 2.0.
 
 TODO: Just experiment.
 

data/Rakefile

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

data/lib/multi_process/group.rb

@@ -1,9 +1,9 @@
 module MultiProcess
-
+  #
   # Store and run a group of processes.
   #
   class Group
-
+    #
     # Return list of processes.
     attr_reader :processes
 
@@ -22,10 +22,10 @@ module MultiProcess
     # @option otps [ Receiver ] :receiver Receiver to use for new added
     #   processes. Defaults to `MultiProcess::Logger.global`.
     #
-    def initialize(opts = {})
+    def initialize(receiver: nil, partition: nil)
       @processes = []
-      @receiver  = opts[:receiver] ? opts[:receiver] : MultiProcess::Logger.global
-      @partition = opts[:partition] ? opts[:partition].to_i : 0
+      @receiver  = receiver ? receiver : MultiProcess::Logger.global
+      @partition = partition ? partition.to_i : 0
       @mutex     = Mutex.new
     end
 
@@ -35,14 +35,12 @@ module MultiProcess
     #
     # @param process [Process, Array<Process>] New process or processes.
     #
-    def <<(process)
-      Array(process).flatten.each do |process|
+    def <<(processes)
+      Array(processes).flatten.each do |process|
         processes << process
         process.receiver = receiver
 
-        if started?
-          start process
-        end
+        start process if started?
       end
     end
 
@@ -50,15 +48,14 @@ module MultiProcess
     #
     # Call blocks until all processes are started.
     #
-    # @param opts [ Hash ] Options.
-    # @option opts [ Integer ] :delay Delay in seconds between starting processes.
+    # @option delay [Integer] Delay in seconds between starting processes.
     #
-    def start(opts = {})
+    def start(delay: nil)
       processes.each do |process|
-        unless process.started?
-          process.start
-          sleep opts[:delay] if opts[:delay]
-        end
+        next if process.started?
+
+        process.start
+        sleep delay if delay
       end
     end
 
@@ -67,15 +64,13 @@ module MultiProcess
     # @return [ Boolean ] True if group was already started.
     #
     def started?
-      processes.any? &:started?
+      processes.any?(&:started?)
     end
 
     # Stop all processes.
     #
     def stop
-      processes.each do |process|
-        process.stop
-      end
+      processes.each(&:stop)
     end
 
     # Wait until all process terminated.
@@ -84,11 +79,11 @@ module MultiProcess
     # @option opts [ Integer ] :timeout Timeout in seconds to wait before
     #   raising {Timeout::Error}.
     #
-    def wait(opts = {})
-      opts[:timeout] ||= 30
-
-      ::Timeout::timeout(opts[:timeout]) do
-        processes.each{|p| p.wait}
+    def wait(timeout: nil)
+      if timeout
+        ::Timeout.timeout(timeout) { wait }
+      else
+        processes.each(&:wait)
       end
     end
 
@@ -100,20 +95,18 @@ module MultiProcess
     # If timeout is given process will be terminated using {#stop}
     # when timeout error is raised.
     #
-    def run(opts = {})
+    def run(**kwargs)
       if partition > 0
-        threads = Array.new
-        partition.times do
-          threads << Thread.new do
+        partition.times.map do
+          Thread.new do
             while (process = next_process)
               process.run
             end
           end
-        end
-        threads.each &:join
+        end.each(&:join)
       else
-        start opts
-        wait opts
+        start(**kwargs)
+        wait(**kwargs)
       end
     ensure
       stop
@@ -124,14 +117,14 @@ module MultiProcess
     # @return [ Boolean ] True if group is alive.
     #
     def alive?
-      processes.any? &:alive?
+      processes.any?(&:alive?)
     end
 
     # Check if group is available. The group is available if all
     # processes are available.
     #
     def available?
-      !processes.any?{|p| !p.available? }
+      processes.all?(:available?)
     end
 
     # Wait until group is available. This implies waiting until
@@ -143,15 +136,14 @@ module MultiProcess
     # @option opts [ Integer ] :timeout Timeout in seconds to wait for processes
     #   to become available. Defaults to {MultiProcess::DEFAULT_TIMEOUT}.
     #
-    def available!(opts = {})
-      timeout = opts[:timeout] ? opts[:timeout].to_i : MultiProcess::DEFAULT_TIMEOUT
-
+    def available!(timeout: MultiProcess::DEFAULT_TIMEOUT)
       Timeout.timeout timeout do
-        processes.each{|p| p.available! }
+        processes.each(&:available!)
       end
     end
 
     private
+
     def next_process
       @mutex.synchronize do
         @index ||= 0

data/lib/multi_process/logger.rb

@@ -1,11 +1,9 @@
 module MultiProcess
-
   # Can create pipes and multiplex pipe content to put into
   # given IO objects e.g. multiple output from multiple
   # processes to current stdout.
   #
   class Logger < Receiver
-
     # Create new logger.
     #
     # @param out [IO] IO to push formatted output from
@@ -14,7 +12,7 @@ module MultiProcess
     #   error sources.
     #
     def initialize(*args)
-      @opts  = Hash === args.last ? args.pop : Hash.new
+      @opts  = Hash === args.last ? args.pop : {}
       @out   = args[0] || $stdout
       @err   = args[1] || $stderr
 
@@ -43,14 +41,15 @@ module MultiProcess
     end
 
     private
+
     def output(process, line, opts = {})
       @mutex.synchronize do
         opts[:delimiter]   ||= ' |'
         name = if opts[:name]
-          opts[:name].to_s.dup
-        else
-          max = @readers.values.map{|h| h[:process] ? h[:process].title.length : 0 }.max
-          process ? process.title.to_s.rjust(max, ' ') : (' ' * max)
+                 opts[:name].to_s.dup
+               else
+                 max = @readers.values.map { |h| h[:process] ? h[:process].title.length : 0 }.max
+                 process ? process.title.to_s.rjust(max, ' ') : (' ' * max)
         end
 
         io = opts[:io] || @out
@@ -68,7 +67,7 @@ module MultiProcess
 
     class << self
       def global
-        @global ||= self.new $stdout, $stderr
+        @global ||= new $stdout, $stderr
       end
     end
   end

data/lib/multi_process/nil_receiver.rb

@@ -1,12 +1,10 @@
 module MultiProcess
-
   # Receiver implementation that does nothing on every input.
   #
   class NilReceiver < Receiver
-
     # Do nothing.
     #
-    def received(process, name, message)
+    def received(_process, _name, _message)
       nil
     end
   end

data/lib/multi_process/process.rb

@@ -1,13 +1,13 @@
 require 'active_support/core_ext/module/delegation'
 
 module MultiProcess
-
+  #
   # Describes a single process that can be configured and run.
   #
   # {Process} basically is just a thin wrapper around {ChildProcess}.
   #
   class Process
-    #@!group Process
+    # @!group Process
 
     # Process title used in e.g. logger
     attr_reader :title
@@ -23,7 +23,7 @@ module MultiProcess
       opts = (Hash === args.last ? args.pop : {})
 
       @title        = opts[:title].to_s || args.first.to_s.strip.split(/\s+/, 2)[0]
-      @command      = args.map{ |arg| (arg =~ /\A[\s"']+\z/ ? arg.inspect : arg).gsub '"', '\"' }.join(' ')
+      @command      = args.map { |arg| (arg =~ /\A[\s"']+\z/ ? arg.inspect : arg).gsub '"', '\"' }.join(' ')
       @childprocess = create_childprocess *args
 
       @env          = opts[:env] if Hash === opts[:env]
@@ -63,7 +63,7 @@ module MultiProcess
       return false if started?
 
       at_exit { stop }
-      receiver.message(self, :sys, self.command) if receiver
+      receiver.message(self, :sys, command) if receiver
       start_childprocess
       @started = true
     end
@@ -116,7 +116,7 @@ module MultiProcess
       wait opts
     end
 
-  #@!group Working Directory
+    # @!group Working Directory
 
     # Working directory for child process.
     attr_reader :dir
@@ -126,10 +126,10 @@ module MultiProcess
     #
     def dir=(dir)
       @dir = ::File.expand_path(dir.to_s)
-      self.env['PWD'] = @dir
+      env['PWD'] = @dir
     end
 
-    #@!group Environment
+    # @!group Environment
 
     # Check if environment will be cleaned up for process.
     #
@@ -144,17 +144,17 @@ module MultiProcess
     # Return current environment.
     #
     def env
-      @env ||= Hash.new
+      @env ||= {}
     end
 
     # Set environment.
     #
     def env=(env)
-      raise ArgumentError.new 'Environment must be a Hash.' unless hash === env
+      fail ArgumentError.new 'Environment must be a Hash.' unless hash === env
       @env = env
     end
 
-    #@!group Receiver
+    # @!group Receiver
 
     # Current receiver. Defaults to `MultiProcess::Logger.global`.
     #
@@ -186,7 +186,7 @@ module MultiProcess
     # Can be used to hook in subclasses and modules.
     #
     def start_childprocess
-      env.each{|k, v| childprocess.environment[k.to_s] = v.to_s }
+      env.each { |k, v| childprocess.environment[k.to_s] = v.to_s }
       childprocess.cwd = dir
 
       if clean_env?

data/lib/multi_process/process/bundle_exec.rb

@@ -1,12 +1,10 @@
 class MultiProcess::Process
-
   # Provides functionality to wrap command in with bundle
   # execute.
   #
   module BundleExec
-
     def initialize(*args)
-      opts = Hash === args.last ? args.pop : Hash.new
+      opts = Hash === args.last ? args.pop : {}
       super %w(bundle exec) + args, opts
     end
   end

data/lib/multi_process/process/rails.rb

@@ -1,5 +1,4 @@
 class MultiProcess::Process
-
   # Provides functionality for a process that is a rails server
   # process.
   #
@@ -9,7 +8,6 @@ class MultiProcess::Process
   # availability check based on if server socket is reachable.
   #
   module Rails
-
     # Server wrapper given as argument to `server` action.
     #
     attr_reader :server
@@ -44,7 +42,7 @@ class MultiProcess::Process
     end
 
     def available?
-      raise ArgumentError.new "Cannot check availability for port #{port}." if port == 0
+      fail ArgumentError.new "Cannot check availability for port #{port}." if port == 0
 
       TCPSocket.new('127.0.0.1', port).close
       true
@@ -69,7 +67,7 @@ class MultiProcess::Process
 
     def free_port
       socket = Socket.new(:INET, :STREAM, 0)
-      socket.bind(Addrinfo.tcp("127.0.0.1", 0))
+      socket.bind(Addrinfo.tcp('127.0.0.1', 0))
       socket.local_address.ip_port
     ensure
       socket.close if socket

data/lib/multi_process/receiver.rb

@@ -1,10 +1,8 @@
 module MultiProcess
-
   # Can handle input from multiple processes and run custom
   # actions on event and output.
   #
   class Receiver
-
     # Mutex to synchronize operations.
     #
     attr_reader :mutex
@@ -21,7 +19,7 @@ module MultiProcess
               op = @readers[reader]
 
               if reader.eof?
-                @readers.delete_if { |key, value| key == reader }
+                @readers.delete_if { |key, _value| key == reader }
                 removed op[:process], op[:name]
               else
                 received op[:process], op[:name], read(reader)
@@ -43,7 +41,7 @@ module MultiProcess
     #
     def pipe(process, name)
       reader, writer = IO.pipe
-      @readers[reader] = {name: name, process: process}
+      @readers[reader] = { name: name, process: process }
       connected process, name
       writer
     end
@@ -61,8 +59,8 @@ module MultiProcess
     #
     # Must be overridden by subclass.
     #
-    def received(process, name, message)
-      raise NotImplementedError.new 'Subclass responsibility.'
+    def received(_process, _name, _message)
+      fail NotImplementedError.new 'Subclass responsibility.'
     end
 
     # Read content from pipe. Can be used to provide custom reading
@@ -77,14 +75,12 @@ module MultiProcess
     # Called after pipe for process and name was removed because it
     # reached EOF.
     #
-    def removed(process, name)
-
+    def removed(_process, _name)
     end
 
     # Called after new pipe for process and name was created.
     #
-    def connected(process, name)
-
+    def connected(_process, _name)
     end
   end
 end

data/lib/multi_process/string_receiver.rb

@@ -1,17 +1,15 @@
 module MultiProcess
-
   # Receiver implementation storing process output
   # in string.
   #
   class StringReceiver < Receiver
-
-    def received(process, name, message)
+    def received(_process, name, message)
       get(name) << message
     end
 
     def get(name)
-      @strings ||= Hash.new
-      @strings[name.to_s] ||= String.new
+      @strings ||= {}
+      @strings[name.to_s] ||= ''
     end
   end
 end

data/lib/multi_process/version.rb

@@ -1,11 +1,13 @@
 module MultiProcess
   module VERSION
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
 
-    def self.to_s; STRING end
+    def self.to_s
+      STRING
+    end
   end
 end

data/multi_process.gemspec

@@ -4,22 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'multi_process/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "multi_process"
+  spec.name          = 'multi_process'
   spec.version       = MultiProcess::VERSION
-  spec.authors       = ["Jan Graichen"]
-  spec.email         = ["jg@altimos.de"]
-  spec.summary       = %q{Handle multiple child processes.}
-  spec.description   = %q{Handle multiple child processes.}
-  spec.homepage      = "https://github.com/jgraichen/multi_process"
-  spec.license       = "GPLv3"
+  spec.authors       = ['Jan Graichen']
+  spec.email         = ['jg@altimos.de']
+  spec.summary       = 'Handle multiple child processes.'
+  spec.description   = 'Handle multiple child processes.'
+  spec.homepage      = 'https://github.com/jgraichen/multi_process'
+  spec.license       = 'GPLv3'
 
   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.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '>= 3.1'
   spec.add_runtime_dependency 'childprocess'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'bundler', '~> 1.5'
 end

data/spec/multi_process_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe MultiProcess do
-
   it 'should run processes' do
     reader, writer = IO.pipe
 
@@ -57,7 +56,7 @@ describe MultiProcess do
 
   it 'should env processes' do
     receiver = MultiProcess::StringReceiver.new
-    process  = MultiProcess::Process.new(%w(ruby spec/files/env.rb TEST), env: {'TEST' => "abc"}, receiver: receiver)
+    process  = MultiProcess::Process.new(%w(ruby spec/files/env.rb TEST), env: { 'TEST' => 'abc' }, receiver: receiver)
     process.run
 
     expect(receiver.get(:out)).to eq "ENV: abc\n"

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ Bundler.require
 
 require 'multi_process'
 
-Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f}
+Dir[File.expand_path('spec/support/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
   # ## Mock Framework

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_process
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Handle multiple child processes.