kosmas58-cucumber 0.3.96 → 0.3.97

data/lib/cucumber/ast/table.rb

@@ -1,11 +1,23 @@
 module Cucumber
   module Ast
-    # Holds the data of a table parsed from a feature file:
+    # Step Definitions that match a plain text Step with a multiline argument table
+    # will receive it as an instance of Table. A Table object holds the data of a 
+    # table parsed from a feature file and lets you access and manipulate the data
+    # in different ways.
     #
-    #   | a | b |
-    #   | c | d |
+    # For example:
     #
-    # This gets parsed into a Table holding the values <tt>[['a', 'b'], ['c', 'd']]</tt>
+    #   Given I have:
+    #     | a | b |
+    #     | c | d |
+    #
+    # And a matching StepDefinition:
+    #
+    #   Given /I have:/ do |table|
+    #     data = table.raw
+    #   end
+    #
+    # This will store <tt>[['a', 'b'], ['c', 'd']]</tt> in the <tt>data</tt> variable.
     #
     class Table
       include Enumerable
@@ -14,10 +26,14 @@ module Cucumber
 
       attr_accessor :file
 
-      def self.default_arg_name
+      def self.default_arg_name #:nodoc:
         "table"
       end
 
+      # Creates a new instance. +raw+ should be an Array of Array of String.
+      # You don't typically create your own Table objects - Cucumber will do
+      # it internally and pass them to your Step Definitions.
+      #
       def initialize(raw, conversion_procs = NULL_CONVERSIONS.dup)
         @cells_class = Cells
         @cell_class = Cell
@@ -28,21 +44,23 @@ module Cucumber
         @conversion_procs = conversion_procs
       end
 
-      # Creates a copy of this table, inheriting the column mappings.
+      # Creates a copy of this table, inheriting any column mappings.
+      # registered with #map_headers!
+      #
       def dup
         self.class.new(raw.dup, @conversion_procs.dup)
       end
 
       # Returns a new, transposed table. Example:
       #
-      # | a | 7 | 4 |
-      # | b | 9 | 2 |
+      #   | a | 7 | 4 |
+      #   | b | 9 | 2 |
       #
       # Gets converted into the following:
       #
-      # | a | b |
-      # | 7 | 9 |
-      # | 4 | 2 |
+      #   | a | b |
+      #   | 7 | 9 |
+      #   | 4 | 2 |
       #
       def transpose
         self.class.new(raw.transpose, @conversion_procs.dup)
@@ -109,11 +127,11 @@ module Cucumber
         raw[1..-1]
       end
 
-      def each_cells_row(&proc)
+      def each_cells_row(&proc) #:nodoc:
         cells_rows.each(&proc)
       end
 
-      def accept(visitor)
+      def accept(visitor) #:nodoc:
         return if $cucumber_interrupted
         cells_rows.each do |row|
           visitor.visit_table_row(row)
@@ -149,8 +167,10 @@ module Cucumber
       def map_headers!(mappings)
         header_cells = cell_matrix[0]
         mappings.each_pair do |pre, post|
-          header_cell = header_cells.detect{|cell| pre === cell.value}
-          header_cell.value = post
+          mapped_cells = header_cells.select{|cell| pre === cell.value}
+          raise "No headers matched #{pre.inspect}" if mapped_cells.empty?
+          raise "#{mapped_cells.length} headers matched #{pre.inspect}: #{mapped_cells.map{|c| c.value}.inspect}" if mapped_cells.length > 1
+          mapped_cells[0].value = post
           if @conversion_procs.has_key?(pre)
             @conversion_procs[post] = @conversion_procs.delete(pre)
           end
@@ -204,10 +224,10 @@ module Cucumber
       # Whether to raise or not raise can be changed by setting values in
       # +options+ to true or false:
       #
-      #   * <tt>missing_row</tt>: Raise on missing rows (defaults to true)
-      #   * <tt>surplus_row</tt>: Raise on surplus rows (defaults to true)
-      #   * <tt>missing_col</tt>: Raise on missing columns (defaults to true)
-      #   * <tt>surplus_col</tt>: Raise on surplus columns (defaults to false)
+      # * <tt>missing_row</tt> : Raise on missing rows (defaults to true)
+      # * <tt>surplus_row</tt> : Raise on surplus rows (defaults to true)
+      # * <tt>missing_col</tt> : Raise on missing columns (defaults to true)
+      # * <tt>surplus_col</tt> : Raise on surplus columns (defaults to false)
       #
       # The +other_table+ argument can be another Table, an Array of Array or
       # an Array of Hash (similar to the structure returned by #hashes).
@@ -296,11 +316,11 @@ module Cucumber
         cells_rows.index(cells)
       end
 
-      def verify_column(column_name)
+      def verify_column(column_name) #:nodoc:
         raise %{The column named "#{column_name}" does not exist} unless raw[0].include?(column_name)
       end
       
-      def verify_table_width(width)
+      def verify_table_width(width) #:nodoc:
         raise %{The table must have exactly #{width} columns} unless raw[0].size == width
       end
 
@@ -319,33 +339,33 @@ module Cucumber
         Table.new(raw_with_replaced_args)
       end
 
-      def has_text?(text)
+      def has_text?(text) #:nodoc:
         raw.flatten.compact.detect{|cell_value| cell_value.index(text)}
       end
 
-      def cells_rows
+      def cells_rows #:nodoc:
         @rows ||= cell_matrix.map do |cell_row|
           @cells_class.new(self, cell_row)
         end
       end
 
-      def headers
+      def headers #:nodoc:
         raw.first
       end
 
-      def header_cell(col)
+      def header_cell(col) #:nodoc:
         cells_rows[0][col]
       end
 
-      def cell_matrix
+      def cell_matrix #:nodoc:
         @cell_matrix
       end
 
-      def col_width(col)
+      def col_width(col) #:nodoc:
         columns[col].__send__(:width)
       end
 
-      def to_s(options = {})
+      def to_s(options = {}) #:nodoc:
         options = {:color => true, :indent => 2, :prefixes => TO_S_PREFIXES}.merge(options)
         io = StringIO.new
 
@@ -369,7 +389,7 @@ module Cucumber
 
       protected
 
-      def inspect_rows(missing_row, inserted_row)
+      def inspect_rows(missing_row, inserted_row) #:nodoc:
         missing_row.each_with_index do |missing_cell, col|
           inserted_cell = inserted_row[col]
           if(missing_cell.value != inserted_cell.value && (missing_cell.value.to_s == inserted_cell.value.to_s))
@@ -379,7 +399,7 @@ module Cucumber
         end
       end
 
-      def create_cell_matrix(raw)
+      def create_cell_matrix(raw) #:nodoc:
         @cell_matrix = raw.map do |raw_row|
           line = raw_row.line rescue -1
           raw_row.map do |raw_cell|
@@ -388,7 +408,7 @@ module Cucumber
         end
       end
 
-      def convert_columns!
+      def convert_columns! #:nodoc:
         cell_matrix.transpose.each do |col|
           conversion_proc = @conversion_procs[col[0].value]
           col[1..-1].each do |cell|
@@ -397,7 +417,7 @@ module Cucumber
         end
       end
 
-      def require_diff_lcs
+      def require_diff_lcs #:nodoc:
         begin
           require 'diff/lcs'
         rescue LoadError => e
@@ -406,23 +426,23 @@ module Cucumber
         end
       end
 
-      def clear_cache!
+      def clear_cache! #:nodoc:
         @hashes = @rows_hash = @rows = @columns = nil
       end
 
-      def columns
+      def columns #:nodoc:
         @columns ||= cell_matrix.transpose.map do |cell_row|
           @cells_class.new(self, cell_row)
         end.freeze
       end
 
-      def new_cell(raw_cell, line)
+      def new_cell(raw_cell, line) #:nodoc:
         @cell_class.new(raw_cell, self, line)
       end
 
       # Pads our own cell_matrix and returns a cell matrix of same
       # column width that can be used for diffing
-      def pad!(other_cell_matrix)
+      def pad!(other_cell_matrix) #:nodoc:
         clear_cache!
         cols = cell_matrix.transpose
         unmapped_cols = other_cell_matrix.transpose
@@ -460,38 +480,38 @@ module Cucumber
         (mapped_cols + unmapped_cols).transpose
       end
 
-      def ensure_table(table_or_array)
+      def ensure_table(table_or_array) #:nodoc:
         return table_or_array if Table === table_or_array
         table_or_array = hashes_to_array(table_or_array) if Hash === table_or_array[0]
         table_or_array = enumerable_to_array(table_or_array) unless Array == table_or_array[0]
         Table.new(table_or_array)
       end
 
-      def hashes_to_array(hashes)
+      def hashes_to_array(hashes) #:nodoc:
         header = hashes[0].keys
         [header] + hashes.map{|hash| header.map{|key| hash[key]}}
       end
 
-      def enumerable_to_array(rows)
+      def enumerable_to_array(rows) #:nodoc:
         rows.map{|row| row.map{|cell| cell}}
       end
 
-      def ensure_green!
+      def ensure_green! #:nodoc:
         each_cell{|cell| cell.status = :passed}
       end
 
-      def each_cell(&proc)
+      def each_cell(&proc) #:nodoc:
         cell_matrix.each{|row| row.each(&proc)}
       end
 
-      def mark_as_missing(col)
+      def mark_as_missing(col) #:nodoc:
         col.each do |cell|
           cell.status = :undefined
         end
       end
 
       # Represents a row of cells or columns of cells
-      class Cells
+      class Cells #:nodoc:
         include Enumerable
         attr_reader :exception
 
@@ -547,7 +567,7 @@ module Cucumber
         end
       end
 
-      class Cell
+      class Cell #:nodoc:
         attr_reader :line, :table
         attr_accessor :status, :value
 
@@ -574,7 +594,7 @@ module Cucumber
         end
       end
       
-      class SurplusCell < Cell
+      class SurplusCell < Cell #:nodoc:
         def status
           :comment
         end

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}