Sha256: 3c81e22c99169c35b1e7acede440b2719b8c84fa6b9ae07cd17f1c8da1f881d3

Contents?: true

Size: 1.07 KB

Versions: 7

Compression:

Stored size: 1.07 KB

Contents

# (see Ruby::MixinHandler)
class YARD::Handlers::Ruby::Legacy::MixinHandler < YARD::Handlers::Ruby::Legacy::Base
  handles /\Ainclude(\s|\()/
  
  process do
    errors = []
    statement.tokens[1..-1].to_s.split(/\s*,\s*/).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

7 entries across 7 versions & 1 rubygems

Version Path
yard-0.6.8 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.6.7 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.6.6 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.6.5 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.6.4 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.6.3 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.6.2 lib/yard/handlers/ruby/legacy/mixin_handler.rb