class Cucumber::Glue::StepDefinition

A Step Definition holds a Regexp pattern and a Proc, and is typically created by calling {Dsl#register_rb_step_definition Given, When or Then} in the step_definitions Ruby files.

Example:

Given /I have (\d+) cucumbers in my belly/ do
  # some code here
end

Attributes

expression[R]
registry[R]

Public Class Methods

new(registry, string_or_regexp, proc_or_sym, options) click to toggle source
Calls superclass method
# File lib/cucumber/glue/step_definition.rb, line 27
def new(registry, string_or_regexp, proc_or_sym, options)
  raise MissingProc if proc_or_sym.nil?
  super registry, registry.create_expression(string_or_regexp), create_proc(proc_or_sym, options)
end
new(registry, expression, proc) click to toggle source
# File lib/cucumber/glue/step_definition.rb, line 67
def initialize(registry, expression, proc)
  raise 'No regexp' if expression.is_a?(Regexp)
  @registry, @expression, @proc = registry, expression, proc
  # @registry.available_step_definition(regexp_source, location)
end

Private Class Methods

create_proc(proc_or_sym, options) click to toggle source
# File lib/cucumber/glue/step_definition.rb, line 34
def create_proc(proc_or_sym, options)
  return proc_or_sym if proc_or_sym.is_a?(Proc)
  raise ArgumentError unless proc_or_sym.is_a?(Symbol)
  message = proc_or_sym
  target_proc = parse_target_proc_from(options)
  patch_location_onto lambda { |*args|
    target = instance_exec(&target_proc)
    target.send(message, *args)
  }
end
parse_target_proc_from(options) click to toggle source
# File lib/cucumber/glue/step_definition.rb, line 51
def parse_target_proc_from(options)
  return lambda { self } unless options.key?(:on)
  target = options[:on]
  case target
  when Proc
    target
  when Symbol
    lambda { self.send(target) }
  else
    lambda { raise ArgumentError, 'Target must be a symbol or a proc' }
  end
end
patch_location_onto(block) click to toggle source
# File lib/cucumber/glue/step_definition.rb, line 45
def patch_location_onto(block)
  location = Core::Ast::Location.of_caller(5)
  block.define_singleton_method(:source_location) { [location.file, location.line] }
  block
end

Public Instance Methods

==(step_definition) click to toggle source

@api private

# File lib/cucumber/glue/step_definition.rb, line 94
def ==(step_definition)
  expression.source == step_definition.expression.source
end
arguments_from(step_name) click to toggle source

@api private

# File lib/cucumber/glue/step_definition.rb, line 99
def arguments_from(step_name)
  args = @expression.match(step_name)
  # @registry.invoked_step_definition(regexp_source, location) if args
  args
end
backtrace_line() click to toggle source

@api private

# File lib/cucumber/glue/step_definition.rb, line 117
def backtrace_line
  "#{location}:in `#{@expression}'"
end
file() click to toggle source

@api private

# File lib/cucumber/glue/step_definition.rb, line 137
def file
  @file ||= location.file
end
file_colon_line() click to toggle source

@api private

# File lib/cucumber/glue/step_definition.rb, line 122
def file_colon_line
  case @proc
  when Proc
    location.to_s
  when Symbol
    ":#{@proc}"
  end
end
invoke(args) click to toggle source

@api private TODO: inline this and step definition just be a value object

# File lib/cucumber/glue/step_definition.rb, line 107
def invoke(args)
  begin
    InvokeInWorld.cucumber_instance_exec_in(@registry.current_world, true, @expression.to_s, *args, &@proc)
  rescue ArityMismatchError => e
    e.backtrace.unshift(self.backtrace_line)
    raise e
  end
end
location() click to toggle source

The source location where the step definition can be found

# File lib/cucumber/glue/step_definition.rb, line 132
def location
  @location ||= Cucumber::Core::Ast::Location.from_source_location(*@proc.source_location)
end
to_hash() click to toggle source

@api private

# File lib/cucumber/glue/step_definition.rb, line 74
def to_hash
  type = expression.is_a?(CucumberExpressions::RegularExpression) ? 'regular expression' : 'cucumber expression'
  regexp = expression.regexp
  flags = ''
  flags += 'm' if (regexp.options & Regexp::MULTILINE) != 0
  flags += 'i' if (regexp.options & Regexp::IGNORECASE) != 0
  flags += 'x' if (regexp.options & Regexp::EXTENDED) != 0
  {
    source: {
      type: type,
      expression: expression.source
    },
    regexp: {
      source: regexp.source,
      flags: flags
    }
  }
end