Sha256: 13f9ec29c5d1e91a4955337919079bafaae6db0eb35ffb1637c440892943a056

Contents?: true

Size: 1.11 KB

Versions: 71

Compression:

Stored size: 1.11 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

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

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

Version data entries

71 entries across 56 versions & 8 rubygems

Version Path
abaci-0.3.0 vendor/bundle/gems/yard-0.9.1/lib/yard/handlers/ruby/legacy/mixin_handler.rb
abaci-0.3.0 vendor/bundle/gems/yard-0.9.2/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.5 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.4 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.3 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.2 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.1 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.0 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.8.7.6 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.8.7.5 lib/yard/handlers/ruby/legacy/mixin_handler.rb
climine-0.0.7 vendor/bundle/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
climine-0.0.7 vendor/bundle/ruby/2.1.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
climine-0.0.6 vendor/bundle/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
climine-0.0.5 vendor/bundle/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.8.7.4 lib/yard/handlers/ruby/legacy/mixin_handler.rb
climine-0.0.4 vendor/bundle/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
climine-0.0.3 vendor/bundle/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
mango-0.8.0 vendor/bundler/ruby/2.1.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
mango-0.7.1 vendor/bundler/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb
mango-0.7.0 vendor/bundler/ruby/2.0.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/mixin_handler.rb