yard 0.9.18 → 0.9.23

data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb

@@ -1,22 +1,22 @@
-# frozen_string_literal: true
-# (see Ruby::PrivateConstantHandler)
-class YARD::Handlers::Ruby::Legacy::PrivateConstantHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles(/\Aprivate_constant(\s|\(|$)/)
-  namespace_only
-
-  process do
-    tokval_list(statement.tokens[2..-1], :attr, TkCONSTANT).each do |name|
-      privatize_constant name
-    end
-  end
-
-  private
-
-  def privatize_constant(name)
-    const = Proxy.new(namespace, name)
-    ensure_loaded!(const)
-    const.visibility = :private
-  rescue NamespaceMissingError
-    raise UndocumentableError, "private visibility set on unrecognized constant: #{name}"
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::PrivateConstantHandler)
+class YARD::Handlers::Ruby::Legacy::PrivateConstantHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\Aprivate_constant(\s|\(|$)/)
+  namespace_only
+
+  process do
+    tokval_list(statement.tokens[2..-1], :attr, TkCONSTANT).each do |name|
+      privatize_constant name
+    end
+  end
+
+  private
+
+  def privatize_constant(name)
+    const = Proxy.new(namespace, name)
+    ensure_loaded!(const)
+    const.visibility = :private
+  rescue NamespaceMissingError
+    raise UndocumentableError, "private visibility set on unrecognized constant: #{name}"
+  end
+end

data/lib/yard/handlers/ruby/legacy/visibility_handler.rb

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
-# (see Ruby::VisibilityHandler)
-class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles(/\A(protected|private|public)(\s|\(|$)/)
-  namespace_only
-
-  process do
-    vis = statement.tokens.first.text
-    if statement.tokens.size == 1
-      self.visibility = vis
-    else
-      tokval_list(statement.tokens[2..-1], :attr).each do |name|
-        MethodObject.new(namespace, name, scope) {|o| o.visibility = vis }
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::VisibilityHandler)
+class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\A(protected|private|public)(\s|\(|$)/)
+  namespace_only
+
+  process do
+    vis = statement.tokens.first.text
+    if statement.tokens.size == 1
+      self.visibility = vis
+    else
+      tokval_list(statement.tokens[2..-1], :attr).each do |name|
+        MethodObject.new(namespace, name, scope) {|o| o.visibility = vis }
+      end
+    end
+  end
+end

data/lib/yard/handlers/ruby/legacy/yield_handler.rb

@@ -1,29 +1,29 @@
-# frozen_string_literal: true
-# (see Ruby::YieldHandler)
-class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles TkYIELD
-
-  process do
-    return unless owner.is_a?(MethodObject) # Only methods yield
-    return if owner.has_tag? :yield         # Don't override yield tags
-    return if owner.has_tag? :yieldparam    # Same thing.
-
-    yieldtag = YARD::Tags::Tag.new(:yield, "", [])
-    tokval_list(statement.tokens[2..-1], Token).each do |item|
-      item = item.inspect unless item.is_a?(String)
-      if item == "self"
-        yieldtag.types << '_self'
-        owner.add_tag YARD::Tags::Tag.new(:yieldparam,
-          "the object that the method was called on", owner.namespace.path, '_self')
-      elsif item == "super"
-        yieldtag.types << '_super'
-        owner.add_tag YARD::Tags::Tag.new(:yieldparam,
-          "the result of the method from the superclass", nil, '_super')
-      else
-        yieldtag.types << item
-      end
-    end
-
-    owner.add_tag(yieldtag) unless yieldtag.types.empty?
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::YieldHandler)
+class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles TkYIELD
+
+  process do
+    return unless owner.is_a?(MethodObject) # Only methods yield
+    return if owner.has_tag? :yield         # Don't override yield tags
+    return if owner.has_tag? :yieldparam    # Same thing.
+
+    yieldtag = YARD::Tags::Tag.new(:yield, "", [])
+    tokval_list(statement.tokens[2..-1], Token).each do |item|
+      item = item.inspect unless item.is_a?(String)
+      if item == "self"
+        yieldtag.types << '_self'
+        owner.add_tag YARD::Tags::Tag.new(:yieldparam,
+          "the object that the method was called on", owner.namespace.path, '_self')
+      elsif item == "super"
+        yieldtag.types << '_super'
+        owner.add_tag YARD::Tags::Tag.new(:yieldparam,
+          "the result of the method from the superclass", nil, '_super')
+      else
+        yieldtag.types << item
+      end
+    end
+
+    owner.add_tag(yieldtag) unless yieldtag.types.empty?
+  end
+end

data/lib/yard/handlers/ruby/method_condition_handler.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-# Handles a conditional inside a method
-class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
-  handles :if_mod, :unless_mod
-
-  process do
-    parse_block(statement.then_block, :owner => owner)
-  end
-end
+# frozen_string_literal: true
+# Handles a conditional inside a method
+class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
+  handles :if_mod, :unless_mod
+
+  process do
+    parse_block(statement.then_block, :owner => owner)
+  end
+end

data/lib/yard/handlers/ruby/method_handler.rb

@@ -1,118 +1,104 @@
-# frozen_string_literal: true
-# Handles a method definition
-class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
-  handles :def, :defs
-
-  process do
-    meth = statement.method_name(true).to_s
-    args = format_args
-    blk = statement.block
-    nobj = namespace
-    mscope = scope
-    if statement.type == :defs
-      if statement[0][0].type == :ident
-        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
-      end
-      nobj = P(namespace, statement[0].source) if statement[0][0].type == :const
-      mscope = :class
-    end
-
-    nobj = P(namespace, nobj.value) while nobj.type == :constant
-    obj = register MethodObject.new(nobj, meth, mscope) do |o|
-      o.signature = method_signature
-      o.explicit = true
-      o.parameters = args
-    end
-
-    # delete any aliases referencing old method
-    nobj.aliases.each do |aobj, name|
-      next unless name == obj.name
-      nobj.aliases.delete(aobj)
-    end if nobj.is_a?(NamespaceObject)
-
-    if obj.constructor?
-      unless obj.has_tag?(:return)
-        obj.add_tag(YARD::Tags::Tag.new(:return,
-          "a new instance of #{namespace.name}", namespace.name.to_s))
-      end
-    elsif mscope == :class && obj.docstring.blank? && %w(inherited included
-        extended method_added method_removed method_undefined).include?(meth)
-      obj.add_tag(YARD::Tags::Tag.new(:private, nil))
-    elsif meth.to_s =~ /\?$/
-      if obj.tag(:return) && (obj.tag(:return).types || []).empty?
-        obj.tag(:return).types = ['Boolean']
-      elsif obj.tag(:return).nil?
-        unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
-          obj.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
-        end
-      end
-    end
-
-    if obj.has_tag?(:option)
-      # create the options parameter if its missing
-      obj.tags(:option).each do |option|
-        expected_param = option.name
-        unless obj.tags(:param).find {|x| x.name == expected_param }
-          new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
-          obj.add_tag(new_tag)
-        end
-      end
-    end
-
-    info = obj.attr_info
-    if info
-      if meth.to_s =~ /=$/ # writer
-        info[:write] = obj if info[:read]
-      elsif info[:write]
-        info[:read] = obj
-      end
-    end
-
-    parse_block(blk, :owner => obj) # mainly for yield/exceptions
-  end
-
-  def format_args
-    args = statement.parameters
-
-    params = []
-
-    if args.unnamed_required_params
-      params += args.unnamed_required_params.map {|a| [a.source, nil] }
-    end
-
-    if args.unnamed_optional_params
-      params += args.unnamed_optional_params.map do |a|
-        [a[0].source, a[1].source]
-      end
-    end
-
-    params << ['*' + args.splat_param.source, nil] if args.splat_param
-
-    if args.unnamed_end_params
-      params += args.unnamed_end_params.map {|a| [a.source, nil] }
-    end
-
-    if args.named_params
-      params += args.named_params.map do |a|
-        [a[0].source, a[1] ? a[1].source : nil]
-      end
-    end
-
-    if args.double_splat_param
-      params << ['**' + args.double_splat_param.source, nil]
-    end
-
-    params << ['&' + args.block_param.source, nil] if args.block_param
-
-    params
-  end
-
-  def method_signature
-    method_name = statement.method_name(true)
-    if statement.parameters.any? {|e| e }
-      "def #{method_name}(#{statement.parameters.source})"
-    else
-      "def #{method_name}"
-    end
-  end
-end
+# frozen_string_literal: true
+# Handles a method definition
+class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
+  include YARD::Handlers::Common::MethodHandler
+
+  handles :def, :defs
+
+  process do
+    meth = statement.method_name(true).to_s
+    args = format_args
+    blk = statement.block
+    nobj = namespace
+    mscope = scope
+    if statement.type == :defs
+      if statement[0][0].type == :ident
+        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
+      end
+      nobj = P(namespace, statement[0].source) if statement[0][0].type == :const
+      mscope = :class
+    end
+
+    nobj = P(namespace, nobj.value) while nobj.type == :constant
+    obj = register MethodObject.new(nobj, meth, mscope) do |o|
+      o.explicit = true
+      o.parameters = args
+    end
+
+    # delete any aliases referencing old method
+    nobj.aliases.each do |aobj, name|
+      next unless name == obj.name
+      nobj.aliases.delete(aobj)
+    end if nobj.is_a?(NamespaceObject)
+
+    if obj.constructor?
+      unless obj.has_tag?(:return)
+        obj.add_tag(YARD::Tags::Tag.new(:return,
+          "a new instance of #{namespace.name}", namespace.name.to_s))
+      end
+    elsif mscope == :class && obj.docstring.blank? && %w(inherited included
+        extended method_added method_removed method_undefined).include?(meth)
+      obj.add_tag(YARD::Tags::Tag.new(:private, nil))
+    elsif meth.to_s =~ /\?$/
+      add_predicate_return_tag(obj)
+    end
+
+    if obj.has_tag?(:option)
+      # create the options parameter if its missing
+      obj.tags(:option).each do |option|
+        expected_param = option.name
+        unless obj.tags(:param).find {|x| x.name == expected_param }
+          new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
+          obj.add_tag(new_tag)
+        end
+      end
+    end
+
+    info = obj.attr_info
+    if info
+      if meth.to_s =~ /=$/ # writer
+        info[:write] = obj if info[:read]
+      elsif info[:write]
+        info[:read] = obj
+      end
+    end
+
+    parse_block(blk, :owner => obj) # mainly for yield/exceptions
+  end
+
+  def format_args
+    args = statement.parameters
+
+    params = []
+
+    if args.unnamed_required_params
+      params += args.unnamed_required_params.map {|a| [a.source, nil] }
+    end
+
+    if args.unnamed_optional_params
+      params += args.unnamed_optional_params.map do |a|
+        [a[0].source, a[1].source]
+      end
+    end
+
+    params << ['*' + args.splat_param.source, nil] if args.splat_param
+
+    if args.unnamed_end_params
+      params += args.unnamed_end_params.map {|a| [a.source, nil] }
+    end
+
+    if args.named_params
+      params += args.named_params.map do |a|
+        [a[0].source, a[1] ? a[1].source : nil]
+      end
+    end
+
+    if args.double_splat_param
+      params << ['**' + args.double_splat_param.source, nil]
+    end
+
+    params << ['&' + args.block_param.source, nil] if args.block_param
+
+    params
+  end
+end

data/lib/yard/handlers/ruby/mixin_handler.rb

@@ -1,37 +1,49 @@
-# frozen_string_literal: true
-# Handles the 'include' statement to mixin a module in the instance scope
-class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
-  handles method_call(:include)
-  namespace_only
-
-  process do
-    errors = []
-    statement.parameters(false).reverse.each do |mixin|
-      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
-
-  protected
-
-  def process_mixin(mixin)
-    raise YARD::Parser::UndocumentableError unless mixin.ref?
-    raise YARD::Parser::UndocumentableError if mixin.first.type == :ident
-
-    case obj = Proxy.new(namespace, mixin.source)
-    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, mixin.source, :module)
-    end
-
-    namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
-  end
-end
+# frozen_string_literal: true
+# Handles the 'include' statement to mixin a module in the instance scope
+class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:include)
+  namespace_only
+
+  process do
+    errors = []
+    statement.parameters(false).reverse.each do |mixin|
+      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
+
+  protected
+
+  def process_mixin(mixin)
+    raise YARD::Parser::UndocumentableError unless mixin.ref?
+    raise YARD::Parser::UndocumentableError if mixin.first.type == :ident
+
+    case obj = Proxy.new(namespace, mixin.source)
+    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, mixin.source, :module)
+    end
+
+    rec = recipient(mixin)
+    return if rec.nil? || rec.mixins(scope).include?(obj)
+    rec.mixins(scope).unshift(obj)
+  end
+
+  def recipient(mixin)
+    if statement[0].type == :var_ref && statement[0][0] != s(:kw, "self")
+      statement[0][0].type == :const ?
+        Proxy.new(namespace, statement.namespace.source) :
+        nil
+    else
+      namespace
+    end
+  end
+end