yard 0.9.23 → 0.9.27

data/spec/cli/diff_spec.rb

@@ -1,254 +0,0 @@
-# frozen_string_literal: true
-require 'stringio'
-require 'open-uri'
-
-RSpec.describe YARD::CLI::Diff do
-  before do
-    allow(CLI::Yardoc).to receive(:run)
-    allow(CLI::Gems).to receive(:run)
-    @diff = CLI::Diff.new
-  end
-
-  describe "Argument handling" do
-    it "exits if there is only one gem name" do
-      expect(@diff).to receive(:exit)
-      expect(log).to receive(:puts).with(/Usage/)
-      @diff.run
-    end
-  end
-
-  describe "Diffing" do
-    before do
-      @objects1 = nil
-      @objects2 = nil
-    end
-
-    def run(*args)
-      @all_call = -1
-      @data = StringIO.new
-      @objects1 ||= %w(C#fooey C#baz D.bar)
-      @objects2 ||= %w(A A::B A::B::C A.foo A#foo B C.foo C.bar C#baz)
-      @objects = [@objects1, @objects2]
-      expect(@diff).to receive(:load_gem_data).ordered.with('gem1') do
-        Registry.clear
-        YARD.parse_string <<-eof
-          class C
-            def fooey; end
-            def baz; FOO end
-          end
-          class D
-            def self.bar; end
-          end
-        eof
-      end
-      expect(@diff).to receive(:load_gem_data).ordered.with('gem2') do
-        Registry.clear
-        YARD.parse_string <<-eof
-          module A
-            module B
-              class C; end
-            end
-            def self.foo; end
-            def foo; end
-          end
-          class C
-            def self.foo; end
-            def self.bar; end
-            def baz; BAR end
-          end
-        eof
-      end
-      allow(log).to receive(:print) {|data| @data << data }
-      allow(log).to receive(:puts) {|*pargs| @data << pargs.join("\n"); @data << "\n" }
-      @diff.run(*(args + ['gem1', 'gem2']))
-    end
-
-    it "shows differences between objects" do
-      run
-      expect(@data.string).to eq <<-eof
-Added objects:
-
-  A ((stdin):1) (...)
-  A::B::C ((stdin):3)
-  C.bar ((stdin):10)
-  C.foo ((stdin):9)
-
-Modified objects:
-
-  C#baz ((stdin):3)
-
-Removed objects:
-
-  C#fooey ((stdin):2)
-  D ((stdin):5) (...)
-
-eof
-    end
-
-    it "accepts --compact" do
-      run('--compact')
-      expect(@data.string).to eq <<-eof
-A A ((stdin):1) (...)
-A A::B::C ((stdin):3)
-A C.bar ((stdin):10)
-A C.foo ((stdin):9)
-M C#baz ((stdin):3)
-D C#fooey ((stdin):2)
-D D ((stdin):5) (...)
-eof
-    end
-
-    it "accepts -a/--all" do
-      ['-a', '--all'].each do |opt|
-        run(opt)
-        expect(@data.string).to eq <<-eof
-Added objects:
-
-  A ((stdin):1)
-  A#foo ((stdin):6)
-  A.foo ((stdin):5)
-  A::B ((stdin):2)
-  A::B::C ((stdin):3)
-  C.bar ((stdin):10)
-  C.foo ((stdin):9)
-
-Modified objects:
-
-  C#baz ((stdin):3)
-
-Removed objects:
-
-  C#fooey ((stdin):2)
-  D ((stdin):5)
-  D.bar ((stdin):6)
-
-eof
-      end
-    end
-
-    it "accepts --compact and --all" do
-      run('--compact', '--all')
-      expect(@data.string).to eq <<-eof
-A A ((stdin):1)
-A A#foo ((stdin):6)
-A A.foo ((stdin):5)
-A A::B ((stdin):2)
-A A::B::C ((stdin):3)
-A C.bar ((stdin):10)
-A C.foo ((stdin):9)
-M C#baz ((stdin):3)
-D C#fooey ((stdin):2)
-D D ((stdin):5)
-D D.bar ((stdin):6)
-eof
-    end
-
-    it "accepts --no-modified" do
-      run('--compact', '--no-modified')
-      expect(@data.string).to eq <<-eof
-A A ((stdin):1) (...)
-A A::B::C ((stdin):3)
-A C.bar ((stdin):10)
-A C.foo ((stdin):9)
-D C#fooey ((stdin):2)
-D D ((stdin):5) (...)
-eof
-    end
-
-    it "accepts --query" do
-      run('--compact', '--query', 'o.type == :method')
-      expect(@data.string).to eq <<-eof
-A A#foo ((stdin):6)
-A A.foo ((stdin):5)
-A C.bar ((stdin):10)
-A C.foo ((stdin):9)
-M C#baz ((stdin):3)
-D C#fooey ((stdin):2)
-D D.bar ((stdin):6)
-eof
-    end
-  end
-
-  describe "File searching" do
-    before do
-      allow(@diff).to receive(:generate_yardoc)
-    end
-
-    it "searches for gem/.yardoc" do
-      expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(true)
-      expect(File).to receive(:directory?).with('gem2/.yardoc').and_return(true)
-      expect(Registry).to receive(:load_yardoc).with('gem1/.yardoc')
-      expect(Registry).to receive(:load_yardoc).with('gem2/.yardoc')
-      @diff.run('gem1', 'gem2')
-    end
-
-    it "searches for argument as yardoc" do
-      expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem2/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem1').and_return(true)
-      expect(File).to receive(:directory?).with('gem2').and_return(true)
-      expect(Registry).to receive(:load_yardoc).with('gem1')
-      expect(Registry).to receive(:load_yardoc).with('gem2')
-      @diff.run('gem1', 'gem2')
-    end
-
-    it "searches for installed gem" do
-      expect(File).to receive(:directory?).with('gem1-1.0.0.gem/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem2-1.0.0/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem1-1.0.0.gem').and_return(false)
-      expect(File).to receive(:directory?).with('gem2-1.0.0').and_return(false)
-      spec1   = double(:spec)
-      spec2   = double(:spec)
-      allow(YARD::GemIndex).to receive(:each) {|&b| [spec1, spec2].each(&b) }
-      allow(spec1).to receive(:full_name).and_return('gem1-1.0.0')
-      allow(spec1).to receive(:name).and_return('gem1')
-      allow(spec1).to receive(:version).and_return('1.0.0')
-      allow(spec2).to receive(:full_name).and_return('gem2-1.0.0')
-      allow(spec2).to receive(:name).and_return('gem2')
-      allow(spec2).to receive(:version).and_return('1.0.0')
-      expect(Registry).to receive(:yardoc_file_for_gem).with('gem1', '= 1.0.0').and_return('/path/to/file')
-      expect(Registry).to receive(:yardoc_file_for_gem).with('gem2', '= 1.0.0').and_return(nil)
-      expect(Registry).to receive(:load_yardoc).with('/path/to/file')
-      expect(CLI::Gems).to receive(:run).with('gem2', '1.0.0').and_return(nil)
-      allow(Dir).to receive(:chdir)
-      @diff.run('gem1-1.0.0.gem', 'gem2-1.0.0')
-    end
-
-    it "searches for .gem file" do
-      expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem1').and_return(false)
-      expect(File).to receive(:directory?).with('gem2.gem').and_return(false)
-      expect(File).to receive(:exist?).with('gem1.gem').and_return(true)
-      expect(File).to receive(:exist?).with('gem2.gem').and_return(true)
-      expect(File).to receive(:open).with('gem1.gem', 'rb')
-      expect(File).to receive(:open).with('gem2.gem', 'rb')
-      allow(FileUtils).to receive(:mkdir_p)
-      allow(Gem::Package).to receive(:open)
-      allow(FileUtils).to receive(:rm_rf)
-      @diff.run('gem1', 'gem2.gem')
-    end
-
-    it "searches for .gem file on rubygems.org" do
-      expect(File).to receive(:directory?).with('gem1/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
-      expect(File).to receive(:directory?).with('gem1').and_return(false)
-      expect(File).to receive(:directory?).with('gem2.gem').and_return(false)
-      expect(File).to receive(:exist?).with('gem1.gem').and_return(false)
-      expect(File).to receive(:exist?).with('gem2.gem').and_return(false)
-      expect(@diff).to receive(:open).with('http://rubygems.org/downloads/gem1.gem')
-      expect(@diff).to receive(:open).with('http://rubygems.org/downloads/gem2.gem')
-      allow(FileUtils).to receive(:mkdir_p)
-      allow(Gem::Package).to receive(:open)
-      allow(FileUtils).to receive(:rm_rf)
-      @diff.run('gem1', 'gem2.gem')
-    end
-
-    it "raises an error if gem is not found" do
-      expect(log).to receive(:error).with("Cannot find gem gem1")
-      expect(log).to receive(:error).with("Cannot find gem gem2.gem")
-      allow(@diff).to receive(:load_gem_data).and_return(false)
-      @diff.run('gem1', 'gem2.gem')
-    end
-  end
-end

data/spec/cli/display_spec.rb

@@ -1,30 +0,0 @@
-# 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 +0,0 @@
-# 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 +0,0 @@
-# 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 +0,0 @@
-# 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 +0,0 @@
-# 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

data/spec/cli/list_spec.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::List do
-  it "passes command off to Yardoc with --list" do
-    expect(YARD::CLI::Yardoc).to receive(:run).with('-c', '--list', '--foo')
-    YARD::CLI::List.run('--foo')
-  end
-end

data/spec/cli/markup_types_spec.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::MarkupTypes do
-  it "lists all available markup types" do
-    YARD::CLI::MarkupTypes.run
-    data = log.io.string
-    exts = YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS
-    YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS.each do |name, providers|
-      expect(data).to match(/\b#{name}\b/)
-
-      # Match all extensions
-      exts[name].each do |ext|
-        expect(data).to include(".#{ext}")
-      end if exts[name]
-
-      # Match all provider libs
-      providers.each do |provider|
-        expect(data).to match(/\b#{provider[:lib]}\b/)
-      end
-    end
-  end
-end