yard 0.9.17 → 0.9.22

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

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
-module YARD
-  module Handlers
-    module Ruby
-      module Legacy
-        # (see Ruby::DSLHandler)
-        class DSLHandler < Base
-          include CodeObjects
-          include DSLHandlerMethods
-          handles TkIDENTIFIER
-          namespace_only
-          process { handle_comments }
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        # (see Ruby::DSLHandler)
+        class DSLHandler < Base
+          include CodeObjects
+          include DSLHandlerMethods
+          handles TkIDENTIFIER
+          namespace_only
+          process { handle_comments }
+        end
+      end
+    end
+  end
+end

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

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-# (see Ruby::ExceptionHandler)
-class YARD::Handlers::Ruby::Legacy::ExceptionHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles(/\Araise(\s|\(|\Z)/)
-
-  process do
-    return unless owner.is_a?(MethodObject) # Only methods yield
-    return if owner.has_tag?(:raise)
-
-    klass = statement.tokens.to_s[/^raise[\(\s]*(#{NAMESPACEMATCH})\s*(?:\)|,|\s(?:if|unless|until)|;|(?:(?:\.|\:\:)\s*)?new|$)/, 1]
-    owner.add_tag YARD::Tags::Tag.new(:raise, '', klass) if klass
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::ExceptionHandler)
+class YARD::Handlers::Ruby::Legacy::ExceptionHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\Araise(\s|\(|\Z)/)
+
+  process do
+    return unless owner.is_a?(MethodObject) # Only methods yield
+    return if owner.has_tag?(:raise)
+
+    klass = statement.tokens.to_s[/^raise[\(\s]*(#{NAMESPACEMATCH})\s*(?:\)|,|\s(?:if|unless|until)|;|(?:(?:\.|\:\:)\s*)?new|$)/, 1]
+    owner.add_tag YARD::Tags::Tag.new(:raise, '', klass) if klass
+  end
+end

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

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-# (see Ruby::ExtendHandler)
-class YARD::Handlers::Ruby::Legacy::ExtendHandler < YARD::Handlers::Ruby::Legacy::MixinHandler
-  handles(/\Aextend(\s|\()/)
-  namespace_only
-
-  def scope; :class end
-
-  private
-
-  def process_mixin(mixin)
-    if mixin == "self"
-      if namespace.is_a?(ClassObject)
-        raise UndocumentableError, "extend(self) statement on class"
-      end
-      namespace.mixins(scope) << namespace
-    else
-      super
-    end
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::ExtendHandler)
+class YARD::Handlers::Ruby::Legacy::ExtendHandler < YARD::Handlers::Ruby::Legacy::MixinHandler
+  handles(/\Aextend(\s|\()/)
+  namespace_only
+
+  def scope; :class end
+
+  private
+
+  def process_mixin(mixin)
+    if mixin == "self"
+      if namespace.is_a?(ClassObject)
+        raise UndocumentableError, "extend(self) statement on class"
+      end
+      namespace.mixins(scope) << namespace
+    else
+      super
+    end
+  end
+end

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

@@ -1,90 +1,90 @@
-# frozen_string_literal: true
-# (see Ruby::MethodHandler)
-class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles TkDEF
-
-  process do
-    nobj = namespace
-    mscope = scope
-
-    if statement.tokens.to_s =~ /^def\s+(#{METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
-      meth = $1
-      args = $2
-      meth.gsub!(/\s+/, '')
-      args = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(args), :all)
-      args.map! do |a|
-        k, v, r = *a.split(/(:)|=/, 2)
-        if r
-          k += v
-          v = r
-        end
-        [k.strip, (v ? v.strip : nil)]
-      end if args
-    else
-      raise YARD::Parser::UndocumentableError, "method: invalid name"
-    end
-
-    # Class method if prefixed by self(::|.) or Module(::|.)
-    if meth =~ /(?:#{NSEPQ}|#{CSEPQ})([^#{NSEP}#{CSEPQ}]+)$/
-      mscope = :class
-      meth = $1
-      prefix = $`
-      if prefix =~ /^[a-z]/ && prefix != "self"
-        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
-      end
-      nobj = P(namespace, prefix) unless prefix == "self"
-    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 mscope == :instance && meth == "initialize"
-      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(:owner => obj) # mainly for yield/exceptions
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::MethodHandler)
+class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles TkDEF
+
+  process do
+    nobj = namespace
+    mscope = scope
+
+    if statement.tokens.to_s =~ /^def\s+(#{METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+      meth = $1
+      args = $2
+      meth.gsub!(/\s+/, '')
+      args = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(args), :all)
+      args.map! do |a|
+        k, v, r = *a.split(/(:)|=/, 2)
+        if r
+          k += v
+          v = r
+        end
+        [k.strip, (v ? v.strip : nil)]
+      end if args
+    else
+      raise YARD::Parser::UndocumentableError, "method: invalid name"
+    end
+
+    # Class method if prefixed by self(::|.) or Module(::|.)
+    if meth =~ /(?:#{NSEPQ}|#{CSEPQ})([^#{NSEP}#{CSEPQ}]+)$/
+      mscope = :class
+      meth = $1
+      prefix = $`
+      if prefix =~ /^[a-z]/ && prefix != "self"
+        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
+      end
+      nobj = P(namespace, prefix) unless prefix == "self"
+    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 mscope == :instance && meth == "initialize"
+      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(:owner => obj) # mainly for yield/exceptions
+  end
+end

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

@@ -1,39 +1,39 @@
-# 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
+# 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

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

@@ -1,19 +1,19 @@
-# frozen_string_literal: true
-# (see Ruby::ModuleFunctionHandler)
-class YARD::Handlers::Ruby::Legacy::ModuleFunctionHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles(/\A(module_function)(\s|\(|$)/)
-  namespace_only
-
-  process do
-    if statement.tokens.size == 1
-      self.scope = :module
-    else
-      tokval_list(statement.tokens[2..-1], :attr).each do |name|
-        instance_method = MethodObject.new(namespace, name)
-        class_method = MethodObject.new(namespace, name, :module)
-        instance_method.copy_to(class_method)
-        class_method.visibility = :public
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::ModuleFunctionHandler)
+class YARD::Handlers::Ruby::Legacy::ModuleFunctionHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\A(module_function)(\s|\(|$)/)
+  namespace_only
+
+  process do
+    if statement.tokens.size == 1
+      self.scope = :module
+    else
+      tokval_list(statement.tokens[2..-1], :attr).each do |name|
+        instance_method = MethodObject.new(namespace, name)
+        class_method = MethodObject.new(namespace, name, :module)
+        instance_method.copy_to(class_method)
+        class_method.visibility = :public
+      end
+    end
+  end
+end

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

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-# (see Ruby::ModuleHandler)
-class YARD::Handlers::Ruby::Legacy::ModuleHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles TkMODULE
-  namespace_only
-
-  process do
-    modname = statement.tokens.to_s[/^module\s+(#{NAMESPACEMATCH})/, 1]
-    mod = register ModuleObject.new(namespace, modname)
-    parse_block(:namespace => mod)
-  end
-end
+# frozen_string_literal: true
+# (see Ruby::ModuleHandler)
+class YARD::Handlers::Ruby::Legacy::ModuleHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles TkMODULE
+  namespace_only
+
+  process do
+    modname = statement.tokens.to_s[/^module\s+(#{NAMESPACEMATCH})/, 1]
+    mod = register ModuleObject.new(namespace, modname)
+    parse_block(:namespace => mod)
+  end
+end

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

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