gurke 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f25197fd297ba62d42f9d4895bd3df3bd556882cd5fc66769b0bb717ebe1c16e
-  data.tar.gz: fd92245e82302cd497b236ba92bbcb14917dbcee30cbc0923c8ce9c9867de028
+  metadata.gz: 4e0e270f3440d5c7d4ebbf8f87fffc06d354db879b7bfb1e8b169e85fccee50c
+  data.tar.gz: b8aaf0dec747886d30eb745ee8464f7b43f83a68fd3e6ca7b6dcffbc979a52a4
 SHA512:
-  metadata.gz: 914606fbd5b71e005980a8dec79d0842093d544299282018a2c0b2cbc4cbdce35dcbf6aa30799417ec1fca855a07bfbf958aa7abaf9f737a698b3f99b887426b
-  data.tar.gz: 0cd6bb85c10f9edcea212902844cc6417c857133584b1f852d31b5ae75707c8c9f2cdbec17b227f7303f90ebfe30e13eae41a54ab8b5fc852464e50e584760e8
+  metadata.gz: 234bc4e6ad8283e1d72bd42d40694f6a49f0a5638f0a0a6e28ddd8edecb600bea9e918f9ff4c83e05a315adebc1aa188603e2378a2ed98575315c866937fa93a
+  data.tar.gz: fa4436190a9cae9dcbc9c00492973dfcdc9b5007330c42e31ce72b7cf1ca86033d16f16168740eef8de892ff7d8648cd69005131487671deb135dc647cef4ed7

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.6.0] - 2025-04-10
+
+### Added
+
+- Expose `#id`, `#name`, `#path`, `#line`, `#state`, `#failed?`, `#pending?`, `#passed?`, and `#aborted?` in hook context if available
+
+## [3.5.1] - 2025-04-10
+
+### Changed
+
+- Print spaces on empty lines to improve logging GitLab CI/CD
+
 ## [3.5.0] - 2025-04-09
 
 ### Added
@@ -136,7 +148,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.0.0] - 2013-12-04
 
-[Unreleased]: https://github.com/jgraichen/gurke/compare/v3.5.0...HEAD
+[Unreleased]: https://github.com/jgraichen/gurke/compare/v3.6.0...HEAD
+[3.6.0]: https://github.com/jgraichen/gurke/compare/v3.5.1...v3.6.0
+[3.5.1]: https://github.com/jgraichen/gurke/compare/v3.5.0...v3.5.1
 [3.5.0]: https://github.com/jgraichen/gurke/compare/v3.4.0...v3.5.0
 [3.4.0]: https://github.com/jgraichen/gurke/compare/v3.3.5...v3.4.0
 [3.3.5]: https://github.com/jgraichen/gurke/compare/v3.3.4...v3.3.5

data/lib/gurke/cli.rb

@@ -102,8 +102,6 @@ module Gurke
         options[:tags] << '~wip'
       end
 
-      pp options
-
       call(options, argv)
     rescue OptionParser::InvalidOption => e
       warn e.message

data/lib/gurke/configuration.rb

@@ -161,6 +161,10 @@ module Gurke
       class Context
         extend Forwardable
 
+        def_delegators :@context,
+          :id, :name, :path, :line, :state,
+          :failed?, :pending?, :passed?, :aborted?
+
         def initialize(context, block)
           @context = context
           @block = block

data/lib/gurke/feature.rb

@@ -43,6 +43,10 @@ module Gurke
       @raw  = raw
     end
 
+    def id
+      raw.id
+    end
+
     # Return name of this feature.
     #
     # @return [String] Feature name.
@@ -63,6 +67,14 @@ module Gurke
       scenarios.any?(&:pending?)
     end
 
+    def aborted?
+      scenarios.any?(&:aborted?)
+    end
+
+    def success?
+      scenarios.all?(&:success?)
+    end
+
     def self.new(*args)
       if args.size == 1 && (f = args.first).is_a?(self)
         super(f.file, f.line, f.tags, f.raw)

data/lib/gurke/reporters/compact_reporter.rb

@@ -15,10 +15,10 @@ module Gurke::Reporters
       return unless result.state == :failed
 
       io.print red 'E'
+      io.puts
 
       feature = scenario.feature
 
-      io.puts
       io.print yellow('Feature')
       io.print ': '
       io.print scenario.feature.name
@@ -67,7 +67,7 @@ module Gurke::Reporters
 
       exout = format_exception(result.exception, backtrace: true, indent: 6)
       io.puts red exout
-      io.puts
+      io.puts ' '
     end
 
     def after_scenario(scenario)
@@ -78,13 +78,13 @@ module Gurke::Reporters
       elsif scenario.passed?
         io.print green '.'
       elsif scenario.aborted?
-        io.puts
+        io.puts ' '
       end
     end
 
     def after_features(features)
-      io.puts
-      io.puts
+      io.puts ' '
+      io.puts ' '
 
       scenarios = features.map(&:scenarios).flatten
 

data/lib/gurke/reporters/default_reporter.rb

@@ -27,7 +27,7 @@ module Gurke::Reporters
 
       io.print light_black(feature.description.gsub(/^/, '  '))
       io.puts
-      io.puts
+      io.puts ' '
     end
 
     def before_scenario(scenario)
@@ -72,18 +72,18 @@ module Gurke::Reporters
 
     def retry_scenario(scenario)
       if scenario.flaky?
-        io.print "\n  Retry flaky scenario due to previous failure:\n\n"
+        io.print " \n  Retry flaky scenario due to previous failure:\n \n"
       else
-        io.print "\n  Retry scenario due to previous failure:\n\n"
+        io.print " \n  Retry scenario due to previous failure:\n \n"
       end
     end
 
     def after_scenario(*)
-      io.puts
+      io.puts ' '
     end
 
     def after_feature(*)
-      io.puts
+      io.puts ' '
     end
 
     def after_features(features)
@@ -108,7 +108,7 @@ module Gurke::Reporters
         io.puts green message
       end
 
-      io.puts
+      io.puts ' '
     end
 
     protected
@@ -140,6 +140,7 @@ module Gurke::Reporters
 
     def print_exception(exception)
       io.puts red format_exception(exception).gsub(/^/, '        ')
+      io.print ' '
     end
 
     def format_location(obj)

data/lib/gurke/runner.rb

@@ -38,8 +38,8 @@ module Gurke
       scenario.flaky? ? config.flaky_retries : config.default_retries
     end
 
-    def hook(scope, world, context, &block)
-      config.hooks[scope].run world, context, &block
+    def hook(scope, context, world, &block)
+      config.hooks[scope].run(context, world, &block)
     end
 
     def with_filtered_backtrace

data/lib/gurke/scenario.rb

@@ -29,8 +29,18 @@ module Gurke
     #
     attr_reader :steps
 
+    # List of this scenario's tags.
+    #
+    # @return [Array<String>] Steps.
+    #
     attr_reader :tags
 
+    # Internal scenario state
+    #
+    # @return [Nil|Symbol] state
+    #
+    attr_reader :state
+
     # @api private
     attr_reader :raw
 
@@ -46,6 +56,10 @@ module Gurke
       @state   = nil
     end
 
+    def id
+      raw.id
+    end
+
     # Return name of the scenario.
     #
     # @return [String] Scenario name.

data/lib/gurke/step.rb

@@ -28,6 +28,10 @@ module Gurke
       @raw = raw
     end
 
+    def id
+      raw.id
+    end
+
     def name
       raw.name
     end

data/lib/gurke/version.rb

@@ -3,7 +3,7 @@
 module Gurke
   module VERSION
     MAJOR = 3
-    MINOR = 5
+    MINOR = 6
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.').freeze

data/spec/gurke/reporters/compact_reporter_spec.rb

@@ -127,20 +127,20 @@ RSpec.describe Gurke::Reporters::CompactReporter do
       end
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          .E
-          .Feature: Demo feature   # features/file.feature:1
-          .  Scenario: Running the scenario   # features/file.feature:5
-          .    Given the scenario is passing
-          .      RuntimeError: An error occurred
-          .        /path/to/file.rb:5:in `block (4 levels) in <top (required)>'
-          .        /path/to/file.rb:24:in in `fail_with'
-          .      caused by: IOError: Socket closed
-          .        script.rb:5:in `a'
-          .        script.rb:10:in `b'
-          .
-          .
-        TEXT
+        expect(out).to eq text(
+          'E',
+          'Feature: Demo feature   # features/file.feature:1',
+          '  Scenario: Running the scenario   # features/file.feature:5',
+          '    Given the scenario is passing',
+          '      RuntimeError: An error occurred',
+          "        /path/to/file.rb:5:in `block (4 levels) in <top (required)>'",
+          "        /path/to/file.rb:24:in in `fail_with'",
+          '      caused by: IOError: Socket closed',
+          "        script.rb:5:in `a'",
+          "        script.rb:10:in `b'",
+          ' ',
+          '',
+        )
       end
     end
   end
@@ -187,12 +187,12 @@ RSpec.describe Gurke::Reporters::CompactReporter do
     let(:action) { [:after_features, []] }
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .
-        .
-        .0 scenarios: 0 passed, 0 failing, 0 pending
-        .
-      TEXT
+      expect(out).to eq text(
+        ' ',
+        ' ',
+        '0 scenarios: 0 passed, 0 failing, 0 pending',
+        '',
+      )
     end
   end
 end

data/spec/gurke/reporters/default_reporter_spec.rb

@@ -30,28 +30,28 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     end
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        Feature: Demo feature   # features/file.feature:1
-          As a developer
-          I would like have this spec passed
-          In order to work on
-        .
-        .
-      TEXT
+      expect(out).to eq text(
+        'Feature: Demo feature   # features/file.feature:1',
+        '  As a developer',
+        '  I would like have this spec passed',
+        '  In order to work on',
+        ' ',
+        '',
+      )
     end
 
     context 'with colors' do
       let(:color) { true }
 
       it 'outputs ASCII color codes' do
-        expect(out).to eq unindent <<~TEXT
-          \e[0;33;49mFeature\e[0m: Demo feature   \e[0;90;49m# features/file.feature:1\e[0m
-          \e[0;90;49m  As a developer
-            I would like have this spec passed
-            In order to work on\e[0m
-          .
-          .
-        TEXT
+        expect(out).to eq text(
+          "\e[0;33;49mFeature\e[0m: Demo feature   \e[0;90;49m# features/file.feature:1\e[0m",
+          "\e[0;90;49m  As a developer",
+          '  I would like have this spec passed',
+          "  In order to work on\e[0m",
+          ' ',
+          '',
+        )
       end
     end
   end
@@ -60,10 +60,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     let(:action) { [:start_background, feature] }
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .    Background:
-        .
-      TEXT
+      expect(out).to eq text(
+        '    Background:',
+        '',
+      )
     end
   end
 
@@ -76,10 +76,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     end
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .  Scenario: Running the scenario   # features/file.feature:5
-        .
-      TEXT
+      expect(out).to eq text(
+        '  Scenario: Running the scenario   # features/file.feature:5',
+        '',
+      )
     end
   end
 
@@ -91,9 +91,9 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     end
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .    Given the scenario is passing
-      TEXT
+      expect(out).to eq text(
+        '    Given the scenario is passing',
+      )
     end
   end
 
@@ -109,10 +109,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
       let(:state) { :passed }
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          . (passed)
-          .
-        TEXT
+        expect(out).to eq text(
+          ' (passed)',
+          '',
+        )
       end
     end
 
@@ -120,10 +120,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
       let(:state) { :pending }
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          . (pending)
-          .
-        TEXT
+        expect(out).to eq text(
+          ' (pending)',
+          '',
+        )
       end
     end
 
@@ -131,10 +131,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
       let(:state) { nil }
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          . (skipped)
-          .
-        TEXT
+        expect(out).to eq text(
+          ' (skipped)',
+          '',
+        )
       end
     end
 
@@ -159,17 +159,17 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
       end
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          . (failure)
-          .        RuntimeError: An error occurred
-          .          /path/to/file.rb:5:in `block (4 levels) in <top (required)>'
-          .          /path/to/file.rb:24:in in `fail_with'
-          .        caused by: IOError: Socket closed
-          .          script.rb:5:in `a'
-          .          script.rb:10:in `b'
-          .
-          .
-        TEXT
+        expect(out).to eq text(
+          ' (failure)',
+          '        RuntimeError: An error occurred',
+          "          /path/to/file.rb:5:in `block (4 levels) in <top (required)>'",
+          "          /path/to/file.rb:24:in in `fail_with'",
+          '        caused by: IOError: Socket closed',
+          "          script.rb:5:in `a'",
+          "          script.rb:10:in `b'",
+          ' ',
+          '',
+        )
       end
     end
   end
@@ -183,12 +183,12 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
       end
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          .
-          .  Retry scenario due to previous failure:
-          .
-          .
-        TEXT
+        expect(out).to eq text(
+          ' ',
+          '  Retry scenario due to previous failure:',
+          ' ',
+          '',
+        )
       end
     end
 
@@ -198,12 +198,12 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
       end
 
       it do
-        expect(out).to eq unindent <<~TEXT
-          .
-          .  Retry flaky scenario due to previous failure:
-          .
-          .
-        TEXT
+        expect(out).to eq text(
+          ' ',
+          '  Retry flaky scenario due to previous failure:',
+          ' ',
+          '',
+        )
       end
     end
   end
@@ -212,10 +212,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     let(:action) { [:after_scenario, scenario] }
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .
-        .
-      TEXT
+      expect(out).to eq text(
+        ' ',
+        '',
+      )
     end
   end
 
@@ -223,10 +223,10 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     let(:action) { [:after_feature, feature] }
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .
-        .
-      TEXT
+      expect(out).to eq text(
+        ' ',
+        '',
+      )
     end
   end
 
@@ -234,11 +234,11 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
     let(:action) { [:after_features, []] }
 
     it do
-      expect(out).to eq unindent <<~TEXT
-        .0 scenarios: 0 failing, 0 pending
-        .
-        .
-      TEXT
+      expect(out).to eq text(
+        '0 scenarios: 0 failing, 0 pending',
+        ' ',
+        '',
+      )
     end
   end
 end

data/spec/spec_helper.rb

@@ -18,6 +18,10 @@ module Helper
   def unindent(str)
     str.rstrip.gsub(/^\./, '')
   end
+
+  def text(*args)
+    args.join("\n")
+  end
 end
 
 RSpec.configure do |config|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gurke
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Jan Graichen
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize