yard 0.9.16 → 0.9.17

data/spec/cli/display_spec.rb

@@ -1,30 +1,30 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::Display do
-  before do
-    allow(Registry).to receive(:load)
-    @object = CodeObjects::ClassObject.new(:root, :Foo)
-    @object.docstring = 'Foo bar'
-  end
-
-  it "displays an object" do
-    YARD::CLI::Display.run('-f', 'text', 'Foo')
-    expect(log.io.string.strip).to eq(@object.format.strip)
-  end
-
-  it "wraps output with -l (defaulting to layout)" do
-    YARD::CLI::Display.run('-l', '-f', 'html', 'Foo')
-    formatted_output = @object.format(:format => :html).strip
-    actual_output = log.io.string.strip
-    expect(actual_output).not_to eq(formatted_output)
-    expect(actual_output).to include(formatted_output)
-  end
-
-  it "wraps output with --layout onefile" do
-    YARD::CLI::Display.run('--layout', 'onefile', '-f', 'html', 'Foo')
-    formatted_output = @object.format(:format => :html).strip
-    actual_output = log.io.string.strip
-    expect(actual_output).not_to eq(formatted_output)
-    expect(actual_output).to include(formatted_output)
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::CLI::Display do
+  before do
+    allow(Registry).to receive(:load)
+    @object = CodeObjects::ClassObject.new(:root, :Foo)
+    @object.docstring = 'Foo bar'
+  end
+
+  it "displays an object" do
+    YARD::CLI::Display.run('-f', 'text', 'Foo')
+    expect(log.io.string.strip).to eq(@object.format.strip)
+  end
+
+  it "wraps output with -l (defaulting to layout)" do
+    YARD::CLI::Display.run('-l', '-f', 'html', 'Foo')
+    formatted_output = @object.format(:format => :html).strip
+    actual_output = log.io.string.strip
+    expect(actual_output).not_to eq(formatted_output)
+    expect(actual_output).to include(formatted_output)
+  end
+
+  it "wraps output with --layout onefile" do
+    YARD::CLI::Display.run('--layout', 'onefile', '-f', 'html', 'Foo')
+    formatted_output = @object.format(:format => :html).strip
+    actual_output = log.io.string.strip
+    expect(actual_output).not_to eq(formatted_output)
+    expect(actual_output).to include(formatted_output)
+  end
+end

data/spec/cli/gems_spec.rb

@@ -1,81 +1,81 @@
-# frozen_string_literal: true
-require 'ostruct'
-require 'rubygems'
-
-RSpec.describe YARD::CLI::Gems do
-  before do
-    @rebuild = false
-    @gem1 = build_mock('gem1')
-    @gem2 = build_mock('gem2')
-    @gem3 = build_mock('gem3')
-  end
-
-  def build_mock(name, version = '1.0')
-    OpenStruct.new  :name => name,
-                    :version => version,
-                    :full_gem_path => "/path/to/gems/#{name}-#{version}",
-                    :yardoc_file => "/path/to/yardoc/#{name}-#{version}"
-  end
-
-  def build_specs(*specs)
-    specs.each do |themock|
-      allow(Registry).to receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}").and_return(themock.yardoc_file)
-      allow(File).to receive(:directory?).with(themock.yardoc_file).and_return(@rebuild)
-      allow(File).to receive(:directory?).with(themock.full_gem_path).and_return(true)
-      allow(Registry).to receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}", true).and_return(themock.yardoc_file)
-      expect(Dir).to receive(:chdir).with(themock.full_gem_path).and_yield
-    end
-    expect(Registry).to receive(:clear).exactly(specs.size).times
-    expect(CLI::Yardoc).to receive(:run).exactly(specs.size).times
-  end
-
-  describe "#run" do
-    it "builds all gem indexes if no gem is specified" do
-      build_specs(@gem1, @gem2)
-      expect(YARD::GemIndex).to receive(:each) {|&b| [@gem1, @gem2].each(&b) }
-      CLI::Gems.run
-    end
-
-    it "allows gem to be specified" do
-      build_specs(@gem1)
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 0').and_return([@gem1])
-      CLI::Gems.run(@gem1.name)
-    end
-
-    it "allows multiple gems to be specified for building" do
-      build_specs(@gem1, @gem2)
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, @gem1.version).and_return([@gem1])
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
-      CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
-    end
-
-    it "allows version to be specified with gem" do
-      build_specs(@gem1)
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
-      CLI::Gems.run(@gem1.name, '>= 1.0')
-    end
-
-    it "warns if one of the gems is not found, but it should process others" do
-      build_specs(@gem2)
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
-      expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
-      CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
-    end
-
-    it "fails if specified gem(s) is/are not found" do
-      expect(CLI::Yardoc).not_to receive(:run)
-      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
-      expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
-      expect(log).to receive(:error).with(/No specified gems could be found/)
-      CLI::Gems.run(@gem1.name, '>= 2.0')
-    end
-
-    it "accepts --rebuild" do
-      @rebuild = true
-      build_specs(@gem1)
-      expect(YARD::GemIndex).to receive(:each) {|&b| [@gem1].each(&b) }
-      CLI::Gems.run('--rebuild')
-    end
-  end
-end
+# frozen_string_literal: true
+require 'ostruct'
+require 'rubygems'
+
+RSpec.describe YARD::CLI::Gems do
+  before do
+    @rebuild = false
+    @gem1 = build_mock('gem1')
+    @gem2 = build_mock('gem2')
+    @gem3 = build_mock('gem3')
+  end
+
+  def build_mock(name, version = '1.0')
+    OpenStruct.new  :name => name,
+                    :version => version,
+                    :full_gem_path => "/path/to/gems/#{name}-#{version}",
+                    :yardoc_file => "/path/to/yardoc/#{name}-#{version}"
+  end
+
+  def build_specs(*specs)
+    specs.each do |themock|
+      allow(Registry).to receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}").and_return(themock.yardoc_file)
+      allow(File).to receive(:directory?).with(themock.yardoc_file).and_return(@rebuild)
+      allow(File).to receive(:directory?).with(themock.full_gem_path).and_return(true)
+      allow(Registry).to receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}", true).and_return(themock.yardoc_file)
+      expect(Dir).to receive(:chdir).with(themock.full_gem_path).and_yield
+    end
+    expect(Registry).to receive(:clear).exactly(specs.size).times
+    expect(CLI::Yardoc).to receive(:run).exactly(specs.size).times
+  end
+
+  describe "#run" do
+    it "builds all gem indexes if no gem is specified" do
+      build_specs(@gem1, @gem2)
+      expect(YARD::GemIndex).to receive(:each) {|&b| [@gem1, @gem2].each(&b) }
+      CLI::Gems.run
+    end
+
+    it "allows gem to be specified" do
+      build_specs(@gem1)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 0').and_return([@gem1])
+      CLI::Gems.run(@gem1.name)
+    end
+
+    it "allows multiple gems to be specified for building" do
+      build_specs(@gem1, @gem2)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, @gem1.version).and_return([@gem1])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
+      CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
+    end
+
+    it "allows version to be specified with gem" do
+      build_specs(@gem1)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
+      CLI::Gems.run(@gem1.name, '>= 1.0')
+    end
+
+    it "warns if one of the gems is not found, but it should process others" do
+      build_specs(@gem2)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
+      expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
+      CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
+    end
+
+    it "fails if specified gem(s) is/are not found" do
+      expect(CLI::Yardoc).not_to receive(:run)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
+      expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
+      expect(log).to receive(:error).with(/No specified gems could be found/)
+      CLI::Gems.run(@gem1.name, '>= 2.0')
+    end
+
+    it "accepts --rebuild" do
+      @rebuild = true
+      build_specs(@gem1)
+      expect(YARD::GemIndex).to receive(:each) {|&b| [@gem1].each(&b) }
+      CLI::Gems.run('--rebuild')
+    end
+  end
+end

data/spec/cli/graph_spec.rb

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::Graph do
-  it "serializes output" do
-    allow(Registry).to receive(:load).at_least(1).times
-    allow(subject).to receive(:yardopts) { [] }
-    expect(subject.options.serializer).to receive(:serialize).once
-    subject.run
-  end
-
-  it "reads yardoc file from .yardopts" do
-    allow(Registry).to receive(:load).at_least(1).times
-    allow(subject).to receive(:yardopts) { %w(--db /path/to/db) }
-    expect(subject.options.serializer).to receive(:serialize).once
-    subject.run
-    expect(Registry.yardoc_file).to eq '/path/to/db'
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::CLI::Graph do
+  it "serializes output" do
+    allow(Registry).to receive(:load).at_least(1).times
+    allow(subject).to receive(:yardopts) { [] }
+    expect(subject.options.serializer).to receive(:serialize).once
+    subject.run
+  end
+
+  it "reads yardoc file from .yardopts" do
+    allow(Registry).to receive(:load).at_least(1).times
+    allow(subject).to receive(:yardopts) { %w(--db /path/to/db) }
+    expect(subject.options.serializer).to receive(:serialize).once
+    subject.run
+    expect(Registry.yardoc_file).to eq '/path/to/db'
+  end
+end

data/spec/cli/help_spec.rb

@@ -1,22 +1,22 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::Help do
-  describe "#run" do
-    it "accepts help command" do
-      expect(CLI::Yardoc).to receive(:run).with('--help')
-      CLI::Help.run('doc')
-    end
-
-    it "accepts no arguments (and lists all commands)" do
-      expect(CLI::CommandParser).to receive(:run).with('--help')
-      CLI::Help.run
-    end
-
-    it "shows all commands if command isn't found" do
-      expect(CLI::CommandParser).to receive(:run).with('--help')
-      help = CLI::Help.new
-      expect(log).to receive(:puts).with(/not found/)
-      help.run('unknown')
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::CLI::Help do
+  describe "#run" do
+    it "accepts help command" do
+      expect(CLI::Yardoc).to receive(:run).with('--help')
+      CLI::Help.run('doc')
+    end
+
+    it "accepts no arguments (and lists all commands)" do
+      expect(CLI::CommandParser).to receive(:run).with('--help')
+      CLI::Help.run
+    end
+
+    it "shows all commands if command isn't found" do
+      expect(CLI::CommandParser).to receive(:run).with('--help')
+      help = CLI::Help.new
+      expect(log).to receive(:puts).with(/not found/)
+      help.run('unknown')
+    end
+  end
+end

data/spec/cli/i18n_spec.rb

@@ -1,107 +1,107 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::I18n do
-  before do
-    @i18n = YARD::CLI::I18n.new
-    @i18n.use_document_file = false
-    @i18n.use_yardopts_file = false
-    output_path = File.expand_path(@i18n.options.serializer.basepath)
-    allow(File).to receive(:open!).with(output_path, "wb")
-    allow(YARD).to receive(:parse)
-  end
-
-  describe "Defaults" do
-    before do
-      @i18n = YARD::CLI::I18n.new
-      allow(@i18n).to receive(:yardopts).and_return([])
-      allow(@i18n).to receive(:support_rdoc_document_file!).and_return([])
-      @i18n.parse_arguments
-    end
-
-    it "reads .yardopts by default" do
-      expect(@i18n.use_yardopts_file).to be true
-    end
-
-    it "only shows public visibility by default" do
-      expect(@i18n.visibilities).to eq [:public]
-    end
-  end
-
-  describe "General options" do
-    def self.should_accept(*args, &block)
-      @counter ||= 0
-      @counter += 1
-      counter = @counter
-      args.each do |arg|
-        define_method("test_options_#{@counter}", &block)
-        it("accepts #{arg}") { send("test_options_#{counter}", arg) }
-      end
-    end
-
-    should_accept('--yardopts') do |arg|
-      @i18n = YARD::CLI::I18n.new
-      @i18n.use_document_file = false
-      expect(@i18n).to receive(:yardopts).at_least(1).times.and_return([])
-      @i18n.parse_arguments(arg)
-      expect(@i18n.use_yardopts_file).to be true
-      @i18n.parse_arguments('--no-yardopts', arg)
-      expect(@i18n.use_yardopts_file).to be true
-    end
-
-    should_accept('--yardopts with filename') do |_arg|
-      @i18n = YARD::CLI::I18n.new
-      expect(File).to receive(:read_binary).with('.yardopts_i18n').and_return('')
-      @i18n.use_document_file = false
-      @i18n.parse_arguments('--yardopts', '.yardopts_i18n')
-      expect(@i18n.use_yardopts_file).to be true
-      expect(@i18n.options_file).to eq '.yardopts_i18n'
-    end
-
-    should_accept('--no-yardopts') do |arg|
-      @i18n = YARD::CLI::I18n.new
-      @i18n.use_document_file = false
-      expect(@i18n).not_to receive(:yardopts)
-      @i18n.parse_arguments(arg)
-      expect(@i18n.use_yardopts_file).to be false
-      @i18n.parse_arguments('--yardopts', arg)
-      expect(@i18n.use_yardopts_file).to be false
-    end
-
-    should_accept('--exclude') do |arg|
-      expect(YARD).to receive(:parse).with(['a'], ['nota', 'b'])
-      @i18n.run(arg, 'nota', arg, 'b', 'a')
-    end
-  end
-
-  describe ".yardopts handling" do
-    before do
-      @i18n.use_yardopts_file = true
-    end
-
-    it "searches for and uses yardopts file specified by #options_file" do
-      expect(File).to receive(:read_binary).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
-      @i18n.use_document_file = false
-      @i18n.options_file = "test"
-      expect(File).to receive(:open!).with(File.expand_path("MYPATH"), "wb")
-      @i18n.run
-      expect(@i18n.files).to eq ["FILE1", "FILE2"]
-    end
-  end
-
-  describe "#run" do
-    it "calls parse_arguments if run() is called" do
-      expect(@i18n).to receive(:parse_arguments)
-      @i18n.run
-    end
-
-    it "calls parse_arguments if run(arg1, arg2, ...) is called" do
-      expect(@i18n).to receive(:parse_arguments)
-      @i18n.run('--private', '-p', 'foo')
-    end
-
-    it "doesn't call parse_arguments if run(nil) is called" do
-      expect(@i18n).not_to receive(:parse_arguments)
-      @i18n.run(nil)
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::CLI::I18n do
+  before do
+    @i18n = YARD::CLI::I18n.new
+    @i18n.use_document_file = false
+    @i18n.use_yardopts_file = false
+    output_path = File.expand_path(@i18n.options.serializer.basepath)
+    allow(File).to receive(:open!).with(output_path, "wb")
+    allow(YARD).to receive(:parse)
+  end
+
+  describe "Defaults" do
+    before do
+      @i18n = YARD::CLI::I18n.new
+      allow(@i18n).to receive(:yardopts).and_return([])
+      allow(@i18n).to receive(:support_rdoc_document_file!).and_return([])
+      @i18n.parse_arguments
+    end
+
+    it "reads .yardopts by default" do
+      expect(@i18n.use_yardopts_file).to be true
+    end
+
+    it "only shows public visibility by default" do
+      expect(@i18n.visibilities).to eq [:public]
+    end
+  end
+
+  describe "General options" do
+    def self.should_accept(*args, &block)
+      @counter ||= 0
+      @counter += 1
+      counter = @counter
+      args.each do |arg|
+        define_method("test_options_#{@counter}", &block)
+        it("accepts #{arg}") { send("test_options_#{counter}", arg) }
+      end
+    end
+
+    should_accept('--yardopts') do |arg|
+      @i18n = YARD::CLI::I18n.new
+      @i18n.use_document_file = false
+      expect(@i18n).to receive(:yardopts).at_least(1).times.and_return([])
+      @i18n.parse_arguments(arg)
+      expect(@i18n.use_yardopts_file).to be true
+      @i18n.parse_arguments('--no-yardopts', arg)
+      expect(@i18n.use_yardopts_file).to be true
+    end
+
+    should_accept('--yardopts with filename') do |_arg|
+      @i18n = YARD::CLI::I18n.new
+      expect(File).to receive(:read_binary).with('.yardopts_i18n').and_return('')
+      @i18n.use_document_file = false
+      @i18n.parse_arguments('--yardopts', '.yardopts_i18n')
+      expect(@i18n.use_yardopts_file).to be true
+      expect(@i18n.options_file).to eq '.yardopts_i18n'
+    end
+
+    should_accept('--no-yardopts') do |arg|
+      @i18n = YARD::CLI::I18n.new
+      @i18n.use_document_file = false
+      expect(@i18n).not_to receive(:yardopts)
+      @i18n.parse_arguments(arg)
+      expect(@i18n.use_yardopts_file).to be false
+      @i18n.parse_arguments('--yardopts', arg)
+      expect(@i18n.use_yardopts_file).to be false
+    end
+
+    should_accept('--exclude') do |arg|
+      expect(YARD).to receive(:parse).with(['a'], ['nota', 'b'])
+      @i18n.run(arg, 'nota', arg, 'b', 'a')
+    end
+  end
+
+  describe ".yardopts handling" do
+    before do
+      @i18n.use_yardopts_file = true
+    end
+
+    it "searches for and uses yardopts file specified by #options_file" do
+      expect(File).to receive(:read_binary).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
+      @i18n.use_document_file = false
+      @i18n.options_file = "test"
+      expect(File).to receive(:open!).with(File.expand_path("MYPATH"), "wb")
+      @i18n.run
+      expect(@i18n.files).to eq ["FILE1", "FILE2"]
+    end
+  end
+
+  describe "#run" do
+    it "calls parse_arguments if run() is called" do
+      expect(@i18n).to receive(:parse_arguments)
+      @i18n.run
+    end
+
+    it "calls parse_arguments if run(arg1, arg2, ...) is called" do
+      expect(@i18n).to receive(:parse_arguments)
+      @i18n.run('--private', '-p', 'foo')
+    end
+
+    it "doesn't call parse_arguments if run(nil) is called" do
+      expect(@i18n).not_to receive(:parse_arguments)
+      @i18n.run(nil)
+    end
+  end
+end