kputnam/stupidedi

View on GitHub
build/doc/lib/rspec-plugin/lib/yard-rspec/legacy.rb

Summary

Maintainability
A
1 hr
Test Coverage
class LegacyRSpecDescribeHandler < YARD::Handlers::Ruby::Legacy::Base
  # @todo deal with rspec metadata hash params
  MATCH = /\Adescribe\s+(.+?)\s+(?:do|\{)/
  handles MATCH
  
  def process
    describes = statement.tokens.to_s[MATCH, 1].gsub(/["']/, '')

    # Remove the argument list from describe "#method(a, b, &c)"
    if arguments = describes[/[#.](?:.+?)(\([^)]*\))$/, 1]
      describes = describes[0, describes.length - arguments.length]
    end

    unless owner.is_a?(Hash)
      pwner = Hash[:describes => describes, :context => ""]
      parse_block(:owner => pwner)
    else
      describes = owner[:describes] + describes
      pwner = owner.merge(:describes => describes)
      parse_block(:owner => pwner)
    end
  rescue YARD::Handlers::NamespaceMissingError
  end
end

class LegacySpecContextHandler < YARD::Handlers::Ruby::Legacy::Base
  MATCH = /\Acontext\s+(['"])(.+?)\1(?:.*?)\s+(?:do|\{)/
  handles MATCH

  def process
    if owner.is_a?(Hash)
      context = statement.tokens.to_s[MATCH, 2]
      context = owner[:context] + context + " "

      parse_block(:owner => owner.merge(:context => context))
    end
  end
end

class LegacyRSpecItHandler < YARD::Handlers::Ruby::Legacy::Base
  MATCH = /\A(?:its?|specify)\s+(['"])(.+?)\1(?:.*?)\s+(?:do|\{)/

  handles MATCH
  handles /\A(?:its?|specify)\s+(?:do|\{)/
  
  def process
    return unless owner.is_a?(Hash)
    return unless owner[:describes]

    node = YARD::Registry.resolve(nil, owner[:describes], true)
    spec = statement.tokens.to_s[MATCH, 2] || "untitled spec"

    unless node
      log.debug "Unknown node #{owner[:describes]} for spec defined in #{parser.file} near line #{statement.line}"
      return
    end

    source = statement.block.to_s.strip

    (node[:specifications] ||= []) << \
      Hash[ :name => owner[:context] + spec,
            :file => parser.file,
            :line => statement.line,
            :source => source ]
  end
end

class LegacyRSpecPropertyHandler < YARD::Handlers::Ruby::Legacy::Base
  MATCH = /\A(?:property)\(?(['"])(.+?)\1(?:.*?)\s+(?:do|\{)/

  handles MATCH
  handles /\A(?:property)\s+(?:do|\{)/

  def process
    return unless owner.is_a?(Hash)
    return unless owner[:describes]

    node = YARD::Registry.resolve(nil, owner[:describes], true)
    spec = statement.tokens.to_s[MATCH, 2] || "untitled spec"

    unless node
      log.debug "Unknown node #{owner[:describes]} for spec defined in #{parser.file} near line #{statement.line}"
      return
    end

    source = statement.to_s.strip

    (node[:specifications] ||= []) << \
      Hash[ :name => owner[:context] + spec,
            :file => parser.file,
            :line => statement.line,
            :source => source ]
  end
end