yard 0.9.16 → 0.9.17

data/lib/yard/templates/helpers/method_helper.rb

@@ -1,75 +1,75 @@
-# frozen_string_literal: true
-module YARD
-  module Templates::Helpers
-    # Helper methods for method objects.
-    module MethodHelper
-      # @return [String] formatted arguments for a method
-      def format_args(object)
-        return if object.parameters.nil?
-        params = object.parameters
-        if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
-          params.reject! do |param|
-            param[0].to_s[0, 1] == "&" &&
-              !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
-          end
-        end
-
-        if params.empty?
-          ""
-        else
-          args = params.map do |n, v|
-            v ? "#{n}#{n[-1, 1] == ':' ? '' : ' ='} #{v}" : n.to_s
-          end.join(", ")
-          h("(#{args})")
-        end
-      end
-
-      # @return [String] formatted and linked return types for a method
-      def format_return_types(object)
-        return unless object.has_tag?(:return) && object.tag(:return).types
-        return if object.tag(:return).types.empty?
-        format_types [object.tag(:return).types.first], false
-      end
-
-      # @return [String] formatted block if one exists
-      def format_block(object)
-        if object.has_tag?(:yield) && object.tag(:yield).types
-          params = object.tag(:yield).types
-        elsif object.has_tag?(:yieldparam)
-          params = object.tags(:yieldparam).map(&:name)
-        elsif object.has_tag?(:yield)
-          return "{ ... }"
-        else
-          params = nil
-        end
-
-        params ? h("{|" + params.join(", ") + "| ... }") : ""
-      end
-
-      # @return [String] formats line numbers for source code of an object
-      def format_lines(object)
-        return "" if object.source.nil? || object.line.nil?
-        i = -1
-        object.source.split(/\n/).map { object.line + (i += 1) }.join("\n")
-      end
-
-      # @return [String] formats source of an object
-      def format_code(object, _show_lines = false)
-        i = -1
-        lines = object.source.split(/\n/)
-        longestline = (object.line + lines.size).to_s.length
-        lines.map do |line|
-          lineno = object.line + (i += 1)
-          (" " * (longestline - lineno.to_s.length)) + lineno.to_s + "    " + line
-        end.join("\n")
-      end
-
-      # @return [String] formats source code of a constant value
-      def format_constant(value)
-        sp = value.split("\n").last[/^(\s+)/, 1]
-        num = sp ? sp.size : 0
-        html_syntax_highlight value.gsub(/^\s{#{num}}/, '')
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Templates::Helpers
+    # Helper methods for method objects.
+    module MethodHelper
+      # @return [String] formatted arguments for a method
+      def format_args(object)
+        return if object.parameters.nil?
+        params = object.parameters
+        if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
+          params.reject! do |param|
+            param[0].to_s[0, 1] == "&" &&
+              !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
+          end
+        end
+
+        if params.empty?
+          ""
+        else
+          args = params.map do |n, v|
+            v ? "#{n}#{n[-1, 1] == ':' ? '' : ' ='} #{v}" : n.to_s
+          end.join(", ")
+          h("(#{args})")
+        end
+      end
+
+      # @return [String] formatted and linked return types for a method
+      def format_return_types(object)
+        return unless object.has_tag?(:return) && object.tag(:return).types
+        return if object.tag(:return).types.empty?
+        format_types [object.tag(:return).types.first], false
+      end
+
+      # @return [String] formatted block if one exists
+      def format_block(object)
+        if object.has_tag?(:yield) && object.tag(:yield).types
+          params = object.tag(:yield).types
+        elsif object.has_tag?(:yieldparam)
+          params = object.tags(:yieldparam).map(&:name)
+        elsif object.has_tag?(:yield)
+          return "{ ... }"
+        else
+          params = nil
+        end
+
+        params ? h("{|" + params.join(", ") + "| ... }") : ""
+      end
+
+      # @return [String] formats line numbers for source code of an object
+      def format_lines(object)
+        return "" if object.source.nil? || object.line.nil?
+        i = -1
+        object.source.split(/\n/).map { object.line + (i += 1) }.join("\n")
+      end
+
+      # @return [String] formats source of an object
+      def format_code(object, _show_lines = false)
+        i = -1
+        lines = object.source.split(/\n/)
+        longestline = (object.line + lines.size).to_s.length
+        lines.map do |line|
+          lineno = object.line + (i += 1)
+          (" " * (longestline - lineno.to_s.length)) + lineno.to_s + "    " + line
+        end.join("\n")
+      end
+
+      # @return [String] formats source code of a constant value
+      def format_constant(value)
+        sp = value.split("\n").last[/^(\s+)/, 1]
+        num = sp ? sp.size : 0
+        html_syntax_highlight value.gsub(/^\s{#{num}}/, '')
+      end
+    end
+  end
+end

data/lib/yard/templates/helpers/module_helper.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-module YARD
-  module Templates
-    module Helpers
-      # Helper methods for managing module objects.
-      module ModuleHelper
-        # Prunes the method listing by running the verifier and removing attributes/aliases
-        # @param [Array<CodeObjects::Base>] list a list of methods
-        # @param [Boolean] hide_attributes whether to prune attribute methods from the list
-        # @return [Array<CodeObjects::Base>] a pruned list of methods
-        def prune_method_listing(list, hide_attributes = true)
-          list = run_verifier(list)
-          list = list.reject {|o| run_verifier([o.parent]).empty? }
-          list = list.reject {|o| o.is_alias? unless CodeObjects::Proxy === o.namespace }
-          list = list.reject {|o| o.is_attribute? unless CodeObjects::Proxy === o.namespace } if hide_attributes
-          list
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Templates
+    module Helpers
+      # Helper methods for managing module objects.
+      module ModuleHelper
+        # Prunes the method listing by running the verifier and removing attributes/aliases
+        # @param [Array<CodeObjects::Base>] list a list of methods
+        # @param [Boolean] hide_attributes whether to prune attribute methods from the list
+        # @return [Array<CodeObjects::Base>] a pruned list of methods
+        def prune_method_listing(list, hide_attributes = true)
+          list = run_verifier(list)
+          list = list.reject {|o| run_verifier([o.parent]).empty? }
+          list = list.reject {|o| o.is_alias? unless CodeObjects::Proxy === o.namespace }
+          list = list.reject {|o| o.is_attribute? unless CodeObjects::Proxy === o.namespace } if hide_attributes
+          list
+        end
+      end
+    end
+  end
+end

data/lib/yard/templates/helpers/text_helper.rb

@@ -1,112 +1,112 @@
-# frozen_string_literal: true
-module YARD
-  module Templates
-    module Helpers
-      # Helper methods for text template formats.
-      module TextHelper
-        # @return [String] escapes text
-        def h(text)
-          out = String.new("")
-          text = resolve_links(text)
-          text = text.split(/\n/)
-          text.each_with_index do |line, i|
-            out <<
-              case line
-              when /^\s*$/; "\n\n"
-              when /^\s+\S/, /^=/; line + "\n"
-              else; line + (text[i + 1] =~ /^\s+\S/ ? "\n" : " ")
-              end
-          end
-          out
-        end
-
-        # @return [String] wraps text at +col+ columns.
-        def wrap(text, col = 72)
-          text.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/, "\\1\\3\n")
-        end
-
-        # @return [String] indents +text+ by +len+ characters.
-        def indent(text, len = 4)
-          text.gsub(/^/, ' ' * len)
-        end
-
-        # @return [String] aligns a title to the right
-        def title_align_right(text, col = 72)
-          align_right(text, '-', col)
-        end
-
-        # @return [String] aligns text to the right
-        def align_right(text, spacer = ' ', col = 72)
-          text = text[0, col - 4] + '...' if (col - 1 - text.length) < 0
-          spacer * (col - 1 - text.length) + " " + text
-        end
-
-        # @return [String] returns a horizontal rule for output
-        def hr(col = 72, sep = "-")
-          sep * col
-        end
-
-        # @return [String] the formatted signature for a method
-        def signature(meth)
-          # use first overload tag if it has a return type and method itself does not
-          if !meth.tag(:return) && meth.tag(:overload) && meth.tag(:overload).tag(:return)
-            meth = meth.tag(:overload)
-          end
-
-          type = options.default_return || ""
-          rmeth = meth
-          if !rmeth.has_tag?(:return) && rmeth.respond_to?(:object)
-            rmeth = meth.object
-          end
-          if rmeth.tag(:return) && rmeth.tag(:return).types
-            types = rmeth.tags(:return).map {|t| t.types ? t.types : [] }.flatten.uniq
-            first = types.first
-            if types.size == 2 && types.last == 'nil'
-              type = first + '?'
-            elsif types.size == 2 && types.last =~ /^(Array)?<#{Regexp.quote types.first}>$/
-              type = first + '+'
-            elsif types.size > 2
-              type = [first, '...'].join(', ')
-            elsif types == ['void'] && options.hide_void_return
-              type = ""
-            else
-              type = types.join(", ")
-            end
-          end
-          type = "(#{type})" if type.include?(',')
-          type = " -> #{type} " unless type.empty?
-          scope = meth.scope == :class ? "#{meth.namespace.name}." : "#{meth.namespace.name.to_s.downcase}."
-          name = meth.name
-          blk = format_block(meth)
-          args = format_args(meth)
-          extras = []
-          extras_text = ''
-          rw = meth.namespace.attributes[meth.scope][meth.name]
-          if rw
-            attname = [rw[:read] ? 'read' : nil, rw[:write] ? 'write' : nil].compact
-            attname = attname.size == 1 ? attname.join('') + 'only' : nil
-            extras << attname if attname
-          end
-          extras << meth.visibility if meth.visibility != :public
-          extras_text = '(' + extras.join(", ") + ')' unless extras.empty?
-          title = "%s%s%s %s%s%s" % [scope, name, args, blk, type, extras_text]
-          title.gsub(/\s+/, ' ')
-        end
-
-        private
-
-        def resolve_links(text)
-          text.gsub(/(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W]|$)/m) do |_str|
-            escape = $1
-            name = $2
-            title = $3
-            match = $&
-            next(match[1..-1]) if escape
-            next(match) if name[0, 1] == '|'
-            linkify(name, title)
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Templates
+    module Helpers
+      # Helper methods for text template formats.
+      module TextHelper
+        # @return [String] escapes text
+        def h(text)
+          out = String.new("")
+          text = resolve_links(text)
+          text = text.split(/\n/)
+          text.each_with_index do |line, i|
+            out <<
+              case line
+              when /^\s*$/; "\n\n"
+              when /^\s+\S/, /^=/; line + "\n"
+              else; line + (text[i + 1] =~ /^\s+\S/ ? "\n" : " ")
+              end
+          end
+          out
+        end
+
+        # @return [String] wraps text at +col+ columns.
+        def wrap(text, col = 72)
+          text.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/, "\\1\\3\n")
+        end
+
+        # @return [String] indents +text+ by +len+ characters.
+        def indent(text, len = 4)
+          text.gsub(/^/, ' ' * len)
+        end
+
+        # @return [String] aligns a title to the right
+        def title_align_right(text, col = 72)
+          align_right(text, '-', col)
+        end
+
+        # @return [String] aligns text to the right
+        def align_right(text, spacer = ' ', col = 72)
+          text = text[0, col - 4] + '...' if (col - 1 - text.length) < 0
+          spacer * (col - 1 - text.length) + " " + text
+        end
+
+        # @return [String] returns a horizontal rule for output
+        def hr(col = 72, sep = "-")
+          sep * col
+        end
+
+        # @return [String] the formatted signature for a method
+        def signature(meth)
+          # use first overload tag if it has a return type and method itself does not
+          if !meth.tag(:return) && meth.tag(:overload) && meth.tag(:overload).tag(:return)
+            meth = meth.tag(:overload)
+          end
+
+          type = options.default_return || ""
+          rmeth = meth
+          if !rmeth.has_tag?(:return) && rmeth.respond_to?(:object)
+            rmeth = meth.object
+          end
+          if rmeth.tag(:return) && rmeth.tag(:return).types
+            types = rmeth.tags(:return).map {|t| t.types ? t.types : [] }.flatten.uniq
+            first = types.first
+            if types.size == 2 && types.last == 'nil'
+              type = first + '?'
+            elsif types.size == 2 && types.last =~ /^(Array)?<#{Regexp.quote types.first}>$/
+              type = first + '+'
+            elsif types.size > 2
+              type = [first, '...'].join(', ')
+            elsif types == ['void'] && options.hide_void_return
+              type = ""
+            else
+              type = types.join(", ")
+            end
+          end
+          type = "(#{type})" if type.include?(',')
+          type = " -> #{type} " unless type.empty?
+          scope = meth.scope == :class ? "#{meth.namespace.name}." : "#{meth.namespace.name.to_s.downcase}."
+          name = meth.name
+          blk = format_block(meth)
+          args = format_args(meth)
+          extras = []
+          extras_text = ''
+          rw = meth.namespace.attributes[meth.scope][meth.name]
+          if rw
+            attname = [rw[:read] ? 'read' : nil, rw[:write] ? 'write' : nil].compact
+            attname = attname.size == 1 ? attname.join('') + 'only' : nil
+            extras << attname if attname
+          end
+          extras << meth.visibility if meth.visibility != :public
+          extras_text = '(' + extras.join(", ") + ')' unless extras.empty?
+          title = "%s%s%s %s%s%s" % [scope, name, args, blk, type, extras_text]
+          title.gsub(/\s+/, ' ')
+        end
+
+        private
+
+        def resolve_links(text)
+          text.gsub(/(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W]|$)/m) do |_str|
+            escape = $1
+            name = $2
+            title = $3
+            match = $&
+            next(match[1..-1]) if escape
+            next(match) if name[0, 1] == '|'
+            linkify(name, title)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard/templates/helpers/uml_helper.rb

@@ -1,47 +1,47 @@
-# frozen_string_literal: true
-module YARD
-  module Templates::Helpers
-    # Helpers for UML template format
-    module UMLHelper
-      # Official UML visibility prefix syntax for an object given its visibility
-      # @param [CodeObjects::Base] object the object to retrieve visibility for
-      # @return [String] the UML visibility prefix
-      def uml_visibility(object)
-        case object.visibility
-        when :public;    '+'
-        when :protected; '#'
-        when :private;   '-'
-        end
-      end
-
-      # Formats the path of an object for Graphviz syntax
-      # @param [CodeObjects::Base] object an object to format the path of
-      # @return [String] the encoded path
-      def format_path(object)
-        object.path.gsub('::', '_')
-      end
-
-      # Encodes text in escaped Graphviz syntax
-      # @param [String] text text to encode
-      # @return [String] the encoded text
-      def h(text)
-        text.to_s.gsub(/(\W)/, '\\\\\1')
-      end
-
-      # Tidies data by formatting and indenting text
-      # @param [String] data pre-formatted text
-      # @return [String] tidied text.
-      def tidy(data)
-        indent = 0
-        data.split(/\n/).map do |line|
-          line.gsub!(/^\s*/, '')
-          next if line.empty?
-          indent -= 1 if line =~ /^\s*\}\s*$/
-          line = (' ' * (indent * 2)) + line
-          indent += 1 if line =~ /\{\s*$/
-          line
-        end.compact.join("\n") + "\n"
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Templates::Helpers
+    # Helpers for UML template format
+    module UMLHelper
+      # Official UML visibility prefix syntax for an object given its visibility
+      # @param [CodeObjects::Base] object the object to retrieve visibility for
+      # @return [String] the UML visibility prefix
+      def uml_visibility(object)
+        case object.visibility
+        when :public;    '+'
+        when :protected; '#'
+        when :private;   '-'
+        end
+      end
+
+      # Formats the path of an object for Graphviz syntax
+      # @param [CodeObjects::Base] object an object to format the path of
+      # @return [String] the encoded path
+      def format_path(object)
+        object.path.gsub('::', '_')
+      end
+
+      # Encodes text in escaped Graphviz syntax
+      # @param [String] text text to encode
+      # @return [String] the encoded text
+      def h(text)
+        text.to_s.gsub(/(\W)/, '\\\\\1')
+      end
+
+      # Tidies data by formatting and indenting text
+      # @param [String] data pre-formatted text
+      # @return [String] tidied text.
+      def tidy(data)
+        indent = 0
+        data.split(/\n/).map do |line|
+          line.gsub!(/^\s*/, '')
+          next if line.empty?
+          indent -= 1 if line =~ /^\s*\}\s*$/
+          line = (' ' * (indent * 2)) + line
+          indent += 1 if line =~ /\{\s*$/
+          line
+        end.compact.join("\n") + "\n"
+      end
+    end
+  end
+end