yard 0.9.17 → 0.9.22

data/lib/yard/cli/yardopts_command.rb

@@ -1,110 +1,110 @@
-# frozen_string_literal: true
-require 'optparse'
-
-module YARD
-  module CLI
-    # Abstract base class for command that reads .yardopts file
-    #
-    # @abstract
-    # @since 0.8.3
-    class YardoptsCommand < Command
-      # The configuration filename to load extra options from
-      DEFAULT_YARDOPTS_FILE = ".yardopts"
-
-      # @return [Boolean] whether to parse options from .yardopts
-      attr_accessor :use_yardopts_file
-
-      # @return [Boolean] whether to parse options from .document
-      attr_accessor :use_document_file
-
-      # The options file name (defaults to {DEFAULT_YARDOPTS_FILE})
-      # @return [String] the filename to load extra options from
-      attr_accessor :options_file
-
-      # Creates a new command that reads .yardopts
-      def initialize
-        super
-        @options_file = DEFAULT_YARDOPTS_FILE
-        @use_yardopts_file = true
-        @use_document_file = true
-      end
-
-      # Parses commandline arguments
-      # @param [Array<String>] args the list of arguments
-      # @return [Boolean] whether or not arguments are valid
-      # @since 0.5.6
-      def parse_arguments(*args)
-        parse_yardopts_options(*args)
-
-        # Parse files and then command line arguments
-        parse_rdoc_document_file
-        parse_yardopts
-        optparse(*args)
-      end
-
-      protected
-
-      # Adds --[no-]yardopts / --[no-]document
-      def yardopts_options(opts)
-        opts.on('--[no-]yardopts [FILE]',
-                "If arguments should be read from FILE",
-                "  (defaults to yes, FILE defaults to .yardopts)") do |use_yardopts|
-          if use_yardopts.is_a?(String)
-            self.options_file = use_yardopts
-            self.use_yardopts_file = true
-          else
-            self.use_yardopts_file = (use_yardopts != false)
-          end
-        end
-
-        opts.on('--[no-]document', "If arguments should be read from .document file. ",
-                                   "  (defaults to yes)") do |use_document|
-          self.use_document_file = use_document
-        end
-      end
-
-      private
-
-      # Parses the .yardopts file for default yard options
-      # @return [Array<String>] an array of options parsed from .yardopts
-      def yardopts(file = options_file)
-        return [] unless use_yardopts_file
-        File.read_binary(file).shell_split
-      rescue Errno::ENOENT
-        []
-      end
-
-      # Parses out the yardopts/document options
-      def parse_yardopts_options(*args)
-        opts = OptionParser.new
-        opts.base.long.clear # HACK: why are --help and --version defined?
-        yardopts_options(opts)
-        begin
-          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] != '-'
-          retry
-        end
-      end
-
-      def parse_rdoc_document_file(file = '.document')
-        optparse(*support_rdoc_document_file!(file)) if use_document_file
-      end
-
-      def parse_yardopts(file = options_file)
-        optparse(*yardopts(file)) if use_yardopts_file
-      end
-
-      # Reads a .document file in the directory to get source file globs
-      # @return [Array<String>] an array of files parsed from .document
-      def support_rdoc_document_file!(file = '.document')
-        return [] unless use_document_file
-        File.read(file).gsub(/^[ \t]*#.+/m, '').split(/\s+/)
-      rescue Errno::ENOENT
-        []
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'optparse'
+
+module YARD
+  module CLI
+    # Abstract base class for command that reads .yardopts file
+    #
+    # @abstract
+    # @since 0.8.3
+    class YardoptsCommand < Command
+      # The configuration filename to load extra options from
+      DEFAULT_YARDOPTS_FILE = ".yardopts"
+
+      # @return [Boolean] whether to parse options from .yardopts
+      attr_accessor :use_yardopts_file
+
+      # @return [Boolean] whether to parse options from .document
+      attr_accessor :use_document_file
+
+      # The options file name (defaults to {DEFAULT_YARDOPTS_FILE})
+      # @return [String] the filename to load extra options from
+      attr_accessor :options_file
+
+      # Creates a new command that reads .yardopts
+      def initialize
+        super
+        @options_file = DEFAULT_YARDOPTS_FILE
+        @use_yardopts_file = true
+        @use_document_file = true
+      end
+
+      # Parses commandline arguments
+      # @param [Array<String>] args the list of arguments
+      # @return [Boolean] whether or not arguments are valid
+      # @since 0.5.6
+      def parse_arguments(*args)
+        parse_yardopts_options(*args)
+
+        # Parse files and then command line arguments
+        parse_rdoc_document_file
+        parse_yardopts
+        optparse(*args)
+      end
+
+      protected
+
+      # Adds --[no-]yardopts / --[no-]document
+      def yardopts_options(opts)
+        opts.on('--[no-]yardopts [FILE]',
+                "If arguments should be read from FILE",
+                "  (defaults to yes, FILE defaults to .yardopts)") do |use_yardopts|
+          if use_yardopts.is_a?(String)
+            self.options_file = use_yardopts
+            self.use_yardopts_file = true
+          else
+            self.use_yardopts_file = (use_yardopts != false)
+          end
+        end
+
+        opts.on('--[no-]document', "If arguments should be read from .document file. ",
+                                   "  (defaults to yes)") do |use_document|
+          self.use_document_file = use_document
+        end
+      end
+
+      private
+
+      # Parses the .yardopts file for default yard options
+      # @return [Array<String>] an array of options parsed from .yardopts
+      def yardopts(file = options_file)
+        return [] unless use_yardopts_file
+        File.read_binary(file).shell_split
+      rescue Errno::ENOENT
+        []
+      end
+
+      # Parses out the yardopts/document options
+      def parse_yardopts_options(*args)
+        opts = OptionParser.new
+        opts.base.long.clear # HACK: why are --help and --version defined?
+        yardopts_options(opts)
+        begin
+          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] != '-'
+          retry
+        end
+      end
+
+      def parse_rdoc_document_file(file = '.document')
+        optparse(*support_rdoc_document_file!(file)) if use_document_file
+      end
+
+      def parse_yardopts(file = options_file)
+        optparse(*yardopts(file)) if use_yardopts_file
+      end
+
+      # Reads a .document file in the directory to get source file globs
+      # @return [Array<String>] an array of files parsed from .document
+      def support_rdoc_document_file!(file = '.document')
+        return [] unless use_document_file
+        File.read(file).gsub(/^[ \t]*#.+/m, '').split(/\s+/)
+      rescue Errno::ENOENT
+        []
+      end
+    end
+  end
+end

data/lib/yard/cli/yri.rb

@@ -1,215 +1,215 @@
-# frozen_string_literal: true
-require 'rbconfig'
-
-module YARD
-  module CLI
-    # A tool to view documentation in the console like `ri`
-    class YRI < Command
-      # The location in {YARD::CONFIG_DIR} where the YRI cache file is loaded
-      # from.
-      CACHE_FILE = File.expand_path(File.join(YARD::Config::CONFIG_DIR, 'yri_cache'))
-
-      # A file containing all paths, delimited by newlines, to search for
-      # yardoc databases.
-      # @since 0.5.1
-      SEARCH_PATHS_FILE = File.expand_path(File.join(YARD::Config::CONFIG_DIR, 'yri_search_paths'))
-
-      # Default search paths that should be loaded dynamically into YRI. These paths
-      # take precedence over all other paths ({SEARCH_PATHS_FILE} and RubyGems
-      # paths). To add a path, call:
-      #
-      #   DEFAULT_SEARCH_PATHS.push("/path/to/.yardoc")
-      #
-      # @return [Array<String>] a list of extra search paths
-      # @since 0.6.0
-      DEFAULT_SEARCH_PATHS = []
-
-      # Helper method to run the utility on an instance.
-      # @see #run
-      def self.run(*args) new.run(*args) end
-
-      def initialize
-        super
-        @cache = {}
-        @search_paths = []
-        add_default_paths
-        add_gem_paths
-        load_cache
-        @search_paths.uniq!
-      end
-
-      def description
-        "A tool to view documentation in the console like `ri`"
-      end
-
-      # Runs the command-line utility.
-      #
-      # @example
-      #   YRI.new.run('String#reverse')
-      # @param [Array<String>] args each tokenized argument
-      def run(*args)
-        optparse(*args)
-
-        if ::RbConfig::CONFIG['host_os'] =~ /mingw|win32/
-          @serializer ||= YARD::Serializers::StdoutSerializer.new
-        else
-          @serializer ||= YARD::Serializers::ProcessSerializer.new('less')
-        end
-
-        if @name.nil? || @name.strip.empty?
-          print_usage
-          return exit(1)
-        end
-
-        object = find_object(@name)
-        if object
-          print_object(object)
-        else
-          STDERR.puts "No documentation for `#{@name}'"
-          return exit(1)
-        end
-      end
-
-      protected
-
-      # Prints the command usage
-      # @return [void]
-      # @since 0.5.6
-      def print_usage
-        log.puts "Usage: yri [options] <Path to object>"
-        log.puts "See yri --help for more options."
-      end
-
-      # Caches the .yardoc file where an object can be found in the {CACHE_FILE}
-      # @return [void]
-      def cache_object(name, path)
-        return if path == Registry.yardoc_file
-        @cache[name] = path
-
-        File.open!(CACHE_FILE, 'w') do |file|
-          @cache.each do |key, value|
-            file.puts("#{key} #{value}")
-          end
-        end
-      end
-
-      # @param [CodeObjects::Base] object the object to print.
-      # @return [String] the formatted output for an object.
-      def print_object(object)
-        if object.type == :method && object.is_alias?
-          tmp = P(object.namespace, (object.scope == :instance ? "#" : "") +
-            object.namespace.aliases[object].to_s)
-          object = tmp unless YARD::CodeObjects::Proxy === tmp
-        end
-        object.format(:serializer => @serializer)
-      end
-
-      # Locates an object by name starting in the cached paths and then
-      # searching through any search paths.
-      #
-      # @param [String] name the full name of the object
-      # @return [CodeObjects::Base] an object if found
-      # @return [nil] if no object is found
-      def find_object(name)
-        @search_paths.unshift(@cache[name]) if @cache[name]
-        @search_paths.unshift(Registry.yardoc_file)
-
-        # Try to load it from in memory cache
-        log.debug "Searching for #{name} in memory"
-        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)
-          obj = try_load_object(name, path)
-          return obj if obj
-        end
-        nil
-      end
-
-      private
-
-      # Tries to load the object with name. If successful, caches the object
-      # with the cache_path
-      #
-      # @param [String] name the object path
-      # @param [String] cache_path the location of the yardoc
-      #   db containing the object to cache for future lookups.
-      #   No caching is done if this is nil.
-      # @return [void]
-      def try_load_object(name, cache_path)
-        obj = Registry.at(name)
-        cache_object(name, cache_path) if obj && cache_path
-        obj
-      end
-
-      # Loads {CACHE_FILE}
-      # @return [void]
-      def load_cache
-        return unless File.file?(CACHE_FILE)
-        File.readlines(CACHE_FILE).each do |line|
-          line = line.strip.split(/\s+/)
-          @cache[line[0]] = line[1]
-        end
-      end
-
-      # Adds all RubyGems yardoc files to search paths
-      # @return [void]
-      def add_gem_paths
-        require 'rubygems'
-        gem_paths = []
-        YARD::GemIndex.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.concat(DEFAULT_SEARCH_PATHS)
-        return unless File.file?(SEARCH_PATHS_FILE)
-        paths = File.readlines(SEARCH_PATHS_FILE).map(&:strip)
-        @search_paths.concat(paths)
-      end
-
-      # Parses commandline options.
-      # @param [Array<String>] args each tokenized argument
-      def optparse(*args)
-        opts = OptionParser.new
-        opts.banner = "Usage: yri [options] <Path to object>"
-        opts.separator "Example: yri String#gsub"
-        opts.separator ""
-        opts.separator "General Options:"
-
-        opts.on('-b', '--db FILE', 'Use a specified .yardoc db to search in') do |yfile|
-          @search_paths.unshift(yfile)
-        end
-
-        opts.on('-T', '--no-pager', 'No pager') do
-          @serializer = YARD::Serializers::StdoutSerializer.new
-        end
-
-        opts.on('-p PAGER', '--pager') do |pager|
-          @serializer = YARD::Serializers::ProcessSerializer.new(pager)
-        end
-
-        common_options(opts)
-        parse_options(opts, args)
-        @name = args.first
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'rbconfig'
+
+module YARD
+  module CLI
+    # A tool to view documentation in the console like `ri`
+    class YRI < Command
+      # The location in {YARD::CONFIG_DIR} where the YRI cache file is loaded
+      # from.
+      CACHE_FILE = File.expand_path(File.join(YARD::Config::CONFIG_DIR, 'yri_cache'))
+
+      # A file containing all paths, delimited by newlines, to search for
+      # yardoc databases.
+      # @since 0.5.1
+      SEARCH_PATHS_FILE = File.expand_path(File.join(YARD::Config::CONFIG_DIR, 'yri_search_paths'))
+
+      # Default search paths that should be loaded dynamically into YRI. These paths
+      # take precedence over all other paths ({SEARCH_PATHS_FILE} and RubyGems
+      # paths). To add a path, call:
+      #
+      #   DEFAULT_SEARCH_PATHS.push("/path/to/.yardoc")
+      #
+      # @return [Array<String>] a list of extra search paths
+      # @since 0.6.0
+      DEFAULT_SEARCH_PATHS = []
+
+      # Helper method to run the utility on an instance.
+      # @see #run
+      def self.run(*args) new.run(*args) end
+
+      def initialize
+        super
+        @cache = {}
+        @search_paths = []
+        add_default_paths
+        add_gem_paths
+        load_cache
+        @search_paths.uniq!
+      end
+
+      def description
+        "A tool to view documentation in the console like `ri`"
+      end
+
+      # Runs the command-line utility.
+      #
+      # @example
+      #   YRI.new.run('String#reverse')
+      # @param [Array<String>] args each tokenized argument
+      def run(*args)
+        optparse(*args)
+
+        if ::RbConfig::CONFIG['host_os'] =~ /mingw|win32/
+          @serializer ||= YARD::Serializers::StdoutSerializer.new
+        else
+          @serializer ||= YARD::Serializers::ProcessSerializer.new('less')
+        end
+
+        if @name.nil? || @name.strip.empty?
+          print_usage
+          return exit(1)
+        end
+
+        object = find_object(@name)
+        if object
+          print_object(object)
+        else
+          STDERR.puts "No documentation for `#{@name}'"
+          return exit(1)
+        end
+      end
+
+      protected
+
+      # Prints the command usage
+      # @return [void]
+      # @since 0.5.6
+      def print_usage
+        log.puts "Usage: yri [options] <Path to object>"
+        log.puts "See yri --help for more options."
+      end
+
+      # Caches the .yardoc file where an object can be found in the {CACHE_FILE}
+      # @return [void]
+      def cache_object(name, path)
+        return if path == Registry.yardoc_file
+        @cache[name] = path
+
+        File.open!(CACHE_FILE, 'w') do |file|
+          @cache.each do |key, value|
+            file.puts("#{key} #{value}")
+          end
+        end
+      end
+
+      # @param [CodeObjects::Base] object the object to print.
+      # @return [String] the formatted output for an object.
+      def print_object(object)
+        if object.type == :method && object.is_alias?
+          tmp = P(object.namespace, (object.scope == :instance ? "#" : "") +
+            object.namespace.aliases[object].to_s)
+          object = tmp unless YARD::CodeObjects::Proxy === tmp
+        end
+        object.format(:serializer => @serializer)
+      end
+
+      # Locates an object by name starting in the cached paths and then
+      # searching through any search paths.
+      #
+      # @param [String] name the full name of the object
+      # @return [CodeObjects::Base] an object if found
+      # @return [nil] if no object is found
+      def find_object(name)
+        @search_paths.unshift(@cache[name]) if @cache[name]
+        @search_paths.unshift(Registry.yardoc_file)
+
+        # Try to load it from in memory cache
+        log.debug "Searching for #{name} in memory"
+        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)
+          obj = try_load_object(name, path)
+          return obj if obj
+        end
+        nil
+      end
+
+      private
+
+      # Tries to load the object with name. If successful, caches the object
+      # with the cache_path
+      #
+      # @param [String] name the object path
+      # @param [String] cache_path the location of the yardoc
+      #   db containing the object to cache for future lookups.
+      #   No caching is done if this is nil.
+      # @return [void]
+      def try_load_object(name, cache_path)
+        obj = Registry.at(name)
+        cache_object(name, cache_path) if obj && cache_path
+        obj
+      end
+
+      # Loads {CACHE_FILE}
+      # @return [void]
+      def load_cache
+        return unless File.file?(CACHE_FILE)
+        File.readlines(CACHE_FILE).each do |line|
+          line = line.strip.split(/\s+/)
+          @cache[line[0]] = line[1]
+        end
+      end
+
+      # Adds all RubyGems yardoc files to search paths
+      # @return [void]
+      def add_gem_paths
+        require 'rubygems'
+        gem_paths = []
+        YARD::GemIndex.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.concat(DEFAULT_SEARCH_PATHS)
+        return unless File.file?(SEARCH_PATHS_FILE)
+        paths = File.readlines(SEARCH_PATHS_FILE).map(&:strip)
+        @search_paths.concat(paths)
+      end
+
+      # Parses commandline options.
+      # @param [Array<String>] args each tokenized argument
+      def optparse(*args)
+        opts = OptionParser.new
+        opts.banner = "Usage: yri [options] <Path to object>"
+        opts.separator "Example: yri String#gsub"
+        opts.separator ""
+        opts.separator "General Options:"
+
+        opts.on('-b', '--db FILE', 'Use a specified .yardoc db to search in') do |yfile|
+          @search_paths.unshift(yfile)
+        end
+
+        opts.on('-T', '--no-pager', 'No pager') do
+          @serializer = YARD::Serializers::StdoutSerializer.new
+        end
+
+        opts.on('-p PAGER', '--pager') do |pager|
+          @serializer = YARD::Serializers::ProcessSerializer.new(pager)
+        end
+
+        common_options(opts)
+        parse_options(opts, args)
+        @name = args.first
+      end
+    end
+  end
+end