parallel-forkmanager 1.0.1 → 2.0.6

data/lib/parallel/forkmanager/dummy_process_status.rb

@@ -0,0 +1,30 @@
+module Parallel
+  class ForkManager
+    ##
+    # This class lets us build a dummy exit status which can be used where we
+    # expect a Process::Status.
+    class DummyProcessStatus
+      ##
+      # @param exitstatus [Integer] The exit status we want to simulate.
+      def initialize(exitstatus = 0)
+        @exitstatus = (Integer(exitstatus) & 0x37)
+      end
+
+      ##
+      # @return [Integer]
+      attr_reader :exitstatus
+
+      ##
+      # @return [nil]
+      def stopsig
+        nil
+      end
+
+      ##
+      # @return [false]
+      def coredump?
+        false
+      end
+    end
+  end
+end

data/lib/parallel/forkmanager/error.rb

@@ -0,0 +1,20 @@
+module Parallel
+  class ForkManager
+    ##
+    # The class from which all of {Parallel::ForkManager}'s error exceptions
+    # should inherit.  This makes rescuing them easier.
+    class Error < RuntimeError; end
+
+    ##
+    # Raised when an unknown type of serialization is requested.
+    class UnknownSerializerError < Error; end
+
+    ##
+    # Raised when the specified temporary directory isn't a directory.
+    class MissingTempDirError < Error; end
+
+    ##
+    # Raised when we call +start+ in a child process.
+    class AttemptedStartInChildProcessError; end
+  end
+end

data/lib/parallel/forkmanager/process_interface.rb

@@ -0,0 +1,51 @@
+require "English"
+require "forwardable"
+
+module Parallel
+  class ForkManager
+    ##
+    # This module defines an interface to +fork+ & +waitpid+ so that there is a
+    # good "seam" at which to mock.
+    #
+    # {Parallel::ForkManager::ProcessInterface} adds a process_interface
+    # attribute and delegates fork, child_status, and waitpid to it as private
+    # methods.
+    module ProcessInterface
+      extend Forwardable
+
+      attr_reader :process_interface
+      private :process_interface
+
+      # Not quite sure why fork can't be delegated successfully.
+      def fork(*args, &block)
+        process_interface.fork(*args, &block)
+      end
+      private :fork
+
+      def_delegators :@process_interface, :child_status, :waitpid
+      private :child_status, :waitpid
+
+      ##
+      # A Parallel::ProcessInterface::Instance is something we can delegate to.
+      class Instance
+        ##
+        # Calls Kernel.fork and returns its return value.
+        def fork(*args, &block)
+          Kernel.fork(*args, &block)
+        end
+
+        ##
+        # Calls Process.waitpid and returns its return value.
+        def waitpid(*args)
+          Process.waitpid(*args)
+        end
+
+        ##
+        # @return [Process::Status] the child's process status.
+        def child_status
+          $CHILD_STATUS
+        end
+      end
+    end
+  end
+end

data/lib/parallel/forkmanager/serializer.rb

@@ -0,0 +1,59 @@
+require "yaml"
+require_relative "error"
+
+module Parallel
+  class ForkManager
+    # TODO: Maybe make this into a factory, given the number of case statements
+    # switching on type.  This is a "shameless green" if you use Sandi Metz's
+    # terminology.
+    class Serializer
+      ##
+      # Raises a {Parallel::ForkManager::UnknownSerializerError} exception if
+      # +type+ isn't one of +marshal+ or +yaml+
+      #
+      # @param type [String] The type of serialization to use.
+      def initialize(type)
+        @type = validate_type(type)
+      end
+
+      ##
+      # @param data_structure [Object] the data to be serialized.
+      # @return [String] the serialized representation of the data.
+      def serialize(data_structure)
+        case type
+        when :marshal
+          Marshal.dump(data_structure)
+        when :yaml
+          YAML.dump(data_structure)
+        end
+      end
+
+      ##
+      # @param serialized [String] the serialized representation of the data.
+      # @return [Object] the resonstituted data structure.
+      def deserialize(serialized)
+        case type
+        when :marshal
+          Marshal.load(serialized)
+        when :yaml
+          YAML.load(serialized)
+        end
+      end
+
+      private
+
+      attr_reader :type
+
+      def validate_type(t)
+        case t.downcase
+        when "marshal"
+          :marshal
+        when "yaml"
+          :yaml
+        else
+          fail Parallel::ForkManager::UnknownSerializerError
+        end
+      end
+    end
+  end
+end

data/lib/parallel/forkmanager/version.rb

@@ -0,0 +1,8 @@
+module Parallel
+  class ForkManager
+    ##
+    # This is the version of the Parallel::ForkManager, used in the library and
+    # in the rake task for packaging.
+    VERSION = "2.0.6"
+  end
+end

data/parallel-forkmanager.gemspec

@@ -0,0 +1,32 @@
+require "pathname"
+lib = (Pathname(__FILE__).dirname + "lib").to_s
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "parallel/forkmanager/version"
+
+Gem::Specification.new do |s|
+  s.platform  =   Gem::Platform::RUBY
+  s.name      =   "parallel-forkmanager"
+  s.version   =   Parallel::ForkManager::VERSION
+  s.author    =   "Nathan Patwardhan"
+  s.homepage  =   "https://github.com/npatwardhan/ruby-parallel-forkmanager/"
+  s.email     =   "noopy.org<at>gmail.com"
+  s.description = <<-ETX
+A simple parallel processing fork manager, based on the Perl module.
+  ETX
+  s.license   =   "Ruby"
+  s.summary   =   "A simple parallel processing fork manager."
+
+  s.files         = `git ls-files -z`.split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "bin"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # recommended versions commented out because we are testing against some
+  # older rubies...
+  s.add_development_dependency "bundler"  # , "~> 1.9"
+  s.add_development_dependency "rake"     # , "~> 10.0"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "yard"
+end

metadata

@@ -1,55 +1,134 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: parallel-forkmanager
-version: !ruby/object:Gem::Version 
-  version: 1.0.1
+version: !ruby/object:Gem::Version
+  version: 2.0.6
 platform: ruby
-authors: 
+authors:
 - Nathan Patwardhan
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2020-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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 parallel processing fork manager, based on the Perl module.
 
-date: 2009-10-24 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: 
-email: noopy.org @nospam@ gmail.com
+'
+email: noopy.org<at>gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- EXAMPLES.yard
+- Gemfile
+- README.md
+- Rakefile
+- examples/callbacks.rb
+- examples/data_structures_advanced.rb
+- examples/data_structures_string.rb
+- examples/parallel_http_get.rb
+- examples/use_pfm.rb
 - lib/parallel/forkmanager.rb
-- use_pfm.rb
-- parallel_http_get.rb
-has_rdoc: true
-homepage: http://rubyforge.org/projects/parallelforkmgr/
+- lib/parallel/forkmanager/dummy_process_status.rb
+- lib/parallel/forkmanager/error.rb
+- lib/parallel/forkmanager/process_interface.rb
+- lib/parallel/forkmanager/serializer.rb
+- lib/parallel/forkmanager/version.rb
+- parallel-forkmanager.gemspec
+homepage: https://github.com/npatwardhan/ruby-parallel-forkmanager/
+licenses:
+- Ruby
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-- lib/parallel
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_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"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: parallelforkmgr
-rubygems_version: 1.3.1
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: A simple parallel processing fork manager.
 test_files: []
-

data/parallel_http_get.rb

@@ -1,53 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'net/http'
-require 'lib/parallel/forkmanager'
-
-save_dir = '/tmp'
-
-my_urls = [
-    'http://www.cnn.com/index.html',
-    'http://www.oreilly.com/index.html',
-    'http://www.cakewalk.com/index.html',
-    'http://www.asdfsemicolonl.kj/index.htm'
-]
-
-max_proc = 20
-pfm = Parallel::ForkManager.new(max_proc)
-
-pfm.run_on_finish(
-    lambda {
-        |pid,exit_code,ident|
-        print "** PID (#{pid}) for #{ident} exited with code #{exit_code}!\n"
-    }
-)
-
-for my_url in my_urls
-    pfm.start(my_url) and next
-
-    url = URI.parse(my_url)
-
-    begin
-        req = Net::HTTP::Get.new(url.path)
-        res = Net::HTTP.start(url.host, url.port) {|http|
-            http.request(req)
-        }
-    rescue
-        pfm.finish(255)
-    end
-
-    status = res.code
-    out_file = save_dir + '/' + url.host + '.txt';
-
-    if status.to_i == 200
-        f = File.open(out_file, 'w')
-        f.print res.body
-        f.close()
-        pfm.finish(0)
-    else
-        pfm.finish(255)
-    end
-end
-
-pfm.wait_all_children()
-

data/use_pfm.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby
-
-require "lib/parallel/forkmanager"
-
-num_procs = 20
-pfm = Parallel::ForkManager.new(num_procs)
-
-items = 1..10
-
-pfm.run_on_start(
-    lambda {
-        |pid,ident|
-        print "run on start ::: #{ident} (#{pid})\n"
-    }
-)
-
-pfm.run_on_finish(
-    lambda {
-        |pid,exit_code,ident|
-        print "  on_finish: ** PID: #{pid} EXIT: #{exit_code} IDENT: #{ident}\n"
-    }
-)
-
-timeout = 0.5
-pfm.run_on_wait(
-    lambda {
-        print "** Have to wait for one child ...\n"
-    },
-    timeout
-)
-
-for item in items
-    my_item = 'nate-' + item.to_s
-    pid = pfm.start(my_item) and next
-
-    pfm.finish()
-end
-
-pfm.wait_all_children()
-