yard 0.8.2.1 → 0.8.3

data/spec/cli/stats_spec.rb

@@ -28,7 +28,7 @@ describe YARD::CLI::Stats do
     @stats = CLI::Stats.new(false)
     @stats.stub!(:support_rdoc_document_file!).and_return([])
     @stats.stub!(:yardopts).and_return([])
-    @stats.stub!(:puts) {|*args| @output << args.join("\n") << "\n" }
+    log.stub!(:puts) {|*args| @output << args.join("\n") << "\n" }
   end
 
   it "should list undocumented objects with --list-undoc" do

data/spec/cli/yardoc_spec.rb

@@ -77,6 +77,10 @@ describe YARD::CLI::Yardoc do
     it "should not embed mixins by default" do
       @yardoc.options.embed_mixins.should be_empty
     end
+
+    it "should not set any locale by default" do
+      @yardoc.options.locale.should be_nil
+    end
   end
 
   describe 'General options' do
@@ -303,6 +307,32 @@ describe YARD::CLI::Yardoc do
         end
       end
     end
+
+    describe '--locale' do
+      it 'should apply specified locale to all extra file objects' do
+        File.stub!(:read).with('extra_file1').and_return('')
+        File.stub!(:read).with('extra_file2').and_return('')
+
+        extra_file_object1 = CodeObjects::ExtraFileObject.new('extra_file1')
+        extra_file_object2 = CodeObjects::ExtraFileObject.new('extra_file2')
+        extra_file_object1.should_receive(:locale=).with('fr')
+        extra_file_object2.should_receive(:locale=).with('fr')
+
+        CodeObjects::ExtraFileObject.stub!(:new).with('extra_file1').and_return(extra_file_object1)
+        CodeObjects::ExtraFileObject.stub!(:new).with('extra_file2').and_return(extra_file_object2)
+        Dir.stub!(:glob).with('README*').and_return([])
+        File.stub!(:file?).with('extra_file1').and_return(true)
+        File.stub!(:file?).with('extra_file2').and_return(true)
+        @yardoc.run('--locale=fr', '-', 'extra_file1', 'extra_file2')
+      end
+    end
+
+    describe '--po-dir' do
+      it 'should set Registry.po_dir' do
+        Registry.should_receive(:po_dir=).with("locale")
+        @yardoc.run('--po-dir=locale')
+      end
+    end
   end
 
   describe '--[no-]api' do
@@ -651,6 +681,12 @@ describe YARD::CLI::Yardoc do
       @yardoc.parse_arguments('--transitive-tag', 'foo')
       Tags::Library.transitive_tags.should include(:foo)
     end
+
+    it "should accept --non-transitive-tag" do
+      Tags::Library.transitive_tags |= [:foo]
+      @yardoc.parse_arguments('--non-transitive-tag', 'foo')
+      Tags::Library.transitive_tags.should_not include(:foo)
+    end
   end
 
   describe 'Safe mode' do

data/spec/code_objects/base_spec.rb

@@ -28,6 +28,21 @@ describe YARD::CodeObjects::Base do
     YARD::Registry.at("MYMODULE").should be_instance_of(ClassObject)
   end
 
+  it "should simplify complex namespace paths" do
+    obj = ClassObject.new(:root, "A::B::C::D")
+    obj.name.should == :D
+    obj.path.should == "A::B::C::D"
+    obj.namespace.should == P("A::B::C")
+  end
+
+  # @bug gh-552
+  it "should simplify complex namespace paths when path starts with ::" do
+    obj = ClassObject.new(:root, "::A::B::C::D")
+    obj.name.should == :D
+    obj.path.should == "A::B::C::D"
+    obj.namespace.should == P("A::B::C")
+  end
+
   it "should recall the block if #new is called on an existing object" do
     o1 = ClassObject.new(:root, :Me) do |o|
       o.docstring = "DOCSTRING"

data/spec/code_objects/constants_spec.rb

@@ -75,7 +75,7 @@ end
 describe YARD::CodeObjects, "BUILTIN_MODULES" do
   it "should include all base modules" do
     YARD::CodeObjects::BUILTIN_MODULES.each do |name|
-      next if RUBY19 && ["Precision"].include?(name)
+      next if YARD.ruby19? && ["Precision"].include?(name)
       eval(name).should be_instance_of(Module)
     end
   end

data/spec/code_objects/extra_file_object_spec.rb

@@ -71,7 +71,7 @@ describe YARD::CodeObjects::ExtraFileObject do
       data.force_encoding('binary')
       file = ExtraFileObject.new('file.txt', data)
       ['Shift_JIS', 'Windows-31J'].should include(file.contents.encoding.to_s)
-    end if RUBY19
+    end if YARD.ruby19?
 
     it "should warn if @encoding is invalid" do
       log.should_receive(:warn).with("Invalid encoding `INVALID' in file.txt")
@@ -79,12 +79,12 @@ describe YARD::CodeObjects::ExtraFileObject do
       encoding = data.encoding
       file = ExtraFileObject.new('file.txt', data)
       file.contents.encoding.should == encoding
-    end if RUBY19
+    end if YARD.ruby19?
 
     it "should ignore encoding in 1.8.x (or encoding-unaware platforms)" do
       log.should_not_receive(:warn)
       file = ExtraFileObject.new('file.txt', "# @encoding INVALID\nFOO")
-    end if RUBY18
+    end if YARD.ruby18?
 
     it "should attempt to re-parse data as 8bit ascii if parsing fails" do
       log.should_not_receive(:warn)
@@ -114,6 +114,18 @@ describe YARD::CodeObjects::ExtraFileObject do
     end
   end
 
+  describe '#locale=' do
+    it "should translate contents" do
+      file = ExtraFileObject.new('file.txt', 'Hello')
+      file.locale = 'fr'
+      fr_locale = I18n::Locale.new('fr')
+      fr_messages = fr_locale.instance_variable_get(:@messages)
+      fr_messages["Hello"] = 'Bonjour'
+      Registry.should_receive(:locale).with('fr').and_return(fr_locale)
+      file.contents.should == 'Bonjour'
+    end
+  end
+
   describe '#==' do
     it "should define equality on filename alone" do
       file1 = ExtraFileObject.new('file.txt', 'A')

data/spec/docstring_parser_spec.rb

@@ -1,6 +1,10 @@
 require File.dirname(__FILE__) + "/spec_helper"
 
 describe YARD::DocstringParser do
+  after(:all) do
+    YARD::Registry.clear
+  end
+
   def parse(content, object = nil, handler = nil)
     @library ||= Tags::Library.instance
     @parser = DocstringParser.new(@library)

data/spec/docstring_spec.rb

@@ -83,6 +83,12 @@ describe YARD::Docstring do
       doc.summary.should == "Returns a list of tags specified by +name+ or all tags if +name+ is not specified."
     end
 
+    it "should not attach period if entire summary is include" do
+      YARD.parse_string "# docstring\ndef foo; end"
+      Docstring.new("{include:#foo}").summary.should == '{include:#foo}'
+      Registry.clear
+    end
+
     it "should handle references embedded in summary" do
       Docstring.new("Aliasing {Test.test}. Done.").summary.should == "Aliasing {Test.test}."
     end
@@ -250,6 +256,18 @@ describe YARD::Docstring do
       doc = Docstring.new("123\n@param")
       doc.to_raw.should == doc.all
     end
+
+    # @bug gh-563
+    it "should handle full @option tags" do
+      doc = Docstring.new("@option foo [String] bar (nil) baz")
+      doc.to_raw.should == "@option foo [String] bar (nil) baz"
+    end
+
+    # @bug gh-563
+    it "should handle simple @option tags" do
+      doc = Docstring.new("@option foo :key bar")
+      doc.to_raw.should == "@option foo :key bar"
+    end
   end
 
   describe '#dup' do

data/spec/handlers/module_function_handler_spec.rb

@@ -43,6 +43,29 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHand
     assert_module_function('Foo', 'baz')
   end
 
+  # @bug gh-563
+  it "should copy tags to module function properly" do
+    YARD.parse_string <<-eof
+      module Foo
+        # @param [String] foo bar
+        # @option foo [String] bar (nil) baz
+        # @return [void]
+        def bar(foo); end
+        module_function :bar
+      end
+    eof
+    assert_module_function('Foo', 'bar')
+    o = Registry.at('Foo.bar')
+    o.tag(:param).types.should == ['String']
+    o.tag(:param).name.should == 'foo'
+    o.tag(:param).text.should == 'bar'
+    o.tag(:option).name.should == 'foo'
+    o.tag(:option).pair.types.should == ['String']
+    o.tag(:option).pair.defaults.should == ['nil']
+    o.tag(:option).pair.text.should == 'baz'
+    o.tag(:return).types.should == ['void']
+  end
+
   it "should handle all method names in parameters" do
     YARD.parse_string <<-eof
       module Foo

data/spec/i18n/locale_spec.rb

@@ -21,7 +21,13 @@ describe YARD::I18n::Locale do
       @locale.load('foo').should == false
     end
 
-    it "should return true for existent PO" do
+    have_gettext_gem = true
+    begin
+      require "gettext/tools/poparser"
+    rescue LoadError
+      have_gettext_gem = false
+    end
+    it "should return true for existent PO", :if => have_gettext_gem do
       data = <<-eop
 msgid ""
 msgstr ""

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -87,6 +87,32 @@ describe YARD::Parser::Ruby::RubyParser do
       ss[2].comments.should == 'hello'
     end
 
+    it "should handle block comment followed by line comment" do
+      ss = stmts <<-eof
+# comments1
+
+=begin
+comments2
+=end
+# comments3
+def hello; end
+eof
+      ss.last.comments.should == "comments3"
+    end
+
+    it "should handle block comment followed by block comment" do
+      ss = stmts <<-eof
+=begin
+comments1
+=end
+=begin
+comments2
+=end
+def hello; end
+eof
+      ss.last.comments.strip.should == "comments2"
+    end
+
     it "should handle 1.9 lambda syntax with args" do
       src = "->(a,b,c=1,*args,&block) { hello_world }"
       stmt(src).source.should == src

data/spec/parser/source_parser_spec.rb

@@ -546,7 +546,7 @@ describe YARD::Parser::SourceParser do
           parser = Parser::SourceParser.new
           File.should_receive(:read_binary).with('tmpfile').and_return(src)
           result = parser.parse("tmpfile")
-          if HAVE_RIPPER && RUBY19
+          if HAVE_RIPPER && YARD.ruby19?
             ['Shift_JIS', 'Windows-31J', 'UTF-8'].send(msg, include(
               result.enumerator[0].source.encoding.to_s))
           end
@@ -572,7 +572,7 @@ describe YARD::Parser::SourceParser do
           ['UTF-8'].send(msg, include(content.encoding.to_s))
         end
       end
-    end if RUBY19
+    end if YARD.ruby19?
 
     Parser::SourceParser::ENCODING_BYTE_ORDER_MARKS.each do |encoding, bom|
       it "should understand #{encoding.upcase} BOM" do
@@ -584,7 +584,7 @@ describe YARD::Parser::SourceParser do
         Registry.all(:class).first.path.should == "FooBar"
         result.enumerator[0].source.encoding.to_s.downcase.should == encoding
       end
-    end if HAVE_RIPPER && RUBY19
+    end if HAVE_RIPPER && YARD.ruby19?
   end
 
   describe '#parse_in_order' do
@@ -606,12 +606,24 @@ describe YARD::Parser::SourceParser do
       end
     end
 
-    it "should attempt to order files by length (process toplevel files first)" do
-      %w(a a/b a/b/c).each do |file|
+    it "should attempt to order files by length for globs (process toplevel files first)" do
+      files = %w(a a/b a/b/c)
+      files.each do |file|
         File.should_receive(:file?).with(file).and_return(true)
         File.should_receive(:read_binary).with(file).ordered.and_return('')
       end
-      YARD.parse %w(a/b/c a/b a)
+      Dir.should_receive(:[]).with('a/**/*').and_return(files.reverse)
+      YARD.parse 'a/**/*'
+    end
+
+    it "should allow overriding of length sorting when single file is presented" do
+      files = %w(a/b/c a a/b)
+      files.each do |file|
+        File.should_receive(:file?).with(file).at_least(1).times.and_return(true)
+        File.should_receive(:read_binary).with(file).ordered.and_return('')
+      end
+      Dir.should_receive(:[]).with('a/**/*').and_return(files.reverse)
+      YARD.parse ['a/b/c', 'a/**/*']
     end
   end
 

data/spec/rake/yardoc_task_spec.rb

@@ -45,6 +45,15 @@ describe YARD::Rake::YardocTask do
       run
       @yardoc.visibilities.should == [:public, :private, :protected]
     end
+
+    it "should allow --api and --no-api" do
+      YARD::Rake::YardocTask.new do |t|
+        t.options = %w(--api public --no-api)
+      end
+      run
+      @yardoc.options.verifier.expressions.
+        should include('["public"].include?(@api.text) || !@api')
+    end
   end
 
   describe '#before' do
@@ -65,28 +74,28 @@ describe YARD::Rake::YardocTask do
       YARD::Rake::YardocTask.new {|t| t.after = proc }
       run
     end
+  end
 
-    describe '#verifier' do
-      it "should allow a verifier proc to be set" do
-        verifier = Verifier.new
-        @yardoc.should_receive(:run) do
-          @yardoc.options[:verifier].should == verifier
-        end
-        YARD::Rake::YardocTask.new {|t| t.verifier = verifier }
-        run
+  describe '#verifier' do
+    it "should allow a verifier proc to be set" do
+      verifier = Verifier.new
+      @yardoc.should_receive(:run) do
+        @yardoc.options[:verifier].should == verifier
       end
+      YARD::Rake::YardocTask.new {|t| t.verifier = verifier }
+      run
+    end
 
-      it "should override --query options" do
-        verifier = Verifier.new
-        @yardoc.should_receive(:run) do
-          @yardoc.options[:verifier].should == verifier
-        end
-        YARD::Rake::YardocTask.new do |t|
-          t.options += ['--query', '@return']
-          t.verifier = verifier
-        end
-        run
+    it "should override --query options" do
+      verifier = Verifier.new
+      @yardoc.should_receive(:run) do
+        @yardoc.options[:verifier].should == verifier
       end
+      YARD::Rake::YardocTask.new do |t|
+        t.options += ['--query', '@return']
+        t.verifier = verifier
+      end
+      run
     end
   end
-end
+end

data/spec/registry_spec.rb

@@ -81,6 +81,15 @@ describe YARD::Registry do
     end
   end
 
+  describe '.locale' do
+    it "should load locale object" do
+      fr_locale = I18n::Locale.new("fr")
+      store = Registry.send(:thread_local_store)
+      store.should_receive(:locale).with("fr").and_return(fr_locale)
+      Registry.locale("fr").should == fr_locale
+    end
+  end
+
   describe '.resolve' do
     it "should resolve any existing namespace" do
       o1 = ModuleObject.new(:root, :A)
@@ -355,5 +364,30 @@ describe YARD::Registry do
     it "should automatically clear in new threads" do
       Thread.new { Registry.all.should be_empty }.join
     end
+
+    it "should allow setting of po_dir in separate threads" do
+      barrier = 0
+      mutex   = Mutex.new
+      threads = []
+      threads << Thread.new do
+        Registry.po_dir.should == 'po'
+        Registry.po_dir = 'locale'
+        mutex.synchronize { barrier += 1 }
+        while barrier == 1 do
+          s = "barrier = 1, spinning"
+        end
+        Registry.po_dir.should == 'locale'
+      end
+      threads << Thread.new do
+        while barrier == 0 do
+          s = "barrier = 0, spinning"
+        end
+        Registry.po_dir.should == 'po'
+        mutex.synchronize { barrier += 1 }
+        Registry.po_dir = '.'
+      end
+      threads.each {|t| t.join }
+      Registry.po_dir = Registry::DEFAULT_PO_DIR
+    end
   end
 end

data/spec/registry_store_spec.rb

@@ -302,4 +302,14 @@ describe YARD::RegistryStore do
       @store.destroy(true).should == true
     end
   end
+
+  describe '#locale' do
+    it "should load ./po/LOCALE_NAME.po" do
+      fr_locale = I18n::Locale.new("fr")
+      I18n::Locale.should_receive(:new).with("fr").and_return(fr_locale)
+      Registry.should_receive(:po_dir).and_return("po")
+      fr_locale.should_receive(:load).with("po")
+      @store.locale("fr").should == fr_locale
+    end
+  end
 end