Sha256: 410d3e0a18819f187080ec29e31c3c4e8674979adb3c36d85a6836ae78a6ce5b

Contents?: true

Size: 1.09 KB

Versions: 5

Compression:

Stored size: 1.09 KB

Contents

# (see Ruby::MixinHandler)
class YARD::Handlers::Ruby::Legacy::MixinHandler < YARD::Handlers::Ruby::Legacy::Base
  handles /\Ainclude(\s|\()/
  namespace_only

  process do
    errors = []
    statement.tokens[1..-1].to_s.split(/\s*,\s*/).reverse.each do |mixin|
      mixin = mixin.strip
      begin
        process_mixin(mixin)
      rescue YARD::Parser::UndocumentableError => err
        errors << err.message
      end
    end

    if errors.size > 0
      msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
      raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}"
    end
  end

  private

  def process_mixin(mixin)
    unless mixmatch = mixin[/\A(#{NAMESPACEMATCH})/, 1]
      raise YARD::Parser::UndocumentableError
    end

    obj = Proxy.new(namespace, mixmatch)

    case obj
    when Proxy
      obj.type = :module
    when ConstantObject # If a constant is included, use its value as the real object
      obj = Proxy.new(namespace, obj.value)
    end

    namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
  end
end

Version data entries

5 entries across 5 versions & 2 rubygems

Version Path
challah-0.6.2 vendor/bundle/gems/yard-0.8.1/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.6.1 vendor/bundle/gems/yard-0.8.1/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.6.0 vendor/bundle/gems/yard-0.8.1/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.8.1 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.8.0 lib/yard/handlers/ruby/legacy/mixin_handler.rb