yard 0.9.16 → 0.9.17

data/lib/yard/version.rb

@@ -1,4 +1,6 @@
+
 # frozen_string_literal: true
+
 module YARD
-  VERSION = '0.9.16'
+  VERSION = '0.9.17'
 end

data/spec/cli/command_parser_spec.rb

@@ -1,43 +1,43 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::CommandParser do
-  describe "#run" do
-    before do
-      @cmd = CLI::CommandParser.new
-    end
-
-    it "shows help if --help is provided" do
-      command = double(:command)
-      expect(command).to receive(:run).with('--help')
-      CLI::CommandParser.commands[:foo] = command
-      @cmd.class.default_command = :foo
-      @cmd.run(*%w(foo --help))
-    end
-
-    it "uses default command if first argument is a switch" do
-      command = double(:command)
-      expect(command).to receive(:run).with('--a', 'b', 'c')
-      CLI::CommandParser.commands[:foo] = command
-      @cmd.class.default_command = :foo
-      @cmd.run(*%w(--a b c))
-    end
-
-    it "uses default command if no arguments are provided" do
-      command = double(:command)
-      expect(command).to receive(:run)
-      CLI::CommandParser.commands[:foo] = command
-      @cmd.class.default_command = :foo
-      @cmd.run
-    end
-
-    it "lists commands if command is not found" do
-      expect(@cmd).to receive(:list_commands)
-      @cmd.run(*%w(unknown_command --args))
-    end
-
-    it "lists commands if --help is provided as sole argument" do
-      expect(@cmd).to receive(:list_commands)
-      @cmd.run(*%w(--help))
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::CLI::CommandParser do
+  describe "#run" do
+    before do
+      @cmd = CLI::CommandParser.new
+    end
+
+    it "shows help if --help is provided" do
+      command = double(:command)
+      expect(command).to receive(:run).with('--help')
+      CLI::CommandParser.commands[:foo] = command
+      @cmd.class.default_command = :foo
+      @cmd.run(*%w(foo --help))
+    end
+
+    it "uses default command if first argument is a switch" do
+      command = double(:command)
+      expect(command).to receive(:run).with('--a', 'b', 'c')
+      CLI::CommandParser.commands[:foo] = command
+      @cmd.class.default_command = :foo
+      @cmd.run(*%w(--a b c))
+    end
+
+    it "uses default command if no arguments are provided" do
+      command = double(:command)
+      expect(command).to receive(:run)
+      CLI::CommandParser.commands[:foo] = command
+      @cmd.class.default_command = :foo
+      @cmd.run
+    end
+
+    it "lists commands if command is not found" do
+      expect(@cmd).to receive(:list_commands)
+      @cmd.run(*%w(unknown_command --args))
+    end
+
+    it "lists commands if --help is provided as sole argument" do
+      expect(@cmd).to receive(:list_commands)
+      @cmd.run(*%w(--help))
+    end
+  end
+end

data/spec/cli/command_spec.rb

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-require 'optparse'
-
-RSpec.describe YARD::CLI::Command do
-  describe "#parse_options" do
-    before do
-      @options = OptionParser.new
-      @saw_foo = false
-      @options.on('--foo') { @saw_foo = true }
-    end
-
-    def parse(*args)
-      CLI::Command.new.send(:parse_options, @options, args)
-      args
-    end
-
-    it "skips unrecognized options but continue to next option" do
-      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
-      expect(log).to receive(:warn).with(/Unrecognized.*--list2/)
-      parse('--list', '--list2', '--foo')
-      expect(@saw_foo).to be true
-    end
-
-    it "skips unrecognized options and any extra non-option arg that follows" do
-      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
-      parse('--list', 'foo', '--foo')
-      expect(@saw_foo).to be true
-    end
-
-    it "stops retrying to parse at non-switch argument" do
-      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
-      args = parse('--list', 'foo', 'foo', 'foo')
-      expect(args).to eq %w(foo foo)
-    end
-  end
-end
+# frozen_string_literal: true
+require 'optparse'
+
+RSpec.describe YARD::CLI::Command do
+  describe "#parse_options" do
+    before do
+      @options = OptionParser.new
+      @saw_foo = false
+      @options.on('--foo') { @saw_foo = true }
+    end
+
+    def parse(*args)
+      CLI::Command.new.send(:parse_options, @options, args)
+      args
+    end
+
+    it "skips unrecognized options but continue to next option" do
+      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
+      expect(log).to receive(:warn).with(/Unrecognized.*--list2/)
+      parse('--list', '--list2', '--foo')
+      expect(@saw_foo).to be true
+    end
+
+    it "skips unrecognized options and any extra non-option arg that follows" do
+      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
+      parse('--list', 'foo', '--foo')
+      expect(@saw_foo).to be true
+    end
+
+    it "stops retrying to parse at non-switch argument" do
+      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
+      args = parse('--list', 'foo', 'foo', 'foo')
+      expect(args).to eq %w(foo foo)
+    end
+  end
+end

data/spec/cli/config_spec.rb

@@ -1,148 +1,148 @@
-# frozen_string_literal: true
-require 'yaml'
-
-RSpec.describe YARD::CLI::Config do
-  before do
-    @config = YARD::CLI::Config.new
-    YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
-    allow(YARD::Config).to receive(:save)
-  end
-
-  def run(*args)
-    @config.run(*args)
-  end
-
-  describe "Listing configuration" do
-    it "accepts --list" do
-      opts = YARD::Config.options
-      expect(YAML).to receive(:dump).twice.and_return("--- foo\nbar\nbaz")
-      expect(log).to receive(:puts).twice.with("bar\nbaz")
-      run
-      run('--list')
-      expect(YARD::Config.options).to eq opts
-    end
-  end
-
-  describe "Viewing an item" do
-    it "views item if no value is given" do
-      YARD::Config.options[:foo] = 'bar'
-      expect(log).to receive(:puts).with('"bar"')
-      run 'foo'
-      expect(YARD::Config.options[:foo]).to eq 'bar'
-    end
-  end
-
-  describe "Modifying an item" do
-    it "accepts --reset to set value" do
-      YARD::Config.options[:load_plugins] = 'foo'
-      run('--reset', 'load_plugins')
-      expect(YARD::Config.options[:load_plugins]).to be false
-    end
-
-    it "accepts --as-list to force single item as list" do
-      run('--as-list', 'foo', 'bar')
-      expect(YARD::Config.options[:foo]).to eq ['bar']
-    end
-
-    it "accepts --append to append values to existing key" do
-      YARD::Config.options[:foo] = ['bar']
-      run('--append', 'foo', 'baz', 'quux')
-      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz', 'quux']
-      run('-a', 'foo', 'last')
-      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz', 'quux', 'last']
-    end
-
-    it "turns key into list if --append is used on single item" do
-      YARD::Config.options[:foo] = 'bar'
-      run('-a', 'foo', 'baz')
-      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz']
-    end
-
-    it "modifies item if value is given" do
-      run('foo', 'xxx')
-      expect(YARD::Config.options[:foo]).to eq 'xxx'
-    end
-
-    it "turns list of values into array of values" do
-      run('foo', 'a', 'b', '1', 'true', 'false')
-      expect(YARD::Config.options[:foo]).to eq ['a', 'b', 1, true, false]
-    end
-
-    it "turns number into numeric Ruby type" do
-      run('foo', '1')
-      expect(YARD::Config.options[:foo]).to eq 1
-    end
-
-    it "turns true into TrueClass" do
-      run('foo', 'true')
-      expect(YARD::Config.options[:foo]).to be true
-    end
-
-    it "turns false into FalseClass" do
-      run('foo', 'false')
-      expect(YARD::Config.options[:foo]).to be false
-    end
-
-    it "saves on modification" do
-      expect(YARD::Config).to receive(:save)
-      run('foo', 'true')
-    end
-  end
-
-  describe "RubyGems hooks" do
-    require 'rubygems'
-
-    class FakeGemConfig < Hash
-      attr_accessor :written
-      def write; @written = true end
-      def path; nil end
-    end
-
-    before do
-      allow(Gem).to receive(:configuration).and_return(FakeGemConfig.new)
-    end
-
-    it "accepts --gem-install-yri" do
-      @config.send(:optparse, '--gem-install-yri')
-      expect(@config.gem_install_cmd).to eq 'yri'
-    end
-
-    it "accepts --gem-install-yard" do
-      @config.send(:optparse, '--gem-install-yard')
-      expect(@config.gem_install_cmd).to eq 'yard'
-    end
-
-    it "does not change back to yri if yard was specified" do
-      @config.send(:optparse, '--gem-install-yard', '--gem-install-yri')
-      expect(@config.gem_install_cmd).to eq 'yard'
-    end
-
-    it "ignores actual config options" do
-      run('--gem-install-yri', 'foo', 'true')
-      expect(YARD::Config).not_to receive(:save)
-    end
-
-    it "updates configuration as :gem if no configuration exists" do
-      run('--gem-install-yri')
-      expect(Gem.configuration[:gem]).to eq "--document=yri"
-      expect(Gem.configuration.written).to eq true
-    end
-
-    [:install, "install", :gem, "gem"].each do |type|
-      it "finds existing config in #{type.inspect} and updates that line without changing anything else" do
-        Gem.configuration[type] = "--opts x"
-        run('--gem-install-yri')
-        expect(Gem.configuration[type]).to eq "--opts x --document=yri"
-        ([:install, "install", :gem, "gem"] - [type]).each do |other|
-          expect(Gem.configuration[other]).to eq nil
-        end
-      end
-    end
-
-    it "scrubs --document values from existing config" do
-      Gem.configuration["gem"] = "--document=yri,ri --no-document --opts x"
-      run('--gem-install-yri')
-      expect(Gem.configuration["gem"]).to eq "--opts x --document=yri"
-    end
-  end
-end
+# frozen_string_literal: true
+require 'yaml'
+
+RSpec.describe YARD::CLI::Config do
+  before do
+    @config = YARD::CLI::Config.new
+    YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
+    allow(YARD::Config).to receive(:save)
+  end
+
+  def run(*args)
+    @config.run(*args)
+  end
+
+  describe "Listing configuration" do
+    it "accepts --list" do
+      opts = YARD::Config.options
+      expect(YAML).to receive(:dump).twice.and_return("--- foo\nbar\nbaz")
+      expect(log).to receive(:puts).twice.with("bar\nbaz")
+      run
+      run('--list')
+      expect(YARD::Config.options).to eq opts
+    end
+  end
+
+  describe "Viewing an item" do
+    it "views item if no value is given" do
+      YARD::Config.options[:foo] = 'bar'
+      expect(log).to receive(:puts).with('"bar"')
+      run 'foo'
+      expect(YARD::Config.options[:foo]).to eq 'bar'
+    end
+  end
+
+  describe "Modifying an item" do
+    it "accepts --reset to set value" do
+      YARD::Config.options[:load_plugins] = 'foo'
+      run('--reset', 'load_plugins')
+      expect(YARD::Config.options[:load_plugins]).to be false
+    end
+
+    it "accepts --as-list to force single item as list" do
+      run('--as-list', 'foo', 'bar')
+      expect(YARD::Config.options[:foo]).to eq ['bar']
+    end
+
+    it "accepts --append to append values to existing key" do
+      YARD::Config.options[:foo] = ['bar']
+      run('--append', 'foo', 'baz', 'quux')
+      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz', 'quux']
+      run('-a', 'foo', 'last')
+      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz', 'quux', 'last']
+    end
+
+    it "turns key into list if --append is used on single item" do
+      YARD::Config.options[:foo] = 'bar'
+      run('-a', 'foo', 'baz')
+      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz']
+    end
+
+    it "modifies item if value is given" do
+      run('foo', 'xxx')
+      expect(YARD::Config.options[:foo]).to eq 'xxx'
+    end
+
+    it "turns list of values into array of values" do
+      run('foo', 'a', 'b', '1', 'true', 'false')
+      expect(YARD::Config.options[:foo]).to eq ['a', 'b', 1, true, false]
+    end
+
+    it "turns number into numeric Ruby type" do
+      run('foo', '1')
+      expect(YARD::Config.options[:foo]).to eq 1
+    end
+
+    it "turns true into TrueClass" do
+      run('foo', 'true')
+      expect(YARD::Config.options[:foo]).to be true
+    end
+
+    it "turns false into FalseClass" do
+      run('foo', 'false')
+      expect(YARD::Config.options[:foo]).to be false
+    end
+
+    it "saves on modification" do
+      expect(YARD::Config).to receive(:save)
+      run('foo', 'true')
+    end
+  end
+
+  describe "RubyGems hooks" do
+    require 'rubygems'
+
+    class FakeGemConfig < Hash
+      attr_accessor :written
+      def write; @written = true end
+      def path; nil end
+    end
+
+    before do
+      allow(Gem).to receive(:configuration).and_return(FakeGemConfig.new)
+    end
+
+    it "accepts --gem-install-yri" do
+      @config.send(:optparse, '--gem-install-yri')
+      expect(@config.gem_install_cmd).to eq 'yri'
+    end
+
+    it "accepts --gem-install-yard" do
+      @config.send(:optparse, '--gem-install-yard')
+      expect(@config.gem_install_cmd).to eq 'yard'
+    end
+
+    it "does not change back to yri if yard was specified" do
+      @config.send(:optparse, '--gem-install-yard', '--gem-install-yri')
+      expect(@config.gem_install_cmd).to eq 'yard'
+    end
+
+    it "ignores actual config options" do
+      run('--gem-install-yri', 'foo', 'true')
+      expect(YARD::Config).not_to receive(:save)
+    end
+
+    it "updates configuration as :gem if no configuration exists" do
+      run('--gem-install-yri')
+      expect(Gem.configuration[:gem]).to eq "--document=yri"
+      expect(Gem.configuration.written).to eq true
+    end
+
+    [:install, "install", :gem, "gem"].each do |type|
+      it "finds existing config in #{type.inspect} and updates that line without changing anything else" do
+        Gem.configuration[type] = "--opts x"
+        run('--gem-install-yri')
+        expect(Gem.configuration[type]).to eq "--opts x --document=yri"
+        ([:install, "install", :gem, "gem"] - [type]).each do |other|
+          expect(Gem.configuration[other]).to eq nil
+        end
+      end
+    end
+
+    it "scrubs --document values from existing config" do
+      Gem.configuration["gem"] = "--document=yri,ri --no-document --opts x"
+      run('--gem-install-yri')
+      expect(Gem.configuration["gem"]).to eq "--opts x --document=yri"
+    end
+  end
+end