gurke 2.4.2 → 3.0.0

data/lib/gurke/reporters/compact_reporter.rb

@@ -0,0 +1,137 @@
+# 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
+    attr_reader :io
+
+    def initialize(io = $stdout)
+      @io = io
+    end
+
+    def after_step(result, scenario, *)
+      return unless result.state == :failed
+
+      io.print red 'E'
+
+      feature = scenario.feature
+
+      io.puts
+      io.print yellow('Feature')
+      io.print ': '
+      io.print scenario.feature.name
+      io.print '   '
+      io.print format_location(scenario.feature)
+      io.puts
+
+      io.print '  '
+      io.print yellow('Scenario')
+      io.print ': '
+      io.print scenario.name
+      io.print '   '
+      io.print format_location(scenario)
+      io.puts
+
+      background = feature.backgrounds.map(&:steps).flatten
+
+      catch(:break) do
+        if background.any?
+          io.print '    '
+          io.print light_black('Background')
+          io.print ':'
+          io.puts
+
+          background.each do |step|
+            io.print '      '
+            io.print yellow(step.keyword)
+            io.print ' '
+            io.print step.name.gsub(/"(.*?)"/, cyan('\0'))
+            io.puts
+
+            throw :break if step == result.step
+          end
+        end
+
+        scenario.steps.each do |step|
+          io.print '    '
+          io.print yellow(step.keyword)
+          io.print ' '
+          io.print step.name.gsub(/"(.*?)"/, cyan('\0'))
+          io.puts
+
+          throw :break if step == result.step
+        end
+      end
+
+      exout = format_exception(result.exception, backtrace: true)
+      io.puts red exout.join("\n").gsub(/^/, '      ')
+      io.puts
+    end
+
+    def after_scenario(scenario)
+      if scenario.failed?
+        # printed in after_step
+      elsif scenario.pending?
+        io.print yellow '?'
+      elsif scenario.passed?
+        io.print green '.'
+      elsif scenario.aborted?
+        io.puts
+      end
+    end
+
+    def after_features(features)
+      io.puts
+      io.puts
+
+      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
+
+      message = "#{scenarios.size} scenarios: "
+      message += "#{passed} passed, "
+      message += "#{failed} failing, #{pending} pending"
+      message += ", #{not_run} not run" if not_run.positive?
+
+      if failed.positive?
+        io.puts red message
+      elsif pending.positive? || not_run.positive?
+        io.puts yellow message
+      else
+        io.puts green message
+      end
+    end
+
+    private
+
+    def format_location(obj)
+      file = obj.file.to_s
+      line = obj.line.to_s
+      cwd  = Pathname.new(Dir.getwd)
+      path = Pathname.new(file).relative_path_from(cwd).to_s
+      path = file if path.length > file.length
+
+      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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 # Colors
@@ -15,24 +17,36 @@ module Gurke::Reporters
   #
   class DefaultReporter < NullReporter
     attr_reader :io
+
     def initialize(io = $stdout)
       @io = io
     end
 
     def before_feature(feature)
-      io.puts "#{yellow('Feature')}: #{feature.name}"
-      io.puts '  ' + light_black(feature.description.split("\n").join("\n  "))
+      io.print yellow('Feature')
+      io.print ': '
+      io.print feature.name
+      io.print '   '
+      io.print format_location(feature)
+      io.puts
+
+      io.print light_black(feature.description.gsub(/^/, '  '))
+      io.puts
       io.puts
     end
 
     def before_scenario(scenario)
-      io.puts "  #{yellow('Scenario')}: #{scenario.name}"
+      io.print '  '
+      io.print yellow('Scenario')
+      io.print ': '
+      io.print scenario.name
+      io.print '   '
+      io.print format_location(scenario)
+      io.puts
     end
 
     def start_background(*)
-      unless @background
-        io.puts light_black('    Background:')
-      end
+      io.puts light_black('    Background:') unless @background
 
       @background = true
     end
@@ -45,6 +59,7 @@ module Gurke::Reporters
       io.print '  ' if @background
       io.print '    '
       io.print yellow(step.keyword)
+      io.print ' '
       io.print step.name.gsub(/"(.*?)"/, cyan('\0'))
     end
 
@@ -52,7 +67,7 @@ module Gurke::Reporters
       case step.state
         when :pending then print_braces yellow 'pending'
         when :failed  then print_failed step
-        when :success then print_braces green 'success'
+        when :passed then print_braces green 'passed'
         else print_braces cyan 'skipped'
       end
       io.puts
@@ -70,14 +85,40 @@ module Gurke::Reporters
     def after_features(features)
       scenarios = features.map(&:scenarios).flatten
 
-      io.puts "  #{scenarios.size} scenarios: " \
-              "#{scenarios.select(&:failed?).size} failing, " \
-              "#{scenarios.select(&:pending?).size} pending"
+      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
+
+      message = "#{scenarios.size} scenarios: "
+      message += "#{passed} passed, " unless passed == size || passed.zero?
+      message += "#{failed} failing, #{pending} pending"
+      message += ", #{not_run} not run" if not_run.positive?
+
+      if failed.positive?
+        io.puts red message
+      elsif pending.positive? || not_run.positive?
+        io.puts yellow message
+      else
+        io.puts green message
+      end
+
       io.puts
     end
 
     private
 
+    def format_location(obj)
+      file = obj.file.to_s
+      line = obj.line.to_s
+      cwd  = Pathname.new(Dir.getwd)
+      path = Pathname.new(file).relative_path_from(cwd).to_s
+      path = file if path.length > file.length
+
+      light_black("# #{path}:#{line}")
+    end
+
     def print_braces(str)
       io.print " (#{str})"
     end
@@ -87,15 +128,15 @@ module Gurke::Reporters
       io.puts
 
       exout = format_exception(step.exception)
-      io.puts exout.map{|s| red("        #{s}\n") }.join
+      io.puts exout.map {|s| red("        #{s}\n") }.join
     end
 
-    [: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|
+    %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 }
+      define_method(color) {|str| io.tty? ? str.send(color) : str }
     end
   end
 end

data/lib/gurke/reporters/null_reporter.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Gurke::Reporters
   #
   # The {NullReporter} does not do anything.
   #
   class NullReporter < Gurke::Reporter
     Gurke::Reporter::CALLBACKS.each do |cb|
-      class_eval <<-EOF, __FILE__, __LINE__
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{cb}(*) end
-      EOF
+      RUBY
     end
   end
 end

data/lib/gurke/reporters/team_city_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gurke::Reporters
   #
   # The {TeamCityReporter} prints features, scenarios and
@@ -21,9 +23,7 @@ module Gurke::Reporters
     end
 
     def start_background(*)
-      unless @background
-        io.puts '    Background:'
-      end
+      io.puts '    Background:' unless @background
 
       @background = true
     end
@@ -77,30 +77,28 @@ module Gurke::Reporters
       io.print " (#{str})"
     end
 
-    def print_pending(step)
+    def print_pending(_step)
       return if @pending == @scenario # only once per scenario
       publish :testIgnored,
-               name: @scenario.name,
-               message: 'Step definition missing'
+        name: @scenario.name,
+        message: 'Step definition missing'
       @pending = @scenario
     end
 
     def print_failed(step)
       publish :testFailed,
-                 name: @scenario.name,
-                 message: step.exception.inspect,
-                 backtrace: step.exception.backtrace.join('\n')
+        name: @scenario.name,
+        message: step.exception.inspect,
+        backtrace: step.exception.backtrace.join('\n')
       @pending = @scenario
 
       print_braces 'failure'
       io.puts
 
       exout = format_exception(step.exception)
-      io.puts exout.map{|s| "        #{s}\n" }.join
+      io.puts exout.map {|s| "        #{s}\n" }.join
     end
 
-
-    private
     def publish(message_name, args)
       args = [] << message_name.to_s << escaped_array_of(args)
       args = args.flatten.reject(&:nil?)
@@ -116,7 +114,7 @@ module Gurke::Reporters
       return [] if args.nil?
 
       if args.is_a? Hash
-        args.map { |key, value| "#{key.to_s}='#{escape value.to_s}'" }
+        args.map {|key, value| "#{key}='#{escape value.to_s}'" }
       else
         "'#{escape args}'"
       end

data/lib/gurke/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 
 Gurke.configure do |c|

data/lib/gurke/run_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gurke
   #
   # A {RunList} is a list of {Background}, {Scenario}

data/lib/gurke/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gurke
   class Runner
     attr_reader :config, :options
@@ -9,7 +11,11 @@ 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
     end
@@ -21,10 +27,10 @@ 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..-1].map {|i| Integer(i) }]
       end
 
-      features = builder.load files.map{|file, _| file }
+      features = builder.load(files.map {|file, _| file })
       features.filter(options, files).run self, reporter
     end
 
@@ -34,10 +40,10 @@ module Gurke
 
     def with_filtered_backtrace
       yield
-    rescue => e
+    rescue StandardError => e
       unless options[:backtrace]
         base = File.expand_path(Gurke.root.dirname)
-        e.backtrace.select!{|l| File.expand_path(l)[0...base.size] == base }
+        e.backtrace.select! {|l| File.expand_path(l)[0...base.size] == base }
       end
       raise
     end
@@ -53,7 +59,7 @@ module Gurke
     class DRbServer < Runner
       URI = 'druby://localhost:8789'
 
-      def run(files)
+      def run(_files)
         require 'drb'
 
         hook :system, nil, nil do

data/lib/gurke/scenario.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gurke
   class Scenario
     #
@@ -42,6 +44,7 @@ module Gurke
       @line    = line
       @tags    = tags
       @raw     = raw
+      @state   = nil
     end
 
     # Return name of the scenario.
@@ -86,6 +89,28 @@ module Gurke
       @state == :failed
     end
 
+    # Check if scenario has passed.
+    #
+    # @return [Boolean] True if scenario passed, false otherwise.
+    #
+    def passed?
+      @state == :passed
+    end
+
+    # Check if scenario was aborted.
+    #
+    # @return [Boolean] True if aborted, false otherwise.
+    #
+    def aborted?
+      @state == :aborted
+    end
+
+    # Check if scenario was run and the state has changed.
+    #
+    def run?
+      !@state.nil?
+    end
+
     # Exception that led to either pending or failed state.
     #
     # @return [Exception] Exception or nil of none given.
@@ -107,12 +132,24 @@ module Gurke
     # @param error [Exception] Given an exception as reason.
     #
     def pending!(error)
-      return if failed?
-
       @exception = error
       @state     = :pending
     end
 
+    # @api private
+    #
+    def passed!
+      @exception = nil
+      @state     = :passed
+    end
+
+    # @api private
+    #
+    def abort!
+      @exception = nil
+      @state     = :aborted
+    end
+
     # @api private
     #
     def run(runner, reporter)
@@ -132,6 +169,8 @@ module Gurke
 
       feature.backgrounds.run runner, reporter, self, world
       steps.run runner, reporter, self, world
+
+      passed! unless @state
     ensure
       reporter.invoke :end_scenario, self
     end