yard 0.9.16 → 0.9.17

data/lib/yard/tags/option_tag.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-module YARD
-  module Tags
-    class OptionTag < Tag
-      attr_accessor :pair
-
-      def initialize(tag_name, name, pair)
-        super(tag_name, nil, nil, name)
-        @pair = pair
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class OptionTag < Tag
+      attr_accessor :pair
+
+      def initialize(tag_name, name, pair)
+        super(tag_name, nil, nil, name)
+        @pair = pair
+      end
+    end
+  end
+end

data/lib/yard/tags/overload_tag.rb

@@ -1,71 +1,71 @@
-# frozen_string_literal: true
-module YARD
-  module Tags
-    class OverloadTag < Tag
-      attr_reader :signature, :parameters, :docstring
-
-      def initialize(tag_name, text)
-        super(tag_name, nil)
-        parse_tag(text)
-        parse_signature
-      end
-
-      def tag(name) docstring.tag(name) end
-      def tags(name = nil) docstring.tags(name) end
-      def has_tag?(name) docstring.has_tag?(name) end
-
-      def object=(value)
-        super(value)
-        docstring.object = value
-        docstring.tags.each {|tag| tag.object = value }
-      end
-
-      def name(prefix = false)
-        return @name unless prefix
-        object.scope == :class ? @name.to_s : "#{object.send(:sep)}#{@name}"
-      end
-
-      def method_missing(*args, &block)
-        object.send(*args, &block)
-      end
-
-      def type
-        object.type
-      end
-
-      def is_a?(other)
-        object.is_a?(other) || self.class >= other.class || false
-      end
-      alias kind_of? is_a?
-
-      private
-
-      def parse_tag(text)
-        @signature, text = *text.split(/\r?\n/, 2)
-        @signature.strip!
-        text ||= String.new("")
-        numspaces = text[/\A(\s*)/, 1].length
-        text.gsub!(/^[ \t]{#{numspaces}}/, '')
-        text.strip!
-        @docstring = Docstring.new(text, nil)
-      end
-
-      def parse_signature
-        if signature =~ /^(?:def\s)?\s*(#{CodeObjects::METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
-          meth = $1
-          args = $2
-          meth.gsub!(/\s+/, '')
-          # FIXME: refactor this code to not make use of the Handlers::Base class (tokval_list should be moved)
-          toks = YARD::Parser::Ruby::Legacy::TokenList.new(args)
-          args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
-          args = args.map do |a|
-            k, v = *a.split(/:|=/, 2)
-            [k.strip.to_s + (a[k.size, 1] == ':' ? ':' : ''), (v ? v.strip : nil)]
-          end if args
-          @name = meth.to_sym
-          @parameters = args
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class OverloadTag < Tag
+      attr_reader :signature, :parameters, :docstring
+
+      def initialize(tag_name, text)
+        super(tag_name, nil)
+        parse_tag(text)
+        parse_signature
+      end
+
+      def tag(name) docstring.tag(name) end
+      def tags(name = nil) docstring.tags(name) end
+      def has_tag?(name) docstring.has_tag?(name) end
+
+      def object=(value)
+        super(value)
+        docstring.object = value
+        docstring.tags.each {|tag| tag.object = value }
+      end
+
+      def name(prefix = false)
+        return @name unless prefix
+        object.scope == :class ? @name.to_s : "#{object.send(:sep)}#{@name}"
+      end
+
+      def method_missing(*args, &block)
+        object.send(*args, &block)
+      end
+
+      def type
+        object.type
+      end
+
+      def is_a?(other)
+        object.is_a?(other) || self.class >= other.class || false
+      end
+      alias kind_of? is_a?
+
+      private
+
+      def parse_tag(text)
+        @signature, text = *text.split(/\r?\n/, 2)
+        @signature.strip!
+        text ||= String.new("")
+        numspaces = text[/\A(\s*)/, 1].length
+        text.gsub!(/^[ \t]{#{numspaces}}/, '')
+        text.strip!
+        @docstring = Docstring.new(text, nil)
+      end
+
+      def parse_signature
+        if signature =~ /^(?:def\s)?\s*(#{CodeObjects::METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+          meth = $1
+          args = $2
+          meth.gsub!(/\s+/, '')
+          # FIXME: refactor this code to not make use of the Handlers::Base class (tokval_list should be moved)
+          toks = YARD::Parser::Ruby::Legacy::TokenList.new(args)
+          args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
+          args = args.map do |a|
+            k, v = *a.split(/:|=/, 2)
+            [k.strip.to_s + (a[k.size, 1] == ':' ? ':' : ''), (v ? v.strip : nil)]
+          end if args
+          @name = meth.to_sym
+          @parameters = args
+        end
+      end
+    end
+  end
+end

data/lib/yard/tags/ref_tag.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-module YARD
-  module Tags
-    module RefTag
-      attr_accessor :owner
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Tags
+    module RefTag
+      attr_accessor :owner
+    end
+  end
+end

data/lib/yard/tags/ref_tag_list.rb

@@ -1,28 +1,28 @@
-# frozen_string_literal: true
-module YARD
-  module Tags
-    class RefTagList
-      attr_accessor :owner, :tag_name, :name
-
-      def initialize(tag_name, owner, name = nil)
-        @owner = CodeObjects::Proxy === owner ? owner : P(owner)
-        @tag_name = tag_name.to_s
-        @name = name
-      end
-
-      def tags
-        if owner.is_a?(CodeObjects::Base)
-          o = owner.tags(tag_name)
-          o = o.select {|t| t.name.to_s == name.to_s } if name
-          o.each do |t|
-            t.extend(RefTag)
-            t.owner = owner
-          end
-          o
-        else
-          []
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class RefTagList
+      attr_accessor :owner, :tag_name, :name
+
+      def initialize(tag_name, owner, name = nil)
+        @owner = CodeObjects::Proxy === owner ? owner : P(owner)
+        @tag_name = tag_name.to_s
+        @name = name
+      end
+
+      def tags
+        if owner.is_a?(CodeObjects::Base)
+          o = owner.tags(tag_name)
+          o = o.select {|t| t.name.to_s == name.to_s } if name
+          o.each do |t|
+            t.extend(RefTag)
+            t.owner = owner
+          end
+          o
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/yard/tags/tag.rb

@@ -1,71 +1,71 @@
-# frozen_string_literal: true
-module YARD
-  module Tags
-    # Represents a metadata tag value (+@tag+). Tags can have any combination of
-    # {#types}, {#name} and {#text}, or none of the above.
-    #
-    # @example Programmatic tag creation
-    #   # The following docstring syntax:
-    #   #   @param [String, nil] arg an argument
-    #   #
-    #   # is equivalent to:
-    #   Tag.new(:param, 'an argument', ['String', 'nil'], 'arg')
-    class Tag
-      # @return [String] the name of the tag
-      attr_accessor :tag_name
-
-      # @return [String] the tag text associated with the tag
-      # @return [nil] if no tag text is supplied
-      attr_accessor :text
-
-      # @return [Array<String>] a list of types associated with the tag
-      # @return [nil] if no types are associated with the tag
-      attr_accessor :types
-
-      # @return [String] a name associated with the tag
-      attr_accessor :name
-
-      # @return [CodeObjects::Base] the associated object
-      attr_accessor :object
-
-      # Creates a new tag object with a tag name and text. Optionally, formally declared types
-      # and a key name can be specified.
-      #
-      # Types are mainly for meta tags that rely on type information, such as +param+, +return+, etc.
-      #
-      # Key names are for tags that declare meta data for a specific key or name, such as +param+,
-      # +raise+, etc.
-      #
-      # @param [#to_s] tag_name        the tag name to create the tag for
-      # @param [String] text           the descriptive text for this tag
-      # @param [Array<String>] types   optional type list of formally declared types
-      #                                for the tag
-      # @param [String] name           optional key name which the tag refers to
-      def initialize(tag_name, text, types = nil, name = nil)
-        @tag_name = tag_name.to_s
-        @text = text
-        @name = name
-        @types = (types ? [types].flatten.compact : nil)
-      end
-
-      # Convenience method to access the first type specified. This should mainly
-      # be used for tags that only specify one type.
-      #
-      # @return [String] the first of the list of specified types
-      # @see #types
-      def type
-        types.first
-      end
-
-      # Provides a plain English summary of the type specification, or nil
-      # if no types are provided or parseable.
-      #
-      # @return [String] a plain English description of the associated types
-      # @return [nil] if no types are provided or not parseable
-      def explain_types
-        return nil if !types || types.empty?
-        TypesExplainer.explain(*types)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Tags
+    # Represents a metadata tag value (+@tag+). Tags can have any combination of
+    # {#types}, {#name} and {#text}, or none of the above.
+    #
+    # @example Programmatic tag creation
+    #   # The following docstring syntax:
+    #   #   @param [String, nil] arg an argument
+    #   #
+    #   # is equivalent to:
+    #   Tag.new(:param, 'an argument', ['String', 'nil'], 'arg')
+    class Tag
+      # @return [String] the name of the tag
+      attr_accessor :tag_name
+
+      # @return [String] the tag text associated with the tag
+      # @return [nil] if no tag text is supplied
+      attr_accessor :text
+
+      # @return [Array<String>] a list of types associated with the tag
+      # @return [nil] if no types are associated with the tag
+      attr_accessor :types
+
+      # @return [String] a name associated with the tag
+      attr_accessor :name
+
+      # @return [CodeObjects::Base] the associated object
+      attr_accessor :object
+
+      # Creates a new tag object with a tag name and text. Optionally, formally declared types
+      # and a key name can be specified.
+      #
+      # Types are mainly for meta tags that rely on type information, such as +param+, +return+, etc.
+      #
+      # Key names are for tags that declare meta data for a specific key or name, such as +param+,
+      # +raise+, etc.
+      #
+      # @param [#to_s] tag_name        the tag name to create the tag for
+      # @param [String] text           the descriptive text for this tag
+      # @param [Array<String>] types   optional type list of formally declared types
+      #                                for the tag
+      # @param [String] name           optional key name which the tag refers to
+      def initialize(tag_name, text, types = nil, name = nil)
+        @tag_name = tag_name.to_s
+        @text = text
+        @name = name
+        @types = (types ? [types].flatten.compact : nil)
+      end
+
+      # Convenience method to access the first type specified. This should mainly
+      # be used for tags that only specify one type.
+      #
+      # @return [String] the first of the list of specified types
+      # @see #types
+      def type
+        types.first
+      end
+
+      # Provides a plain English summary of the type specification, or nil
+      # if no types are provided or parseable.
+      #
+      # @return [String] a plain English description of the associated types
+      # @return [nil] if no types are provided or not parseable
+      def explain_types
+        return nil if !types || types.empty?
+        TypesExplainer.explain(*types)
+      end
+    end
+  end
+end

data/lib/yard/tags/tag_format_error.rb

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-module YARD
-  module Tags
-    class TagFormatError < RuntimeError
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class TagFormatError < RuntimeError
+    end
+  end
+end

data/lib/yard/tags/types_explainer.rb

@@ -1,162 +1,162 @@
-# frozen_string_literal: true
-require 'strscan'
-
-module YARD
-  module Tags
-    class TypesExplainer
-      # (see Tag#explain_types)
-      # @param types [Array<String>] a list of types to parse and summarize
-      def self.explain(*types)
-        explain!(*types)
-      rescue SyntaxError
-        nil
-      end
-
-      # (see explain)
-      # @raise [SyntaxError] if the types are not parseable
-      def self.explain!(*types)
-        Parser.parse(types.join(", ")).join("; ")
-      end
-
-      class << self
-        private :new
-      end
-
-      # @private
-      class Type
-        attr_accessor :name
-
-        def initialize(name)
-          @name = name
-        end
-
-        def to_s(singular = true)
-          if name[0, 1] == "#"
-            singular ? "an object that responds to #{name}" : "objects that respond to #{name}"
-          elsif name[0, 1] =~ /[A-Z]/
-            singular ? "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} " + name : "#{name}#{name[-1, 1] =~ /[A-Z]/ ? "'" : ''}s"
-          else
-            name
-          end
-        end
-
-        private
-
-        def list_join(list)
-          index = 0
-          list.inject(String.new) do |acc, el|
-            acc << el.to_s
-            acc << ", " if index < list.size - 2
-            acc << " or " if index == list.size - 2
-            index += 1
-            acc
-          end
-        end
-      end
-
-      # @private
-      class CollectionType < Type
-        attr_accessor :types
-
-        def initialize(name, types)
-          @name = name
-          @types = types
-        end
-
-        def to_s(_singular = true)
-          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} of (" + list_join(types.map {|t| t.to_s(false) }) + ")"
-        end
-      end
-
-      # @private
-      class FixedCollectionType < CollectionType
-        def to_s(_singular = true)
-          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} containing (" + types.map(&:to_s).join(" followed by ") + ")"
-        end
-      end
-
-      # @private
-      class HashCollectionType < Type
-        attr_accessor :key_types, :value_types
-
-        def initialize(name, key_types, value_types)
-          @name = name
-          @key_types = key_types
-          @value_types = value_types
-        end
-
-        def to_s(_singular = true)
-          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} with keys made of (" +
-            list_join(key_types.map {|t| t.to_s(false) }) +
-            ") and values of (" + list_join(value_types.map {|t| t.to_s(false) }) + ")"
-        end
-      end
-
-      # @private
-      class Parser
-        include CodeObjects
-
-        TOKENS = {
-          :collection_start => /</,
-          :collection_end => />/,
-          :fixed_collection_start => /\(/,
-          :fixed_collection_end => /\)/,
-          :type_name => /#{ISEP}#{METHODNAMEMATCH}|#{NAMESPACEMATCH}|\w+/,
-          :type_next => /[,;]/,
-          :whitespace => /\s+/,
-          :hash_collection_start => /\{/,
-          :hash_collection_next => /=>/,
-          :hash_collection_end => /\}/,
-          :parse_end => nil
-        }
-
-        def self.parse(string)
-          new(string).parse
-        end
-
-        def initialize(string)
-          @scanner = StringScanner.new(string)
-        end
-
-        def parse
-          types = []
-          type = nil
-          name = nil
-          loop do
-            found = false
-            TOKENS.each do |token_type, match|
-              # TODO: cleanup this code.
-              # rubocop:disable Lint/AssignmentInCondition
-              next unless (match.nil? && @scanner.eos?) || (match && token = @scanner.scan(match))
-              found = true
-              case token_type
-              when :type_name
-                raise SyntaxError, "expecting END, got name '#{token}'" if name
-                name = token
-              when :type_next
-                raise SyntaxError, "expecting name, got '#{token}' at #{@scanner.pos}" if name.nil?
-                type = Type.new(name) unless type
-                types << type
-                type = nil
-                name = nil
-              when :fixed_collection_start, :collection_start
-                name ||= "Array"
-                klass = token_type == :collection_start ? CollectionType : FixedCollectionType
-                type = klass.new(name, parse)
-              when :hash_collection_start
-                name ||= "Hash"
-                type = HashCollectionType.new(name, parse, parse)
-              when :hash_collection_next, :hash_collection_end, :fixed_collection_end, :collection_end, :parse_end
-                raise SyntaxError, "expecting name, got '#{token}'" if name.nil?
-                type = Type.new(name) unless type
-                types << type
-                return types
-              end
-            end
-            raise SyntaxError, "invalid character at #{@scanner.peek(1)}" unless found
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'strscan'
+
+module YARD
+  module Tags
+    class TypesExplainer
+      # (see Tag#explain_types)
+      # @param types [Array<String>] a list of types to parse and summarize
+      def self.explain(*types)
+        explain!(*types)
+      rescue SyntaxError
+        nil
+      end
+
+      # (see explain)
+      # @raise [SyntaxError] if the types are not parseable
+      def self.explain!(*types)
+        Parser.parse(types.join(", ")).join("; ")
+      end
+
+      class << self
+        private :new
+      end
+
+      # @private
+      class Type
+        attr_accessor :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        def to_s(singular = true)
+          if name[0, 1] == "#"
+            singular ? "an object that responds to #{name}" : "objects that respond to #{name}"
+          elsif name[0, 1] =~ /[A-Z]/
+            singular ? "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} " + name : "#{name}#{name[-1, 1] =~ /[A-Z]/ ? "'" : ''}s"
+          else
+            name
+          end
+        end
+
+        private
+
+        def list_join(list)
+          index = 0
+          list.inject(String.new) do |acc, el|
+            acc << el.to_s
+            acc << ", " if index < list.size - 2
+            acc << " or " if index == list.size - 2
+            index += 1
+            acc
+          end
+        end
+      end
+
+      # @private
+      class CollectionType < Type
+        attr_accessor :types
+
+        def initialize(name, types)
+          @name = name
+          @types = types
+        end
+
+        def to_s(_singular = true)
+          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} of (" + list_join(types.map {|t| t.to_s(false) }) + ")"
+        end
+      end
+
+      # @private
+      class FixedCollectionType < CollectionType
+        def to_s(_singular = true)
+          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} containing (" + types.map(&:to_s).join(" followed by ") + ")"
+        end
+      end
+
+      # @private
+      class HashCollectionType < Type
+        attr_accessor :key_types, :value_types
+
+        def initialize(name, key_types, value_types)
+          @name = name
+          @key_types = key_types
+          @value_types = value_types
+        end
+
+        def to_s(_singular = true)
+          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} with keys made of (" +
+            list_join(key_types.map {|t| t.to_s(false) }) +
+            ") and values of (" + list_join(value_types.map {|t| t.to_s(false) }) + ")"
+        end
+      end
+
+      # @private
+      class Parser
+        include CodeObjects
+
+        TOKENS = {
+          :collection_start => /</,
+          :collection_end => />/,
+          :fixed_collection_start => /\(/,
+          :fixed_collection_end => /\)/,
+          :type_name => /#{ISEP}#{METHODNAMEMATCH}|#{NAMESPACEMATCH}|\w+/,
+          :type_next => /[,;]/,
+          :whitespace => /\s+/,
+          :hash_collection_start => /\{/,
+          :hash_collection_next => /=>/,
+          :hash_collection_end => /\}/,
+          :parse_end => nil
+        }
+
+        def self.parse(string)
+          new(string).parse
+        end
+
+        def initialize(string)
+          @scanner = StringScanner.new(string)
+        end
+
+        def parse
+          types = []
+          type = nil
+          name = nil
+          loop do
+            found = false
+            TOKENS.each do |token_type, match|
+              # TODO: cleanup this code.
+              # rubocop:disable Lint/AssignmentInCondition
+              next unless (match.nil? && @scanner.eos?) || (match && token = @scanner.scan(match))
+              found = true
+              case token_type
+              when :type_name
+                raise SyntaxError, "expecting END, got name '#{token}'" if name
+                name = token
+              when :type_next
+                raise SyntaxError, "expecting name, got '#{token}' at #{@scanner.pos}" if name.nil?
+                type = Type.new(name) unless type
+                types << type
+                type = nil
+                name = nil
+              when :fixed_collection_start, :collection_start
+                name ||= "Array"
+                klass = token_type == :collection_start ? CollectionType : FixedCollectionType
+                type = klass.new(name, parse)
+              when :hash_collection_start
+                name ||= "Hash"
+                type = HashCollectionType.new(name, parse, parse)
+              when :hash_collection_next, :hash_collection_end, :fixed_collection_end, :collection_end, :parse_end
+                raise SyntaxError, "expecting name, got '#{token}'" if name.nil?
+                type = Type.new(name) unless type
+                types << type
+                return types
+              end
+            end
+            raise SyntaxError, "invalid character at #{@scanner.peek(1)}" unless found
+          end
+        end
+      end
+    end
+  end
+end