yard 0.9.5 → 0.9.6

data/lib/yard/code_objects/extended_method_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   # Represents an instance method of a module that was mixed into the class
   # scope of another namespace.
@@ -20,4 +21,4 @@ module YARD::CodeObjects
     # @see MethodObject
     def method_missing(sym, *args, &block) @del.__send__(sym, *args, &block) end
   end
-end
+end

data/lib/yard/code_objects/extra_file_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   # An ExtraFileObject represents an extra documentation file (README or other
   # file). It is not strictly a CodeObject (does not inherit from `Base`) although

data/lib/yard/code_objects/macro_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ostruct'
 
 module YARD
@@ -68,11 +69,7 @@ module YARD
         # @return [nil] if the +data+ has no macro tag or if the macro is
         #   not new and no macro by the macro name is found.
         def find_or_create(macro_name, data, method_object = nil)
-          if macro = find(name)
-            macro
-          else
-            create(macro_name, data, method_object)
-          end
+          find(name) || create(macro_name, data, method_object)
         end
         alias create_docstring find_or_create
 
@@ -93,10 +90,13 @@ module YARD
         #     interpolating the block data as a variable.
         #   @return [String] the expanded macro data
         # @param [String] macro_data the macro data to expand (taken from {#macro_data})
-        def expand(macro_data, call_params = [], full_source = '', block_source = '')
+        def expand(macro_data, call_params = [], full_source = '', block_source = '') # rubocop:disable Lint/UnusedMethodArgument
           macro_data = macro_data.all if macro_data.is_a?(Docstring)
           macro_data.gsub(MACRO_MATCH) do
-            escape, first, last, rng = $1, $2 || $5, $4, $3 ? true : false
+            escape = $1
+            first = $2 || $5
+            last = $4
+            rng = $3 ? true : false
             next $&[1..-1] if escape
             if first == '*'
               last ? $& : full_source
@@ -117,7 +117,7 @@ module YARD
         # @param [Docstring] docstring the docstring to create a macro out of
         # @!macro macro.expand
         # @see find_or_create
-        def apply(docstring, call_params = [], full_source = '', block_source = '', method_object = nil)
+        def apply(docstring, call_params = [], full_source = '', block_source = '', _method_object = nil) # rubocop:disable Lint/UnusedMethodArgument
           docstring = docstring.all if Docstring === docstring
           parser = Docstring.parser
           handler = OpenStruct.new
@@ -133,7 +133,7 @@ module YARD
         #
         # @param [MacroObject] macro the macro object
         # @!macro macro.expand
-        def apply_macro(macro, docstring, call_params = [], full_source = '', block_source = '')
+        def apply_macro(macro, docstring, call_params = [], full_source = '', block_source = '') # rubocop:disable Lint/UnusedMethodArgument
           apply(docstring, call_params, full_source, block_source)
         end
       end
@@ -169,4 +169,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/code_objects/method_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator CSEP, :method
   register_separator ISEP, :method
@@ -69,9 +70,7 @@ module YARD::CodeObjects
       YARD::Registry.delete(self)
       @path = nil
       @scope = v.to_sym
-      if @scope == :module
-        @scope = :class
-      end
+      @scope = :class if @scope == :module
       YARD::Registry.register(self) if reregister
     end
 
@@ -99,27 +98,34 @@ module YARD::CodeObjects
     # @return [Boolean] whether the method is a writer attribute
     # @since 0.5.3
     def writer?
-      !!((info = attr_info) && info[:write] == self)
+      info = attr_info
+      info && info[:write] == self ? true : false
     end
 
     # @return [Boolean] whether the method is a reader attribute
     # @since 0.5.3
     def reader?
-      !!((info = attr_info) && info[:read] == self)
+      info = attr_info
+      info && info[:read] == self ? true : false
     end
 
     # Tests if the object is defined as an attribute in the namespace
     # @return [Boolean] whether the object is an attribute
     def is_attribute?
-      return false unless info = attr_info
-      info[name.to_s =~ /=$/ ? :write : :read] ? true : false
+      info = attr_info
+      if info
+        read_or_write = name.to_s =~ /=$/ ? :write : :read
+        info[read_or_write] ? true : false
+      else
+        false
+      end
     end
 
     # Tests if the object is defined as an alias of another method
     # @return [Boolean] whether the object is an alias
     def is_alias?
       return false unless namespace.is_a?(NamespaceObject)
-      namespace.aliases.has_key? self
+      namespace.aliases.key? self
     end
 
     # Tests boolean {#explicit} value.
@@ -153,11 +159,7 @@ module YARD::CodeObjects
     # (they should still have a separator as a prefix).
     # @return [String] the path of a method
     def path
-      @path ||= if !namespace || namespace.path == ""
-        sep + super
-      else
-        super
-      end
+      @path ||= !namespace || namespace.path == "" ? sep + super : super
     end
 
     # Returns the name of the object.

data/lib/yard/code_objects/module_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :module
 

data/lib/yard/code_objects/namespace_mapper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # This module controls registration and accessing of namespace separators

data/lib/yard/code_objects/namespace_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :namespace
   default_separator NSEP
@@ -6,10 +7,6 @@ module YARD::CodeObjects
   # The two main Ruby objects that can act as namespaces are modules
   # ({ModuleObject}) and classes ({ClassObject}).
   class NamespaceObject < Base
-    attr_writer :constants, :cvars, :mixins, :child, :meths
-    attr_writer :class_attributes, :instance_attributes
-    attr_writer :included_constants, :included_meths
-
     # @return [Array<String>] a list of ordered group names inside the namespace
     # @since 0.6.0
     attr_accessor :groups
@@ -93,7 +90,7 @@ module YARD::CodeObjects
         opts = SymbolHash[opts]
         children.find do |obj|
           opts.each do |meth, value|
-            break false if !(value.is_a?(Array) ? value.include?(obj[meth]) : obj[meth] == value)
+            break false unless value.is_a?(Array) ? value.include?(obj[meth]) : obj[meth] == value
           end
         end
       end

data/lib/yard/code_objects/proxy.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # A special type of +NoMethodError+ when raised from a {Proxy}
     class ProxyMethodError < NoMethodError; end
 
+    # @private
+    PROXY_MATCH = /(?:#{NSEPQ}|#{ISEPQ}|#{CSEPQ})([^#{Regexp.quote(
+      (NSEP + ISEP + CSEP).split('').uniq.join
+    )}]+)$/
+
     # The Proxy class is a way to lazily resolve code objects in
     # cases where the object may not yet exist. A proxy simply stores
     # an unresolved path until a method is called on the object, at which
@@ -19,7 +25,7 @@ module YARD
       def self.===(other) other.is_a?(self) end
 
       attr_reader :namespace
-      alias_method :parent, :namespace
+      alias parent namespace
 
       # Creates a new Proxy
       #
@@ -33,13 +39,16 @@ module YARD
           name = name[2..-1]
         end
 
-        if name =~ /(?:#{NSEPQ}|#{ISEPQ}|#{CSEPQ})([^#{NSEPQ}#{ISEPQ}#{CSEPQ}]+)$/
-          @orignamespace, @origname = namespace, name
+        if name =~ PROXY_MATCH
+          @orignamespace = namespace
+          @origname = name
           @imethod = true if name.include? ISEP
           namespace = Proxy.new(namespace, $`) unless $`.empty?
           name = $1
         else
-          @orignamespace, @origname, @imethod = nil, nil, nil
+          @orignamespace = nil
+          @origname = nil
+          @imethod = nil
         end
 
         @name = name.to_sym
@@ -54,7 +63,7 @@ module YARD
           @namespace = Proxy.new(@namespace.namespace, @namespace.value)
         end
 
-        unless @namespace.is_a?(NamespaceObject) or @namespace.is_a?(Proxy)
+        unless @namespace.is_a?(NamespaceObject) || @namespace.is_a?(Proxy)
           raise ArgumentError, "Invalid namespace object: #{namespace}"
         end
 
@@ -69,17 +78,13 @@ module YARD
 
       # (see Base#name)
       def name(prefix = false)
-        prefix ? (@imethod ? ISEP : '') + @name.to_s : @name
+        prefix ? "#{@imethod && ISEP}#{@name}" : @name
       end
 
       # Returns a text representation of the Proxy
       # @return [String] the object's #inspect method or P(OBJECTPATH)
       def inspect
-        if obj = to_obj
-          obj.inspect
-        else
-          "P(#{path})"
-        end
+        to_obj ? to_obj.inspect : "P(#{path})"
       end
 
       # If the proxy resolves to an object, returns its path, otherwise
@@ -88,11 +93,7 @@ module YARD
       # @return [String] the assumed path of the proxy (or the real path
       #   of the resolved object)
       def path
-        if obj = to_obj
-          obj.path
-        else
-          proxy_path
-        end
+        to_obj ? to_obj.path : proxy_path
       end
       alias to_s path
       alias to_str path
@@ -100,20 +101,12 @@ module YARD
 
       # @return [Boolean]
       def is_a?(klass)
-        if obj = to_obj
-          obj.is_a?(klass)
-        else
-          self.class <= klass
-        end
+        to_obj ? to_obj.is_a?(klass) : self.class <= klass
       end
 
       # @return [Boolean]
       def ===(other)
-        if obj = to_obj
-          obj === other
-        else
-          self.class <= other.class
-        end
+        to_obj ? to_obj === other : self.class <= other.class
       end
 
       # @return [Boolean]
@@ -142,11 +135,7 @@ module YARD
       # resolved. Otherwise returns +Proxy+.
       # @return [Class] the resolved object's class or +Proxy+
       def class
-        if obj = to_obj
-          obj.class
-        else
-          Proxy
-        end
+        to_obj ? to_obj.class : Proxy
       end
 
       # Returns the type of the proxy. If it cannot be resolved at the
@@ -155,11 +144,7 @@ module YARD
       # @return [Symbol] the Proxy's type
       # @see #type=
       def type
-        if obj = to_obj
-          obj.type
-        else
-          @type || :proxy
-        end
+        to_obj ? to_obj.type : @type || :proxy
       end
 
       # Allows a parser to infer the type of the proxy by its path.
@@ -179,29 +164,25 @@ module YARD
 
       # @return [Boolean]
       def respond_to?(meth, include_private = false)
-        if obj = to_obj
-          obj.respond_to?(meth, include_private)
-        else
-          super
-        end
+        to_obj ? to_obj.respond_to?(meth, include_private) : super
       end
 
       # Dispatches the method to the resolved object.
       #
       # @raise [ProxyMethodError] if the proxy cannot find the real object
       def method_missing(meth, *args, &block)
-        if obj = to_obj
-          obj.__send__(meth, *args, &block)
+        if to_obj
+          to_obj.__send__(meth, *args, &block)
         else
-          log.warn "Load Order / Name Resolution Problem on #{path}:"
-          log.warn "-"
-          log.warn "Something is trying to call #{meth} on object #{path} before it has been recognized."
-          log.warn "This error usually means that you need to modify the order in which you parse files"
-          log.warn "so that #{path} is parsed before methods or other objects attempt to access it."
-          log.warn "-"
-          log.warn "YARD will recover from this error and continue to parse but you *may* have problems"
-          log.warn "with your generated documentation. You should probably fix this."
-          log.warn "-"
+          log.warn "Load Order / Name Resolution Problem on #{path}:\n" \
+                   "-\n" \
+                   "Something is trying to call #{meth} on object #{path} before it has been recognized.\n" \
+                   "This error usually means that you need to modify the order in which you parse files\n" \
+                   "so that #{path} is parsed before methods or other objects attempt to access it.\n" \
+                   "-\n" \
+                   "YARD will recover from this error and continue to parse but you *may* have problems\n" \
+                   "with your generated documentation. You should probably fix this.\n" \
+                   "-\n"
           begin
             super
           rescue NoMethodError
@@ -225,7 +206,8 @@ module YARD
       # @return [Base, nil] the registered code object or nil
       def to_obj
         return @obj if @obj
-        if @obj = Registry.resolve(@namespace, (@imethod ? ISEP : '') + @name.to_s, false, false, @type)
+        @obj = Registry.resolve(@namespace, (@imethod ? ISEP : '') + @name.to_s, false, false, @type)
+        if @obj
           if @origname && @origname.include?("::") && !@obj.path.include?(@origname)
             # the object's path should include the original proxy namespace,
             # otherwise it's (probably) not the right object.

data/lib/yard/code_objects/root_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # Represents the root namespace object (the invisible Ruby module that
@@ -7,6 +8,7 @@ module YARD
       def inspect; @inspect ||= "#<yardoc root>" end
       def root?; true end
       def title; 'Top Level Namespace' end
+
       def equal?(other)
         other == :root ? true : super(other)
       end
@@ -14,4 +16,4 @@ module YARD
       def hash; :root.hash end
     end
   end
-end
+end

data/lib/yard/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # This class maintains all system-wide configuration for YARD and handles
   # the loading of plugins. To access options call {options}, and to load
@@ -164,20 +165,18 @@ module YARD
       load_plugin_failed(name, e)
     end
 
-    private
-
     # Load gem plugins if :load_plugins is true
     def self.load_gem_plugins
       return true unless options[:load_plugins]
       require 'rubygems'
       result = true
-      Gem.source_index.find_name('').each do |gem|
+      YARD::GemIndex.find_all_by_name('').each do |gem|
         begin
           next true unless gem.name =~ YARD_PLUGIN_PREFIX
           load_plugin(gem.name)
         rescue Gem::LoadError => e
           tmp = load_plugin_failed(gem.name, e)
-          result = tmp if !tmp
+          result = tmp unless tmp
         end
       end
       result
@@ -196,7 +195,7 @@ module YARD
       with_yardopts do
         arguments.each_with_index do |arg, i|
           next unless arg == '--plugin'
-          load_plugin(arguments[i+1])
+          load_plugin(arguments[i + 1])
         end
       end
     end
@@ -204,7 +203,7 @@ module YARD
     # Check for command-line safe_mode switch in {arguments}
     def self.load_commandline_safemode
       with_yardopts do
-        arguments.each_with_index do |arg, i|
+        arguments.each_with_index do |arg, _i|
           options[:safe_mode] = true if arg == '--safe'
         end
       end
@@ -213,7 +212,7 @@ module YARD
     # Print a warning if the plugin failed to load
     # @return [false]
     def self.load_plugin_failed(name, exception)
-      log.warn "Error loading plugin '#{name}'"
+      log.error "Error loading plugin '#{name}'"
       log.backtrace(exception) if $DEBUG
       false
     end
@@ -247,13 +246,13 @@ module YARD
     # @param [String] name the plugin name
     # @return [String] the sanitized and normalized plugin name.
     def self.translate_plugin_name(name)
-      name = name.gsub('/', '') # Security sanitization
+      name = name.delete('/') # Security sanitization
       name = "yard-" + name unless name =~ YARD_PLUGIN_PREFIX
       name
     end
 
     # Temporarily loads .yardopts file into @yardopts
-    def self.with_yardopts(&block)
+    def self.with_yardopts
       yfile = CLI::Yardoc::DEFAULT_YARDOPTS_FILE
       @yardopts = File.file?(yfile) ? File.read_binary(yfile).shell_split : []
       result = yield