gurke 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67753800c554ed5230279ea3fedb0765c04bdbebb23e0adcfe51d39aa171e943
-  data.tar.gz: 1272789c4796298eccbea8d1c4b7993d09e5adb67be6d1c9750e7b9fc0c57837
+  metadata.gz: f2311a29357e984f6868342e33b6521a51c7697774155d061090b21484a446a8
+  data.tar.gz: 314bc36b51bd2236407ea0489679edca0aaa78ce47a2870348557a73a66637d1
 SHA512:
-  metadata.gz: 68edef2b0fd8b60b87dca69ac2a6bd2bfbed63ea58d9c0a0484a72e1a4aea5713a673a0eb46b182ba0ffa006002d7db991d5e842504827bea841365e6ffb28cd
-  data.tar.gz: 9c3f090fd25a651f46d85e11864d539379af2977c9d2174a3bf23fd542933af388336cd0a7f968d40e2330bab234c792645dd21999e2ac6710e1d422b1c7f9f2
+  metadata.gz: d658e154b2d261d8b4a529f8f7d6b474e8519a042e15808cdc8492a2084c4d0ffa1020cf997ef4900c33a79200cc31886024905da3725038f217b6c362241372
+  data.tar.gz: 2d2ec2d30909f5b6b3f2673cdb079ef2342c50f9cf7bdf9d9f40e62d022ab08d1570ec4f22212a7c337f9e8bcdef277dd4c862a701d923a4644e10d4cb68ed03

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.0
+
+* Update TeamCity formatter to extend default formatter
+
 ## 3.0.0
 
 * Drop support for MRI < 2.3

data/lib/gurke/cli.rb

@@ -61,7 +61,7 @@ module Gurke
         opt :version, 'Show program version information.'
         opt :backtrace, 'Show full error backtraces.'
         opt :formatter, 'Select a special formatter as reporter', \
-          default: 'compact'
+          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' \

data/lib/gurke/reporter.rb

@@ -7,8 +7,6 @@ module Gurke
   #
   # @api public
   #
-  # rubocop:disable MissingCopEnableDirective
-  # rubocop:disable UnusedMethodArgument
   #
   class Reporter
     # List of all callback methods as symbols.
@@ -42,7 +40,7 @@ module Gurke
     #
     # @api public
     #
-    def before_features(features)
+    def before_features(_features)
       raise NotImplementedError.new \
         "#{self.class.name}#before_features must be implemented in subclass."
     end
@@ -55,7 +53,7 @@ module Gurke
     #
     # @api public
     #
-    def start_features(features)
+    def start_features(_features)
       raise NotImplementedError.new \
         "#{self.class.name}#before_features must be implemented in subclass."
     end
@@ -68,7 +66,7 @@ module Gurke
     #
     # @api public
     #
-    def before_feature(feature)
+    def before_feature(_feature)
       raise NotImplementedError.new \
         "#{self.class.name}#start_feature must be implemented in subclass."
     end
@@ -81,7 +79,7 @@ module Gurke
     #
     # @api public
     #
-    def start_feature(feature)
+    def start_feature(_feature)
       raise NotImplementedError.new \
         "#{self.class.name}#start_feature must be implemented in subclass."
     end
@@ -93,7 +91,7 @@ module Gurke
     #
     # @api public
     #
-    def before_scenario(scenario)
+    def before_scenario(_scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#before_scenario must be implemented in subclass."
     end
@@ -105,7 +103,7 @@ module Gurke
     #
     # @api public
     #
-    def start_scenario(scenario)
+    def start_scenario(_scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#start_scenario must be implemented in subclass."
     end
@@ -117,7 +115,7 @@ module Gurke
     #
     # @api public
     #
-    def start_background(background, scenario)
+    def start_background(_background, _scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#start_background must be implemented in subclass."
     end
@@ -129,7 +127,7 @@ module Gurke
     #
     # @api public
     #
-    def end_background(background, scenario)
+    def end_background(_background, _scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#end_background must be implemented in subclass."
     end
@@ -141,7 +139,7 @@ module Gurke
     #
     # @api public
     #
-    def before_step(step, scenario)
+    def before_step(_step, _scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#before_step must be implemented in subclass."
     end
@@ -153,7 +151,7 @@ module Gurke
     #
     # @api public
     #
-    def start_step(step, scenario)
+    def start_step(_step, _scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#start_step must be implemented in subclass."
     end
@@ -166,7 +164,7 @@ module Gurke
     #
     # @api public
     #
-    def end_step(step_result, scenario)
+    def end_step(_step_result, _scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#end_step must be implemented in subclass."
     end
@@ -179,7 +177,7 @@ module Gurke
     #
     # @api public
     #
-    def after_step(step_result, scenario)
+    def after_step(_step_result, _scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#after_step must be implemented in subclass."
     end
@@ -191,7 +189,7 @@ module Gurke
     #
     # @api public
     #
-    def end_scenario(scenario)
+    def end_scenario(_scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#end_scenario must be implemented in subclass."
     end
@@ -203,7 +201,7 @@ module Gurke
     #
     # @api public
     #
-    def after_scenario(scenario)
+    def after_scenario(_scenario)
       raise NotImplementedError.new \
         "#{self.class.name}#after_scenario must be implemented in subclass."
     end
@@ -214,7 +212,7 @@ module Gurke
     #
     # @api public
     #
-    def end_feature(feature)
+    def end_feature(_feature)
       raise NotImplementedError.new \
         "#{self.class.name}#end_feature must be implemented in subclass."
     end
@@ -225,7 +223,7 @@ module Gurke
     #
     # @api public
     #
-    def after_feature(feature)
+    def after_feature(_feature)
       raise NotImplementedError.new \
         "#{self.class.name}#after_feature must be implemented in subclass."
     end
@@ -236,7 +234,7 @@ module Gurke
     #
     # @api public
     #
-    def end_features(features)
+    def end_features(_features)
       raise NotImplementedError.new \
         "#{self.class.name}#end_features must be implemented in subclass."
     end
@@ -247,7 +245,7 @@ module Gurke
     #
     # @api public
     #
-    def after_features(features)
+    def after_features(_features)
       raise NotImplementedError.new \
         "#{self.class.name}#after_features must be implemented in subclass."
     end
@@ -265,7 +263,7 @@ module Gurke
     protected
 
     def format_exception(ex, backtrace: true)
-      s = [ex.class.to_s + ': ' + ex.message.strip]
+      s = ex.class.to_s << ': ' << ex.message.strip << "\n"
 
       if backtrace
         if ex.backtrace.nil?
@@ -274,7 +272,7 @@ module Gurke
           s << '  <backtrace empty>'
         else
           ex.backtrace.each do |bt|
-            s << '  ' + bt.strip
+            s << '  ' << bt.strip << "\n"
           end
         end
       end
@@ -282,9 +280,7 @@ module Gurke
       if ex.respond_to?(:cause) && ex.cause &&
          ex.cause.respond_to?(:message) && ex.cause.respond_to?(:backtrace)
 
-        cause = format_exception(ex.cause, backtrace: backtrace)
-        s << 'caused by: ' + cause.shift
-        s += cause
+        s << 'caused by: ' << format_exception(ex.cause, backtrace: backtrace)
       end
 
       s

data/lib/gurke/reporters/default_reporter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'colorize'
-
 # Colors
 #   :black, :red, :green, :yellow, :blue,
 #   :magenta, :cyan, :white, :default, :light_black,
@@ -63,13 +61,14 @@ module Gurke::Reporters
       io.print step.name.gsub(/"(.*?)"/, cyan('\0'))
     end
 
-    def after_step(step, *)
+    def after_step(step, *args)
       case step.state
-        when :pending then print_braces yellow 'pending'
-        when :failed  then print_failed step
-        when :passed then print_braces green 'passed'
-        else print_braces cyan 'skipped'
+        when :pending then step_pending(step, *args)
+        when :failed  then step_failed(step, *args)
+        when :passed then step_passed(step, *args)
+        else step_skipped(step, *args)
       end
+
       io.puts
       io.flush
     end
@@ -107,7 +106,36 @@ module Gurke::Reporters
       io.puts
     end
 
-    private
+    protected
+
+    def status(str)
+      " (#{str})"
+    end
+
+    def step_pending(*)
+      io.print status yellow 'pending'
+    end
+
+    def step_failed(step, *_args, exception: true)
+      io.print status red 'failure'
+      io.puts
+
+      return unless exception
+
+      print_exception(step.exception)
+    end
+
+    def step_passed(*)
+      io.print status green 'passed'
+    end
+
+    def step_skipped(*)
+      io.print cyan 'skipped'
+    end
+
+    def print_exception(exception)
+      io.puts red format_exception(exception).gsub(/^/, '        ')
+    end
 
     def format_location(obj)
       file = obj.file.to_s
@@ -119,18 +147,6 @@ module Gurke::Reporters
       light_black("# #{path}:#{line}")
     end
 
-    def print_braces(str)
-      io.print " (#{str})"
-    end
-
-    def print_failed(step)
-      print_braces red('failure')
-      io.puts
-
-      exout = format_exception(step.exception)
-      io.puts exout.map {|s| red("        #{s}\n") }.join
-    end
-
     %i[black red green yellow blue
        magenta cyan white default light_black
        light_red light_green light_yellow light_blue

data/lib/gurke/reporters/team_city_reporter.rb

@@ -5,98 +5,64 @@ module Gurke::Reporters
   # The {TeamCityReporter} prints features, scenarios and
   # steps in a format parseable by TeamCity CI.
   #
-  class TeamCityReporter < NullReporter
-    attr_reader :io
-    def initialize(io = $stdout)
-      @io = io
-    end
-
+  class TeamCityReporter < DefaultReporter
     def before_feature(feature)
       publish :testSuiteStarted, name: feature.name
-      io.puts "  #{feature.description.split("\n").join("\n  ")}"
-      io.puts
-    end
-
-    def before_scenario(scenario)
-      @scenario = scenario
-      publish :testStarted, name: scenario.name
-    end
 
-    def start_background(*)
-      io.puts '    Background:' unless @background
-
-      @background = true
+      super
     end
 
-    def end_background(*)
-      @background = false
-    end
+    def before_scenario(scenario)
+      @status_reported = false
 
-    def before_step(step, *)
-      io.print '  ' if @background
-      io.print '    '
-      io.print step.keyword
-      io.print step.name
-    end
+      publish :testStarted, name: scenario.name
 
-    def after_step(step, *)
-      case step.state
-        when :pending then print_pending step
-        when :failed  then print_failed step
-        when :success then print_braces 'success'
-        else print_braces 'skipped'
-      end
-      io.puts
-      io.flush
+      super
     end
 
     def after_scenario(scenario)
       publish :testFinished, name: scenario.name
+
+      super
     end
 
     def after_feature(feature)
       publish :testSuiteFinished, name: feature.name
-    end
-
-    def after_features(features)
-      scenarios = features.map(&:scenarios).flatten
 
-      example_count = scenarios.size
-      failure_count = scenarios.select(&:failed?).size
-      pending_count = scenarios.select(&:pending?).size
-
-      io.puts "  #{example_count} scenarios: " \
-              "#{failure_count} failing, " \
-              "#{pending_count} pending"
-      io.puts
+      super
     end
 
-    private
+    protected
 
-    def print_braces(str)
-      io.print " (#{str})"
-    end
+    def step_pending(step, *)
+      super
 
-    def print_pending(_step)
-      return if @pending == @scenario # only once per scenario
-      publish :testIgnored,
-        name: @scenario.name,
+      report :testIgnored,
+        name: step.scenario.name,
         message: 'Step definition missing'
-      @pending = @scenario
     end
 
-    def print_failed(step)
-      publish :testFailed,
-        name: @scenario.name,
+    def step_failed(step, *args)
+      super(step, *args, exception: false)
+
+      report :testFailed,
+        name: step.scenario.name,
         message: step.exception.inspect,
         backtrace: step.exception.backtrace.join('\n')
-      @pending = @scenario
 
-      print_braces 'failure'
-      io.puts
+      print_exception(step.exception)
+    end
+
+    private
 
-      exout = format_exception(step.exception)
-      io.puts exout.map {|s| "        #{s}\n" }.join
+    def status_reported?
+      @status_reported
+    end
+
+    def report(*args)
+      return if status_reported?
+
+      publish(*args)
     end
 
     def publish(message_name, args)
@@ -119,9 +85,5 @@ module Gurke::Reporters
         "'#{escape args}'"
       end
     end
-
-    def step_name(step)
-      step.keyword + step.name.gsub(/"(.*?)"/, '\0')
-    end
   end
 end

data/lib/gurke/step.rb

@@ -61,14 +61,14 @@ module Gurke
       result = find_and_run_step runner, scenario, world
     rescue Interrupt
       scenario.abort!
-      result = StepResult.new self, :aborted
+      result = StepResult.new self, scenario, :aborted
       raise
     rescue StepPending => e
       scenario.pending! e
-      result = StepResult.new self, :pending, e
+      result = StepResult.new self, scenario, :pending, e
     rescue Exception => e # rubocop:disable RescueException
       scenario.failed! e
-      result = StepResult.new self, :failed, e
+      result = StepResult.new self, scenario, :failed, e
     ensure
       reporter.invoke :end_step, result, scenario
     end
@@ -78,23 +78,24 @@ module Gurke
         match = Steps.find_step self, world, type
 
         if scenario.pending? || scenario.failed? || scenario.aborted?
-          return StepResult.new self, :skipped
+          return StepResult.new self, scenario, :skipped
         end
 
         m = world.method match.method_name
         world.send match.method_name, *(match.params + [self])[0...m.arity]
 
-        StepResult.new self, :passed
+        StepResult.new self, scenario, :passed
       end
     end
 
     #
     class StepResult
-      attr_reader :step, :exception, :state
+      attr_reader :step, :exception, :state, :scenario
 
-      def initialize(step, state, err = nil)
+      def initialize(step, scenario, state, err = nil)
         @step = step
         @state = state
+        @scenario = scenario
         @exception = err
       end
 

data/lib/gurke/version.rb

@@ -3,7 +3,7 @@
 module Gurke
   module VERSION
     MAJOR = 3
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gurke
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jan Graichen