multi_process 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d62d4ef2d14471f23abcd7c7015d4370acffba45c77007df13505dd96e9fd16
-  data.tar.gz: 479e3d12ed873435fcdebe1d8d1d37bab3fbd276f5db85bdb079fa0264bbae27
+  metadata.gz: ec194b3c4920ec50a3ff76ef6129c7950d9bf52f54d9fadbbd6e2be8820ad85a
+  data.tar.gz: ca53b1cd6dbe8b3522e6fa519a1c09843c52afdb30d0d4416e2814e801b94abe
 SHA512:
-  metadata.gz: 5865c7397ca0cfcdc7b91c4d1e02f573b85dd63e1b1876074c49d1e5e3595926e6ef9d04d49b0cf0863be3e7c7bdbef814f7fb04a0f389308484847442b699e6
-  data.tar.gz: c15f75913b1b3824386430e90202700ff2ac261f3ec09e4db46a52b9d2d639c3eda54102c00e3058bcdca01d1ffde87b4b79febe4d59474d99a86d889ba534e2
+  metadata.gz: '0709709c6a7b22570455a6c59f3581ad21ac4685bcdc4ef29b5f97dc260645e06a482aee960f30f7ff910850c78f11443004cbb8d6304ec59bddeafe1a2eb216'
+  data.tar.gz: 365c78a689b76dac6ea29400eed562488caf82ea83c945b691b2acb0a314d5e995197987f0d5dd014b3b6cdf6611f4a218e12ada743f783bed46d19ba604d7f3

data/.markdownlint.yml

@@ -0,0 +1,12 @@
+# markdownlint config
+
+# The CHANGELOG contains duplicated headers by design
+MD024: false
+
+# MD013/line-length: disable line length for all. We prefer lines as
+# long as paragraph with in-editor line breaks.
+MD013: false
+
+# MD048/code-fence-style: code fence style
+MD048:
+  style: backtick

data/.rubocop.yml

@@ -4,6 +4,6 @@ inherit_gem:
   rubocop-config: default.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: '2.7'
   SuggestExtensions: False
-  NewCops: enable
+  NewCops: enable

data/CHANGELOG.md

@@ -6,9 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [1.4.0] - 2025-05-13
+
+### Changed
+
+- Find free port in a cross-platform way by @tylerhunt (#13)
+
+### Fixed
+
+- Fix Process#available! error handling by @tylerhunt (#12)
+- Non-deterministic output causing intermittent spec failure by @tylerhunt (#14)
+
+## [1.3.0] - 2024-01-12
+
 ### Changed
 
-- Use unbundled environment for child processes to support nested bundler invokations by @tylerhunt (#10)
+- Use unbundled environment for child processes to support nested bundler invocations by @tylerhunt (#10)
 
 ### Fixed
 
@@ -45,7 +58,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Possible concurrent hash modification while iterating (#1)
 
-[Unreleased]: https://github.com/jgraichen/multi_process/compare/v1.2.1...HEAD
+[Unreleased]: https://github.com/jgraichen/multi_process/compare/v1.4.0...HEAD
+[1.4.0]: https://github.com/jgraichen/multi_process/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/jgraichen/multi_process/compare/v1.2.1...v1.3.0
 [1.2.1]: https://github.com/jgraichen/multi_process/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/jgraichen/multi_process/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/jgraichen/multi_process/compare/v1.1.0...v1.1.1

data/README.md

@@ -4,7 +4,7 @@ Run multiple processes.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'multi_process'
@@ -47,7 +47,7 @@ group.stop  # Stop processes
 
 ## Contributing
 
-1. Fork it (http://github.com/jgraichen/multi_process/fork)
+1. [Fork it](http://github.com/jgraichen/multi_process/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -55,7 +55,7 @@ group.stop  # Stop processes
 
 ## License
 
-Copyright © 2019-2023 Jan Graichen
+Copyright © 2019-2025 Jan Graichen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/lib/multi_process/group.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'timeout'
+
 module MultiProcess
   #
   # Store and run a group of processes.
@@ -27,7 +29,7 @@ module MultiProcess
     def initialize(receiver: nil, partition: nil)
       @processes = []
       @receiver  = receiver || MultiProcess::Logger.global
-      @partition = partition ? partition.to_i : 0
+      @partition = partition ? Integer(partition) : 0
       @mutex     = Mutex.new
     end
 

data/lib/multi_process/process/bundle_exec.rb

@@ -7,7 +7,7 @@ class MultiProcess::Process
   module BundleExec
     def initialize(*args)
       opts = args.last.is_a?(Hash) ? args.pop : {}
-      super %w[bundle exec] + args, opts
+      super(%w[bundle exec] + args, opts)
     end
   end
 end

data/lib/multi_process/process/rails.rb

@@ -30,7 +30,8 @@ class MultiProcess::Process
     end
 
     def port=(port)
-      @port = port.to_i.zero? ? free_port : port.to_i
+      port = Integer(port)
+      @port = port.zero? ? free_port : port
     end
 
     def port
@@ -63,7 +64,7 @@ class MultiProcess::Process
 
     def free_port
       socket = Socket.new(:INET, :STREAM, 0)
-      socket.bind(Addrinfo.tcp('localhost', 0))
+      socket.bind(Addrinfo.tcp('127.0.0.1', 0))
       socket.local_address.ip_port
     ensure
       socket&.close

data/lib/multi_process/process.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'timeout'
 
 module MultiProcess
   #
@@ -31,7 +32,7 @@ module MultiProcess
       @childprocess = create_childprocess(*args)
 
       @env          = opts[:env] if opts[:env].is_a?(Hash)
-      @env_clean    = opts[:clean_env].nil? ? true : !opts[:clean_env].nil?
+      @env_clean    = opts[:clean_env].nil? || !opts[:clean_env].nil?
 
       self.receiver = opts[:receiver] || MultiProcess::Logger.global
 
@@ -94,29 +95,29 @@ module MultiProcess
       childprocess.stop(*args) if started?
     end
 
-    # Check if server is available. What available means can be defined
-    # by subclasses e.g. a server process can check if server port is reachable.
+    # Check if the process is available. What available means can be defined
+    # by subclasses e.g. a server process can check if its port is reachable.
     #
-    # By default is process if available if alive? returns true.
+    # By default a process is available if `#alive?` returns true.
     #
     def available?
       alive?
     end
 
-    # Wait until process is available. See {#available?}.
+    # Wait until the process is available. See {#available?}.
     #
     # @param opts [Hash] Options.
     # @option opts [Integer] :timeout Timeout in seconds. Will raise
     #  Timeout::Error if timeout is reached.
     #
     def available!(opts = {})
-      timeout = opts[:timeout] ? opts[:timeout].to_i : MultiProcess::DEFAULT_TIMEOUT
+      timeout = opts[:timeout] ? Float(opts[:timeout]) : MultiProcess::DEFAULT_TIMEOUT
 
       Timeout.timeout timeout do
         sleep 0.2 until available?
       end
     rescue Timeout::Error
-      raise Timeout::Error.new "Server #{id.inspect} on port #{port} didn't get up after #{timeout} seconds..."
+      raise Timeout::Error.new "Process #{pid} failed to start."
     end
 
     # Check if process was started.

data/lib/multi_process/version.rb

@@ -3,7 +3,7 @@
 module MultiProcess
   module VERSION
     MAJOR = 1
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.')

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: multi_process
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jan Graichen
-autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -38,19 +37,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Handle multiple child processes.
-email:
-- jg@altimos.de
+email: jgraichen@altimos.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".github/workflows/test.yml"
-- ".gitignore"
+- ".markdownlint.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -66,22 +61,15 @@ files:
 - lib/multi_process/receiver.rb
 - lib/multi_process/string_receiver.rb
 - lib/multi_process/version.rb
-- multi_process.gemspec
 - renovate.json
-- spec/files/env.rb
-- spec/files/fail.rb
-- spec/files/sleep.rb
-- spec/files/test.rb
-- spec/multi_process/group_spec.rb
-- spec/multi_process/process_spec.rb
-- spec/multi_process_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/jgraichen/multi_process
 licenses:
 - GPLv3
 metadata:
+  changelog_uri: https://github.com/jgraichen/multi_process/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/jgraichen/multi_process
+  source_code_uri: https://github.com/jgraichen/multi_process.git
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Handle multiple child processes.
+summary: Run multiple processes
 test_files: []

data/.github/workflows/test.yml

@@ -1,38 +0,0 @@
-# vim: ft=yaml
-
-name: test
-on: push
-jobs:
-  rspec:
-    name: ruby-${{ matrix.ruby }}
-    runs-on: ubuntu-22.04
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["3.2", "3.1", "3.0", "2.7"]
-
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: True
-
-      - run: bundle exec rspec --color
-
-  rubocop:
-    name: rubocop
-    runs-on: ubuntu-22.04
-
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: True
-        env:
-          BUNDLE_JOBS: 4
-          BUNDLE_RETRY: 3
-
-      - run: bundle exec rubocop --parallel --color

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.rspec

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in multi_process.gemspec
-gemspec
-
-gem 'rake'
-gem 'rake-release', '~> 1.3'
-gem 'rspec', '~> 3.11'
-gem 'rubocop-config', github: 'jgraichen/rubocop-config', ref: 'v11', require: false

data/multi_process.gemspec

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'multi_process/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'multi_process'
-  spec.version       = MultiProcess::VERSION
-  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.metadata['rubygems_mfa_required'] = 'true'
-  spec.required_ruby_version = '>= 2.7'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'childprocess'
-  spec.add_runtime_dependency 'nio4r', '~> 2.0'
-end

data/spec/files/env.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-$stdout.puts "ENV: #{ENV.fetch(ARGV[0], nil)}"
-$stdout.sync
-
-sleep 1

data/spec/files/fail.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-exit Integer(ARGV.fetch(0, '1'))

data/spec/files/sleep.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-sleep ARGV[0].to_i

data/spec/files/test.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-2.times do
-  $stdout.puts "Output from #{ARGV[0]}"
-  $stdout.flush
-  sleep rand
-end

data/spec/multi_process/group_spec.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe MultiProcess::Group do
-  subject(:group) { MultiProcess::Group.new }
-
-  before do
-    group << MultiProcess::Process.new(command)
-  end
-
-  describe '#run!' do
-    context 'with failing command' do
-      let(:command) { %w[ruby spec/files/fail.rb] }
-
-      it 'does raise an error' do
-        expect { group.run! }.to raise_error(MultiProcess::ProcessError, /Process \d+ exited with code 1/)
-      end
-    end
-
-    context 'with partition and failing command' do
-      subject(:group) { MultiProcess::Group.new(partition: 1) }
-
-      let(:command) { %w[ruby spec/files/fail.rb] }
-
-      it 'does raise an error' do
-        expect { group.run! }.to raise_error(MultiProcess::ProcessError, /Process \d+ exited with code 1/)
-      end
-    end
-  end
-end

data/spec/multi_process/process_spec.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe MultiProcess::Process do
-  subject(:process) { MultiProcess::Process.new(command) }
-
-  describe '#run!' do
-    context 'with failing command' do
-      let(:command) { %w[ruby spec/files/fail.rb] }
-
-      it 'does raise an error' do
-        expect { process.run! }.to raise_error(MultiProcess::ProcessError, /Process \d+ exited with code 1/)
-      end
-    end
-  end
-end

data/spec/multi_process_spec.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe MultiProcess do
-  it 'runs processes (I)' do
-    reader, writer = IO.pipe
-
-    logger = MultiProcess::Logger.new writer, collapse: false
-    group  = MultiProcess::Group.new receiver: logger
-    group << MultiProcess::Process.new(%w[ruby spec/files/test.rb A], title: 'rubyA')
-    group << MultiProcess::Process.new(%w[ruby spec/files/test.rb B], title: 'rubyBB')
-    group << MultiProcess::Process.new(%w[ruby spec/files/test.rb C], title: 'rubyCCC')
-    group.run
-
-    expect(reader.read_nonblock(4096).split("\n")).to match_array <<-OUTPUT.gsub(/^\s+\./, '').split("\n")
-    .  rubyBB  | Output from B
-    .   rubyA  | Output from A
-    .   rubyA  | Output from A
-    . rubyCCC  | Output from C
-    . rubyCCC  | Output from C
-    .  rubyBB  | Output from B
-    OUTPUT
-  end
-
-  it 'runs processes (II)' do
-    start = Time.now
-
-    group = MultiProcess::Group.new receiver: MultiProcess::NilReceiver.new
-    group << MultiProcess::Process.new(%w[ruby spec/files/sleep.rb 5000], title: 'rubyA')
-    group << MultiProcess::Process.new(%w[ruby spec/files/sleep.rb 5000], title: 'rubyB')
-    group << MultiProcess::Process.new(%w[ruby spec/files/sleep.rb 5000], title: 'rubyC')
-    group.start
-    sleep 1
-    group.stop
-
-    group.processes.each do |p|
-      expect(p).not_to be_alive
-    end
-    expect(Time.now - start).to be < 2
-  end
-
-  it 'starts a process added after the group has been started' do
-    reader, writer = IO.pipe
-
-    logger = MultiProcess::Logger.new writer, collapse: false
-    group  = MultiProcess::Group.new receiver: logger
-    group << MultiProcess::Process.new(%w[ruby spec/files/test.rb 1], title: 'ruby1')
-    group.start
-    group << MultiProcess::Process.new(%w[ruby spec/files/test.rb 2], title: 'ruby2')
-    sleep 1
-    group.stop
-
-    expect(reader.read_nonblock(4096).split("\n")).to match_array <<-OUTPUT.gsub(/^\s+\./, '').split("\n")
-    . ruby1  | Output from 1
-    . ruby1  | Output from 1
-    . ruby2  | Output from 2
-    . ruby2  | Output from 2
-    OUTPUT
-  end
-
-  it 'partitions processes' do
-    group = MultiProcess::Group.new partition: 4, receiver: MultiProcess::NilReceiver.new
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyA')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyB')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyC')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyD')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyE')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyF')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyG')
-    group << MultiProcess::Process.new(%w[ruby sleep.rb 1], dir: 'spec/files', title: 'rubyH')
-
-    start = Time.now
-    group.run
-    expect(Time.now - start).to be_within(0.5).of(2)
-  end
-
-  it 'envs processes' do
-    receiver = MultiProcess::StringReceiver.new
-    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"
-  end
-end

data/spec/spec_helper.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec'
-
-require 'bundler'
-Bundler.require
-
-require 'multi_process'
-
-Dir[File.expand_path('spec/support/**/*.rb')].sort.each {|f| require f }
-
-RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-
-  # Raise error when using old :should expectation syntax.
-  config.raise_errors_for_deprecations!
-end