Sha256: ed5230607ba2150440bd8e906fad8123bef75ad968760dc3dbe36b18ede92c7e

Contents?: true

Size: 1.14 KB

Versions: 63

Compression:

Stored size: 1.14 KB

Contents

# frozen_string_literal: true
# (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

    unless errors.empty?
      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)
    mixmatch = mixin[/\A(#{NAMESPACEMATCH})/, 1]
    raise YARD::Parser::UndocumentableError unless mixmatch

    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

63 entries across 62 versions & 9 rubygems

Version Path
kinetic_sdk-5.0.29 gems/yard-0.9.36/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.28 gems/yard-0.9.36/lib/yard/handlers/ruby/legacy/mixin_handler.rb
direct7-0.0.18 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
direct7-0.0.17 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
direct7-0.0.16 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.37 lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.27 gems/yard-0.9.36/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.26 gems/yard-0.9.36/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.25 gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.24 gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb
direct7-0.0.13 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.36 lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.35 lib/yard/handlers/ruby/legacy/mixin_handler.rb
direct7-0.0.12 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.23 gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb
getargv-0.3.3-universal-darwin vendor/bundle/ruby/3.3.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
direct7-0.0.11 vendor/bundle/ruby/2.7.0/gems/yard-0.9.34/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.22 gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb
kinetic_sdk-5.0.21 gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb
yard-0.9.34 lib/yard/handlers/ruby/legacy/mixin_handler.rb