gurke 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6701a22fdedaffd847fa2cb45077bed6d3bbbf7f6c1faf996a9908bac7ca335
-  data.tar.gz: 621bf975bcaf87268a5f98e28b7a15830820d4eef866fcccc74766c15ceecbf8
+  metadata.gz: f25197fd297ba62d42f9d4895bd3df3bd556882cd5fc66769b0bb717ebe1c16e
+  data.tar.gz: fd92245e82302cd497b236ba92bbcb14917dbcee30cbc0923c8ce9c9867de028
 SHA512:
-  metadata.gz: 3933d5b317b1da87502c1c171b39e48975184720ae9924196c6e05ddfbf922b26ec75c5ce39df087d4a9e51e5f331ec60c435a3bc81bcb31d0166e2ebe8369d4
-  data.tar.gz: 4e2d338ef6266709da78fd237906e20cd49839d4e0e55e4005251815b4802924d35436841e15a5b48ea13793dedf1876ce9b9ef157b62c934a0fdb00cb2fe5c5
+  metadata.gz: 914606fbd5b71e005980a8dec79d0842093d544299282018a2c0b2cbc4cbdce35dcbf6aa30799417ec1fca855a07bfbf958aa7abaf9f737a698b3f99b887426b
+  data.tar.gz: 0cd6bb85c10f9edcea212902844cc6417c857133584b1f852d31b5ae75707c8c9f2cdbec17b227f7303f90ebfe30e13eae41a54ab8b5fc852464e50e584760e8

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.5.0] - 2025-04-09
+
+### Added
+
+- Add `--color=[(auto)|on|off]` command line flag
+
 ## [3.4.0] - 2024-08-28
 
 ### Added
@@ -130,7 +136,8 @@ 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.4.0...HEAD
+[Unreleased]: https://github.com/jgraichen/gurke/compare/v3.5.0...HEAD
+[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
 [3.3.4]: https://github.com/jgraichen/gurke/compare/v3.3.3...v3.3.4

data/gurke.gemspec

@@ -28,5 +28,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'colorize'
   spec.add_dependency 'gherkin', '~> 2.0'
-  spec.add_dependency 'optimist', '~> 3.0'
 end

data/lib/gurke/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'optimist'
+require 'optparse'
 
 module Gurke
   class CLI
@@ -10,13 +10,103 @@ module Gurke
     # @param argv [Array<String>] Tokenized argument list.
     #
     def run(argv)
-      call parser.parse(argv), argv
-    rescue Optimist::VersionNeeded
-      print_version && exit
-    rescue Optimist::HelpNeeded
-      print_help && exit
-    rescue Optimist::CommandlineError => e
-      warn "Error: #{e}"
+      options = {
+        backtrace: false,
+        drb_server: false,
+        drb: false,
+        force_color: false,
+        formatter: 'default',
+        pattern: 'features/**/*.feature',
+        require: [],
+        tags: [],
+      }
+
+      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+        opts.banner = 'Usage: gurke [options] [files...]'
+
+        opts.on('-h', '--help', 'Print this help.') do
+          puts opts
+          exit
+        end
+
+        opts.on('-v', '--version', 'Show program version information.') do
+          puts "gurke v#{Gurke::VERSION}"
+          exit
+        end
+
+        opts.on('-b', '--backtrace', 'Show full error backtraces.') do
+          options[:backtrace] = true
+        end
+
+        opts.on(
+          '-f', '--formatter=<s>',
+          'Select a special formatter as reporter (default: "default")',
+        ) do |arg|
+          options[:formatter] = arg.to_s
+        end
+
+        opts.on(
+          '-r', '--require=<s>',
+          'Files matching this pattern will be required after loading ' \
+          'environment but before running features. ' \
+          '(Default: features/steps/**/*.rb, features/support/steps/**/*.rb)',
+        ) do |arg|
+          options[:require] << arg.to_s
+        end
+
+        opts.on(
+          '-t', '--tags=<s>',
+          'Only run features and scenarios matching given tag ' \
+          'filtering expression. (Default: ~wip)',
+        ) do |arg|
+          options[:tags] << arg.to_s
+        end
+
+        opts.on(
+          '-p', '--pattern=<s>',
+          'File pattern matching feature files to be run. (Default: features/**/*.feature)',
+        ) do |arg|
+          options[:pattern] = arg.to_s
+        end
+
+        opts.on('--drb', 'Run features on already started DRb server. (experimental)') do
+          options[:drb] = true
+        end
+
+        opts.on('--drb-server', 'Run features on already started DRb server. (experimental)') do
+          options[:drb_server] = true
+        end
+
+        opts.on('-c', '--color=<mode>', 'Colored output (default: "auto")') do |arg|
+          value = arg.to_s.downcase
+          if value == 'auto'
+            options[:color] = :auto
+          elsif %w[1 yes on true t force].include?(value)
+            options[:color] = true
+          elsif %w[0 no off false f].include?(value)
+            options[:color] = false
+          else
+            warn "Invalid value for color: #{value}"
+            warn 'Supported values are: 0, 1, yes, no, true, false, t, f, force, auto'
+            exit 255
+          end
+        end
+      end.parse!(argv)
+
+      if options[:require].empty?
+        options[:require] << 'features/steps/**/*.rb'
+        options[:require] << 'features/support/steps/**/*.rb'
+      end
+
+      if options[:tags].empty?
+        options[:tags] << '~wip'
+      end
+
+      pp options
+
+      call(options, argv)
+    rescue OptionParser::InvalidOption => e
+      warn e.message
       warn "Run with `-h' for more information on available arguments."
       exit 255
     end
@@ -45,40 +135,6 @@ module Gurke
       Kernel.exit runner.run files
     end
 
-    def print_version
-      $stdout.puts <<~VSTR
-        gurke v#{Gurke::VERSION}
-      VSTR
-    end
-
-    def print_help
-      parser.educate($stdout)
-    end
-
-    def parser
-      @parser ||= Optimist::Parser.new do
-        opt :help, 'Print this help.'
-        opt :version, 'Show program version information.'
-        opt :backtrace, 'Show full error backtraces.'
-        opt :formatter, 'Select a special formatter as reporter', \
-          default: 'default'
-        opt :pattern, 'File pattern matching feature files to be run.',
-          default: 'features/**/*.feature'
-        opt :require, 'Files matching this pattern will be required after' \
-                      'loading environment but before running features.',
-          default: ['features/steps/**/*.rb',
-                    'features/support/steps/**/*.rb',],
-          multi: true
-        opt :tags, 'Only run features and scenarios matching given tag ' \
-                   'filtering expression. TODO: Description.',
-          default: ['~wip'],
-          multi: true
-        opt :drb_server, 'Run gurke DRb server. (experimental)', short: :none
-        opt :drb, 'Run features on already started DRb server. (experimental)',
-          short: :none
-      end
-    end
-
     private
 
     def expand_files(files, options)

data/lib/gurke/reporter.rb

@@ -36,6 +36,8 @@ module Gurke
       retry_scenario
     ].freeze
 
+    def initialize(**kwargs); end
+
     # Called before the execution of any feature and before any
     # before-features hook is invoked.
     #
@@ -293,7 +295,7 @@ module Gurke
         end
       end
 
-      if err.respond_to?(:cause) && err.cause && err.cause.respond_to?(:message)
+      if err.respond_to?(:cause) && err.cause.respond_to?(:message)
         s << (' ' * indent) << 'caused by: '
         s << format_exception(
           err.cause, backtrace: backtrace, indent: indent,

data/lib/gurke/reporters/colored.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+# Colors
+#   :black, :red, :green, :yellow, :blue,
+#   :magenta, :cyan, :white, :default, :light_black,
+#   :light_red, :light_green, :light_yellow, :light_blue,
+#   :light_magenta, :light_cyan, :light_white
+#
+module Gurke::Reporters
+  module Colored
+    def initialize(color: nil, **kwargs)
+      super(**kwargs)
+
+      case color
+        when :auto, nil
+          @colored = io.tty?
+        when TrueClass
+          @colored = true
+        when FalseClass
+          @colored = false
+      end
+    end
+
+    def color?
+      (@color == :auto && io.tty?) || @color
+    end
+
+    protected
+
+    %i[black red green yellow blue
+       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) do |str|
+        @colored ? str.send(color) : str
+      end
+    end
+  end
+end

data/lib/gurke/reporters/compact_reporter.rb

@@ -1,20 +1,14 @@
 # frozen_string_literal: true
 
-require 'colorize'
-
-# Colors
-#   :black, :red, :green, :yellow, :blue,
-#   :magenta, :cyan, :white, :default, :light_black,
-#   :light_red, :light_green, :light_yellow, :light_blue,
-#   :light_magenta, :light_cyan, :light_white
-#
 module Gurke::Reporters
   class CompactReporter < NullReporter
+    include Colored
+
     attr_reader :io
 
-    def initialize(io = $stdout)
-      super()
+    def initialize(io: $stdout, **kwargs)
       @io = io
+      super(**kwargs)
     end
 
     def after_step(result, scenario, *)
@@ -125,12 +119,5 @@ module Gurke::Reporters
 
       light_black("# #{path}:#{line}")
     end
-
-    %i[black red green yellow blue
-       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
 end

data/lib/gurke/reporters/default_reporter.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-# Colors
-#   :black, :red, :green, :yellow, :blue,
-#   :magenta, :cyan, :white, :default, :light_black,
-#   :light_red, :light_green, :light_yellow, :light_blue,
-#   :light_magenta, :light_cyan, :light_white
-#
 module Gurke::Reporters
   #
   # The {DefaultReporter} prints features, scenarios and
@@ -14,11 +8,13 @@ module Gurke::Reporters
   # That includes colorized step results reports etc.
   #
   class DefaultReporter < NullReporter
+    include Colored
+
     attr_reader :io
 
-    def initialize(io = $stdout)
-      super()
+    def initialize(io: $stdout, **kwargs)
       @io = io
+      super(**kwargs)
     end
 
     def before_feature(feature)
@@ -155,12 +151,5 @@ module Gurke::Reporters
 
       light_black("# #{path}:#{line}")
     end
-
-    %i[black red green yellow blue
-       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
 end

data/lib/gurke/runner.rb

@@ -16,7 +16,7 @@ module Gurke
           .map(&:capitalize)
           .join
 
-        Reporters.const_get(r).new
+        Reporters.const_get(r).new(color: options[:color])
       end
     end
 

data/lib/gurke/version.rb

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

data/lib/gurke.rb

@@ -23,6 +23,8 @@ module Gurke
   require 'gurke/world'
 
   module Reporters
+    require 'gurke/reporters/colored'
+
     require 'gurke/reporters/null_reporter'
     require 'gurke/reporters/compact_reporter'
     require 'gurke/reporters/default_reporter'

data/spec/gurke/reporters/compact_reporter_spec.rb

@@ -6,7 +6,7 @@ require 'spec_helper'
 
 RSpec.describe Gurke::Reporters::CompactReporter do
   subject(:out) do
-    reporter = described_class.new(StringIO.new)
+    reporter = described_class.new(io: StringIO.new)
     reporter.send(*action)
     reporter.io.string
   end

data/spec/gurke/reporters/default_reporter_spec.rb

@@ -6,11 +6,13 @@ require 'spec_helper'
 
 RSpec.describe Gurke::Reporters::DefaultReporter do
   subject(:out) do
-    reporter = described_class.new(StringIO.new)
+    reporter = described_class.new(io: StringIO.new, color: color)
     reporter.send(*action)
     reporter.io.string
   end
 
+  let(:color) { nil }
+
   let(:feature) { instance_double(Gurke::Feature) }
   let(:scenario) { instance_double(Gurke::Scenario) }
   let(:step) { instance_double(Gurke::Step) }
@@ -37,6 +39,21 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
         .
       TEXT
     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
+      end
+    end
   end
 
   describe '#start_background' do

data/spec/gurke/reporters/team_city_reporter_spec.rb

@@ -6,7 +6,7 @@ require 'spec_helper'
 
 RSpec.describe Gurke::Reporters::TeamCityReporter do
   subject(:statements) do
-    reporter = described_class.new(StringIO.new)
+    reporter = described_class.new(io: StringIO.new)
     reporter.send(*action)
     reporter.io.string.scan(/##teamcity\[.*\]/)
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gurke
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Jan Graichen
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -38,21 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: optimist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
 email:
 - jgraichen@altimos.de
 executables:
@@ -90,6 +74,7 @@ files:
 - lib/gurke/feature.rb
 - lib/gurke/feature_list.rb
 - lib/gurke/reporter.rb
+- lib/gurke/reporters/colored.rb
 - lib/gurke/reporters/compact_reporter.rb
 - lib/gurke/reporters/default_reporter.rb
 - lib/gurke/reporters/null_reporter.rb
@@ -118,7 +103,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: An alternative gherkin feature runner inspired by rspec and turnip.
 test_files: []