gurke 3.3.3 → 3.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f0e20c2294765e444f6d57c93c0f396aacca045a6e68d38913841d9c10ac455
-  data.tar.gz: f691ffa3fe1ee9675db5e030b30cab01d0e79444d4865eb42e101278115b7017
+  metadata.gz: 322a0da4f1144d8731c128defb26359658b933496b2f7033123e413cb754a74c
+  data.tar.gz: 6d14692f0061b371be67376920f3c5f76a8adc3dd8cc6a01b84dbe8d5796ea73
 SHA512:
-  metadata.gz: e5acfcc8dc29a615b5d522ad375d13aa782663c8a1f5e5ccb7385e0416a617afab642911726a8ea4dbe6234a14b15d0dceecfc45e8a527e4537ac06b45570c7f
-  data.tar.gz: 7b236cecf9842f9905b9160d65ee7641ecdb88004700de5766f88de1ac9c6b63e0e7cbecfef14153b80c8ef6a5add5c144cf47e6d4a41cfe6bdce0ca1e3a7401
+  metadata.gz: e9daef2468e65bd5df367479f6ab74ca0b492e9093f9984e4d7847fdb8e71d73fcea728e123593d09825967ee1ac41ef7b0abe03f2516d5f8edbd92938cf6749
+  data.tar.gz: 8c39e5a7be118c60a9c9a9996d7e2982b570640490d0d7e3e4f56bde0930507363343268360011cc3c85d563457f671c4734c8889c8b125f68c9e467056a3d43

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 3.3.5
+
+* Test with Ruby 2.7, 3.0, 3.1, and 3.2
+* Upgrade to Ruby 2.7+
+* Fix required `StringIO` usage
+* Fix `send :include`
+
+## 3.3.4
+
+* Replace renamed trollop dependency with optimist
+
 ## 3.3.3
 
 * Fix a TC reporter issues reporting all scenarios as aborted

data/README.md

@@ -1,16 +1,26 @@
 # Gurke
 
-[![Gem Version](https://badge.fury.io/rb/gurke.svg)](http://badge.fury.io/rb/gurke) [![Build Status](http://img.shields.io/travis/jgraichen/gurke/master.svg)](https://travis-ci.org/jgraichen/gurke) [![Code Climate](http://img.shields.io/codeclimate/github/jgraichen/gurke.svg)](https://codeclimate.com/github/jgraichen/gurke) [![Dependency Status](http://img.shields.io/gemnasium/jgraichen/gurke.svg)](https://gemnasium.com/jgraichen/gurke) [![RubyDoc Documentation](http://img.shields.io/badge/rubydoc-here-blue.svg)](http://rubydoc.info/github/jgraichen/gurke/master/frames)
+[![Build Status](https://github.com/jgraichen/gurke/actions/workflows/test.yml/badge.svg)](https://github.com/jgraichen/gurke/actions/workflows/test.yml)
 
 **Gurke** is an experimental, alternative cucumber runner. It ~~steals~~ borrows ideas and concepts from [turnip](https://github.com/jnicklas/turnip), [rspec](http://rspec.info) and tries to avoid [cucumber](https://github.com/cucumber/cucumber/).
 
-That includes * Step definitions in modules * Before, After and Around hooks * Formatters * Partial step inclusion (via modules) * Keyword-dependent steps * Scenario-local world * Running DRb background test server.
+That includes:
+
+* Step definitions in modules
+* Before, After and Around hooks
+* Formatters
+* Partial step inclusion (via modules)
+* Keyword-dependent steps
+* Scenario-local world
+* Running DRb background test server.
 
 ## Installation
 
 Or install it yourself as:
 
-    $ gem install gurke
+```console
+gem install gurke
+```
 
 Or add it to your `Gemfile` and install it using bundler.
 
@@ -18,11 +28,11 @@ Or add it to your `Gemfile` and install it using bundler.
 
 ## Usage
 
-1. Put features in `features/`.
+First, create your `*.features` files inside `features/`, for example, `features/user/create_account.feature`. Support files and step definitions can be added as Ruby files to `features/support`.
 
-2. Put support and configuration files as ruby into `features/support/**`.
+### Configuration
 
-e.g.
+For example, you can configure the environment or [hooks](#hooks):
 
 ```ruby
 # features/support/gurke.rb
@@ -39,7 +49,9 @@ Gurke.configure do |c|
 end
 ```
 
-3. Put your step definitions into `features/support/**`.
+### Steps
+
+Steps can be defined in Ruby modules as methods, for example in `features/support/steps`:
 
 ```ruby
 # features/support/steps/file_steps.rb
@@ -55,7 +67,7 @@ end
 Gurke.configure{|c| c.include FileSteps }
 ```
 
-You can also use an existing method as a step:
+You can use an existing method as a step too:
 
 ```ruby
 module MySteps
@@ -88,9 +100,9 @@ Gurke.configure do |c|
 end
 ```
 
-Therefore you can use different step implementations for same named steps depending on the tags of the the feature and scenario.
+Therefore, you can use different step implementations for same named steps depending on the tags of the feature and scenario.
 
-### Keyword specific step definitions
+#### Keyword specific step definitions
 
 You can also define steps for only a specific keyword. This also allows you to use the same step pattern for different keywords, e.g.
 
@@ -101,23 +113,23 @@ module PathSteps
 end
 ```
 
-Therefore you can write your scenarios in a documentary style of facts:
+Therefore, you can write your scenarios in a documentary style of facts:
 
-```
-Scenario: Use the back button
-  Given I am on the start page
-  When I click on "Go to another page"
-  And I click the back button
-  Then I am on the start page
+```feature
+  Scenario: Use the back button
+    Given I am on the start page
+    When I click on "Go to another page"
+    And I click the back button
+    Then I am on the start page
 ```
 
 `And` and `But` steps will inherit the keyword type from the step before, e.g. the `And` step above will be of the `when` type.
 
-### Included Step Definitions & Hooks
+### Hooks
 
-Each scenario runs in it's own world. All modules registered to be included will be included in this world. Before and after scenario or step hooks will also be executed within this world. All steps are run in this world.
+Each scenario runs in its own world. All modules registered to be included will be included in this world. Before and after scenario or step hooks will also be executed within this world. All steps are run in this world.
 
-You can define hooks similar to RSpec:
+You can define hooks similar to `rspec`:
 
 ```ruby
 Gurke.configure do |config|
@@ -152,13 +164,13 @@ Examples:
 
 You can also specify a list of files that will be run:
 
-```
+```console
 gurke features/my_feature.feature
 ```
 
 If you append one or more line numbers - separated by colons - only the scenarios defined around the given lines will be run:
 
-```
+```console
 gurke features/my_feature.feature:14:34
 ```
 
@@ -166,7 +178,7 @@ gurke features/my_feature.feature:14:34
 
 If you have scenarios that might fail sometime, you can mark them as `@flaky`:
 
-```
+```feature
 Feature: F
   @flaky
   Scenario: I am flaky
@@ -180,7 +192,7 @@ Gurke will retry a marked scenario only once if a step failed.
 
 You can choose another formatter using a command line switch:
 
-```
+```console
 gurke -f team_city
 ```
 
@@ -200,9 +212,9 @@ Remember to reload e.g. your step definitions before `:features` to pick up chan
   end
 ```
 
-Use the after `:system` hook to shutdown resources.
+Use the after `:system` hook to shut down resources.
 
-Remember to restart background server when changing hooks, configuration or removing/redefining steps as otherwise the changes won't be picked up or steps won't change or are ambiguous now.
+Remember to restart the running background server when changing hooks, configuration or removing/redefining steps as otherwise the changes won't be picked up, steps won't change, or are ambiguous now.
 
 ## TODO
 
@@ -211,16 +223,8 @@ Remember to restart background server when changing hooks, configuration or remo
 * Random run order (rspec)
 * Using strings with placeholders as step pattern (turnip)
 * Custom placeholders (turnip)
-* More reporters (NyanCat / JUnit / TeamCity / Adapter to run multiple reporters)
+* More reporters (NyanCat / JUnit / Adapter to run multiple reporters)
 * SimpleCov support (and use it in own tests)
 * Scope hooks by scenario tags
 * Fast-fail
 * Additional feature-scope and global worlds
-
-## History
-
-Now: * Can finally (start to) test itself.
-
-## Contributing
-
-Send me code.

data/features/support/steps/cli_steps.rb

@@ -5,21 +5,17 @@ require 'open3'
 module CLISteps
   def _execute(args = nil)
     Dir.chdir(@__root) do
-      Bundler.with_clean_env do
-        cmd = ['ruby']
-        cmd << '-I' << Gurke.root.join('..', 'lib').realpath
-        cmd << '-S' << Gurke.root.join('..', 'bin', 'gurke').realpath
+      cmd = %w[bundle exec gurke]
 
-        unless args.to_s.include?('-f ') || args.to_s.include?('--formatter ')
-          cmd << '-f' << 'default'
-        end
+      unless args.to_s.include?('-f ') || args.to_s.include?('--formatter ')
+        cmd << '-f' << 'default'
+      end
 
-        cmd << args.to_s
+      cmd << args.to_s
 
-        out, err, status = Open3.capture3 cmd.join ' '
+      out, err, status = Open3.capture3 cmd.join ' '
 
-        @last_process = [Integer(status), out, err]
-      end
+      @last_process = [Integer(status), out, err]
     end
   end
 
@@ -46,7 +42,7 @@ module CLISteps
   end
 
   step(/the program output should not include "(.*?)"/,
-    :_cli_not_include_content)
+    :_cli_not_include_content,)
 
   step(/all scenarios have passed/) do
     _cli_include_content 'scenarios: 0 failing, 0 pending'

data/gurke.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gurke/version'
 
@@ -8,32 +8,25 @@ Gem::Specification.new do |spec|
   spec.name          = 'gurke'
   spec.version       = Gurke::VERSION
   spec.authors       = ['Jan Graichen']
-  spec.email         = %w[jg@altimos.de]
+  spec.email         = %w[jgraichen@altimos.de]
   spec.homepage      = 'https://github.com/jgraichen/gurke'
   spec.license       = 'MIT'
 
-  spec.description = \
-    'An alternative gherkin feature runner inspired by rspec and turnip.'
   spec.summary = \
     'An alternative gherkin feature runner inspired by rspec and turnip.'
 
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.required_ruby_version = '>= 2.7.0'
+
   spec.files = Dir['**/*'].grep %r{^(
     (bin/|lib/|test/|spec/|features/)|
     (\w*\.gemspec|LICENSE.*|README.*|CHANGELOG.*)$
   )}x
 
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w[lib]
 
   spec.add_dependency 'colorize'
   spec.add_dependency 'gherkin', '~> 2.0'
-  spec.add_dependency 'trollop'
-
-  spec.add_development_dependency 'bundler', '~> 1.3'
-
-  if ENV['TRAVIS_BUILD_NUMBER'] && !ENV['TRAVIS_TAG']
-    # Append travis build number for auto-releases
-    spec.version = "#{spec.version}.1.b#{ENV['TRAVIS_BUILD_NUMBER']}"
-  end
+  spec.add_dependency 'optimist', '~> 3.0'
 end

data/lib/gurke/background.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Gurke
-  #
   class Background
     #
     # Return path to file containing this background.

data/lib/gurke/builder.rb

@@ -10,7 +10,7 @@ module Gurke
     def initialize
       @language = 'en'
       @parser   = Gherkin::Parser::Parser.new(
-        self, true, 'root', false, @language
+        self, true, 'root', false, @language,
       )
     end
 

data/lib/gurke/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'trollop'
+require 'optimist'
 
 module Gurke
   class CLI
@@ -11,11 +11,11 @@ module Gurke
     #
     def run(argv)
       call parser.parse(argv), argv
-    rescue Trollop::VersionNeeded
+    rescue Optimist::VersionNeeded
       print_version && exit
-    rescue Trollop::HelpNeeded
+    rescue Optimist::HelpNeeded
       print_help && exit
-    rescue Trollop::CommandlineError => e
+    rescue Optimist::CommandlineError => e
       warn "Error: #{e}"
       warn "Run with `-h' for more information on available arguments."
       exit 255
@@ -56,7 +56,7 @@ module Gurke
     end
 
     def parser
-      @parser ||= Trollop::Parser.new do
+      @parser ||= Optimist::Parser.new do
         opt :help, 'Print this help.'
         opt :version, 'Show program version information.'
         opt :backtrace, 'Show full error backtraces.'
@@ -67,7 +67,7 @@ module Gurke
         opt :require, 'Files matching this pattern will be required after' \
                       'loading environment but before running features.',
           default: ['features/steps/**/*.rb',
-                    'features/support/steps/**/*.rb'],
+                    'features/support/steps/**/*.rb',],
           multi: true
         opt :tags, 'Only run features and scenarios matching given tag ' \
                    'filtering expression. TODO: Description.',
@@ -85,7 +85,7 @@ module Gurke
       files = Dir[options[:pattern].to_s] if files.empty? && options[:pattern]
       files.each_with_object([]) do |input, memo|
         if File.directory? input
-          Dir[input + '/**/*'].each do |file_in_dir|
+          Dir["#{input}/**/*"].each do |file_in_dir|
             if options[:pattern] &&
                !File.fnmatch?(options[:pattern], file_in_dir)
               next

data/lib/gurke/configuration.rb

@@ -91,7 +91,7 @@ module Gurke
           feature: HookSet.new,
           scenario: HookSet.new,
           step: HookSet.new,
-          system: HookSet.new
+          system: HookSet.new,
         }
 
         hooks[:each] = hooks[:scenario]
@@ -152,11 +152,9 @@ module Gurke
         end.call
       ensure
         @after.each do |hook|
-          begin
-            hook.run world, ctx
-          rescue StandardError => e
-            warn "Rescued error in after hook: #{e}\n#{e.backtrace.join("\n")}"
-          end
+          hook.run world, ctx
+        rescue StandardError => e
+          warn "Rescued error in after hook: #{e}\n#{e.backtrace.join("\n")}"
         end
       end
 

data/lib/gurke/dsl.rb

@@ -8,7 +8,7 @@ module Gurke
         method_name = nil
       end
 
-      if method_name && block_given?
+      if method_name && block
         raise ArgumentError.new <<~ERR.strip
           You can either specify a method name or given a block, not both.
         ERR
@@ -24,14 +24,14 @@ module Gurke
         step.match(name, s)
       end
 
-      if block_given?
+      if block
         define_method(step.method_name.to_s, &block)
       elsif method_name
         alias_method step.method_name.to_s, method_name
       end
     end
 
-    # rubocop:disable MethodName
+    # rubocop:disable Naming/MethodName
     def Given(pattern, method_name = nil, opts = {}, &block)
       step pattern, method_name, opts.merge(type: :given), &block
     end
@@ -43,6 +43,6 @@ module Gurke
     def Then(pattern, method_name = nil, opts = {}, &block)
       step pattern, method_name, opts.merge(type: :then), &block
     end
-    # rubocop:enable MethodName
+    # rubocop:enable Naming/MethodName
   end
 end

data/lib/gurke/feature_list.rb

@@ -30,7 +30,7 @@ module Gurke
       filter = Filter.new options, files
 
       each do |feature|
-        file, _lines = files.select {|f, _| f == feature.file }.first
+        file, _lines = files.find {|f, _| f == feature.file }
         next unless file
 
         f = Feature.new(feature)
@@ -53,7 +53,7 @@ module Gurke
       each do |feature|
         feature.run runner, reporter
       end
-    rescue Interrupt # rubocop:disable HandleExceptions
+    rescue Interrupt
       # nothing
     ensure
       reporter.invoke :end_features, self
@@ -84,7 +84,7 @@ module Gurke
       end
 
       def filtered_by_line?(scenario)
-        _, lines = files.select {|f, _| f == scenario.file }.first
+        _, lines = files.find {|f, _| f == scenario.file }
 
         return false if lines.empty?
 
@@ -93,7 +93,7 @@ module Gurke
 
       TagFilter = Struct.new(:tag) do
         def name
-          @name ||= negated? ? tag[1..-1] : tag
+          @name ||= negated? ? tag[1..] : tag
         end
 
         def negated?

data/lib/gurke/reporter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'stringio'
+
 module Gurke
   #
   # A {Reporter} provides callbacks that will be executed whenever
@@ -275,26 +277,26 @@ module Gurke
 
     protected
 
-    def format_exception(ex, backtrace: true, indent: 0)
-      s = StringIO.new
-      s << (' ' * indent) << ex.class.to_s << ': ' << ex.message.strip << "\n"
+    def format_exception(err, backtrace: true, indent: 0)
+      s = ::StringIO.new
+      s << (' ' * indent) << err.class.to_s << ': ' << err.message.strip << "\n"
 
-      if backtrace && ex.respond_to?(:backtrace)
-        if ex.backtrace.nil?
+      if backtrace && err.respond_to?(:backtrace)
+        if err.backtrace.nil?
           s << (' ' * indent) << '  <no backtrace available>'
-        elsif ex.backtrace.empty?
+        elsif err.backtrace.empty?
           s << (' ' * indent) << '  <backtrace empty>'
         else
-          ex.backtrace.each do |bt|
+          err.backtrace.each do |bt|
             s << (' ' * indent) << '  ' << bt.strip << "\n"
           end
         end
       end
 
-      if ex.respond_to?(:cause) && ex.cause && ex.cause.respond_to?(:message)
+      if err.respond_to?(:cause) && err.cause && err.cause.respond_to?(:message)
         s << (' ' * indent) << 'caused by: '
         s << format_exception(
-          ex.cause, backtrace: backtrace, indent: indent
+          err.cause, backtrace: backtrace, indent: indent,
         ).strip
       end
 

data/lib/gurke/reporters/compact_reporter.rb

@@ -9,11 +9,11 @@ require 'colorize'
 #   :light_magenta, :light_cyan, :light_white
 #
 module Gurke::Reporters
-  #
   class CompactReporter < NullReporter
     attr_reader :io
 
     def initialize(io = $stdout)
+      super()
       @io = io
     end
 
@@ -95,10 +95,10 @@ module Gurke::Reporters
       scenarios = features.map(&:scenarios).flatten
 
       size    = scenarios.size
-      passed  = scenarios.select(&:passed?).size
-      failed  = scenarios.select(&:failed?).size
-      pending = scenarios.select(&:pending?).size
-      not_run = size - scenarios.select(&:run?).size
+      passed  = scenarios.count(&:passed?)
+      failed  = scenarios.count(&:failed?)
+      pending = scenarios.count(&:pending?)
+      not_run = size - scenarios.count(&:run?)
 
       message = "#{scenarios.size} scenarios: "
       message += "#{passed} passed, "
@@ -130,7 +130,6 @@ module Gurke::Reporters
        magenta cyan white default light_black
        light_red light_green light_yellow light_blue
        light_magenta light_cyan light_white].each do |color|
-
       define_method(color) {|str| io.tty? ? str.send(color) : str }
     end
   end

data/lib/gurke/reporters/default_reporter.rb

@@ -17,6 +17,7 @@ module Gurke::Reporters
     attr_reader :io
 
     def initialize(io = $stdout)
+      super()
       @io = io
     end
 
@@ -93,10 +94,10 @@ module Gurke::Reporters
       scenarios = features.map(&:scenarios).flatten
 
       size    = scenarios.size
-      passed  = scenarios.select(&:passed?).size
-      failed  = scenarios.select(&:failed?).size
-      pending = scenarios.select(&:pending?).size
-      not_run = size - scenarios.select(&:run?).size
+      passed  = scenarios.count(&:passed?)
+      failed  = scenarios.count(&:failed?)
+      pending = scenarios.count(&:pending?)
+      not_run = size - scenarios.count(&:run?)
 
       message = "#{scenarios.size} scenarios: "
       message += "#{passed} passed, " unless passed == size || passed.zero?
@@ -159,7 +160,6 @@ module Gurke::Reporters
        magenta cyan white default light_black
        light_red light_green light_yellow light_blue
        light_magenta light_cyan light_white].each do |color|
-
       define_method(color) {|str| io.tty? ? str.send(color) : str }
     end
   end

data/lib/gurke/reporters/null_reporter.rb

@@ -6,7 +6,7 @@ module Gurke::Reporters
   #
   class NullReporter < Gurke::Reporter
     Gurke::Reporter::CALLBACKS.each do |cb|
-      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1  # rubocop:disable Style/DocumentDynamicEvalDefinition
         def #{cb}(*) end
       RUBY
     end

data/lib/gurke/reporters/team_city_reporter.rb

@@ -49,7 +49,7 @@ module Gurke::Reporters
 
     def publish(message_name, args)
       args = [] << message_name.to_s << escaped_array_of(args)
-      args = args.flatten.reject(&:nil?)
+      args = args.flatten.compact
 
       io.puts "##teamcity[#{args.join(' ')}]"
     end

data/lib/gurke/runner.rb

@@ -11,10 +11,10 @@ module Gurke
 
     def reporter
       @reporter ||= begin
-        r = (options[:formatter] + '_reporter')
-            .split('_')
-            .map(&:capitalize)
-            .join
+        r = "#{options[:formatter]}_reporter"
+          .split('_')
+          .map(&:capitalize)
+          .join
 
         Reporters.const_get(r).new
       end
@@ -27,7 +27,7 @@ module Gurke
     def run(files, reporter = self.reporter)
       files.map! do |file|
         split = file.split(':')
-        [split[0], split[1..-1].map {|i| Integer(i) }]
+        [split[0], split[1..].map {|i| Integer(i) }]
       end
 
       features = builder.load(files.map {|file, _| file })

data/lib/gurke/scenario.rb

@@ -29,7 +29,6 @@ module Gurke
     #
     attr_reader :steps
 
-    #
     attr_reader :tags
 
     # @api private

data/lib/gurke/step.rb

@@ -66,7 +66,7 @@ module Gurke
     rescue StepPending => e
       scenario.pending! e
       result = StepResult.new self, scenario, :pending, e
-    rescue Exception => e # rubocop:disable RescueException
+    rescue Exception => e # rubocop:disable Lint/RescueException
       scenario.failed! e
       result = StepResult.new self, scenario, :failed, e
     ensure
@@ -88,7 +88,6 @@ module Gurke
       end
     end
 
-    #
     class StepResult
       attr_reader :step, :exception, :state, :scenario
 
@@ -100,7 +99,7 @@ module Gurke
       end
 
       Step.public_instance_methods(false).each do |mth|
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
           def #{mth}(*args) @step.send(:#{mth}, *args); end
         RUBY
       end

data/lib/gurke/step_definition.rb

@@ -20,11 +20,12 @@ module Gurke
     def match(name, type = :any)
       return if self.type != :any && self.type != type
       return if pattern.is_a?(String) && name != pattern
+
       match = pattern.match(name)
 
       return unless match
 
-      Match.new method_name, match.to_a[1..-1]
+      Match.new method_name, match.to_a[1..]
     end
 
     Match = Struct.new :method_name, :params