squirrel-cucumber 0.3.12

data/lib/cucumber/formatter/pretty.rb

@@ -0,0 +1,188 @@
+require 'cucumber/formatter/console'
+require 'fileutils'
+
+module Cucumber
+  module Formatter
+    # This formatter prints features to plain text - exactly how they were parsed,
+    # just prettier. That means with proper indentation and alignment of table columns.
+    #
+    # If the output is STDOUT (and not a file), there are bright colours to watch too.
+    #
+    class Pretty < Ast::Visitor
+      include FileUtils
+      include Console
+      attr_writer :indent
+
+      def initialize(step_mother, io, options, delim='|')
+        super(step_mother)
+        @io = io
+        @options = options
+        @delim = delim
+        @exceptions = []
+        @indent = 0
+      end
+
+      def visit_features(features)
+        super
+        print_summary(features) unless @options[:autoformat]
+      end
+
+      def visit_feature(feature)
+        @exceptions = []
+        @indent = 0
+        if @options[:autoformat]
+          file = File.join(@options[:autoformat], feature.file)
+          dir = File.dirname(file)
+          mkdir_p(dir) unless File.directory?(dir)
+          File.open(file, Cucumber.file_mode('w')) do |io|
+            @io = io
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def visit_comment(comment)
+        comment.accept(self)
+      end
+
+      def visit_comment_line(comment_line)
+        @io.puts(comment_line.indent(@indent)) 
+        @io.flush
+      end
+
+      def visit_tags(tags)
+        tags.accept(self)
+        if @indent == 1
+          @io.puts 
+          @io.flush
+        end
+      end
+
+      def visit_tag_name(tag_name)
+        tag = format_string("@#{tag_name}", :tag).indent(@indent)
+        @io.print(tag)
+        @io.flush
+        @indent = 1
+      end
+
+      def visit_feature_name(name)
+        @io.puts(name)
+        @io.puts
+        @io.flush
+      end
+
+      def visit_feature_element(feature_element)
+        @indent = 2
+        @scenario_indent = 2
+        super
+        @io.puts
+        @io.flush
+      end
+
+      def visit_background(background)
+        @indent = 2
+        @scenario_indent = 2
+        @in_background = true
+        super
+        @in_background = nil
+        @io.puts
+        @io.flush
+      end
+
+      def visit_background_name(keyword, name, file_colon_line, source_indent)
+        visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+      end
+
+      def visit_examples_name(keyword, name)
+        names = name.empty? ? [name] : name.split("\n")
+        @io.puts("\n    #{keyword} #{names[0]}")
+        names[1..-1].each {|s| @io.puts "      #{s}" }
+        @io.flush
+        @indent = 6
+        @scenario_indent = 6
+      end
+
+      def visit_scenario_name(keyword, name, file_colon_line, source_indent)
+        visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+      end
+
+      def visit_feature_element_name(keyword, name, file_colon_line, source_indent)
+        @io.puts if @scenario_indent == 6
+        names = name.empty? ? [name] : name.split("\n")
+        line = "#{keyword} #{names[0]}".indent(@scenario_indent)
+        @io.print(line)
+        if @options[:source]
+          line_comment = " # #{file_colon_line}".indent(source_indent)
+          @io.print(format_string(line_comment, :comment))
+        end
+        @io.puts
+        names[1..-1].each {|s| @io.puts "    #{s}"}
+        @io.flush
+      end
+
+      def visit_step(step)
+        @indent = 6
+        super
+      end
+
+      def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+        if exception
+          return if @exceptions.index(exception)
+          @exceptions << exception
+        end
+        return if status != :failed && @in_background ^ background
+        @status = status
+        super
+      end
+
+      def visit_step_name(keyword, step_match, status, source_indent, background)
+        source_indent = nil unless @options[:source]
+        formatted_step_name = format_step(keyword, step_match, status, source_indent)
+        @io.puts(formatted_step_name.indent(@scenario_indent + 2))
+      end
+
+      def visit_multiline_arg(multiline_arg)
+        return if @options[:no_multiline]
+        super
+      end
+
+      def visit_exception(exception, status)
+        print_exception(exception, status, @indent)
+        @io.flush
+      end
+
+      def visit_table_row(table_row)
+        @io.print @delim.indent(@indent)
+        super
+        @io.puts
+        if table_row.exception && !@exceptions.index(table_row.exception)
+          print_exception(table_row.exception, :failed, @indent) 
+        end
+      end
+
+      def visit_py_string(string)
+        s = %{"""\n#{string}\n"""}.indent(@indent)
+        s = s.split("\n").map{|l| l =~ /^\s+$/ ? '' : l}.join("\n")
+        @io.puts(format_string(s, @status))
+        @io.flush
+      end
+
+      def visit_table_cell_value(value, width, status)
+        status ||= @status || :passed
+        @io.print(' ' + format_string((value.to_s || '').ljust(width), status) + ::Term::ANSIColor.reset(" #{@delim}"))
+        @io.flush
+      end
+
+      private
+
+      def print_summary(features)
+        print_stats(features)
+        print_snippets(@options)
+        print_passing_wip(@options)
+      end
+
+    end
+  end
+end

data/lib/cucumber/formatter/profile.rb

@@ -0,0 +1,77 @@
+require 'cucumber/formatter/progress'
+
+module Cucumber
+  module Formatter
+    class Profile < Progress
+      NUMBER_OF_STEP_DEFINITONS_TO_SHOW = 10
+      NUMBER_OF_STEP_INVOCATIONS_TO_SHOW = 5
+
+      def initialize(step_mother, io, options)
+        super
+        @step_definition_durations = Hash.new { |h,step_definition| h[step_definition] = [] }
+      end
+
+      def visit_step(step)
+        @step_duration = Time.now
+        @step = step
+        super
+      end
+
+      def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+        duration = Time.now - @step_duration
+        super
+
+        if step_match.step_definition
+          description = format_step(keyword, step_match, status, nil)
+          @step_definition_durations[step_match.step_definition] << [duration, description, @step.file_colon_line]
+        end
+      end
+
+      def print_summary(features)
+        super
+        @io.puts "\n\nTop #{NUMBER_OF_STEP_DEFINITONS_TO_SHOW} average slowest steps with #{NUMBER_OF_STEP_INVOCATIONS_TO_SHOW} slowest matches:\n"
+
+        mean_durations = map_to_mean_durations(@step_definition_durations)
+        mean_durations = mean_durations.sort_by do |duration_description_location, step_definition, mean_duration| 
+          mean_duration
+        end.reverse
+
+        mean_durations[0...NUMBER_OF_STEP_DEFINITONS_TO_SHOW].each do |duration_description_location, step_definition, mean_duration|
+          print_step_definition(step_definition, mean_duration)
+          duration_description_location = duration_description_location.sort_by do |duration, description, location| 
+            duration 
+          end.reverse
+          print_step_definitions(duration_description_location, step_definition)
+        end
+      end
+
+      private
+
+      def map_to_mean_durations(step_definition_durations)
+        mean_durations = []
+        step_definition_durations.each do |step_definition, duration_description_location|
+          total_duration = duration_description_location.inject(0) { |sum, step_details| step_details[0] + sum }
+          mean_duration = total_duration / duration_description_location.length
+
+          mean_durations << [duration_description_location, step_definition, mean_duration]
+        end
+        mean_durations
+      end
+
+      def print_step_definition(step_definition, mean_duration)
+        duration = sprintf("%.7f",  mean_duration)
+        @io.puts format_string("#{duration} #{step_definition.backtrace_line}", :failed)
+      end
+
+      def print_step_definitions(duration_description_location, step_definition)
+        max_length = duration_description_location[0...NUMBER_OF_STEP_INVOCATIONS_TO_SHOW].map{|_, d, _| d.jlength}.max
+        duration_description_location[0...NUMBER_OF_STEP_INVOCATIONS_TO_SHOW].each do |duration, description, location|
+          @io.print format_string("  #{sprintf("%.7f", duration)}", :pending)
+          @io.print "  #{description}"
+          @io.print format_string("  # #{location}".indent(max_length - description.jlength), :comment)
+          @io.puts
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/progress.rb

@@ -0,0 +1,60 @@
+require 'cucumber/formatter/console'
+
+module Cucumber
+  module Formatter
+    class Progress < Ast::Visitor
+      include Console
+
+      def initialize(step_mother, io, options)
+        super(step_mother)
+        @io = io
+        @options = options
+      end
+
+      def visit_features(features)
+        super
+        @io.puts
+        @io.puts
+        print_summary(features)
+      end
+
+      def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+        progress(status)
+        @status = status
+      end
+
+      def visit_table_cell_value(value, width, status)
+        status ||= @status
+        progress(status) unless table_header_cell?(status)
+      end
+
+      private
+
+      def print_summary(features)
+        print_steps(:pending)
+        print_steps(:failed)
+        print_stats(features)
+        print_snippets(@options)
+        print_passing_wip(@options)
+      end
+
+      CHARS = {
+        :passed    => '.',
+        :failed    => 'F',
+        :undefined => 'U',
+        :pending   => 'P',
+        :skipped   => '-'
+      }
+
+      def progress(status)
+        char = CHARS[status]
+        @io.print(format_string(char, status))
+        @io.flush
+      end
+      
+      def table_header_cell?(status)
+        status == :skipped_param
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/rerun.rb

@@ -0,0 +1,44 @@
+module Cucumber
+  module Formatter
+    # This formatter keeps track of all failing features and print out their location.
+    # Example:
+    #
+    #   features/foo.feature:34 features/bar.feature:11:76:81
+    #
+    # This formatter is used by AutoTest - it will use the output to decide what
+    # to run the next time, simply passing the output string on the command line.
+    #
+    class Rerun < Ast::Visitor
+      def initialize(step_mother, io, options)
+        super(step_mother)
+        @io = io
+        @options = options
+        @file_names = []
+        @file_colon_lines = Hash.new{|h,k| h[k] = []}
+      end
+
+      def visit_features(features)
+        super
+        files = @file_names.uniq.map do |file|
+          lines = @file_colon_lines[file]
+          "#{file}:#{lines.join(':')}"
+        end
+        @io.puts files.join(' ')
+      end
+
+      def visit_feature_element(feature_element)
+        @rerun = false
+        super
+        if @rerun
+          file, line = *feature_element.file_colon_line.split(':')
+          @file_colon_lines[file] << line
+          @file_names << file
+        end
+      end
+
+      def visit_step_name(keyword, step_match, status, source_indent, background)
+        @rerun = true if [:failed].index(status)
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/tag_cloud.rb

@@ -0,0 +1,28 @@
+module Cucumber
+  module Formatter
+    # Custom formatter that prints a tag cloud
+    class TagCloud < Cucumber::Ast::Visitor
+      def initialize(step_mother, io, options)
+        super(step_mother)
+        @io = io
+        @options = options
+        @counts = Hash.new{|h,k| h[k] = 0}
+      end
+
+      def visit_features(features)
+        super
+        print_summary(features)
+      end
+
+      def visit_tag_name(tag_name)
+        @counts[tag_name] += 1
+      end
+  
+      def print_summary(features)
+        matrix = @counts.to_a.sort{|paira, pairb| paira[0] <=> pairb[0]}.transpose
+        table = Cucumber::Ast::Table.new(matrix)
+        Cucumber::Formatter::Pretty.new(@step_mother, @io, {}).visit_multiline_arg(table)
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/unicode.rb

@@ -0,0 +1,35 @@
+# Require this file if you need Unicode support.
+require 'cucumber/platform'
+require 'cucumber/formatter/ansicolor'
+
+$KCODE='u' unless Cucumber::RUBY_1_9
+
+if Cucumber::WINDOWS_MRI && `chcp` =~ /(\d+)/
+  codepage = $1.to_i
+  codepages = (1251..1252)
+
+  if codepages.include?(codepage)
+    Cucumber::CODEPAGE = "cp#{codepage}"
+  
+    require 'iconv'
+    module Kernel
+      alias cucumber_print print
+      def print(*a)
+        begin
+          cucumber_print(*Iconv.iconv(Cucumber::CODEPAGE, "UTF-8", *a))
+        rescue Iconv::IllegalSequence
+          cucumber_print(*a)
+        end
+      end
+
+      alias cucumber_puts puts
+      def puts(*a)
+        begin
+          cucumber_puts(*Iconv.iconv(Cucumber::CODEPAGE, "UTF-8", *a))
+        rescue Iconv::IllegalSequence
+          cucumber_puts(*a)
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/usage.rb

@@ -0,0 +1,85 @@
+require 'cucumber/formatter/progress'
+
+module Cucumber
+  module Formatter
+    class Usage < Ast::Visitor
+      include Console
+
+      def initialize(step_mother, io, options)
+        super(step_mother)
+        @io = io
+        @options = options
+        @step_definitions = Hash.new { |h,step_definition| h[step_definition] = [] }
+        @all_step_definitions = step_mother.step_definitions.dup
+        @locations = []
+      end
+
+      def visit_features(features)
+        super
+        print_summary(features)
+      end
+
+      def visit_step(step)
+        @step = step
+        super
+      end
+
+      def visit_step_name(keyword, step_match, status, source_indent, background)
+        if step_match.step_definition
+          location = @step.file_colon_line
+          return if @locations.index(location)
+          @locations << location
+          
+          description = format_step(keyword, step_match, status, nil)
+          length = (keyword + step_match.format_args).jlength
+          @step_definitions[step_match.step_definition] << [step_match, description, length, location]
+          @all_step_definitions.delete(step_match.step_definition)
+        end
+      end
+
+      def print_summary(features)
+        sorted_defs = @step_definitions.keys.sort_by{|step_definition| step_definition.backtrace_line}
+        
+        sorted_defs.each do |step_definition|          
+          step_matches_and_descriptions = @step_definitions[step_definition].sort_by do |step_match_and_description|
+            step_match = step_match_and_description[0]
+            step_match.step_definition.regexp.inspect
+          end
+
+          step_matches = step_matches_and_descriptions.map{|step_match_and_description| step_match_and_description[0]}
+
+          lengths = step_matches_and_descriptions.map do |step_match_and_description| 
+            step_match_and_description[2]
+          end
+          lengths << step_definition.text_length
+          max_length = lengths.max
+
+          @io.print step_definition.regexp.inspect
+          @io.puts format_string("   # #{step_definition.file_colon_line}".indent(max_length - step_definition.text_length), :comment)
+          da = step_matches_and_descriptions.map do |step_match_and_description|
+            step_match      = step_match_and_description[0]
+            description     = step_match_and_description[1]
+            length          = step_match_and_description[2]
+            file_colon_line = step_match_and_description[3]
+            " #{description}" + format_string(" # #{file_colon_line}".indent(max_length - length), :comment)
+          end
+          da.sort.each{|d| puts d}
+        end
+
+        print_unused_step_definitions
+      end
+
+      def print_unused_step_definitions
+        if @all_step_definitions.any?
+          max_length = @all_step_definitions.map{|step_definition| step_definition.text_length}.max
+
+          @io.puts format_string("(::) UNUSED (::)", :failed)
+          @all_step_definitions.each do |step_definition|
+            @io.print format_string(step_definition.regexp.inspect, :failed)
+            @io.puts format_string("  # #{step_definition.file_colon_line}".indent(max_length - step_definition.text_length), :comment)
+          end
+        end
+      end
+    end
+  end
+end