yard 0.7.5 → 0.8.0

data/spec/cli/command_parser_spec.rb

@@ -5,7 +5,7 @@ describe YARD::CLI::CommandParser do
     before do
       @cmd = CLI::CommandParser.new
     end
-    
+
     it "should show help if --help is provided" do
       command = mock(:command)
       command.should_receive(:run).with('--help')
@@ -13,7 +13,7 @@ describe YARD::CLI::CommandParser do
       @cmd.class.default_command = :foo
       @cmd.run *%w( foo --help )
     end
-    
+
     it "should use default command if first argument is a switch" do
       command = mock(:command)
       command.should_receive(:run).with('--a', 'b', 'c')
@@ -21,7 +21,7 @@ describe YARD::CLI::CommandParser do
       @cmd.class.default_command = :foo
       @cmd.run *%w( --a b c )
     end
-    
+
     it "should use default command if no arguments are provided" do
       command = mock(:command)
       command.should_receive(:run)
@@ -29,7 +29,7 @@ describe YARD::CLI::CommandParser do
       @cmd.class.default_command = :foo
       @cmd.run
     end
-    
+
     it "should list commands if command is not found" do
       @cmd.should_receive(:list_commands)
       @cmd.run *%w( unknown_command --args )

data/spec/cli/command_spec.rb

@@ -8,7 +8,7 @@ describe YARD::CLI::Command do
       @saw_foo = false
       @options.on('--foo') { @saw_foo = true }
     end
-    
+
     def parse(*args)
       CLI::Command.new.send(:parse_options, @options, args)
       args
@@ -20,13 +20,13 @@ describe YARD::CLI::Command do
       parse('--list', '--list2', '--foo')
       @saw_foo.should be_true
     end
-    
+
     it "should skip unrecognized options and any extra non-option arg that follows" do
       log.should_receive(:warn).with(/Unrecognized.*--list/)
       parse('--list', 'foo', '--foo')
       @saw_foo.should be_true
     end
-    
+
     it "should stop retrying to parse at non-switch argument" do
       log.should_receive(:warn).with(/Unrecognized.*--list/)
       args = parse('--list', 'foo', 'foo', 'foo')

data/spec/cli/config_spec.rb

@@ -8,11 +8,11 @@ describe YARD::CLI::Config do
     YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
     YARD::Config.stub!(:save)
   end
-  
+
   def run(*args)
     @config.run(*args)
   end
-  
+
   describe 'Listing configuration' do
     it "should accept --list" do
       opts = YARD::Config.options
@@ -23,7 +23,7 @@ describe YARD::CLI::Config do
       YARD::Config.options.should == opts
     end
   end
-  
+
   describe 'Viewing an item' do
     it "should view item if no value is given" do
       YARD::Config.options[:foo] = 'bar'
@@ -32,19 +32,19 @@ describe YARD::CLI::Config do
       YARD::Config.options[:foo].should == 'bar'
     end
   end
-  
+
   describe 'Modifying an item' do
     it "should accept --reset to set value" do
       YARD::Config.options[:load_plugins] = 'foo'
       run('--reset', 'load_plugins')
       YARD::Config.options[:load_plugins].should == false
     end
-    
+
     it "should accept --as-list to force single item as list" do
       run('--as-list', 'foo', 'bar')
       YARD::Config.options[:foo].should == ['bar']
     end
-    
+
     it "should accept --append to append values to existing key" do
       YARD::Config.options[:foo] = ['bar']
       run('--append', 'foo', 'baz', 'quux')
@@ -52,38 +52,38 @@ describe YARD::CLI::Config do
       run('-a', 'foo', 'last')
       YARD::Config.options[:foo].should == ['bar', 'baz', 'quux', 'last']
     end
-    
+
     it "should turn key into list if --append is used on single item" do
       YARD::Config.options[:foo] = 'bar'
       run('-a', 'foo', 'baz')
       YARD::Config.options[:foo].should == ['bar', 'baz']
     end
-    
+
     it "should modify item if value is given" do
       run('foo', 'xxx')
       YARD::Config.options[:foo].should == 'xxx'
     end
-    
+
     it "should turn list of values into array of values" do
       run('foo', 'a', 'b', '1', 'true', 'false')
       YARD::Config.options[:foo].should == ['a', 'b', 1, true, false]
     end
-    
+
     it "should turn number into numeric Ruby type" do
       run('foo', '1')
       YARD::Config.options[:foo].should == 1
     end
-    
+
     it "should turn true into TrueClass" do
       run('foo', 'true')
       YARD::Config.options[:foo].should == true
     end
-    
+
     it "should turn false into FalseClass" do
       run('foo', 'false')
       YARD::Config.options[:foo].should == false
     end
-    
+
     it "should save on modification" do
       YARD::Config.should_receive(:save)
       run('foo', 'true')

data/spec/cli/diff_spec.rb

@@ -8,7 +8,7 @@ describe YARD::CLI::Diff do
     CLI::Gems.stub!(:run)
     @diff = CLI::Diff.new
   end
-  
+
   describe 'Argument handling' do
     it "should exit if there is only one gem name" do
       @diff.should_receive(:exit)
@@ -16,7 +16,7 @@ describe YARD::CLI::Diff do
       @diff.run
     end
   end
-  
+
   describe 'Diffing' do
     before do
       @objects1 = nil
@@ -24,13 +24,16 @@ describe YARD::CLI::Diff do
     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]
       @diff.should_receive(:load_gem_data).ordered.with('gem1').and_return(true)
       @diff.should_receive(:load_gem_data).ordered.with('gem2').and_return(true)
-      Registry.should_receive(:all).ordered.and_return(@objects1.map {|o| P(o) })
-      Registry.should_receive(:all).ordered.and_return(@objects2.map {|o| P(o) })
+      Registry.should_receive(:all).twice.and_return do
+        @objects[@all_call += 1].map {|o| P(o) }
+      end
       @diff.stub!(:print) {|data| @data << data }
       @diff.stub!(:puts) {|*args| @data << args.join("\n"); @data << "\n" }
       @diff.run(*(args + ['gem1', 'gem2']))
@@ -78,12 +81,12 @@ eof
       end
     end
   end
-  
+
   describe 'File searching' do
     before do
       @diff.stub!(:generate_yardoc)
     end
-    
+
     it "should search for gem/.yardoc" do
       File.should_receive(:directory?).with('gem1/.yardoc').and_return(true)
       File.should_receive(:directory?).with('gem2/.yardoc').and_return(true)
@@ -91,7 +94,7 @@ eof
       Registry.should_receive(:load_yardoc).with('gem2/.yardoc')
       @diff.run('gem1', 'gem2')
     end
-    
+
     it "should search for argument as yardoc" do
       File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
       File.should_receive(:directory?).with('gem2/.yardoc').and_return(false)
@@ -125,7 +128,7 @@ eof
       Dir.stub!(:chdir)
       @diff.run('gem1-1.0.0.gem', 'gem2-1.0.0')
     end
-    
+
     it "should search for .gem file" do
       iomock = mock(:io)
       File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
@@ -143,7 +146,7 @@ eof
       FileUtils.should_receive(:rm_rf)
       @diff.run('gem1', 'gem2.gem')
     end
-    
+
     it "should search for .gem file on rubygems.org" do
       iomock = mock(:io)
       File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
@@ -161,7 +164,7 @@ eof
       FileUtils.should_receive(:rm_rf)
       @diff.run('gem1', 'gem2.gem')
     end
-    
+
     it "should error if gem is not found" do
       log.should_receive(:error).with("Cannot find gem gem1")
       log.should_receive(:error).with("Cannot find gem gem2.gem")

data/spec/cli/gems_spec.rb

@@ -9,14 +9,14 @@ describe YARD::CLI::Gems do
     @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}", 
+    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|
       Registry.should_receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}").and_return(themock.yardoc_file)
@@ -28,33 +28,33 @@ describe YARD::CLI::Gems do
     Registry.should_receive(:clear).exactly(specs.size).times
     CLI::Yardoc.should_receive(:run).exactly(specs.size).times
   end
-  
+
   describe '#run' do
     it "should build all gem indexes if no gem is specified" do
       build_specs(@gem1, @gem2)
       Gem.source_index.should_receive(:find_name).with('').and_return([@gem1, @gem2])
       CLI::Gems.run
     end
-    
+
     it "should allow gem to be specified" do
       build_specs(@gem1)
       Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 0').and_return([@gem1])
       CLI::Gems.run(@gem1.name)
     end
-    
+
     it "should allow multiple gems to be specified for building" do
       build_specs(@gem1, @gem2)
       Gem.source_index.should_receive(:find_name).with(@gem1.name, @gem1.version).and_return([@gem1])
       Gem.source_index.should_receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
       CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
     end
-    
+
     it "should allow version to be specified with gem" do
       build_specs(@gem1)
       Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
       CLI::Gems.run(@gem1.name, '>= 1.0')
     end
-    
+
     it "should warn if one of the gems is not found, but it should process others" do
       build_specs(@gem2)
       Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
@@ -62,7 +62,7 @@ describe YARD::CLI::Gems do
       log.should_receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
       CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
     end
-    
+
     it "should fail if specified gem(s) is/are not found" do
       CLI::Yardoc.should_not_receive(:run)
       Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
@@ -70,7 +70,7 @@ describe YARD::CLI::Gems do
       log.should_receive(:error).with(/No specified gems could be found/)
       CLI::Gems.run(@gem1.name, '>= 2.0')
     end
-    
+
     it "should accept --rebuild" do
       @rebuild = true
       build_specs(@gem1)

data/spec/cli/help_spec.rb

@@ -6,12 +6,12 @@ describe YARD::CLI::Help do
       CLI::Yardoc.should_receive(:run).with('--help')
       CLI::Help.run('doc')
     end
-    
+
     it "should accept no arguments (lists all commands)" do
       CLI::CommandParser.should_receive(:run).with('--help')
       CLI::Help.run
     end
-    
+
     it "should show all commands if command isn't found" do
       CLI::CommandParser.should_receive(:run).with('--help')
       help = CLI::Help.new

data/spec/cli/i18n_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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)
+    File.stub!(:open!).with(output_path, "wb")
+    YARD.stub!(:parse)
+  end
+
+  describe 'Defaults' do
+    before do
+      @i18n = YARD::CLI::I18n.new
+      @i18n.stub!(:yardopts).and_return([])
+      @i18n.stub!(:support_rdoc_document_file!).and_return([])
+      @i18n.parse_arguments
+    end
+
+    it "should read .yardopts by default" do
+      @i18n.use_yardopts_file.should == true
+    end
+
+    it "should use {lib,app}/**/*.rb and ext/**/*.c as default file glob" do
+      @i18n.files.should == ['{lib,app}/**/*.rb', 'ext/**/*.c']
+    end
+
+    it "should only show public visibility by default" do
+      @i18n.visibilities.should == [: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("should accept #{arg}") { send("test_options_#{counter}", arg) }
+      end
+    end
+
+    should_accept('--yardopts') do |arg|
+      @i18n = YARD::CLI::I18n.new
+      @i18n.use_document_file = false
+      @i18n.should_receive(:yardopts).at_least(1).times.and_return([])
+      @i18n.parse_arguments(arg)
+      @i18n.use_yardopts_file.should == true
+      @i18n.parse_arguments('--no-yardopts', arg)
+      @i18n.use_yardopts_file.should == true
+    end
+
+    should_accept('--yardopts with filename') do |arg|
+      @i18n = YARD::CLI::I18n.new
+      File.should_receive(:read_binary).with('.yardopts_i18n').and_return('')
+      @i18n.use_document_file = false
+      @i18n.parse_arguments('--yardopts', '.yardopts_i18n')
+      @i18n.use_yardopts_file.should == true
+      @i18n.options_file.should == '.yardopts_i18n'
+    end
+
+    should_accept('--no-yardopts') do |arg|
+      @i18n = YARD::CLI::I18n.new
+      @i18n.use_document_file = false
+      @i18n.should_not_receive(:yardopts)
+      @i18n.parse_arguments(arg)
+      @i18n.use_yardopts_file.should == false
+      @i18n.parse_arguments('--yardopts', arg)
+      @i18n.use_yardopts_file.should == false
+    end
+
+    should_accept('--exclude') do |arg|
+      YARD.should_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 "should search for and use yardopts file specified by #options_file" do
+      File.should_receive(:read_binary).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
+      @i18n.use_document_file = false
+      @i18n.options_file = "test"
+      File.should_receive(:open!).with(File.expand_path("MYPATH"), "wb")
+      @i18n.run
+      @i18n.files.should == ["FILE1", "FILE2"]
+    end
+  end
+
+  describe '#run' do
+    it "should parse_arguments if run() is called" do
+      @i18n.should_receive(:parse_arguments)
+      @i18n.run
+    end
+
+    it "should parse_arguments if run(arg1, arg2, ...) is called" do
+      @i18n.should_receive(:parse_arguments)
+      @i18n.run('--private', '-p', 'foo')
+    end
+
+    it "should not parse_arguments if run(nil) is called" do
+      @i18n.should_not_receive(:parse_arguments)
+      @i18n.run(nil)
+    end
+  end
+end

data/spec/cli/server_spec.rb

@@ -13,15 +13,19 @@ describe YARD::CLI::Server do
     @adapter.stub!(:setup)
     @cli = YARD::CLI::Server.new
   end
-  
+
   def rack_required
     begin; require 'rack'; rescue LoadError; pending "rack required for this test" end
   end
-  
+
+  def bundler_required
+    begin; require 'bundler'; rescue LoadError; pending "bundler required for this test" end
+  end
+
   def unstub_adapter
     @no_adapter_mock = true
   end
-  
+
   def run(*args)
     if @libraries.empty?
       library = Server::LibraryVersion.new(File.basename(Dir.pwd), nil, File.expand_path('.yardoc'))
@@ -36,6 +40,7 @@ describe YARD::CLI::Server do
       @adapter.should_receive(:start)
     end
     @cli.run(*args.flatten)
+    @cli = YARD::CLI::Server.new
   end
 
   it "should default to current dir if no library is specified" do
@@ -43,65 +48,65 @@ describe YARD::CLI::Server do
     @libraries['foo'] = [Server::LibraryVersion.new('foo', nil, File.expand_path('.yardoc'))]
     run
   end
-  
+
   it "should use .yardoc as yardoc file is library list is odd" do
     @libraries['a'] = [Server::LibraryVersion.new('a', nil, File.expand_path('.yardoc'))]
     run 'a'
   end
-  
+
   it "should force multi library if more than one library is listed" do
     @options[:single_library] = false
     @libraries['a'] = [Server::LibraryVersion.new('a', nil, File.expand_path('b'))]
     @libraries['c'] = [Server::LibraryVersion.new('c', nil, File.expand_path('.yardoc'))]
     run %w(a b c)
   end
-  
+
   it "should accept -m, --multi-library" do
     @options[:single_library] = false
     run '-m'
     run '--multi-library'
   end
-  
+
   it "should accept -c, --cache" do
     @options[:caching] = true
     run '-c'
     run '--cache'
   end
-  
+
   it "should accept -r, --reload" do
     @options[:incremental] = true
     run '-r'
     run '--reload'
   end
-  
+
   it "should accept -d, --daemon" do
     @server_options[:daemonize] = true
     run '-d'
     run '--daemon'
   end
-  
+
   it "should accept -p, --port" do
     @server_options[:Port] = 10
     run '-p', '10'
     run '--port', '10'
   end
-  
+
   it "should accept --docroot" do
     @server_options[:DocumentRoot] = Dir.pwd + '/__foo/bar'
     run '--docroot', '__foo/bar'
   end
-  
+
   it "should accept -a webrick to create WEBrick adapter" do
     @cli.should_receive(:adapter=).with(YARD::Server::WebrickAdapter)
     run '-a', 'webrick'
   end
-  
+
   it "should accept -a rack to create Rack adapter" do
     rack_required
     @cli.should_receive(:adapter=).with(YARD::Server::RackAdapter)
     run '-a', 'rack'
   end
-  
+
   it "should default to Rack adapter if exists on system" do
     rack_required
     @cli.should_receive(:require).with('rubygems').and_return(false)
@@ -116,13 +121,13 @@ describe YARD::CLI::Server do
     @cli.should_receive(:adapter=).with(YARD::Server::WebrickAdapter)
     @cli.send(:select_adapter)
   end
-  
+
   it "should accept -s, --server" do
     @server_options[:server] = 'thin'
     run '-s', 'thin'
     run '--server', 'thin'
   end
-  
+
   it "should accept -g, --gems" do
     @no_verify_libraries = true
     @options[:single_library] = false
@@ -145,14 +150,57 @@ describe YARD::CLI::Server do
     run '-g'
     run '--gems'
   end
-  
+
+  it "should accept -G, --gemfile" do
+    bundler_required
+    @no_verify_libraries = true
+    @options[:single_library] = false
+
+    @libraries['gem1'] = [Server::LibraryVersion.new('gem1', '1.0.0', nil, :gem)]
+    @libraries['gem2'] = [Server::LibraryVersion.new('gem2', '1.0.0', nil, :gem)]
+    gem1 = mock(:gem1)
+    gem1.stub!(:name).and_return('gem1')
+    gem1.stub!(:version).and_return('1.0.0')
+    gem1.stub!(:full_gem_path).and_return('/path/to/foo')
+    gem2 = mock(:gem2)
+    gem2.stub!(:name).and_return('gem2')
+    gem2.stub!(:version).and_return('1.0.0')
+    gem2.stub!(:full_gem_path).and_return('/path/to/bar')
+    specs = {'gem1' => gem1, 'gem2' => gem2}
+    lockfile_parser = mock(:new)
+    lockfile_parser.stub!(:specs).and_return([gem1, gem2])
+    Bundler::LockfileParser.stub!(:new).and_return(lockfile_parser)
+
+    File.should_receive(:exists?).at_least(2).times.with("Gemfile.lock").and_return(true)
+    File.stub!(:read)
+
+    run '-G'
+    run '--gemfile'
+
+    File.should_receive(:exists?).with("different_name.lock").and_return(true)
+    run '--gemfile', 'different_name'
+  end
+
+  it "should warn if lockfile is not found (with -G)" do
+    bundler_required
+    File.should_receive(:exists?).with('somefile.lock').and_return(false)
+    log.should_receive(:warn).with(/Cannot find somefile.lock/)
+    run '-G', 'somefile'
+  end
+
+  it "should error if Bundler not available (with -G)" do
+    @cli.should_receive(:require).with('bundler').and_raise(LoadError)
+    log.should_receive(:error).with(/Bundler not available/)
+    run '-G'
+  end
+
   it "should load template paths after adapter template paths" do
     unstub_adapter
     @cli.adapter = Server::WebrickAdapter
     run '-t', 'foo'
     Templates::Engine.template_paths.last.should == 'foo'
   end
-  
+
   it "should load ruby code (-e) after adapter" do
     unstub_adapter
     @cli.adapter = Server::WebrickAdapter