require 'cucumber/step_definition' require 'cucumber/world' require 'cucumber/core_ext/instance_exec' module Cucumber class Undefined < StandardError attr_reader :step_name def initialize(step_name) super %{Undefined step: "#{step_name}"} @step_name = step_name end def nested! @nested = true end def nested? @nested end end # Raised when a StepDefinition's block invokes World#pending class Pending < StandardError end # Raised when a step matches 2 or more StepDefinition class Ambiguous < StandardError def initialize(step_name, step_definitions, used_guess) message = "Ambiguous match of \"#{step_name}\":\n\n" message << step_definitions.map{|sd| sd.backtrace_line}.join("\n") message << "\n\n" message << "You can run again with --guess to make Cucumber be more smart about it\n" unless used_guess super(message) end end # Raised when 2 or more StepDefinition have the same Regexp class Redundant < StandardError def initialize(step_def_1, step_def_2) message = "Multiple step definitions have the same Regexp:\n\n" message << step_def_1.backtrace_line << "\n" message << step_def_2.backtrace_line << "\n\n" super(message) end end class NilWorld < StandardError def initialize super("World procs should never return nil") end end # This is the main interface for registering step definitions, which is done # from *_steps.rb files. This module is included right at the top-level # so #register_step_definition (and more interestingly - its aliases) are # available from the top-level. module StepMother class << self def alias_adverb(adverb) adverb = adverb.gsub(/\s/, '') alias_method adverb, :register_step_definition end end attr_writer :snippet_generator, :options, :visitor def step_visited(step) steps << step unless steps.index(step) end def steps(status = nil) @steps ||= [] if(status) @steps.select{|step| step.status == status} else @steps end end def scenarios @scenarios ||= [] end # Registers a new StepDefinition. This method is aliased # to Given, When and Then. # # See Cucumber#alias_steps for details on how to # create your own aliases. # # The +&proc+ gets executed in the context of a world # object, which is defined by #World. A new world # object is created for each scenario and is shared across # step definitions within that scenario. def register_step_definition(regexp, &proc) step_definition = StepDefinition.new(regexp, &proc) step_definitions.each do |already| raise Redundant.new(already, step_definition) if already.match(regexp) end step_definitions << step_definition step_definition end # Registers a Before proc. You can call this method as many times as you # want (typically from ruby scripts under support). def Before(&proc) (@before_procs ||= []) << proc end def After(&proc) (@after_procs ||= []).unshift(proc) end # Registers a World proc. You can call this method as many times as you # want (typically from ruby scripts under support). def World(&proc) (@world_procs ||= []) << proc end def current_world @current_world end def step_match(step_name, formatted_step_name=nil) matches = step_definitions.map { |d| d.step_match(step_name, formatted_step_name) }.compact raise Undefined.new(step_name) if matches.empty? matches = best_matches(step_name, matches) if matches.size > 1 && options[:guess] raise Ambiguous.new(step_name, matches, options[:guess]) if matches.size > 1 matches[0] end def best_matches(step_name, step_matches) max_arg_length = step_matches.map {|step_match| step_match.args.length }.max top_groups = step_matches.select {|step_match| step_match.args.length == max_arg_length } if top_groups.length > 1 shortest_capture_length = top_groups.map {|step_match| step_match.args.inject(0) {|sum, c| sum + c.length } }.min top_groups.select {|step_match| step_match.args.inject(0) {|sum, c| sum + c.length } == shortest_capture_length } else top_groups end end def step_definitions @step_definitions ||= [] end def snippet_text(step_keyword, step_name, multiline_arg_class) @snippet_generator.snippet_text(step_keyword, step_name, multiline_arg_class) end def before_and_after(scenario, skip=false) unless current_world || skip new_world! execute_before(scenario) end if block_given? yield execute_after(scenario) unless skip nil_world! scenario_visited(scenario) end end private def max_step_definition_length @max_step_definition_length ||= step_definitions.map{|step_definition| step_definition.text_length}.max end def options @options || {} end # Creates a new world instance def new_world! @current_world = Object.new (@world_procs ||= []).each do |proc| @current_world = proc.call(@current_world) if @current_world.nil? begin raise NilWorld.new rescue NilWorld => e e.backtrace.clear e.backtrace.push(proc.backtrace_line("World")) raise e end end end @current_world.extend(World) @current_world.__cucumber_step_mother = self @current_world.__cucumber_visitor = @visitor @current_world.extend(::Spec::Matchers) if defined?(::Spec::Matchers) @current_world end def nil_world! @current_world = nil end def execute_before(scenario) (@before_procs ||= []).each do |proc| @current_world.cucumber_instance_exec(false, 'Before', scenario, &proc) end end def execute_after(scenario) (@after_procs ||= []).each do |proc| @current_world.cucumber_instance_exec(false, 'After', scenario, &proc) end end def scenario_visited(scenario) scenarios << scenario unless scenarios.index(scenario) end def options @options || {} end end end