aruba 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d3e68b36ad2938d35b9f147b8b776b3eb1e25b2e2a271f5346b8b423888964
-  data.tar.gz: 4a70c60f9ccb254e8c5edb7b9c91cc51274f11912c2c1554df61ed8d96cb3b5f
+  metadata.gz: 9b464d3e65f58bdcafd421ed026c8541de9cc9723258f76175b8b8ad3dab4621
+  data.tar.gz: 2215471629083ac51e4b5e31694ac60408d374f8a0aa504addb79ae70f364e84
 SHA512:
-  metadata.gz: 10d08cceb237bb14cd0c0559163326c3340eba5a7db7275d876f6836ec11323b37e734dff617f727c783b653cbdbf47c333952177b0cea4b2117ea4d8ba4d2a7
-  data.tar.gz: 9c71d0e7409899b56b36d53c2a4581ea7143093bacd6dd8fbacac60c211512e7bd4118ef69f7f4e8bca651010609079f05c90f746cdb9f2fdcba41ae9e684430
+  metadata.gz: 2222d8d29dccca2bcbe973512ae24bbdc14a82d2b7dbb3e1fd84b72c35793af4919043cc077bacb2e48db3fbe9c8f60d2c8ed032a36a93d88a0c2ec3ef2e190f
+  data.tar.gz: 007bda65f38b79499f0fda2243f44539c76e541d871cf66b841adafbe1f9a7800946d96c32637264313a24f381f4f97d176a93a02d0e171f1d116d3467b58c19

data/CHANGELOG.md

@@ -6,6 +6,15 @@ This project adheres to [Semantic Versioning][1].
 
 This document is formatted according to the principles of [Keep A CHANGELOG][2].
 
+## [Unreleased]
+
+## [1.1.0] / 2021-04-14
+
+* Add step and API to add whole lines to a file ([#780] by [mvz])
+* Deprecate file creation when using `append_to_file` ([#781] by [mvz])
+* Update dependencies to cucumber to allow working with incoming major versions
+  ([#801] by [mattwynne])
+
 ## [1.0.4] / 2021-01-04
 
 * Update rubocop and fix new offenses (various pull requests)
@@ -964,6 +973,7 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- issues & pull requests -->
 
+[#801]: https://github.com/cucumber/aruba/pull/801
 [#727]: https://github.com/cucumber/aruba/pull/727
 [#725]: https://github.com/cucumber/aruba/pull/725
 [#724]: https://github.com/cucumber/aruba/pull/724
@@ -1242,7 +1252,9 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- Releases -->
 
-[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.0.3...master
+[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.1.0...master
+[1.1.0]:          https://github.com/cucumber/aruba/compare/v1.0.4...v1.1.0
+[1.0.4]:          https://github.com/cucumber/aruba/compare/v1.0.3...v1.0.4
 [1.0.3]:          https://github.com/cucumber/aruba/compare/v1.0.2...v1.0.3
 [1.0.2]:          https://github.com/cucumber/aruba/compare/v1.0.1...v1.0.2
 [1.0.1]:          https://github.com/cucumber/aruba/compare/v1.0.0...v1.0.1

data/CONTRIBUTING.md

@@ -118,22 +118,15 @@ bundle install
 
 Run the following command to run the test suite.
 
-```bash
-# Run the test suite
-bin/test
-```
-
-Or use these Rake tasks:
-
 ```bash
 # Run the whole test suite
-rake test
+bundle exec rake
 # Run RSpec tests
-rake spec
+bundle exec rake spec
 # Run Cucumber features
-rake cucumber
+bundle exec rake cucumber
 # Run Cucumber features which are "WORK IN PROGRESS" and are allowed to fail
-rake cucumber:wip
+bundle exec rake cucumber:wip
 ```
 
 If you have problems because our assumptions about your local setup are wrong,
@@ -142,19 +135,14 @@ installed on your local system.
 
 ```bash
 # Build the docker container
-bundle exec rake docker:build
-
-# Alternative: Build with disabled cache
-bundle exec rake 'docker:build[false]'
+docker build -t test-aruba .
 
-# Build image with version tag
-bundle exec rake 'docker:build[false, 0.1.0]'
+# Open a bash shell inside the container with attached volume so changes to the
+# code will be picked up automatically.
+docker run -v $PWD:/aruba --rm -it test-aruba:latest bash
 
-# Run the whole test suite in "docker"-container
-RUN_IN_DOCKER=1 bin/test
-
-# Run only selected scenario
-RUN_IN_DOCKER=1 bin/test cucumber features/steps/command/shell.feature:14
+# Run the test suite
+bundle exec rake
 ```
 
 ### Installing your own gems used for development
@@ -218,7 +206,7 @@ Now release it:
 bundle update
 
 # Run test suite
-bin/test
+bundle exec rake
 
 # Release gem
 git commit -m "Version bump"

data/README.md

@@ -32,8 +32,7 @@ gem install aruba
 ### As a user getting started with Aruba
 
 Our most current documentation to get started with Aruba as a user can be
-found on [Cucumber Jam](https://app.cucumber.pro/projects/aruba).
-It is generated from our feature files describing the use of Aruba.
+found in [./features/](https://github.com/cucumber/aruba/tree/master/features/).
 
 ### As a user getting started with a ruby testing framework
 

data/exe/aruba

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << File.expand_path('../lib', __dir__)
+$LOAD_PATH << File.expand_path("../lib", __dir__)
 
-require 'aruba/cli'
+require "aruba/cli"
 
 Aruba::Cli.start

data/lib/aruba.rb

@@ -1 +1 @@
-require 'aruba/api'
+require "aruba/api"

data/lib/aruba/api.rb

@@ -1,18 +1,18 @@
-require 'rspec/expectations'
-require 'shellwords'
+require "rspec/expectations"
+require "shellwords"
 
-require 'aruba/version'
+require "aruba/version"
 
-require 'aruba/platform'
-require 'aruba/api/core'
-require 'aruba/api/commands'
+require "aruba/platform"
+require "aruba/api/core"
+require "aruba/api/commands"
 
-require 'aruba/api/environment'
-require 'aruba/api/filesystem'
-require 'aruba/api/text'
-require 'aruba/api/bundler'
+require "aruba/api/environment"
+require "aruba/api/filesystem"
+require "aruba/api/text"
+require "aruba/api/bundler"
 
-Aruba.platform.require_matching_files('../matchers/**/*.rb', __FILE__)
+Aruba.platform.require_matching_files("../matchers/**/*.rb", __FILE__)
 
 # Aruba
 module Aruba

data/lib/aruba/api/bundler.rb

@@ -1,4 +1,4 @@
-require 'aruba/api/environment'
+require "aruba/api/environment"
 
 module Aruba
   module Api

data/lib/aruba/api/commands.rb

@@ -1,7 +1,7 @@
-require 'pathname'
+require "pathname"
 
-require 'aruba/platform'
-require 'aruba/command'
+require "aruba/platform"
+require "aruba/command"
 
 # require 'win32/file' if File::ALT_SEPARATOR
 
@@ -22,7 +22,7 @@ module Aruba
       def which(program, path = nil)
         with_environment do
           # ENV is set within this block
-          path = ENV['PATH'] if path.nil?
+          path = ENV["PATH"] if path.nil?
 
           Aruba.platform.which(program, path)
         end
@@ -35,7 +35,7 @@ module Aruba
       def pipe_in_file(file_name)
         file_name = expand_path(file_name)
 
-        File.open(file_name, 'r').each_line do |line|
+        File.open(file_name, "r").each_line do |line|
           last_command_started.write(line)
         end
       end
@@ -152,7 +152,7 @@ module Aruba
 
         unless command.interactive?
           raise NotImplementedError,
-                'Running interactively is not supported with this process launcher.'
+                "Running interactively is not supported with this process launcher."
         end
 
         start_command(command)
@@ -232,7 +232,7 @@ module Aruba
         @commands << cmd
 
         environment       = aruba.environment
-        working_directory = expand_path('.')
+        working_directory = expand_path(".")
         event_bus         = aruba.event_bus
 
         cmd = Aruba.platform.detect_ruby(cmd)

data/lib/aruba/api/core.rb

@@ -1,7 +1,7 @@
-require 'rspec/expectations'
-require 'aruba/runtime'
-require 'aruba/errors'
-require 'aruba/setup'
+require "rspec/expectations"
+require "aruba/runtime"
+require "aruba/errors"
+require "aruba/setup"
 
 # Aruba
 module Aruba
@@ -38,8 +38,8 @@ module Aruba
       # @yield
       #   The block which should be run in current directory
       def in_current_directory(&block)
-        create_directory '.' unless directory?('.')
-        cd('.', &block)
+        create_directory "." unless directory?(".")
+        cd(".", &block)
       end
 
       # Switch to directory
@@ -64,9 +64,9 @@ module Aruba
                     "#{expand_path(dir)} is not a directory or does not exist."
             end
 
-            old_directory = expand_path('.')
+            old_directory = expand_path(".")
             aruba.current_directory << dir
-            new_directory = expand_path('.')
+            new_directory = expand_path(".")
 
             aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory,
                                                                        new: new_directory)
@@ -78,8 +78,8 @@ module Aruba
             Aruba.platform.chdir real_new_directory
 
             result = with_environment(
-              'OLDPWD' => old_dir,
-              'PWD' => real_new_directory,
+              "OLDPWD" => old_dir,
+              "PWD" => real_new_directory,
               &block
             )
           ensure
@@ -94,9 +94,9 @@ module Aruba
           raise ArgumentError, "#{expand_path(dir)} is not a directory or does not exist."
         end
 
-        old_directory = expand_path('.')
+        old_directory = expand_path(".")
         aruba.current_directory << dir
-        new_directory = expand_path('.')
+        new_directory = expand_path(".")
 
         aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory,
                                                                    new: new_directory)
@@ -143,7 +143,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."
 
           raise ArgumentError, message
@@ -152,7 +152,7 @@ module Aruba
         unless Aruba.platform.directory? File.join(aruba.config.root_directory,
                                                    aruba.config.working_directory)
           raise "Aruba's working directory does not exist." \
-            ' Maybe you forgot to run `setup_aruba` before using its API.'
+            " Maybe you forgot to run `setup_aruba` before using its API."
         end
 
         prefix = file_name[0]
@@ -162,22 +162,22 @@ module Aruba
           path = File.join(*[aruba.fixtures_directory, rest].compact)
           unless Aruba.platform.exist? path
             aruba_fixture_candidates = aruba.config.fixtures_directories
-                                            .map { |p| format('"%s"', p) }.join(', ')
+                                            .map { |p| format('"%s"', p) }.join(", ")
 
             raise ArgumentError,
                   "Fixture \"#{rest}\" does not exist" \
                   " in fixtures directory \"#{aruba.fixtures_directory}\"." \
-                  ' This was the one we found first on your system from all possible' \
+                  " This was the one we found first on your system from all possible" \
                   " candidates: #{aruba_fixture_candidates}."
           end
 
           path
-        elsif prefix == '~'
+        elsif prefix == "~"
           path = with_environment do
             File.expand_path(file_name)
           end
 
-          raise ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == '/'
+          raise ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == "/"
 
           unless Aruba.platform.absolute_path? path
             raise ArgumentError,
@@ -192,8 +192,8 @@ module Aruba
             aruba.logger.warn \
               "Aruba's `expand_path` method was called with an absolute path" \
               " at #{caller_file_line}, which is not recommended." \
-              ' 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"
           end
           file_name
         else

data/lib/aruba/api/environment.rb

@@ -1,4 +1,4 @@
-require 'aruba/platform'
+require "aruba/platform"
 
 # Aruba
 module Aruba
@@ -96,7 +96,7 @@ module Aruba
 
         environment_change = { old: old_environment,
                                new: new_environment,
-                               changed: { name: name, value: '' } }
+                               changed: { name: name, value: "" } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self

data/lib/aruba/api/filesystem.rb

@@ -1,10 +1,10 @@
-require 'pathname'
+require "pathname"
 
-require 'aruba/platform'
+require "aruba/platform"
 
-Aruba.platform.require_matching_files('../matchers/file/*.rb', __FILE__)
-Aruba.platform.require_matching_files('../matchers/directory/*.rb', __FILE__)
-Aruba.platform.require_matching_files('../matchers/path/*.rb', __FILE__)
+Aruba.platform.require_matching_files("../matchers/file/*.rb", __FILE__)
+Aruba.platform.require_matching_files("../matchers/directory/*.rb", __FILE__)
+Aruba.platform.require_matching_files("../matchers/path/*.rb", __FILE__)
 
 # Aruba
 module Aruba
@@ -67,7 +67,7 @@ module Aruba
       # @return [Array]
       #   List of files and directories
       def all_paths
-        list('.').map { |path| expand_path(path) }
+        list(".").map { |path| expand_path(path) }
       end
 
       # Return all existing files in current directory
@@ -75,7 +75,7 @@ module Aruba
       # @return [Array]
       #   List of files
       def all_files
-        list('.').select { |p| file? p }.map { |p| expand_path(p) }
+        list(".").select { |p| file? p }.map { |p| expand_path(p) }
       end
 
       # Return all existing directories in current directory
@@ -83,7 +83,7 @@ module Aruba
       # @return [Array]
       #   List of files
       def all_directories
-        list('.').select { |p| directory? p }.map { |p| expand_path(p) }
+        list(".").select { |p| directory? p }.map { |p| expand_path(p) }
       end
 
       # Create directory object
@@ -108,8 +108,8 @@ module Aruba
                 %(Only directories are supported. Path "#{name}" is not a directory.)
         end
 
-        existing_files            = Dir.glob(expand_path(File.join(name, '**', '*')))
-        current_working_directory = Pathname.new(expand_path('.'))
+        existing_files            = Dir.glob(expand_path(File.join(name, "**", "*")))
+        current_working_directory = Pathname.new(expand_path("."))
 
         existing_files.map do |d|
           Pathname.new(d).relative_path_from(current_working_directory).to_s
@@ -191,7 +191,7 @@ module Aruba
         end
 
         if source.count > 1 && exist?(destination) && !directory?(destination)
-          raise ArgumentError, 'Multiples sources can only be copied to a directory'
+          raise ArgumentError, "Multiples sources can only be copied to a directory"
         end
 
         source_paths     = source.map { |f| expand_path(f) }
@@ -240,7 +240,7 @@ module Aruba
         end
 
         if source.count > 1 && exist?(destination) && !directory?(destination)
-          raise ArgumentError, 'Multiple sources can only be copied to a directory'
+          raise ArgumentError, "Multiple sources can only be copied to a directory"
         end
 
         source_paths     = source.map { |f| expand_path(f) }
@@ -326,8 +326,35 @@ module Aruba
       def append_to_file(file_name, file_content)
         file_name = expand_path(file_name)
 
-        Aruba.platform.mkdir(File.dirname(file_name))
-        File.open(file_name, 'a') { |f| f << file_content }
+        unless File.exist? file_name
+          Aruba.platform.deprecated("The ability to call #append_to_file with a file that" \
+                                    " does not exist is deprecated and will be removed in" \
+                                    " Aruba 2.0.")
+          Aruba.platform.mkdir(File.dirname(file_name))
+        end
+        File.open(file_name, "a") { |f| f << file_content }
+      end
+
+      # Append lines to a (text) file. This will make sure a newline is present
+      # between the old content and the new.
+      #
+      # @param [String] file_name
+      #   The name of the file to be used
+      #
+      # @param [String] file_content
+      #   The lines which should be appended to file
+      def append_lines_to_file(file_name, file_content)
+        file_name = expand_path(file_name)
+
+        last = File.open(file_name) do |f|
+          f.seek(-3, IO::SEEK_END)
+          f.read
+        end
+
+        File.open(file_name, "a") do |f|
+          f << "\n" unless last.end_with? "\n"
+          f << file_content
+        end
       end
 
       # Create a directory in current directory