cucumber 0.3.96 → 0.3.97

data/lib/cucumber/ast/tags.rb

@@ -6,7 +6,7 @@ module Cucumber
     #
     # This gets stored internally as <tt>["invoice", "release_2"]</tt>
     #
-    class Tags
+    class Tags #:nodoc:
       def self.strip_prefix(tag_name)
         tag_name =~ /^@(.*)/ ? $1 : tag_name
       end
@@ -23,7 +23,7 @@ module Cucumber
       end
 
       def accept_hook?(hook)
-        hook.matches_tag_names?(@tag_names)
+        hook.tag_names.empty? || (hook.tag_names.map{|tag| Ast::Tags.strip_prefix(tag)} & @tag_names).any?
       end
 
       def count(tag)

data/lib/cucumber/ast/visitor.rb

@@ -1,20 +1,17 @@
 module Cucumber
   module Ast
-    # A dumb visitor that implements the whole Visitor API and just walks the tree.
+    # Base class for formatters. This class just walks the tree depth first.
+    # Just override the methods you care about. Remember to call super if you
+    # override a method.
     class Visitor
-      attr_accessor :options
-      attr_reader :step_mother
+      attr_accessor :options #:nodoc:
+      attr_reader :step_mother #:nodoc:
 
       def initialize(step_mother)
         @options = {}
         @step_mother = step_mother
       end
 
-      def matches_scenario_names?(node)
-        scenario_name_regexps = options[:name_regexps] || []
-        scenario_name_regexps.empty? || node.matches_scenario_names?(scenario_name_regexps)
-      end
-
       def visit_features(features)
         features.accept(self)
       end
@@ -109,6 +106,7 @@ module Cucumber
       def visit_table_cell_value(value, status)
       end
 
+      # Print +announcement+. This method can be called from within StepDefinitions.
       def announce(announcement)
       end
 

data/lib/cucumber/broadcaster.rb

@@ -1,5 +1,5 @@
 module Cucumber
-  class Broadcaster
+  class Broadcaster #:nodoc:
     def initialize(receivers = [])
       @receivers = receivers
     end

data/lib/cucumber/cli/language_help_formatter.rb

@@ -23,7 +23,7 @@ http://wiki.github.com/aslakhellesoy/cucumber/spoken-languages
       end
 
       def self.list_keywords(io, lang)
-        language = Parser::NaturalLanguage[lang]
+        language = Parser::NaturalLanguage.get(nil, lang)
         raw = Parser::NaturalLanguage::KEYWORD_KEYS.map do |key|
           [key, language.keywords(key)]
         end

data/lib/cucumber/cli/main.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 require 'cucumber'
 require 'ostruct'
+require 'logger'
 require 'cucumber/parser'
 require 'cucumber/feature_file'
 require 'cucumber/formatter/color_io'
@@ -13,6 +14,12 @@ module Cucumber
     class Main
       FAILURE = 1
 
+      class LogFormatter < ::Logger::Formatter
+        def call(severity, time, progname, msg)
+          msg
+        end
+      end
+
       class << self
         def step_mother
           @step_mother ||= StepMother.new
@@ -27,8 +34,6 @@ module Cucumber
         @args         = args
         @out_stream   = out_stream == STDOUT ? Formatter::ColorIO.new : out_stream
         @error_stream = error_stream
-        $err = error_stream
-        @unsupported_programming_languages = []
       end
 
       def execute!(step_mother)
@@ -41,13 +46,19 @@ module Cucumber
           end
         end
         step_mother.options = configuration.options
+        
+        logger = Logger.new(@out_stream)
+        logger.formatter = LogFormatter.new
+        logger.level = Logger::INFO
+        logger.level = Logger::DEBUG if configuration.verbose?
+        step_mother.log = logger
 
         # Feature files must be loaded before files are required.
         # This is because i18n step methods are only aliased when
         # features are loaded. If we swap the order, the requires
         # will fail.
-        features = load_plain_text_features(step_mother)
-        load_step_defs(step_mother)
+        features = step_mother.load_plain_text_features(configuration.feature_files)
+        step_mother.load_code_files(configuration.step_defs_to_load)
         enable_diffing
 
         visitor = configuration.build_formatter_broadcaster(step_mother)
@@ -80,22 +91,6 @@ module Cucumber
         exceeded
       end
 
-      def load_plain_text_features(step_mother)
-        features = Ast::Features.new
-
-        verbose_log("Features:")
-        configuration.feature_files.each do |f|
-          feature_file = FeatureFile.new(f)
-          feature = feature_file.parse(step_mother, configuration.options)
-          if feature
-            features.add_feature(feature)
-            verbose_log("  * #{f}")
-          end
-        end
-        verbose_log("\n")
-        features
-      end
-
       def configuration
         return @configuration if @configuration
 
@@ -110,38 +105,6 @@ module Cucumber
 
       private
 
-      def load_step_defs(step_mother)
-        step_def_files = configuration.step_defs_to_load
-        verbose_log("Step Definitions:")
-        step_def_files.each do |step_def_file|
-          load_step_def(step_mother, step_def_file)
-        end
-        verbose_log("\n")
-      end
-
-      def load_step_def(step_mother, step_def_file)
-        if programming_language = programming_language_for(step_mother, step_def_file)
-          verbose_log("  * #{step_def_file}")
-          programming_language.load_step_def_file(step_def_file)
-        else
-          verbose_log("  * #{step_def_file} [NOT SUPPORTED]")
-        end
-      end
-
-      def programming_language_for(step_mother, step_def_file) # :nodoc:
-        if ext = File.extname(step_def_file)[1..-1]
-          return nil if @unsupported_programming_languages.index(ext)
-          begin
-            step_mother.load_programming_language(ext)
-          rescue LoadError
-            @unsupported_programming_languages << ext
-            nil
-          end
-        else
-          nil
-        end
-      end
-
       def enable_diffing
         if configuration.diff_enabled?
           begin

data/lib/cucumber/constantize.rb

@@ -1,5 +1,5 @@
 module Cucumber
-  module Constantize
+  module Constantize #:nodoc:
     def constantize(camel_cased_word)
       begin
         names = camel_cased_word.split('::')

data/lib/cucumber/core_ext/exception.rb

@@ -18,7 +18,7 @@
 #
 # All backtrace munging can be turned off with the <tt>--backtrace</tt> switch
 #
-class Exception
+class Exception #:nodoc:
   CUCUMBER_FILTER_PATTERNS = [
     /vendor\/rails|lib\/cucumber|bin\/cucumber:|lib\/rspec|gems\//
   ]

data/lib/cucumber/core_ext/instance_exec.rb

@@ -1,11 +1,13 @@
 require 'cucumber/platform'
 
 module Cucumber
+  # Raised if the number of a StepDefinition's Regexp match groups
+  # is different from the number of Proc arguments.
   class ArityMismatchError < StandardError
   end
 end
 
-class Object
+class Object #:nodoc:
   def cucumber_instance_exec(check_arity, pseudo_method, *args, &block)
     cucumber_run_with_backtrace_filtering(pseudo_method) do
       if check_arity && !cucumber_compatible_arity?(args, block)
@@ -23,7 +25,9 @@ class Object
       end
     end
   end
-  
+
+  private
+
   def cucumber_arity(block)
     a = block.arity
     Cucumber::RUBY_1_9 ? a : (a == -1 ? 0 : a)
@@ -48,7 +52,8 @@ class Object
   
   unless defined? instance_exec # 1.9
     # http://eigenclass.org/hiki/bounded+space+instance_exec
-    module InstanceExecHelper; end
+    module InstanceExecHelper #:nodoc:
+    end
     include InstanceExecHelper
     def instance_exec(*args, &block)
       begin

data/lib/cucumber/core_ext/proc.rb

@@ -1,5 +1,5 @@
 # Proc extension to get more location info out of a proc
-class Proc
+class Proc #:nodoc:
   PROC_PATTERN = /[\d\w]+@(.*):(.*)>/
   
   def to_comment_line

data/lib/cucumber/core_ext/string.rb

@@ -1,4 +1,4 @@
-class String
+class String #:nodoc:
   def indent(n)
     if n >= 0
       gsub(/^/, ' ' * n)

data/lib/cucumber/feature_file.rb

@@ -3,10 +3,11 @@ require 'cucumber/filter'
 
 module Cucumber
   class FeatureFile
-    FILE_COLON_LINE_PATTERN = /^([\w\W]*?):([\d:]+)$/
-    LANGUAGE_PATTERN = /language:\s*(.*)/
+    FILE_COLON_LINE_PATTERN = /^([\w\W]*?):([\d:]+)$/ #:nodoc:
+    LANGUAGE_PATTERN = /language:\s*(.*)/ #:nodoc:
 
-    # The +uri+ argument can ba a path or a path:line1:line2 etc.
+    # The +uri+ argument is the location of the source. It can ba a path 
+    # or a path:line1:line2 etc. If +source+ is passed, +uri+ is ignored.
     def initialize(uri, source=nil)
       @source = source
       _, @path, @lines = *FILE_COLON_LINE_PATTERN.match(uri)

data/lib/cucumber/filter.rb

@@ -1,5 +1,6 @@
 module Cucumber
-  class Filter
+  # Filters the AST based on --tags and --name
+  class Filter #:nodoc:
     def initialize(lines, options)
       @lines = lines
 

data/lib/cucumber/formatter/ansicolor.rb

@@ -23,8 +23,9 @@ Term::ANSIColor.coloring = false if !STDOUT.tty? and not ENV.has_key?("AUTOTEST"
 
 module Cucumber
   module Formatter
-    # Defines aliases for coloured output. You can tweak the colours by defining
-    # a <tt>CUCUMBER_COLORS</tt> variable in your shell, very much like you can
+    # Defines aliases for coloured output. You don't invoke any methods from this
+    # module directly, but you can change the output colours by defining
+    # a <tt>CUCUMBER_COLORS</tt> variable in your shell, very much like how you can
     # tweak the familiar POSIX command <tt>ls</tt> with
     # <a href="http://mipsisrisc.com/rambling/2008/06/27/lscolorsls_colors-now-with-linux-support/">$LSCOLORS/$LS_COLORS</a>
     #
@@ -97,7 +98,7 @@ module Cucumber
         end
       end
       
-      def self.define_grey
+      def self.define_grey #:nodoc:
         begin
           gem 'genki-ruby-terminfo'
           require 'terminfo'
@@ -125,8 +126,8 @@ module Cucumber
         end
       end
       
-      def self.define_real_grey
-        def grey(m)
+      def self.define_real_grey #:nodoc:
+        def grey(m) #:nodoc:
           if ::Term::ANSIColor.coloring?
             "\e[90m#{m}\e[0m"
           else

data/lib/cucumber/formatter/color_io.rb

@@ -3,10 +3,10 @@ require 'forwardable'
 module Cucumber
   module Formatter
     # Adapter to make #puts/#print/#flush work with colours on Windows
-    class ColorIO
+    class ColorIO #:nodoc:
       extend Forwardable
       def_delegators :@kernel, :puts, :print # win32console colours only work when sent to Kernel
-      def_delegators :@stdout, :flush, :tty?, :write
+      def_delegators :@stdout, :flush, :tty?, :write, :close
 
       def initialize
         @kernel = Kernel

data/lib/cucumber/formatter/console.rb

@@ -3,6 +3,8 @@ require 'cucumber/formatter/duration'
 
 module Cucumber
   module Formatter
+    # This module contains helper methods that are used by formatters
+    # that print output to the terminal.
     module Console
       extend ANSIColor
       include Duration

data/lib/cucumber/formatter/duration.rb

@@ -1,6 +1,9 @@
 module Cucumber
   module Formatter
     module Duration
+      # Helper method for formatters that need to
+      # format a duration in seconds to the UNIX
+      # <tt>time</tt> format.
       def format_duration(seconds)
         m, s = seconds.divmod(60)
         "#{m}m#{'%.3f' % s}s" 

data/lib/cucumber/formatter/html.rb

@@ -3,6 +3,7 @@ require 'cucumber/formatter/duration'
 
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format html</tt>
     class Html < Ast::Visitor
       include ERB::Util # for the #h method
       include Duration

data/lib/cucumber/formatter/junit.rb

@@ -2,6 +2,7 @@ require 'cucumber/formatter/ordered_xml_markup'
 
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format junit</tt>
     class Junit < Cucumber::Ast::Visitor
 
       def initialize(step_mother, io, options)

data/lib/cucumber/formatter/ordered_xml_markup.rb

@@ -8,7 +8,7 @@ end
 module Cucumber
   module Formatter
     # Emits attributes ordered alphabetically, so that we can predicatbly test output.
-    class OrderedXmlMarkup < Builder::XmlMarkup
+    class OrderedXmlMarkup < Builder::XmlMarkup #:nodoc:
       def _insert_attributes(attrs, order=[])
         return if attrs.nil?
         keys = attrs.keys.map{|k| k.to_s}

data/lib/cucumber/formatter/pretty.rb

@@ -3,6 +3,8 @@ require 'fileutils'
 
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format pretty</tt> (the default 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.
     #
@@ -96,15 +98,30 @@ module Cucumber
         visit_feature_element_name(keyword, name, file_colon_line, source_indent)
       end
 
+      def visit_examples_array(examples_array)
+        @indent = 4
+        @io.puts
+        examples_array[0..-2].each { |ea| super(ea) }
+        @last_example = true
+        super(examples_array.last)
+        @last_example = nil
+      end
+      
       def visit_examples_name(keyword, name)
         names = name.strip.empty? ? [name.strip] : name.split("\n")        
-        @io.puts("\n    #{keyword} #{names[0]}")
+        @io.puts("    #{keyword} #{names[0]}")
         names[1..-1].each {|s| @io.puts "      #{s}" } unless names.empty?
         @io.flush
         @indent = 6
         @scenario_indent = 6
       end
 
+      def visit_outline_table(outline_table)
+        super
+        @indent = 4
+        @io.puts unless @last_example
+      end
+      
       def visit_scenario_name(keyword, name, file_colon_line, source_indent)
         visit_feature_element_name(keyword, name, file_colon_line, source_indent)
       end
@@ -188,9 +205,6 @@ module Cucumber
       end
 
       private
-      def cell_prefix(status)
-        @prefixes[status]
-      end
 
       def cell_prefix(status)
         @prefixes[status]

data/lib/cucumber/formatter/profile.rb

@@ -2,6 +2,7 @@ require 'cucumber/formatter/progress'
 
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format profile</tt>
     class Profile < Progress
       NUMBER_OF_STEP_DEFINITONS_TO_SHOW = 10
       NUMBER_OF_STEP_INVOCATIONS_TO_SHOW = 5

data/lib/cucumber/formatter/progress.rb

@@ -2,6 +2,7 @@ require 'cucumber/formatter/console'
 
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format progress</tt>
     class Progress < Ast::Visitor
       include Console
 

data/lib/cucumber/formatter/rerun.rb

@@ -1,5 +1,7 @@
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format rerun</tt>
+    #
     # This formatter keeps track of all failing features and print out their location.
     # Example:
     #

data/lib/cucumber/formatter/steps.rb

@@ -1,5 +1,6 @@
 module Cucumber
   module Formatter
+    # The formatter used for <tt>--format steps</tt>
     class Steps < Ast::Visitor
 
       def initialize(step_mother, io, options)