aruba 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81d7260059ff82a28fa715d2a679f65ac9fbf6952e560b887c1c9a546727e3cd
-  data.tar.gz: d5aa01763869599dd1b69b66fd6f3504ea781a6b5aa6742c5146eb05c833341b
+  metadata.gz: 5ecd6da4e86f63a073bffd882d13902780ca69946de8867aa81cba5a8c6ad118
+  data.tar.gz: f588ff00344ee379a877dbbed442d411769516d8f2f53a164b6a219660e0c38a
 SHA512:
-  metadata.gz: 5552a1bc0e6fd93e96626a0a8ca6e92d62ab56f17020170fe5156be69c91430497edb20ad096b862b99bda50cff49975c6f2641d1d319ddfe8186a09c225c7be
-  data.tar.gz: f791bb3f0603fa86661d782e0c6d82a6363a37b4cd9e034783871271574d358031ac3f1d616a8bd6669d06cb1454558e3353384183f1d8f97da905ab6687461e
+  metadata.gz: d35cd2c9c3d89085f0a04ad2bf2e7b8b83b1cd10cebb87ed39111d0d3feb39b18ad905c5a02e9773881687574abc4b57c5c1d281d7432b746b8f685bd6862f7a
+  data.tar.gz: cd8bbb1369f18078e3d27a56fb43bef2fc3d25c9b17d81921d30ad759d4c8b16ac5c3a49e7e26e5d19a041df7fcb67da6e978b3c2f79198e22f05b585caa90db

data/CHANGELOG.md

@@ -6,6 +6,17 @@ This project adheres to [Semantic Versioning][1].
 
 This document is formatted according to the principles of [Keep A CHANGELOG][2].
 
+## [2.2.0] / 2023-09-02
+
+* Drop support for Ruby 2.5 ([#836] by [mvz])
+* Add support for JRuby 9.4 ([#882] by [mvz])
+* Support CRuby 3.2 ([#883] by [mvz])
+* Improve `be_a_command_found_in_path matcher` and its tests ([#895] by [mvz])
+* Replace ChildProcess with Process.spawn ([#891] and [#892] by [mvz])
+* Support Cucumber version 9.0 ([#904] by [mvz])
+* Drop support for Cucumber 4 through 7 ([#906] by [mvz])
+* Drop support for Ruby 2.6 ([#907] by [mvz])
+
 ## [2.1.0] / 2022-05-20
 
 * Support Cucumber 8 ([#870] by [mvz] with [dependabot])
@@ -1017,17 +1028,26 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 [scottj97]:       https://github.com/scottj97
 [stamhankar999]:  https://github.com/stamhankar999
 [taylor]:         https://github.com/taylor
-[utkarsh2102]:    https://github.com/utkarsh2102
 [tdreyno]:        https://github.com/tdreyno
+[utkarsh2102]:    https://github.com/utkarsh2102
 [xtrasimplicity]: https://github.com/xtrasimplicity
 [y-higuchi]:      https://github.com/y-higuchi
 
 <!-- bots -->
 
+[renovate]:       https://github.com/apps/renovate
 [dependabot]:     https://github.com/apps/dependabot
 
 <!-- issues & pull requests -->
 
+[#904]: https://github.com/cucumber/aruba/pull/904
+[#895]: https://github.com/cucumber/aruba/pull/895
+[#892]: https://github.com/cucumber/aruba/pull/892
+[#891]: https://github.com/cucumber/aruba/pull/891
+[#883]: https://github.com/cucumber/aruba/pull/883
+[#882]: https://github.com/cucumber/aruba/pull/882
+[#836]: https://github.com/cucumber/aruba/pull/836
+
 [#870]: https://github.com/cucumber/aruba/pull/870
 [#867]: https://github.com/cucumber/aruba/pull/867
 [#858]: https://github.com/cucumber/aruba/pull/858
@@ -1337,7 +1357,8 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- Releases -->
 
-[Unreleased]:     https://github.com/cucumber/aruba/compare/v2.1.0...main
+[Unreleased]:     https://github.com/cucumber/aruba/compare/v2.2.0...main
+[2.2.0]:          https://github.com/cucumber/aruba/compare/v2.1.0...v2.2.0
 [2.1.0]:          https://github.com/cucumber/aruba/compare/v2.0.1...v2.1.0
 [2.0.1]:          https://github.com/cucumber/aruba/compare/v2.0.0...v2.0.1
 [2.0.0]:          https://github.com/cucumber/aruba/compare/v1.1.2...v2.0.0

data/README.md

@@ -77,12 +77,12 @@ bump.
 
 ## Supported Ruby versions
 
-Aruba is supported on Ruby 2.5 and up, and tested against CRuby 2.5, 2.6, 2.7,
-3.0 and 3.1, and JRuby 9.2 and 9.2.
+Aruba is supported on Ruby 2.7 and up, and tested against CRuby 2.7, 3.0,
+3.1 and 3.2, and JRuby 9.4.
 
 ## Supported Cucumber versions
 
-Aruba is supported on and tested with Cucumber versions 4 through 8.
+Aruba is supported on and tested with Cucumber versions 8 and 9.
 
 ## Supported operating systems
 

data/lib/aruba/api/core.rb

@@ -144,7 +144,7 @@ module Aruba
       def expand_path(file_name, dir_string = nil)
         unless file_name.is_a?(String) && !file_name.empty?
           message = "Filename #{file_name} needs to be a string." \
-                    " It cannot be nil or empty either."\
+                    " It cannot be nil or empty either." \
                     " Please use `expand_path('.')` if you want" \
                     " the current directory to be expanded."
 
@@ -160,7 +160,7 @@ module Aruba
         prefix = file_name[0]
 
         if prefix == aruba.config.fixtures_path_prefix
-          rest = file_name[2..-1]
+          rest = file_name[2..]
           path = File.join(*[aruba.fixtures_directory, rest].compact)
           unless Aruba.platform.exist? path
             aruba_fixture_candidates = aruba.config.fixtures_directories
@@ -195,8 +195,8 @@ module Aruba
               "Aruba's `expand_path` method was called with an absolute path" \
               " at #{caller_file_line}, which is not recommended." \
               " The path passed was '#{file_name}'." \
-              " Change the call to pass a relative path or set "\
-              "`config.allow_absolute_paths = true` to silence this warning"
+              " Change the call to pass a relative path or set" \
+              " `config.allow_absolute_paths = true` to silence this warning"
             raise UserError, message
           end
           file_name

data/lib/aruba/api/filesystem.rb

@@ -302,11 +302,7 @@ module Aruba
                   end
 
         mode = args.shift
-        mode = if mode.is_a? String
-                 mode.to_i(8)
-               else
-                 mode
-               end
+        mode = mode.to_i(8) if mode.is_a? String
 
         args.each { |path| raise "Expected #{path} to be present" unless exist?(path) }
         paths = args.map { |path| expand_path(path) }

data/lib/aruba/cucumber/command.rb

@@ -81,7 +81,7 @@ When(/^I stop the command(?: started last)? if (output|stdout|stderr) contains:$
       sleep 0.1
     end
   end
-rescue ChildProcess::TimeoutError, Timeout::Error
+rescue Timeout::Error
   last_command_started.terminate
 end
 

data/lib/aruba/event_bus/name_resolver.rb

@@ -10,7 +10,7 @@ module Aruba
       # Helpers for Resolvers
       module ResolveHelpers
         def camel_case(underscored_name)
-          underscored_name.to_s.split("_").map { |word| word.upcase[0] + word[1..-1] }.join
+          underscored_name.to_s.split("_").map { |word| word.upcase[0] + word[1..] }.join
         end
 
         # Thanks ActiveSupport

data/lib/aruba/matchers/file/be_a_command_found_in_path.rb

@@ -15,17 +15,17 @@
 #     end
 RSpec::Matchers.define :be_a_command_found_in_path do
   match do |actual|
-    @actual = Shellwords.split(actual.commandline).first if actual.respond_to? :commandline
-
-    !which(@actual).nil?
+    !which(actual).nil?
   end
 
   failure_message do |actual|
-    format(%(expected that command "%s" can be found in PATH "#{ENV['PATH']}".), actual)
+    format(%(expected that command "%s" can be found in PATH "%s".),
+           actual, aruba.environment["PATH"])
   end
 
   failure_message_when_negated do |actual|
-    format(%(expected that command "%s" cannot be found in PATH "#{ENV['PATH']}".), actual)
+    format(%(expected that command "%s" cannot be found in PATH "%s".),
+           actual, aruba.environment["PATH"])
   end
 end
 

data/lib/aruba/platforms/simple_table.rb

@@ -32,7 +32,7 @@ module Aruba
         name_size = longest_key.length
 
         rows = hash.map do |k, v|
-          format("# %-#{name_size}s => %s", k, v)
+          format("# %-*s => %s", name_size, k, v)
         end
 
         if opts[:sort] == true

data/lib/aruba/platforms/unix_platform.rb

@@ -241,6 +241,10 @@ module Aruba
       def builtin_shell_commands
         []
       end
+
+      def term_signal_supported?
+        true
+      end
     end
   end
 end

data/lib/aruba/platforms/windows_command_string.rb

@@ -4,8 +4,6 @@ module Aruba
   module Platforms
     # This is a command which should be run
     #
-    # This adds `cmd.exec` in front of commmand
-    #
     # @private
     class WindowsCommandString
       def initialize(command, *arguments)
@@ -15,22 +13,7 @@ module Aruba
 
       # Convert to array
       def to_a
-        [cmd_path, "/c", [escaped_command, *escaped_arguments].join(" ")]
-      end
-
-      private
-
-      def escaped_arguments
-        @arguments.map { |arg| arg.gsub(/"/, '"""') }
-                  .map { |arg| / /.match?(arg) ? "\"#{arg}\"" : arg }
-      end
-
-      def escaped_command
-        @command.gsub(/ /, '""" """')
-      end
-
-      def cmd_path
-        Aruba.platform.which("cmd.exe")
+        [@command, *@arguments]
       end
     end
   end

data/lib/aruba/platforms/windows_platform.rb

@@ -39,6 +39,10 @@ module Aruba
       def builtin_shell_commands
         %w(cd dir echo exit set type)
       end
+
+      def term_signal_supported?
+        false
+      end
     end
   end
 end

data/lib/aruba/processes/basic_process.rb

@@ -125,7 +125,7 @@ module Aruba
       end
 
       def arguments
-        return Shellwords.split(commandline)[1..-1] if Shellwords.split(commandline).size > 1
+        return Shellwords.split(commandline)[1..] if Shellwords.split(commandline).size > 1
 
         []
       end

data/lib/aruba/processes/spawn_process.rb

@@ -1,4 +1,3 @@
-require "childprocess"
 require "tempfile"
 require "shellwords"
 
@@ -10,6 +9,85 @@ require "aruba/platform"
 module Aruba
   # Platforms
   module Processes
+    # Wrapper around Process.spawn that broadly follows the ChildProcess interface
+    # @private
+    class ProcessRunner
+      def initialize(command_array)
+        @command_array = command_array
+        @exit_status = nil
+      end
+
+      attr_accessor :stdout, :stderr, :cwd, :environment
+      attr_reader :command_array, :pid
+
+      def start
+        @stdin_r, @stdin_w = IO.pipe
+        @pid = Process.spawn(environment, *command_array,
+                             unsetenv_others: true,
+                             in: @stdin_r,
+                             out: stdout.fileno,
+                             err: stderr.fileno,
+                             close_others: true,
+                             chdir: cwd)
+      end
+
+      def stdin
+        @stdin_w
+      end
+
+      def stop
+        return if @exit_status
+
+        if Aruba.platform.term_signal_supported?
+          send_signal "TERM"
+          return if poll_for_exit(3)
+        end
+
+        send_signal "KILL"
+        wait
+      end
+
+      def wait
+        _, status = Process.waitpid2 @pid
+        @exit_status = status
+      end
+
+      def exited?
+        return true if @exit_status
+
+        pid, status = Process.waitpid2 @pid, Process::WNOHANG | Process::WUNTRACED
+
+        if pid
+          @exit_status = status
+          return true
+        end
+
+        false
+      end
+
+      def poll_for_exit(exit_timeout)
+        start = Time.now
+        wait_until = start + exit_timeout
+        loop do
+          return true if exited?
+          break if Time.now >= wait_until
+
+          sleep 0.1
+        end
+        false
+      end
+
+      def exit_code
+        @exit_status&.exitstatus
+      end
+
+      private
+
+      def send_signal(signal)
+        Process.kill signal, @pid
+      end
+    end
+
     # Spawn a process for command
     #
     # `SpawnProcess` is not meant for direct use - `SpawnProcess.new` - by
@@ -74,7 +152,8 @@ module Aruba
 
         @started = true
 
-        @process = ChildProcess.build(*command_string.to_a)
+        @process = ProcessRunner.new(command_string.to_a)
+
         @stdout_file = Tempfile.new("aruba-stdout-")
         @stderr_file = Tempfile.new("aruba-stderr-")
 
@@ -85,23 +164,19 @@ module Aruba
         @stderr_file.set_encoding("ASCII-8BIT")
 
         @exit_status = nil
-        @duplex      = true
 
         before_run
 
-        @process.io.stdout = @stdout_file
-        @process.io.stderr = @stderr_file
-        @process.duplex    = @duplex
-        @process.cwd       = @working_directory
+        @process.stdout = @stdout_file
+        @process.stderr = @stderr_file
+        @process.cwd    = @working_directory
 
-        @process.environment.update(environment)
+        @process.environment = environment
 
         begin
-          Aruba.platform.with_environment(environment) do
-            @process.start
-            sleep startup_wait_time
-          end
-        rescue ChildProcess::LaunchError => e
+          @process.start
+          sleep startup_wait_time
+        rescue SystemCallError => e
           raise LaunchError, "It tried to start #{commandline}. " + e.message
         end
 
@@ -131,7 +206,7 @@ module Aruba
         return @stdout_cache if stopped?
 
         wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
-          @process.io.stdout.flush
+          @process.stdout.flush
           open(@stdout_file.path).read
         end
       end
@@ -150,7 +225,7 @@ module Aruba
         return @stderr_cache if stopped?
 
         wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
-          @process.io.stderr.flush
+          @process.stderr.flush
           open(@stderr_file.path).read
         end
       end
@@ -158,8 +233,8 @@ module Aruba
       def write(input)
         return if stopped?
 
-        @process.io.stdin.write(input)
-        @process.io.stdin.flush
+        @process.stdin.write(input)
+        @process.stdin.flush
 
         self
       end
@@ -168,18 +243,14 @@ module Aruba
       def close_io(name)
         return if stopped?
 
-        @process.io.public_send(name.to_sym).close
+        @process.public_send(name.to_sym).close
       end
 
       # Stop command
       def stop(*)
         return @exit_status if stopped?
 
-        begin
-          @process.poll_for_exit(@exit_timeout)
-        rescue ChildProcess::TimeoutError
-          @timed_out = true
-        end
+        @process.poll_for_exit(@exit_timeout) or @timed_out = true
 
         terminate
       end

data/lib/aruba/version.rb

@@ -1,3 +1,3 @@
 module Aruba
-  VERSION = "2.1.0".freeze
+  VERSION = "2.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aruba
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Aslak Hellesøy, Matt Wynne and other Aruba Contributors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,26 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: contracts
   requirement: !ruby/object:Gem::Requirement
@@ -76,20 +56,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '8.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '8.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
@@ -194,20 +174,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.15.0
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -327,7 +293,7 @@ dependencies:
         version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -337,21 +303,7 @@ dependencies:
         version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: yard-junk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.23.0
 description: |
   Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest",
   to make testing command line applications meaningful, easy and fun.
@@ -486,15 +438,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
-summary: aruba-2.1.0
+summary: aruba-2.2.0
 test_files: []