yard 0.9.16 → 0.9.17

data/lib/yard/cli/display.rb

@@ -1,69 +1,69 @@
-# frozen_string_literal: true
-module YARD
-  module CLI
-    # Display one object
-    # @since 0.8.6
-    class Display < Yardoc
-      def description; 'Displays a formatted object' end
-
-      def initialize(*args)
-        super
-        options.format = :text # default for this command
-        @layout = nil
-        @objects = []
-      end
-
-      # Runs the commandline utility, parsing arguments and displaying an object
-      # from the {Registry}.
-      #
-      # @param [Array<String>] args the list of arguments.
-      # @return [void]
-      def run(*args)
-        return unless parse_arguments(*args)
-        log.puts wrap_layout(format_objects)
-      end
-
-      # @return [String] the output data for all formatted objects
-      def format_objects
-        @objects.inject([]) do |arr, obj|
-          arr.push obj.format(options)
-        end.join("\n")
-      end
-
-      def wrap_layout(contents)
-        return contents unless @layout
-        opts = options.merge(
-          :contents => contents,
-          :object => @objects.first,
-          :objects => @objects
-        )
-        args = [options.template, @layout, options.format]
-        Templates::Engine.template(*args).run(opts)
-      end
-
-      # Parses commandline options.
-      # @param [Array<String>] args each tokenized argument
-      def parse_arguments(*args)
-        opts = OptionParser.new
-        opts.banner = "Usage: yard display [options] OBJECT [OTHER OBJECTS]"
-        general_options(opts)
-        output_options(opts)
-        parse_options(opts, args)
-
-        Registry.load
-        @objects = args.map {|o| Registry.at(o) }
-
-        # validation
-        return false if @objects.any?(&:nil?)
-        verify_markup_options
-      end
-
-      def output_options(opts)
-        super(opts)
-        opts.on('-l', '--layout [LAYOUT]', 'Wraps output in layout template (good for HTML)') do |layout|
-          @layout = layout || 'layout'
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module CLI
+    # Display one object
+    # @since 0.8.6
+    class Display < Yardoc
+      def description; 'Displays a formatted object' end
+
+      def initialize(*args)
+        super
+        options.format = :text # default for this command
+        @layout = nil
+        @objects = []
+      end
+
+      # Runs the commandline utility, parsing arguments and displaying an object
+      # from the {Registry}.
+      #
+      # @param [Array<String>] args the list of arguments.
+      # @return [void]
+      def run(*args)
+        return unless parse_arguments(*args)
+        log.puts wrap_layout(format_objects)
+      end
+
+      # @return [String] the output data for all formatted objects
+      def format_objects
+        @objects.inject([]) do |arr, obj|
+          arr.push obj.format(options)
+        end.join("\n")
+      end
+
+      def wrap_layout(contents)
+        return contents unless @layout
+        opts = options.merge(
+          :contents => contents,
+          :object => @objects.first,
+          :objects => @objects
+        )
+        args = [options.template, @layout, options.format]
+        Templates::Engine.template(*args).run(opts)
+      end
+
+      # Parses commandline options.
+      # @param [Array<String>] args each tokenized argument
+      def parse_arguments(*args)
+        opts = OptionParser.new
+        opts.banner = "Usage: yard display [options] OBJECT [OTHER OBJECTS]"
+        general_options(opts)
+        output_options(opts)
+        parse_options(opts, args)
+
+        Registry.load
+        @objects = args.map {|o| Registry.at(o) }
+
+        # validation
+        return false if @objects.any?(&:nil?)
+        verify_markup_options
+      end
+
+      def output_options(opts)
+        super(opts)
+        opts.on('-l', '--layout [LAYOUT]', 'Wraps output in layout template (good for HTML)') do |layout|
+          @layout = layout || 'layout'
+        end
+      end
+    end
+  end
+end

data/lib/yard/cli/gems.rb

@@ -1,84 +1,84 @@
-# frozen_string_literal: true
-module YARD
-  module CLI
-    # @since 0.6.0
-    class Gems < Command
-      def initialize
-        @rebuild = false
-        @gems = []
-      end
-
-      def description; "Builds YARD index for gems" end
-
-      # Runs the commandline utility, parsing arguments and generating
-      # YARD indexes for gems.
-      #
-      # @param [Array<String>] args the list of arguments
-      # @return [void]
-      def run(*args)
-        require 'rubygems'
-        optparse(*args)
-        build_gems
-      end
-
-      private
-
-      # Builds .yardoc files for all non-existing gems
-      def build_gems
-        require 'rubygems'
-        @gems.each do |spec|
-          ver = "= #{spec.version}"
-          dir = Registry.yardoc_file_for_gem(spec.name, ver)
-          if dir && File.directory?(dir) && !@rebuild
-            log.debug "#{spec.name} index already exists at '#{dir}'"
-          else
-            yfile = Registry.yardoc_file_for_gem(spec.name, ver, true)
-            next unless yfile
-            next unless File.directory?(spec.full_gem_path)
-            Registry.clear
-            Dir.chdir(spec.full_gem_path) do
-              log.info "Building yardoc index for gem: #{spec.full_name}"
-              Yardoc.run('--no-stats', '-n', '-b', yfile)
-            end
-          end
-        end
-      end
-
-      def add_gems(gems)
-        0.step(gems.size - 1, 2) do |index|
-          gem = gems[index]
-          ver_require = gems[index + 1] || ">= 0"
-          specs = YARD::GemIndex.find_all_by_name(gem, ver_require)
-          if specs.empty?
-            log.warn "#{gem} #{ver_require} could not be found in RubyGems index"
-          else
-            @gems += specs
-          end
-        end
-      end
-
-      # Parses options
-      def optparse(*args)
-        opts = OptionParser.new
-        opts.banner = 'Usage: yard gems [options] [gem_name [version]]'
-        opts.separator ""
-        opts.separator "#{description}. If no gem_name is given,"
-        opts.separator "all gems are built."
-        opts.separator ""
-        opts.on('--rebuild', 'Rebuilds index') do
-          @rebuild = true
-        end
-
-        common_options(opts)
-        parse_options(opts, args)
-        add_gems(args)
-
-        if !args.empty? && @gems.empty?
-          log.error "No specified gems could be found for command"
-        elsif @gems.empty?
-          @gems += YARD::GemIndex.all if @gems.empty?
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module CLI
+    # @since 0.6.0
+    class Gems < Command
+      def initialize
+        @rebuild = false
+        @gems = []
+      end
+
+      def description; "Builds YARD index for gems" end
+
+      # Runs the commandline utility, parsing arguments and generating
+      # YARD indexes for gems.
+      #
+      # @param [Array<String>] args the list of arguments
+      # @return [void]
+      def run(*args)
+        require 'rubygems'
+        optparse(*args)
+        build_gems
+      end
+
+      private
+
+      # Builds .yardoc files for all non-existing gems
+      def build_gems
+        require 'rubygems'
+        @gems.each do |spec|
+          ver = "= #{spec.version}"
+          dir = Registry.yardoc_file_for_gem(spec.name, ver)
+          if dir && File.directory?(dir) && !@rebuild
+            log.debug "#{spec.name} index already exists at '#{dir}'"
+          else
+            yfile = Registry.yardoc_file_for_gem(spec.name, ver, true)
+            next unless yfile
+            next unless File.directory?(spec.full_gem_path)
+            Registry.clear
+            Dir.chdir(spec.full_gem_path) do
+              log.info "Building yardoc index for gem: #{spec.full_name}"
+              Yardoc.run('--no-stats', '-n', '-b', yfile)
+            end
+          end
+        end
+      end
+
+      def add_gems(gems)
+        0.step(gems.size - 1, 2) do |index|
+          gem = gems[index]
+          ver_require = gems[index + 1] || ">= 0"
+          specs = YARD::GemIndex.find_all_by_name(gem, ver_require)
+          if specs.empty?
+            log.warn "#{gem} #{ver_require} could not be found in RubyGems index"
+          else
+            @gems += specs
+          end
+        end
+      end
+
+      # Parses options
+      def optparse(*args)
+        opts = OptionParser.new
+        opts.banner = 'Usage: yard gems [options] [gem_name [version]]'
+        opts.separator ""
+        opts.separator "#{description}. If no gem_name is given,"
+        opts.separator "all gems are built."
+        opts.separator ""
+        opts.on('--rebuild', 'Rebuilds index') do
+          @rebuild = true
+        end
+
+        common_options(opts)
+        parse_options(opts, args)
+        add_gems(args)
+
+        if !args.empty? && @gems.empty?
+          log.error "No specified gems could be found for command"
+        elsif @gems.empty?
+          @gems += YARD::GemIndex.all if @gems.empty?
+        end
+      end
+    end
+  end
+end

data/lib/yard/cli/graph.rb

@@ -1,125 +1,125 @@
-# frozen_string_literal: true
-module YARD
-  module CLI
-    # Options to pass to the {Graph} CLI.
-    class GraphOptions < Templates::TemplateOptions
-      # @return [:dot] the default output format
-      default_attr :format, :dot
-
-      # @return [Boolean] whether to list the full class diagram
-      attr_accessor :full
-
-      # @return [Boolean] whether to show the object dependencies
-      attr_accessor :dependencies
-
-      # @return [String] any contents to pass to the digraph
-      attr_accessor :contents
-    end
-
-    # A command-line utility to generate Graphviz graphs from
-    # a set of objects
-    #
-    # @see Graph#run
-    # @since 0.6.0
-    class Graph < YardoptsCommand
-      # The options parsed out of the commandline.
-      # Default options are:
-      #   :format => :dot
-      attr_reader :options
-
-      # The set of objects to include in the graph.
-      attr_reader :objects
-
-      # Creates a new instance of the command-line utility
-      def initialize
-        super
-        @use_document_file = false
-        @options = GraphOptions.new
-        options.reset_defaults
-        options.serializer = YARD::Serializers::StdoutSerializer.new
-      end
-
-      def description
-        "Graphs class diagram using Graphviz"
-      end
-
-      # Runs the command-line utility.
-      #
-      # @example
-      #   grapher = Graph.new
-      #   grapher.run('--private')
-      # @param [Array<String>] args each tokenized argument
-      def run(*args)
-        parse_arguments(*args)
-
-        contents = objects.map do |o|
-          o.format(options.merge(:serialize => false))
-        end.join("\n")
-        opts = {:type => :layout, :contents => contents}
-        options.update(opts)
-        Templates::Engine.render(options)
-      end
-
-      private
-
-      def unrecognized_option(err) end
-
-      # Parses commandline options.
-      # @param [Array<String>] args each tokenized argument
-      def optparse(*args)
-        visibilities = [:public]
-        opts = OptionParser.new
-
-        opts.separator ""
-        opts.separator "General Options:"
-
-        opts.on('-b', '--db FILE', 'Use a specified .yardoc db to load from or save to. (defaults to .yardoc)') do |yfile|
-          YARD::Registry.yardoc_file = yfile
-        end
-
-        opts.on('--full', 'Full class diagrams (show methods and attributes).') do
-          options[:full] = true
-        end
-
-        opts.on('-d', '--dependencies', 'Show mixins in dependency graph.') do
-          options[:dependencies] = true
-        end
-
-        opts.on('--no-public', "Don't show public methods. (default shows public)") do
-          visibilities.delete(:public)
-        end
-
-        opts.on('--protected', "Show or don't show protected methods. (default hides protected)") do
-          visibilities.push(:protected)
-        end
-
-        opts.on('--private', "Show or don't show private methods. (default hides private)") do
-          visibilities.push(:private)
-        end
-
-        opts.separator ""
-        opts.separator "Output options:"
-
-        opts.on('--dot [OPTIONS]', 'Send the results directly to `dot` with optional arguments.') do |dotopts|
-          options.serializer = Serializers::ProcessSerializer.new('dot ' + dotopts.to_s)
-        end
-
-        opts.on('-f', '--file [FILE]', 'Writes output to a file instead of stdout.') do |file|
-          options.serializer = Serializers::FileSystemSerializer.new(:basepath => '.', :extension => nil)
-          options.serializer.instance_eval "def serialized_path(object) #{file.inspect} end"
-        end
-
-        common_options(opts)
-        parse_options(opts, args)
-
-        Registry.load
-
-        expression = "#{visibilities.uniq.inspect}.include?(object.visibility)"
-        options.verifier = Verifier.new(expression)
-        @objects = args.first ?
-          args.map {|o| Registry.at(o) }.compact :
-          [Registry.root]
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module CLI
+    # Options to pass to the {Graph} CLI.
+    class GraphOptions < Templates::TemplateOptions
+      # @return [:dot] the default output format
+      default_attr :format, :dot
+
+      # @return [Boolean] whether to list the full class diagram
+      attr_accessor :full
+
+      # @return [Boolean] whether to show the object dependencies
+      attr_accessor :dependencies
+
+      # @return [String] any contents to pass to the digraph
+      attr_accessor :contents
+    end
+
+    # A command-line utility to generate Graphviz graphs from
+    # a set of objects
+    #
+    # @see Graph#run
+    # @since 0.6.0
+    class Graph < YardoptsCommand
+      # The options parsed out of the commandline.
+      # Default options are:
+      #   :format => :dot
+      attr_reader :options
+
+      # The set of objects to include in the graph.
+      attr_reader :objects
+
+      # Creates a new instance of the command-line utility
+      def initialize
+        super
+        @use_document_file = false
+        @options = GraphOptions.new
+        options.reset_defaults
+        options.serializer = YARD::Serializers::StdoutSerializer.new
+      end
+
+      def description
+        "Graphs class diagram using Graphviz"
+      end
+
+      # Runs the command-line utility.
+      #
+      # @example
+      #   grapher = Graph.new
+      #   grapher.run('--private')
+      # @param [Array<String>] args each tokenized argument
+      def run(*args)
+        parse_arguments(*args)
+
+        contents = objects.map do |o|
+          o.format(options.merge(:serialize => false))
+        end.join("\n")
+        opts = {:type => :layout, :contents => contents}
+        options.update(opts)
+        Templates::Engine.render(options)
+      end
+
+      private
+
+      def unrecognized_option(err) end
+
+      # Parses commandline options.
+      # @param [Array<String>] args each tokenized argument
+      def optparse(*args)
+        visibilities = [:public]
+        opts = OptionParser.new
+
+        opts.separator ""
+        opts.separator "General Options:"
+
+        opts.on('-b', '--db FILE', 'Use a specified .yardoc db to load from or save to. (defaults to .yardoc)') do |yfile|
+          YARD::Registry.yardoc_file = yfile
+        end
+
+        opts.on('--full', 'Full class diagrams (show methods and attributes).') do
+          options[:full] = true
+        end
+
+        opts.on('-d', '--dependencies', 'Show mixins in dependency graph.') do
+          options[:dependencies] = true
+        end
+
+        opts.on('--no-public', "Don't show public methods. (default shows public)") do
+          visibilities.delete(:public)
+        end
+
+        opts.on('--protected', "Show or don't show protected methods. (default hides protected)") do
+          visibilities.push(:protected)
+        end
+
+        opts.on('--private', "Show or don't show private methods. (default hides private)") do
+          visibilities.push(:private)
+        end
+
+        opts.separator ""
+        opts.separator "Output options:"
+
+        opts.on('--dot [OPTIONS]', 'Send the results directly to `dot` with optional arguments.') do |dotopts|
+          options.serializer = Serializers::ProcessSerializer.new('dot ' + dotopts.to_s)
+        end
+
+        opts.on('-f', '--file [FILE]', 'Writes output to a file instead of stdout.') do |file|
+          options.serializer = Serializers::FileSystemSerializer.new(:basepath => '.', :extension => nil)
+          options.serializer.instance_eval "def serialized_path(object) #{file.inspect} end"
+        end
+
+        common_options(opts)
+        parse_options(opts, args)
+
+        Registry.load
+
+        expression = "#{visibilities.uniq.inspect}.include?(object.visibility)"
+        options.verifier = Verifier.new(expression)
+        @objects = args.first ?
+          args.map {|o| Registry.at(o) }.compact :
+          [Registry.root]
+      end
+    end
+  end
+end