Sha256: 973f4692cbbacf8d712da315602fff152bf620cf6e9267c1e54e71139c9675da

Contents?: true

Size: 1.08 KB

Versions: 30

Compression:

Stored size: 1.08 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*/).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

30 entries across 30 versions & 4 rubygems

Version Path
challah-0.6.2 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.6.1 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.6.0 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.5.4 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.5.3 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.5.2 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.5.1 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.5.0 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.4.1 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.4.0 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.3.5 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.3.4 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.3.3 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.3.2 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.3.1 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.3.0 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.2.1 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
challah-0.2.0 vendor/bundle/gems/yard-0.7.5/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.7.5 lib/yard/handlers/ruby/legacy/mixin_handler.rb
nutshell-crm-0.0.6.alpha vendor/bundle/gems/yard-0.7.4/lib/yard/handlers/ruby/legacy/mixin_handler.rb