dwaite-cucumber 0.3.101

data/lib/cucumber/ast/visitor.rb

@@ -0,0 +1,115 @@
+module Cucumber
+  module Ast
+    # 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 #:nodoc:
+      attr_reader :step_mother #:nodoc:
+
+      def initialize(step_mother)
+        @options = {}
+        @step_mother = step_mother
+      end
+
+      def visit_features(features)
+        features.accept(self)
+      end
+
+      def visit_feature(feature)
+        feature.accept(self)
+      end
+
+      def visit_comment(comment)
+        comment.accept(self)
+      end
+
+      def visit_comment_line(comment_line)
+      end
+
+      def visit_tags(tags)
+        tags.accept(self)
+      end
+
+      def visit_tag_name(tag_name)
+      end
+
+      def visit_feature_name(name)
+      end
+
+      # +feature_element+ is either Scenario or ScenarioOutline
+      def visit_feature_element(feature_element)
+        feature_element.accept(self)
+      end
+
+      def visit_background(background)
+        background.accept(self)
+      end
+
+      def visit_background_name(keyword, name, file_colon_line, source_indent)
+      end
+
+      def visit_examples_array(examples_array)
+        examples_array.accept(self)
+      end
+
+      def visit_examples(examples)
+        examples.accept(self)
+      end
+
+      def visit_examples_name(keyword, name)
+      end
+
+      def visit_outline_table(outline_table)
+        @table = outline_table
+        outline_table.accept(self)
+      end
+
+      def visit_scenario_name(keyword, name, file_colon_line, source_indent)
+      end
+
+      def visit_steps(steps)
+        steps.accept(self)
+      end
+
+      def visit_step(step)
+        step.accept(self)
+      end
+
+      def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+        visit_step_name(keyword, step_match, status, source_indent, background)
+        visit_multiline_arg(multiline_arg) if multiline_arg
+        visit_exception(exception, status) if exception
+      end
+
+      def visit_step_name(keyword, step_match, status, source_indent, background) #:nodoc:
+      end
+
+      def visit_multiline_arg(multiline_arg) #:nodoc:
+        multiline_arg.accept(self)
+      end
+
+      def visit_exception(exception, status) #:nodoc:
+      end
+
+      def visit_py_string(string)
+      end
+
+      def visit_table_row(table_row)
+        table_row.accept(self)
+      end
+
+      def visit_table_cell(table_cell)
+        table_cell.accept(self)
+      end
+
+      def visit_table_cell_value(value, status)
+      end
+
+      # Print +announcement+. This method can be called from within StepDefinitions.
+      def announce(announcement)
+      end
+
+    end
+  end
+end

data/lib/cucumber/ast.rb

@@ -0,0 +1,29 @@
+require 'cucumber/ast/comment'
+require 'cucumber/ast/tags'
+require 'cucumber/ast/features'
+require 'cucumber/ast/feature'
+require 'cucumber/ast/background'
+require 'cucumber/ast/scenario'
+require 'cucumber/ast/scenario_outline'
+require 'cucumber/ast/step_invocation'
+require 'cucumber/ast/step_collection'
+require 'cucumber/ast/step'
+require 'cucumber/ast/table'
+require 'cucumber/ast/py_string'
+require 'cucumber/ast/outline_table'
+require 'cucumber/ast/examples'
+require 'cucumber/ast/visitor'
+
+module Cucumber
+  # Classes in this module represent the Abstract Syntax Tree (AST)
+  # that gets built when feature files are parsed.
+  #
+  # AST classes don't expose any internal data directly. This is
+  # in order to encourage a less coupled design in the classes
+  # that operate on the AST. The only public method is #accept.
+  #
+  # The AST can be traversed with a visitor. See Cucumber::Format::Pretty
+  # for an example.
+  module Ast
+  end
+end

data/lib/cucumber/broadcaster.rb

@@ -0,0 +1,13 @@
+module Cucumber
+  class Broadcaster #:nodoc:
+    def initialize(receivers = [])
+      @receivers = receivers
+    end
+
+    def method_missing(method_name, *args)
+      @receivers.map do |receiver|
+        receiver.__send__(method_name, *args)
+      end
+    end
+  end
+end

data/lib/cucumber/cli/configuration.rb

@@ -0,0 +1,190 @@
+require 'logger'
+require 'cucumber/cli/options'
+require 'cucumber/constantize'
+
+module Cucumber
+  module Cli
+    class YmlLoadError < StandardError; end
+    class ProfilesNotDefinedError < YmlLoadError; end
+    class ProfileNotFound < StandardError; end
+
+    class Configuration
+      include Constantize
+      
+      attr_reader :options, :out_stream
+
+      def initialize(out_stream = STDOUT, error_stream = STDERR)
+        @out_stream   = out_stream
+        @error_stream = error_stream
+        @options = Options.new(@out_stream, @error_stream, :default_profile => 'default')
+      end
+
+      def parse!(args)
+        @args = args
+        @options.parse!(args)
+        arrange_formats
+        raise("You can't use both --strict and --wip") if strict? && wip?
+
+        return @args.replace(@options.expanded_args_without_drb) if drb?
+
+        set_environment_variables
+      end
+
+      def verbose?
+        @options[:verbose]
+      end
+
+      def strict?
+        @options[:strict]
+      end
+
+      def wip?
+        @options[:wip]
+      end
+
+      def guess?
+        @options[:guess]
+      end
+
+      def diff_enabled?
+        @options[:diff_enabled]
+      end
+
+      def drb?
+        @options[:drb]
+      end
+
+      def drb_port
+        @options[:drb_port].to_i if @options[:drb_port]
+      end
+
+      def build_formatter_broadcaster(step_mother)
+        return Formatter::Pretty.new(step_mother, nil, @options) if @options[:autoformat]
+        formatters = @options[:formats].map do |format_and_out|
+          format = format_and_out[0]
+          out    = format_and_out[1]
+          if String === out # file name
+            unless File.directory?(out)
+              out = File.open(out, Cucumber.file_mode('w'))
+              at_exit do
+                out.flush
+                out.close
+              end
+            end
+          end
+
+          begin
+            formatter_class = formatter_class(format)
+            formatter_class.new(step_mother, out, @options)
+          rescue Exception => e
+            e.message << "\nError creating formatter: #{format}"
+            raise e
+          end
+        end
+
+        broadcaster = Broadcaster.new(formatters)
+        broadcaster.options = @options
+        return broadcaster
+      end
+
+      def formatter_class(format)
+        if(builtin = Options::BUILTIN_FORMATS[format])
+          constantize(builtin[0])
+        else
+          constantize(format)
+        end
+      end
+
+      def all_files_to_load
+        requires = @options[:require].empty? ? require_dirs : @options[:require]
+        files = requires.map do |path|
+          path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
+          path = path.gsub(/\/$/, '') # Strip trailing slash.
+          File.directory?(path) ? Dir["#{path}/**/*"] : path
+        end.flatten.uniq
+        remove_excluded_files_from(files)
+        files.reject! {|f| !File.file?(f)}
+        files.reject! {|f| File.extname(f) == '.feature' }
+        files.reject! {|f| f =~ /^http/}
+        files      
+      end
+      
+      def step_defs_to_load
+        all_files_to_load.reject {|f| f =~ %r{/support/} }
+      end
+      
+      def support_to_load
+        support_files = all_files_to_load.select {|f| f =~ %r{/support/} }
+        env_files = support_files.select {|f| f =~ %r{/support/env\..*} }
+        other_files = support_files - env_files
+        @options[:dry_run] ? other_files : env_files + other_files
+      end
+
+      def feature_files
+        potential_feature_files = paths.map do |path|
+          path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
+          path = path.chomp('/')
+          if File.directory?(path)
+            Dir["#{path}/**/*.feature"]
+          elsif path[0..0] == '@' and # @listfile.txt
+              File.file?(path[1..-1]) # listfile.txt is a file
+            IO.read(path[1..-1]).split
+          else 
+            path
+          end
+        end.flatten.uniq
+        remove_excluded_files_from(potential_feature_files)
+        potential_feature_files
+      end
+      
+      def feature_dirs
+        paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
+      end
+
+      def log
+        logger = Logger.new(@out_stream)
+        logger.formatter = LogFormatter.new
+        logger.level = Logger::INFO
+        logger.level = Logger::DEBUG if self.verbose?
+        logger
+      end
+
+    private
+
+      class LogFormatter < ::Logger::Formatter
+        def call(severity, time, progname, msg)
+          msg
+        end
+      end
+
+      def paths
+        @options[:paths].empty? ? ['features'] : @options[:paths]
+      end
+
+      def set_environment_variables
+        @options[:env_vars].each do |var, value|
+          ENV[var] = value
+        end
+      end
+
+      def arrange_formats
+        @options[:formats] << ['pretty', @out_stream] if @options[:formats].empty?
+        @options[:formats] = @options[:formats].sort_by{|f| f[1] == @out_stream ? -1 : 1}
+        streams = @options[:formats].map { |(_, stream)| stream }
+        if streams != streams.uniq
+          raise "All but one formatter must use --out, only one can print to each stream (or STDOUT)"
+        end
+      end
+
+      def remove_excluded_files_from(files)
+        files.reject! {|path| @options[:excludes].detect {|pattern| path =~ pattern } }
+      end
+
+      def require_dirs
+        feature_dirs + Dir['vendor/{gems,plugins}/*/cucumber']
+      end
+      
+    end
+
+  end
+end

data/lib/cucumber/cli/drb_client.rb

@@ -0,0 +1,26 @@
+require "drb/drb"
+# This code was taken from the RSpec project and slightly modified.
+
+module Cucumber
+  module Cli
+    class DRbClientError < StandardError
+    end
+    # Runs features on a DRB server, originally created with Spork compatibility in mind.
+    class DRbClient
+      DEFAULT_PORT = 8990
+
+      def self.run(args, error_stream, out_stream, port = nil)
+        port ||= ENV["CUCUMBER_DRB"] || DEFAULT_PORT
+
+        # See http://redmine.ruby-lang.org/issues/show/496 as to why we specify localhost:0
+        DRb.start_service("druby://localhost:0")
+        feature_server = DRbObject.new_with_uri("druby://127.0.0.1:#{port}")
+        cloned_args = [] # I have no idea why this is needed, but if the regular args are sent then DRb magically transforms it into a DRb object - not an array
+        args.each { |arg| cloned_args << arg }
+        feature_server.run(cloned_args, error_stream, out_stream)
+      rescue DRb::DRbConnError => e
+        raise DRbClientError, "No DRb server is running."
+      end
+    end
+  end
+end

data/lib/cucumber/cli/language_help_formatter.rb

@@ -0,0 +1,61 @@
+require 'cucumber/formatter/pretty'
+require 'cucumber/parser/natural_language'
+
+module Cucumber
+  module Cli
+    class LanguageHelpFormatter < Formatter::Pretty
+      INCOMPLETE = %{
+The Cucumber grammar has evolved since this translation was written.
+Please help us complete the translation by translating the missing words in
+
+#{Cucumber::LANGUAGE_FILE}
+
+Then contribute back to the Cucumber project. Details here:
+http://wiki.github.com/aslakhellesoy/cucumber/spoken-languages
+}
+
+      def self.list_languages(io)
+        raw = Cucumber::LANGUAGES.keys.sort.map do |lang|
+          [lang, Cucumber::LANGUAGES[lang]['name'], Cucumber::LANGUAGES[lang]['native']]
+        end
+        table = Ast::Table.new(raw)
+        new(nil, io, {:check_lang=>true}).visit_multiline_arg(table)
+      end
+
+      def self.list_keywords(io, lang)
+        language = Parser::NaturalLanguage.get(nil, lang)
+        raw = Parser::NaturalLanguage::KEYWORD_KEYS.map do |key|
+          [key, language.keywords(key)]
+        end
+        table = Ast::Table.new(raw)
+        new(nil, io, {:incomplete => language.incomplete?}).visit_multiline_arg(table)
+      end
+
+      def visit_multiline_arg(table)
+        if @options[:incomplete]
+          @io.puts(format_string(INCOMPLETE, :failed))
+        end
+        super
+      end
+
+      def visit_table_row(table_row)
+        @col = 1
+        super
+      end
+
+      def visit_table_cell_value(value, status)
+        if @col == 1
+          if(@options[:check_lang])
+            @incomplete = Parser::NaturalLanguage.get(nil, value).incomplete?
+          end
+          status = :comment 
+        elsif @incomplete
+          status = :undefined
+        end
+        
+        @col += 1
+        super(value, status)
+      end
+    end
+  end
+end

data/lib/cucumber/cli/main.rb

@@ -0,0 +1,116 @@
+require 'optparse'
+require 'cucumber'
+require 'ostruct'
+require 'logger'
+require 'cucumber/parser'
+require 'cucumber/feature_file'
+require 'cucumber/formatter/color_io'
+require 'cucumber/cli/language_help_formatter'
+require 'cucumber/cli/configuration'
+require 'cucumber/cli/drb_client'
+
+module Cucumber
+  module Cli
+    class Main
+      FAILURE = 1
+
+      class << self
+        def step_mother
+          @step_mother ||= StepMother.new
+        end
+
+        def execute(args)
+          new(args).execute!(step_mother)
+        end
+      end
+
+      def initialize(args, out_stream = STDOUT, error_stream = STDERR)
+        @args         = args
+        @out_stream   = out_stream == STDOUT ? Formatter::ColorIO.new : out_stream
+        @error_stream = error_stream
+      end
+
+      def execute!(step_mother)
+        trap_interrupt
+        if configuration.drb?
+          begin
+            return DRbClient.run(@args, @error_stream, @out_stream, configuration.drb_port)
+          rescue DRbClientError => e
+            @error_stream.puts "WARNING: #{e.message} Running features locally:"
+          end
+        end
+        step_mother.options = configuration.options
+        step_mother.log = configuration.log
+
+        step_mother.load_code_files(configuration.support_to_load)
+        step_mother.after_configuration(configuration)
+        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)
+        step_mother.visitor = visitor # Needed to support World#announce
+        visitor.visit_features(features)
+
+        failure = if exceeded_tag_limts?(features)
+            FAILURE
+          elsif configuration.wip?
+            step_mother.scenarios(:passed).any?
+          else
+            step_mother.scenarios(:failed).any? ||
+            (configuration.strict? && (step_mother.steps(:undefined).any? || step_mother.steps(:pending).any?))
+          end
+      rescue ProfilesNotDefinedError, YmlLoadError, ProfileNotFound => e
+        @error_stream.puts e.message
+        true
+      end
+
+      def exceeded_tag_limts?(features)
+        exceeded = false
+        configuration.options[:include_tags].each do |tag, limit|
+          unless limit.nil?
+            tag_count = features.tag_count(tag)
+            if tag_count > limit.to_i
+              exceeded = true
+            end
+          end
+        end
+        exceeded
+      end
+
+      def configuration
+        return @configuration if @configuration
+
+        @configuration = Configuration.new(@out_stream, @error_stream)
+        @configuration.parse!(@args)
+        @configuration
+      end
+
+      private
+
+      def enable_diffing
+        if configuration.diff_enabled?
+          begin
+            require 'spec/expectations'
+            begin
+              require 'spec/runner/differs/default' # RSpec >=1.2.4
+            rescue ::LoadError
+              require 'spec/expectations/differs/default' # RSpec <=1.2.3
+            end
+            options = OpenStruct.new(:diff_format => :unified, :context_lines => 3)
+            ::Spec::Expectations.differ = ::Spec::Expectations::Differs::Default.new(options)
+          rescue ::LoadError => ignore
+          end
+        end
+      end
+
+      def trap_interrupt
+        trap('INT') do
+          exit!(1) if $cucumber_interrupted
+          $cucumber_interrupted = true
+          STDERR.puts "\nExiting... Interrupt again to exit immediately."
+        end
+      end
+    end
+  end
+end