yard 0.9.5 → 0.9.6

data/lib/yard/cli/yardoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'digest/sha1'
 require 'fileutils'
 
@@ -44,8 +45,7 @@ module YARD
       # @return [CodeObjects::ExtraFileObject] the file object being rendered.
       #   The +object+ key is not used so that a file may be rendered in the context
       #   of an object's namespace (for generating links).
-      attr_reader :file
-      def file=(v) @file = v end
+      attr_accessor :file
 
       # @return [String] the current locale
       attr_accessor :locale
@@ -220,7 +220,10 @@ module YARD
         @has_markup = false
 
         if defined?(::Encoding) && ::Encoding.respond_to?(:default_external=)
-          ::Encoding.default_external, ::Encoding.default_internal = 'utf-8', 'utf-8'
+          utf8 = ::Encoding.find('utf-8')
+
+          ::Encoding.default_external = utf8 unless ::Encoding.default_external == utf8
+          ::Encoding.default_internal = utf8 unless ::Encoding.default_internal == utf8
         end
       end
 
@@ -236,7 +239,7 @@ module YARD
       # @return [void]
       def run(*args)
         log.show_progress = true
-        if args.size == 0 || !args.first.nil?
+        if args.empty? || !args.first.nil?
           # fail early if arguments are not valid
           return unless parse_arguments(*args)
         end
@@ -283,8 +286,8 @@ module YARD
         super(*args)
 
         # Last minute modifications
-        self.files = Parser::SourceParser::DEFAULT_PATH_GLOB if self.files.empty?
-        self.files.delete_if {|x| x =~ /\A\s*\Z/ } # remove empty ones
+        self.files = Parser::SourceParser::DEFAULT_PATH_GLOB if files.empty?
+        files.delete_if {|x| x =~ /\A\s*\Z/ } # remove empty ones
         readme = Dir.glob('README{,*[^~]}').first
         readme ||= Dir.glob(files.first).first if options.onefile
         options.readme ||= CodeObjects::ExtraFileObject.new(readme) if readme
@@ -336,7 +339,7 @@ module YARD
         Registry.load_all if use_cache
         objects = run_verifier(all_objects).reject do |object|
           serialized = !options.serializer || options.serializer.exists?(object)
-          if checksums && serialized && !object.files.any? {|f, line| changed_files.include?(f) }
+          if checksums && serialized && !object.files.any? {|f, _line| changed_files.include?(f) }
             true
           else
             log.debug "Re-generating object #{object.path}..."
@@ -351,7 +354,8 @@ module YARD
       #
       # @return (see YARD::Templates::Helpers::MarkupHelper#load_markup_provider)
       def verify_markup_options
-        result, lvl = false, has_markup ? log.level : Logger::FATAL
+        result = false
+        lvl = has_markup ? log.level : Logger::FATAL
         obj = Struct.new(:options).new(options)
         obj.extend(Templates::Helpers::MarkupHelper)
         options.files.each do |file|
@@ -362,8 +366,8 @@ module YARD
         options.markup = :rdoc unless has_markup
         log.enter_level(lvl) { result = obj.load_markup_provider }
         if !result && !has_markup
-          log.warn "Could not load default RDoc formatter, " +
-            "ignoring any markup (install RDoc to get default formatting)."
+          log.warn "Could not load default RDoc formatter, " \
+                   "ignoring any markup (install RDoc to get default formatting)."
           options.markup = :none
           true
         else
@@ -450,15 +454,13 @@ module YARD
         no_api = true if apis.delete('')
         exprs = []
 
-        if apis.size > 0
-          exprs << "#{apis.uniq.inspect}.include?(@api.text)"
-        end
+        exprs << "#{apis.uniq.inspect}.include?(@api.text)" unless apis.empty?
 
-        if hidden_apis.size > 0
+        unless hidden_apis.empty?
           exprs << "!#{hidden_apis.uniq.inspect}.include?(@api.text)"
         end
 
-        exprs = exprs.size > 0 ? [exprs.join(' && ')] : []
+        exprs = !exprs.empty? ? [exprs.join(' && ')] : []
         exprs << "!@api" if no_api
 
         expr = exprs.join(' || ')
@@ -551,7 +553,7 @@ module YARD
         end
 
         opts.on('--exclude REGEXP', 'Ignores a file if it matches path match (regexp)') do |path|
-          self.excluded << path
+          excluded << path
         end
       end
 
@@ -564,7 +566,7 @@ module YARD
           options.onefile = true
         end
 
-        opts.on('--list', 'List objects to standard out (implies -n)') do |format|
+        opts.on('--list', 'List objects to standard out (implies -n)') do |_format|
           self.generate = false
           self.list = true
         end
@@ -646,7 +648,7 @@ module YARD
 
         opts.on('--asset FROM[:TO]', 'A file or directory to copy over to output ',
                                      '  directory after generating') do |asset|
-          re = /^(?:\.\.\/|\/)/
+          re = %r{^(?:\.\./|/)}
           from, to = *asset.split(':').map {|f| File.cleanpath(f) }
           to ||= from
           if from =~ re || to =~ re
@@ -678,7 +680,8 @@ module YARD
                                  '  (default is system locale)') do |encoding|
           begin
             if defined?(Encoding) && Encoding.respond_to?(:default_external=)
-              Encoding.default_external, Encoding.default_internal = encoding, encoding
+              Encoding.default_external = encoding
+              Encoding.default_internal = encoding
             end
           rescue ArgumentError => e
             raise OptionParser::InvalidOption, e

data/lib/yard/cli/yardopts_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module YARD
@@ -82,8 +83,8 @@ module YARD
           opts.parse(args)
         rescue OptionParser::ParseError => err
           idx = args.index(err.args.first)
-          args = args[(idx+1)..-1]
-          args.shift while args.first && args.first[0,1] != '-'
+          args = args[(idx + 1)..-1]
+          args.shift while args.first && args.first[0, 1] != '-'
           retry
         end
       end

data/lib/yard/cli/yri.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rbconfig'
 
 module YARD
@@ -57,12 +58,15 @@ module YARD
 
         if @name.nil? || @name.strip.empty?
           print_usage
-          exit(1)
-        elsif object = find_object(@name)
+          return exit(1)
+        end
+
+        object = find_object(@name)
+        if object
           print_object(object)
         else
           STDERR.puts "No documentation for `#{@name}'"
-          exit(1)
+          return exit(1)
         end
       end
 
@@ -112,18 +116,16 @@ module YARD
 
         # Try to load it from in memory cache
         log.debug "Searching for #{name} in memory"
-        if obj = try_load_object(name, nil)
-          return obj
-        end
+        obj = try_load_object(name, nil)
+        return obj if obj
 
         log.debug "Searching for #{name} in search paths"
         @search_paths.each do |path|
           next unless File.exist?(path)
           log.debug "Searching for #{name} in #{path}..."
           Registry.load(path)
-          if obj = try_load_object(name, path)
-            return obj
-          end
+          obj = try_load_object(name, path)
+          return obj if obj
         end
         nil
       end
@@ -139,12 +141,9 @@ module YARD
       #   No caching is done if this is nil.
       # @return [void]
       def try_load_object(name, cache_path)
-        if obj = Registry.at(name)
-          if cache_path
-            cache_object(name, cache_path)
-          end
-          return obj
-        end
+        obj = Registry.at(name)
+        cache_object(name, cache_path) if obj && cache_path
+        obj
       end
 
       # Loads {CACHE_FILE}
@@ -162,26 +161,28 @@ module YARD
       def add_gem_paths
         require 'rubygems'
         gem_paths = []
-        Gem.source_index.find_name('').each do |spec|
-          if yfile = Registry.yardoc_file_for_gem(spec.name)
-            if spec.name =~ /^yard-doc-/
-              gem_paths.unshift(yfile)
-            else
-              gem_paths.push(yfile)
-            end
+        YARD::GemIndex.find_all_by_name('').each do |spec|
+          yfile = Registry.yardoc_file_for_gem(spec.name)
+          next if yfile.nil?
+
+          if spec.name =~ /^yard-doc-/
+            gem_paths.unshift(yfile)
+          else
+            gem_paths.push(yfile)
           end
         end
         @search_paths += gem_paths
       rescue LoadError
+        nil # noop
       end
 
       # Adds paths in {SEARCH_PATHS_FILE}
       # @since 0.5.1
       def add_default_paths
-        @search_paths.push(*DEFAULT_SEARCH_PATHS)
+        @search_paths.concat(DEFAULT_SEARCH_PATHS)
         return unless File.file?(SEARCH_PATHS_FILE)
-        paths = File.readlines(SEARCH_PATHS_FILE).map {|l| l.strip }
-        @search_paths.push(*paths)
+        paths = File.readlines(SEARCH_PATHS_FILE).map(&:strip)
+        @search_paths.concat(paths)
       end
 
       # Parses commandline options.

data/lib/yard/code_objects/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CodeObjects
     # A list of code objects. This array acts like a set (no unique items)
@@ -24,7 +25,7 @@ module YARD
         end
         self
       end
-      alias_method :<<, :push
+      alias << push
     end
 
     extend NamespaceMapper
@@ -57,31 +58,40 @@ module YARD
     NAMESPACEMATCH = /(?:(?:#{NSEPQ}\s*)?#{CONSTANTMATCH})+/
 
     # Regular expression to match a method name
-    METHODNAMEMATCH = /[a-zA-Z_]\w*[!?=]?|[-+~]\@|<<|>>|=~|===?|![=~]?|<=>|[<>]=?|\*\*|[-\/+%^&*~`|]|\[\]=?/
+    METHODNAMEMATCH = %r{[a-zA-Z_]\w*[!?=]?|[-+~]\@|<<|>>|=~|===?|![=~]?|<=>|[<>]=?|\*\*|[-/+%^&*~`|]|\[\]=?}
 
     # Regular expression to match a fully qualified method def (self.foo, Class.foo).
     METHODMATCH = /(?:(?:#{NAMESPACEMATCH}|[a-z]\w*)\s*(?:#{CSEPQ}|#{NSEPQ})\s*)?#{METHODNAMEMATCH}/
 
     # All builtin Ruby exception classes for inheritance tree.
-    BUILTIN_EXCEPTIONS = ["SecurityError", "Exception", "NoMethodError", "FloatDomainError",
-      "IOError", "TypeError", "NotImplementedError", "SystemExit", "Interrupt", "SyntaxError",
-      "RangeError", "NoMemoryError", "ArgumentError", "ThreadError", "EOFError", "RuntimeError",
-      "ZeroDivisionError", "StandardError", "LoadError", "NameError", "LocalJumpError", "SystemCallError",
-      "SignalException", "ScriptError", "SystemStackError", "RegexpError", "IndexError"]
+    BUILTIN_EXCEPTIONS = ["ArgumentError", "ClosedQueueError", "EncodingError",
+      "EOFError", "Exception", "FiberError", "FloatDomainError", "IndexError",
+      "Interrupt", "IOError", "KeyError", "LoadError", "LocalJumpError",
+      "NameError", "NoMemoryError", "NoMethodError", "NotImplementedError",
+      "RangeError", "RegexpError", "RuntimeError", "ScriptError", "SecurityError",
+      "SignalException", "StandardError", "StopIteration", "SyntaxError",
+      "SystemCallError", "SystemExit", "SystemStackError", "ThreadError",
+      "TypeError", "UncaughtThrowError", "ZeroDivisionError"]
+
     # All builtin Ruby classes for inheritance tree.
     # @note MatchingData is a 1.8.x legacy class
-    BUILTIN_CLASSES = ["TrueClass", "Array", "Dir", "Struct", "UnboundMethod", "Object", "Fixnum", "Float",
-      "ThreadGroup", "MatchingData", "MatchData", "Proc", "Binding", "Class", "Time", "Bignum", "NilClass", "Symbol",
-      "Numeric", "String", "Data", "MatchData", "Regexp", "Integer", "File", "IO", "Range", "FalseClass",
-      "Method", "Continuation", "Thread", "Hash", "Module"] + BUILTIN_EXCEPTIONS
+    BUILTIN_CLASSES = ["Array", "Bignum", "Binding", "Class", "Complex",
+      "ConditionVariable", "Data", "Dir", "Encoding", "Enumerator", "FalseClass",
+      "Fiber", "File", "Fixnum", "Float", "Hash", "IO", "Integer", "MatchData",
+      "Method", "Module", "NilClass", "Numeric", "Object", "Proc", "Queue",
+      "Random", "Range", "Rational", "Regexp", "RubyVM", "SizedQueue", "String",
+      "Struct", "Symbol", "Thread", "ThreadGroup", "Time", "TracePoint",
+      "TrueClass", "UnboundMethod"] + BUILTIN_EXCEPTIONS
+
     # All builtin Ruby modules for mixin handling.
-    BUILTIN_MODULES = ["ObjectSpace", "Signal", "Marshal", "Kernel", "Process", "GC", "FileTest", "Enumerable",
-      "Comparable", "Errno", "Precision", "Math"]
+    BUILTIN_MODULES = ["Comparable", "Enumerable", "Errno", "FileTest", "GC",
+      "Kernel", "Marshal", "Math", "ObjectSpace", "Precision", "Process", "Signal"]
+
     # All builtin Ruby classes and modules.
     BUILTIN_ALL = BUILTIN_CLASSES + BUILTIN_MODULES
 
     # Hash of {BUILTIN_EXCEPTIONS} as keys and true as value (for O(1) lookups)
-    BUILTIN_EXCEPTIONS_HASH = BUILTIN_EXCEPTIONS.inject({}) {|h,n| h.update(n => true) }
+    BUILTIN_EXCEPTIONS_HASH = BUILTIN_EXCEPTIONS.inject({}) {|h, n| h.update(n => true) }
 
     # +Base+ is the superclass of all code objects recognized by YARD. A code
     # object is any entity in the Ruby language (class, method, module). A
@@ -182,7 +192,7 @@ module YARD
             namespace = Proxy.new(namespace.namespace, namespace.value)
           end
 
-          if name.to_s[0,2] == NSEP
+          if name.to_s[0, 2] == NSEP
             name = name.to_s[2..-1]
             namespace = Registry.root
           end
@@ -221,9 +231,9 @@ module YARD
       # @yield [self] a block to perform any extra initialization on the object
       # @yieldparam [Base] self the newly initialized code object
       # @return [Base] the newly created object
-      def initialize(namespace, name, *args, &block)
+      def initialize(namespace, name, *)
         if namespace && namespace != :root &&
-            !namespace.is_a?(NamespaceObject) && !namespace.is_a?(Proxy)
+           !namespace.is_a?(NamespaceObject) && !namespace.is_a?(Proxy)
           raise ArgumentError, "Invalid namespace object: #{namespace}"
         end
 
@@ -262,7 +272,7 @@ module YARD
       # @return [String] if prefix is true, prefix + the name as a String.
       #   This must be implemented by the subclass.
       def name(prefix = false)
-        prefix ? @name.to_s : @name
+        prefix ? @name.to_s : (defined?(@name) && @name)
       end
 
       # Associates a file with a code object, optionally adding the line where it was defined.
@@ -408,11 +418,8 @@ module YARD
       #   into a docstring and meta tags.
       def docstring=(comments)
         @docstrings.clear
-        if Docstring === comments
-          @docstring = comments
-        else
-          @docstring = Docstring.new(comments, self)
-        end
+        @docstring = Docstring === comments ?
+          comments : Docstring.new(comments, self)
       end
 
       # Default type is the lowercase class name without the "Object" suffix.
@@ -434,12 +441,12 @@ module YARD
       # @see #sep
       def path
         @path ||= if parent && !parent.root?
-          [parent.path, name.to_s].join(sep)
-        else
-          name.to_s
-        end
+                    [parent.path, name.to_s].join(sep)
+                  else
+                    name.to_s
+                  end
       end
-      alias_method :to_s, :path
+      alias to_s path
 
       # @note
       #   Override this method if your object has a special title that does
@@ -465,11 +472,8 @@ module YARD
         common = [path, other].join(" ").match(/^(\S*)\S*(?: \1\S*)*$/)[1]
         common = path unless common =~ /(\.|::|#)$/
         common = common.sub(/(\.|::|#)[^:#\.]*?$/, '') if same_parent
-        if %w(. :).include?(common[-1,1]) || other[common.size,1] == '#'
-          suffix = ''
-        else
-          suffix = '(::|\.)'
-        end
+        suffix = %w(. :).include?(common[-1, 1]) || other[common.size, 1] == '#' ?
+          '' : '(::|\.)'
         result = other.sub(/^#{Regexp.quote common}#{suffix}/, '')
         result.empty? ? other : result
       end
@@ -489,7 +493,7 @@ module YARD
       # @see Templates::Engine#render
       def format(options = {})
         options = options.merge(:object => self)
-        options = options.merge(:type => type) if !options[:type]
+        options = options.merge(:type => type) unless options[:type]
         Templates::Engine.render(options)
       end
 
@@ -520,8 +524,8 @@ module YARD
         end
       end
 
-      alias_method :parent, :namespace
-      alias_method :parent=, :namespace=
+      alias parent namespace
+      alias parent= namespace=
 
       # Gets a tag from the {#docstring}
       # @see Docstring#tag
@@ -577,7 +581,7 @@ module YARD
       # @param [String] source the source code to format
       # @return [String] formatted source
       def format_source(source)
-        source.chomp!
+        source = source.chomp
         last = source.split(/\r?\n/).last
         indent = last ? last[/^([ \t]*)/, 1].length : 0
         source.gsub(/^[ \t]{#{indent}}/, '')

data/lib/yard/code_objects/class_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :class
 
@@ -32,7 +33,7 @@ module YARD::CodeObjects
     #
     # @return [Boolean] whether the object represents a Ruby exception
     def is_exception?
-      inheritance_tree.reverse.any? {|o| BUILTIN_EXCEPTIONS_HASH.has_key? o.path }
+      inheritance_tree.reverse.any? {|o| BUILTIN_EXCEPTIONS_HASH.key? o.path }
     end
 
     # Returns the inheritance tree of the object including self.
@@ -136,7 +137,7 @@ module YARD::CodeObjects
       end
 
       if @superclass == self
-        msg = "superclass #{@superclass.inspect} cannot be the same as the declared class #{self.inspect}"
+        msg = "superclass #{@superclass.inspect} cannot be the same as the declared class #{inspect}"
         @superclass = P("::Object")
         raise ArgumentError, msg
       end

data/lib/yard/code_objects/class_variable_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :class_variable
 
@@ -7,4 +8,4 @@ module YARD::CodeObjects
     # @return [String] the class variable's value
     attr_accessor :value
   end
-end
+end

data/lib/yard/code_objects/constant_object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD::CodeObjects
   register_separator NSEP, :constant
 
@@ -12,4 +13,4 @@ module YARD::CodeObjects
       @value = format_source(value)
     end
   end
-end
+end