Contents

# Finds and processes all the step matchers defined in the source code.
#
# To override the language you can define the step keywords in the YARD
# configuration file `~./yard/config`.
class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
  def self.default_step_definitions
    [ "Given", "When", "Then", "And", "But", "*" ]
  end

  def self.custom_step_definitions
    YARD::Config.options["yard-lucid"]["language"]["step_definitions"]
  end

  def self.custom_step_definitions_defined?
    YARD::Config.options["yard-lucid"] and
    YARD::Config.options["yard-lucid"]["language"] and
    YARD::Config.options["yard-lucid"]["language"]["step_definitions"]
  end

  def self.step_definitions
    if custom_step_definitions_defined?
      custom_step_definitions
    else
      default_step_definitions
    end
  end

  step_definitions.each { |step_def| handles method_call(step_def) }

  process do
    instance = YARD::CodeObjects::StepDefinitionObject.new(step_transform_namespace, step_definition_name) do |o|
      o.source = statement.source
      o.comments = statement.comments
      o.keyword = statement.method_name.source
      o.value = statement.parameters.source
      o.pending = pending_keyword_used?(statement.block)
    end

    obj = register instance
    parse_block(statement[2],:owner => obj)
  end

  def pending_keyword
    "pending"
  end

  def pending_command_statement?(line)
    (line.type == :command || line.type == :vcall) && line.first.source == pending_keyword
  end

  def pending_keyword_used?(block)
    code_in_block = block.last
    code_in_block.find { |line| pending_command_statement?(line) }
  end

  def step_transform_namespace
    YARD::CodeObjects::Lucid::LUCID_STEPTRANSFORM_NAMESPACE
  end

  def step_definition_name
    "step_definition#{self.class.generate_unique_id}"
  end

  def self.generate_unique_id
    @step_definition_count = @step_definition_count.to_i + 1
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
yard-lucid-0.5.0	lib/yard/handlers/step_definition_handler.rb
yard-lucid-0.4.0	lib/yard/handlers/step_definition_handler.rb
yard-lucid-0.3.0	lib/yard/handlers/step_definition_handler.rb
yard-lucid-0.2.0	lib/yard/handlers/step_definition_handler.rb
yard-lucid-0.1.0	lib/yard/handlers/step_definition_handler.rb