Class: Cucumber::Glue::RegistryAndMore

Inherits:
Object
  • Object
show all
Defined in:
lib/cucumber/glue/registry_and_more.rb

Overview

TODO: This class has too many responsibilities, split off

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(runtime, configuration) ⇒ RegistryAndMore

Returns a new instance of RegistryAndMore.


56
57
58
59
60
61
62
63
64
65
# File 'lib/cucumber/glue/registry_and_more.rb', line 56

def initialize(runtime, configuration)
  @runtime = runtime
  @configuration = configuration
  @step_definitions = []
  Glue::Dsl.rb_language = self
  @world_proc = @world_modules = nil
  @parameter_type_registry = CucumberExpressions::ParameterTypeRegistry.new
  cucumber_expression_generator = CucumberExpressions::CucumberExpressionGenerator.new(@parameter_type_registry)
  @configuration.register_snippet_generator(Snippet::Generator.new(cucumber_expression_generator))
end

Instance Attribute Details

#current_worldObject (readonly)

Returns the value of attribute current_world.


45
46
47
# File 'lib/cucumber/glue/registry_and_more.rb', line 45

def current_world
  @current_world
end

#step_definitionsObject (readonly)

Returns the value of attribute step_definitions.


45
46
47
# File 'lib/cucumber/glue/registry_and_more.rb', line 45

def step_definitions
  @step_definitions
end

Class Method Details

.cli_snippet_type_optionsObject


189
190
191
192
193
194
195
# File 'lib/cucumber/glue/registry_and_more.rb', line 189

def self.cli_snippet_type_options
  registry = CucumberExpressions::ParameterTypeRegistry.new
  cucumber_expression_generator = CucumberExpressions::CucumberExpressionGenerator.new(registry)
  Snippet::SNIPPET_TYPES.keys.sort_by(&:to_s).map do |type|
    Snippet::SNIPPET_TYPES[type].cli_option_string(type, cucumber_expression_generator)
  end
end

Instance Method Details

#add_hook(phase, hook) ⇒ Object


157
158
159
160
# File 'lib/cucumber/glue/registry_and_more.rb', line 157

def add_hook(phase, hook)
  hooks[phase.to_sym] << hook
  hook
end

#after_allObject


151
152
153
154
155
# File 'lib/cucumber/glue/registry_and_more.rb', line 151

def after_all
  hooks[:after_all].each do |hook|
    hook.invoke('AfterAll', [])
  end
end

#available_step_definition(regexp_source, file_colon_line) ⇒ Object


174
175
176
# File 'lib/cucumber/glue/registry_and_more.rb', line 174

def available_step_definition(regexp_source, file_colon_line)
  available_step_definition_hash[StepDefinitionLight.new(regexp_source, file_colon_line)] = nil
end

#before_allObject


145
146
147
148
149
# File 'lib/cucumber/glue/registry_and_more.rb', line 145

def before_all
  hooks[:before_all].each do |hook|
    hook.invoke('BeforeAll', [])
  end
end

#begin_scenario(test_case) ⇒ Object


127
128
129
130
131
132
133
# File 'lib/cucumber/glue/registry_and_more.rb', line 127

def begin_scenario(test_case)
  @current_world = WorldFactory.new(@world_proc).create_world
  @current_world.extend(ProtoWorld.for(@runtime, test_case.language))
  MultiTest.extend_with_best_assertion_library(@current_world)
  @current_world.add_modules!(@world_modules || [],
                              @namespaced_world_modules || {})
end

#build_rb_world_factory(world_modules, namespaced_world_modules, proc) ⇒ Object


100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/cucumber/glue/registry_and_more.rb', line 100

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|
    @namespaced_world_modules[namespace] << world_module unless @namespaced_world_modules[namespace].include?(world_module)
  end
end

#clear_hooksObject


162
163
164
# File 'lib/cucumber/glue/registry_and_more.rb', line 162

def clear_hooks
  @hooks = nil
end

#create_expression(string_or_regexp) ⇒ Object

Raises:

  • (ArgumentError)

182
183
184
185
186
187
# File 'lib/cucumber/glue/registry_and_more.rb', line 182

def create_expression(string_or_regexp)
  return CucumberExpressions::CucumberExpression.new(string_or_regexp, @parameter_type_registry) if string_or_regexp.is_a?(String)
  return CucumberExpressions::RegularExpression.new(string_or_regexp, @parameter_type_registry) if string_or_regexp.is_a?(Regexp)

  raise ArgumentError, 'Expression must be a String or Regexp'
end

#define_parameter_type(parameter_type) ⇒ Object


81
82
83
84
85
# File 'lib/cucumber/glue/registry_and_more.rb', line 81

def define_parameter_type(parameter_type)
  @configuration.notify :envelope, parameter_type_envelope(parameter_type)

  @parameter_type_registry.define_parameter_type(parameter_type)
end

#end_scenarioObject


135
136
137
# File 'lib/cucumber/glue/registry_and_more.rb', line 135

def end_scenario
  @current_world = nil
end

#hooks_for(phase, scenario) ⇒ Object

:nodoc:


166
167
168
# File 'lib/cucumber/glue/registry_and_more.rb', line 166

def hooks_for(phase, scenario) # :nodoc:
  hooks[phase.to_sym].select { |hook| scenario.accept_hook?(hook) }
end

#install_plugin(configuration, registry) ⇒ Object


139
140
141
142
143
# File 'lib/cucumber/glue/registry_and_more.rb', line 139

def install_plugin(configuration, registry)
  hooks[:install_plugin].each do |hook|
    hook.invoke('InstallPlugin', [configuration, registry])
  end
end

#invoked_step_definition(regexp_source, file_colon_line) ⇒ Object


178
179
180
# File 'lib/cucumber/glue/registry_and_more.rb', line 178

def invoked_step_definition(regexp_source, file_colon_line)
  invoked_step_definition_hash[StepDefinitionLight.new(regexp_source, file_colon_line)] = nil
end

#load_code_file(code_file) ⇒ Object


115
116
117
118
119
120
121
122
123
124
125
# File 'lib/cucumber/glue/registry_and_more.rb', line 115

def load_code_file(code_file)
  return unless File.extname(code_file) == '.rb'

  # This will cause self.add_step_definition, self.add_hook, and self.define_parameter_type to be called from Glue::Dsl

  if Cucumber.use_legacy_autoloader
    load File.expand_path(code_file)
  else
    require File.expand_path(code_file)
  end
end

#register_rb_hook(phase, tag_expressions, proc) ⇒ Object


75
76
77
78
79
# File 'lib/cucumber/glue/registry_and_more.rb', line 75

def register_rb_hook(phase, tag_expressions, proc)
  hook = add_hook(phase, Hook.new(@configuration.id_generator.new_id, self, tag_expressions, proc))
  @configuration.notify :envelope, hook.to_envelope
  hook
end

#register_rb_step_definition(string_or_regexp, proc_or_sym, options) ⇒ Object


87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/cucumber/glue/registry_and_more.rb', line 87

def register_rb_step_definition(string_or_regexp, proc_or_sym, options)
  step_definition = StepDefinition.new(@configuration.id_generator.new_id, self, string_or_regexp, proc_or_sym, options)
  @step_definitions << step_definition
  @configuration.notify :step_definition_registered, step_definition
  @configuration.notify :envelope, step_definition.to_envelope
  step_definition
rescue Cucumber::CucumberExpressions::UndefinedParameterTypeError => e
  # TODO: add a way to extract the parameter type directly from the error.
  type_name = e.message.match(/^Undefined parameter type ['|{](.*)['|}].?$/)[1]

  @configuration.notify :undefined_parameter_type, type_name, string_or_regexp
end

#step_matches(name_to_match) ⇒ Object


67
68
69
70
71
72
73
# File 'lib/cucumber/glue/registry_and_more.rb', line 67

def step_matches(name_to_match)
  @step_definitions.each_with_object([]) do |step_definition, result|
    if (arguments = step_definition.arguments_from(name_to_match))
      result << StepMatch.new(step_definition, name_to_match, arguments)
    end
  end
end

#unmatched_step_definitionsObject


170
171
172
# File 'lib/cucumber/glue/registry_and_more.rb', line 170

def unmatched_step_definitions
  available_step_definition_hash.keys - invoked_step_definition_hash.keys
end