# frozen_string_literal: true require 'cucumber/core_ext/instance_exec' require 'cucumber/rb_support/rb_dsl' require 'cucumber/rb_support/rb_world' require 'cucumber/rb_support/rb_step_definition' require 'cucumber/rb_support/rb_hook' require 'cucumber/rb_support/rb_transform' require 'cucumber/rb_support/snippet' require 'cucumber/gherkin/i18n' require 'multi_test' require 'cucumber/step_match' require 'cucumber/step_definition_light' require 'cucumber/events/step_definition_registered' module Cucumber module RbSupport # Raised if a World block returns Nil. class NilWorld < StandardError def initialize super("World procs should never return nil") end end # Raised if there are 2 or more World blocks. class MultipleWorld < StandardError def initialize(first_proc, second_proc) message = String.new message << "You can only pass a proc to #World once, but it's happening\n" message << "in 2 places:\n\n" message << RbSupport.backtrace_line(first_proc, 'World') << "\n" message << RbSupport.backtrace_line(second_proc, 'World') << "\n\n" message << "Use Ruby modules instead to extend your worlds. See the Cucumber::RbSupport::RbDsl#World RDoc\n" message << "or http://wiki.github.com/cucumber/cucumber/a-whole-new-world.\n\n" super(message) end end # The Ruby implementation of the programming language API. class RbLanguage attr_reader :current_world, :step_definitions all_keywords = ::Gherkin::DIALECTS.keys.map do |dialect_name| dialect = ::Gherkin::Dialect.for(dialect_name) dialect.given_keywords + dialect.when_keywords + dialect.then_keywords + dialect.and_keywords + dialect.but_keywords end Cucumber::Gherkin::I18n.code_keywords_for(all_keywords.flatten.uniq.sort).each do |adverb| RbDsl.alias_adverb(adverb.strip) end def initialize(runtime, configuration) @runtime, @configuration = runtime, configuration @step_definitions = [] RbDsl.rb_language = self @world_proc = @world_modules = nil @configuration.register_snippet_generator(Snippet::Generator.new) end def step_matches(name_to_match) @step_definitions.reduce([]) { |result, step_definition| if (arguments = step_definition.arguments_from(name_to_match)) result << StepMatch.new(step_definition, name_to_match, arguments) end result } end def begin_rb_scenario(scenario) create_world extend_world connect_world(scenario) end def register_rb_hook(phase, tag_expressions, proc) add_hook(phase, RbHook.new(self, tag_expressions, proc)) end def register_rb_transform(regexp, proc) add_transform(RbTransform.new(self, regexp, proc)) end def register_rb_step_definition(regexp, proc_or_sym, options) step_definition = RbStepDefinition.new(self, regexp, proc_or_sym, options) @step_definitions << step_definition @configuration.notify :step_definition_registered, step_definition step_definition end def build_rb_world_factory(world_modules, namespaced_world_modules, proc) if proc raise MultipleWorld.new(@world_proc, proc) if @world_proc @world_proc = proc end @world_modules ||= [] @world_modules += world_modules @namespaced_world_modules ||= Hash.new { |h, k| h[k] = [] } namespaced_world_modules.each do |namespace, world_module| unless @namespaced_world_modules[namespace].include?(world_module) @namespaced_world_modules[namespace] << world_module end end end def load_code_file(code_file) return unless File.extname(code_file) == ".rb" load File.expand_path(code_file) # This will cause self.add_step_definition, self.add_hook, and self.add_transform to be called from RbDsl end def begin_scenario(scenario) begin_rb_scenario(scenario) end def end_scenario @current_world = nil end def after_configuration(configuration) hooks[:after_configuration].each do |hook| hook.invoke('AfterConfiguration', configuration) end end def execute_transforms(args) args.map do |arg| matching_transform = transforms.detect {|transform| transform.match(arg) } matching_transform ? matching_transform.invoke(arg) : arg end end def add_hook(phase, hook) hooks[phase.to_sym] << hook hook end def clear_hooks @hooks = nil end def add_transform(transform) transforms.unshift transform transform end def hooks_for(phase, scenario) #:nodoc: hooks[phase.to_sym].select{|hook| scenario.accept_hook?(hook)} end def unmatched_step_definitions available_step_definition_hash.keys - invoked_step_definition_hash.keys end def available_step_definition(regexp_source, file_colon_line) available_step_definition_hash[StepDefinitionLight.new(regexp_source, file_colon_line)] = nil end def invoked_step_definition(regexp_source, file_colon_line) invoked_step_definition_hash[StepDefinitionLight.new(regexp_source, file_colon_line)] = nil end private def available_step_definition_hash @available_step_definition_hash ||= {} end def invoked_step_definition_hash @invoked_step_definition_hash ||= {} end def hooks @hooks ||= Hash.new{|h,k| h[k] = []} end def transforms @transforms ||= [] end def create_world if(@world_proc) @current_world = @world_proc.call check_nil(@current_world, @world_proc) else @current_world = Object.new end end def extend_world @current_world.extend(RbWorld) MultiTest.extend_with_best_assertion_library(@current_world) @current_world.add_modules!(@world_modules || [], @namespaced_world_modules || {}) end def connect_world(scenario) @current_world.__cucumber_runtime = @runtime @current_world.__natural_language = scenario.language end def check_nil(o, proc) if o.nil? begin raise NilWorld.new rescue NilWorld => e e.backtrace.clear e.backtrace.push(RbSupport.backtrace_line(proc, "World")) raise e end else o end end def self.cli_snippet_type_options Snippet::SNIPPET_TYPES.keys.sort_by(&:to_s).map do |type| Snippet::SNIPPET_TYPES[type].cli_option_string(type) end end end def self.backtrace_line(proc, name) location = Cucumber::Core::Ast::Location.from_source_location(*proc.source_location) "#{location.to_s}:in `#{name}'" end end end