yard 0.8.0 → 0.8.1

data/spec/cli/list_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::CLI::List do
   it "should pass command off to Yardoc with --list" do
-    YARD::CLI::Yardoc.should_receive(:run).with('--list', '--foo')
+    YARD::CLI::Yardoc.should_receive(:run).with('-c', '--list', '--foo')
     YARD::CLI::List.run('--foo')
   end
 end

data/spec/cli/stats_spec.rb

@@ -77,13 +77,13 @@ eof
     @output.string.should == @main_stats
   end
 
-  it "should not include public methods in stats with --no-public" do
+  it "should ignore everything with --no-public" do
     @stats.run('--no-public')
     @output.string.should ==
-      "Files:           1\n" +
-      "Modules:         1 (    1 undocumented)\n" +
-      "Classes:         1 (    1 undocumented)\n" +
-      "Constants:       1 (    1 undocumented)\n" +
+      "Files:           0\n" +
+      "Modules:         0 (    0 undocumented)\n" +
+      "Classes:         0 (    0 undocumented)\n" +
+      "Constants:       0 (    0 undocumented)\n" +
       "Methods:         0 (    0 undocumented)\n" +
       " 0.00% documented\n"
   end

data/spec/cli/yardoc_spec.rb

@@ -305,6 +305,71 @@ describe YARD::CLI::Yardoc do
     end
   end
 
+  describe '--[no-]api' do
+    before { Registry.clear }
+
+    it "should allow --api name" do
+      YARD.parse_string <<-eof
+        # @api private
+        class Foo; end
+        # @api public
+        class Bar; end
+        class Baz; end
+      eof
+      @yardoc.run('--api', 'private')
+      @yardoc.options.verifier.run(Registry.all).should == [P('Foo')]
+    end
+
+    it "should allow multiple --api's to all be shown" do
+      YARD.parse_string <<-eof
+        # @api private
+        class Foo; end
+        # @api public
+        class Bar; end
+        class Baz; end
+      eof
+      @yardoc.run('--api', 'private', '--api', 'public')
+      @yardoc.options.verifier.run(Registry.all).
+        sort_by {|o| o.path }.should == [P('Bar'), P('Foo')]
+    end
+
+    it "should allow --no-api to specify objects with no @api tag" do
+      YARD.parse_string <<-eof
+        # @api private
+        class Foo; end
+        # @api public
+        class Bar; end
+        class Baz; end
+      eof
+      @yardoc.run('--api', '')
+      @yardoc.options.verifier.run(Registry.all).should == [P('Baz')]
+      @yardoc.options.verifier = Verifier.new
+      @yardoc.run('--no-api')
+      @yardoc.options.verifier.run(Registry.all).should == [P('Baz')]
+    end
+
+    it "should allow --no-api to work with other --api switches" do
+      YARD.parse_string <<-eof
+        # @api private
+        class Foo; end
+        # @api public
+        class Bar; end
+        class Baz; end
+      eof
+      @yardoc.run('--no-api', '--api', 'public')
+      @yardoc.options.verifier.run(Registry.all).
+        sort_by {|o| o.path }.should == [P('Bar'), P('Baz')]
+    end
+
+    it "should ensure Ruby code cannot be used" do
+      [':symbol', '42', '"; exit'].each do |ruby|
+        @yardoc.options.verifier.expressions = []
+        @yardoc.run('--api', ruby)
+        @yardoc.options.verifier.expressions[1].should include(ruby.inspect)
+      end
+    end
+  end
+
   describe '--no-private option' do
     it "should accept --no-private" do
       obj = mock(:object)
@@ -406,8 +471,12 @@ describe YARD::CLI::Yardoc do
   end
 
   describe 'Query options' do
-    before do
-      Registry.clear
+    after { Registry.clear }
+
+    it "should hide private constants in with default visibilities" do
+      classobj = CodeObjects::ClassObject.new(:root, :Foo) {|o| o.visibility = :private }
+      @yardoc.run
+      @yardoc.options.verifier.run([classobj]).should == []
     end
 
     it "should setup visibility rules as verifier" do

data/spec/docstring_parser_spec.rb

@@ -203,5 +203,22 @@ eof
       parser.parse("Some text")
       the_yielded_obj.should == parser
     end
+
+    it "should warn about invalid named parameters" do
+      log.should_receive(:warn).with(/@param tag has unknown parameter name: notaparam/)
+      YARD.parse_string <<-eof
+        # @param notaparam foo
+        def foo(a) end
+      eof
+    end
+
+    it "should warn about duplicate named parameters" do
+      log.should_receive(:warn).with(/@param tag has duplicate parameter name: a/)
+      YARD.parse_string <<-eof
+        # @param a foo
+        # @param a foo
+        def foo(a) end
+      eof
+    end
   end
 end

data/spec/i18n/message_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::I18n::Message do
+  def message(id)
+    YARD::I18n::Message.new(id)
+  end
+
+  before do
+    @message = message("Hello World!")
+  end
+
+  describe "#id" do
+    it "should return ID" do
+      message("Hello World!").id.should == "Hello World!"
+    end
+  end
+
+  describe "#add_location" do
+    it "should add some locations" do
+      @message.add_location("hello.rb", 10)
+      @message.add_location("message.rb", 5)
+      @message.locations.should == Set.new([["hello.rb", 10], ["message.rb", 5]])
+    end
+  end
+
+  describe "#add_comment" do
+    it "should add some comments" do
+      @message.add_comment("YARD.title")
+      @message.add_comment("Hello#message")
+      @message.comments.should == Set.new(["YARD.title", "Hello#message"])
+    end
+  end
+
+  describe "#==" do
+    it "should return true for same value messages" do
+      locations = [["hello.rb", 10], ["message.rb", 5]]
+      comments = ["YARD.title", "Hello#message"]
+
+      other_message = message(@message.id)
+      locations.each do |path, line|
+        @message.add_location(path, line)
+        other_message.add_location(path, line)
+      end
+      comments.each do |comment|
+        @message.add_comment(comment)
+        other_message.add_comment(comment)
+      end
+
+      @message.should == other_message
+    end
+  end
+end

data/spec/i18n/messages_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::I18n::Messages do
+  def message(id)
+    YARD::I18n::Message.new(id)
+  end
+
+  def messages
+    YARD::I18n::Messages.new
+  end
+
+  before do
+    @messages = messages
+  end
+
+  describe "#each" do
+    it "should enumerate Message" do
+      @messages.register("Hello World!")
+      @messages.register("Title")
+      enumerated_messages = []
+      @messages.each do |message|
+        enumerated_messages << message
+      end
+      enumerated_messages = enumerated_messages.sort_by {|m| m.id }
+      enumerated_messages.should == [message("Hello World!"), message("Title")]
+    end
+
+    it "should not any Message for empty messages" do
+      enumerated_messages = []
+      @messages.each do |message|
+        enumerated_messages << message
+      end
+      enumerated_messages.should == []
+    end
+  end
+
+  describe "#[]" do
+    it "should return registered message" do
+      @messages.register("Hello World!")
+      @messages["Hello World!"].should == message("Hello World!")
+    end
+
+    it "should return for nonexistent message ID" do
+      @messages["Hello World!"].should == nil
+    end
+  end
+
+  describe "#register" do
+    it "should return registered message" do
+      @messages.register("Hello World!").should == message("Hello World!")
+    end
+
+    it "should return existent message" do
+      message = @messages.register("Hello World!")
+      @messages.register("Hello World!").object_id.should == message.object_id
+    end
+  end
+
+  describe "#==" do
+    it "should return true for same value messages" do
+      @messages.register("Hello World!")
+      other_messages = messages
+      other_messages.register("Hello World!")
+      @messages.should == other_messages
+    end
+  end
+end

data/spec/i18n/pot_generator_spec.rb

@@ -1,6 +1,24 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::I18n::PotGenerator do
+  def create_messages(messages)
+    yard_messages = YARD::I18n::Messages.new
+    add_messages(yard_messages, messages)
+    yard_messages
+  end
+
+  def add_messages(yard_messages, messages)
+    messages.each do |id, properties|
+      yard_message = yard_messages.register(id)
+      (properties[:locations] || []).each do |path, line|
+        yard_message.add_location(path, line)
+      end
+      (properties[:comments] || []).each do |comment|
+        yard_message.add_comment(comment)
+      end
+    end
+  end
+
   before do
     @generator = YARD::I18n::PotGenerator.new("..")
   end
@@ -32,14 +50,17 @@ eoh
 
     it "should generate messages in location order" do
       @generator.stub!(:header).and_return("HEADER\n\n")
-      @generator.messages["tag|see|Parser::SourceParser.parse"] = {
-        :locations => [["yard.rb", 14]],
-        :comments => ["@see"],
-      }
-      @generator.messages["Parses a path or set of paths"] = {
-        :locations => [["yard.rb", 12], ["yard/parser/source_parser.rb", 83]],
-        :comments => ["YARD.parse", "YARD::Parser::SourceParser.parse"],
+      messages = {
+        "tag|see|Parser::SourceParser.parse" => {
+          :locations => [["yard.rb", 14]],
+          :comments => ["@see"],
+        },
+        "Parses a path or set of paths" => {
+          :locations => [["yard.rb", 12], ["yard/parser/source_parser.rb", 83]],
+          :comments => ["YARD.parse", "YARD::Parser::SourceParser.parse"],
+        }
       }
+      add_messages(@generator.messages, messages)
       @generator.generate.should == <<-'eoh'
 HEADER
 
@@ -60,13 +81,10 @@ eoh
   end
 
   describe "Escape" do
-    def generate_message_pot(message)
+    def generate_message_pot(message_id)
       pot = ""
-      options = {
-        :comments => [],
-        :locations => [],
-      }
-      @generator.send(:generate_message, pot, message, options)
+      message = YARD::I18n::Message.new(message_id)
+      @generator.send(:generate_message, pot, message)
       pot
     end
 
@@ -107,12 +125,12 @@ eop
         o.docstring = "An alias to {Parser::SourceParser}'s parsing method"
       end
       @generator.parse_objects([object])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         "An alias to {Parser::SourceParser}'s parsing method" => {
           :locations => [],
           :comments => ["YARD.parse"],
         }
-      }
+      })
     end
 
     it "should extract location" do
@@ -121,12 +139,12 @@ eop
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         "An alias to {Parser::SourceParser}'s parsing method" => {
           :locations => [["yard.rb", 13]],
           :comments => ["YARD.parse"],
         }
-      }
+      })
     end
 
     it "should extract tag name" do
@@ -135,12 +153,12 @@ eop
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         "tag|see|Parser::SourceParser.parse" => {
           :locations => [["yard.rb", 12]],
           :comments => ["@see"],
         },
-      }
+      })
     end
 
     it "should extract tag text" do
@@ -152,7 +170,7 @@ eod
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         "tag|example|Parse a glob of files" => {
           :locations => [["yard.rb", 12]],
           :comments => ["@example"],
@@ -161,7 +179,7 @@ eod
           :locations => [["yard.rb", 12]],
           :comments => ["@example Parse a glob of files"],
         }
-      }
+      })
     end
 
     it "should extract tag types" do
@@ -173,7 +191,7 @@ eod
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         "tag|param|paths" => {
           :locations => [["yard.rb", 12]],
           :comments => ["@param [String, Array<String>]"],
@@ -182,7 +200,7 @@ eod
           :locations => [["yard.rb", 12]],
           :comments => ["@param [String, Array<String>] paths"],
         }
-      }
+      })
     end
   end
 
@@ -198,7 +216,7 @@ eor
       File.stub!(:read).with(path).and_return(text)
       file = YARD::CodeObjects::ExtraFileObject.new(path)
       @generator.parse_files([file])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         "Getting Started Guide" => {
           :locations => [[path, 1]],
           :comments => ["title"],
@@ -207,7 +225,7 @@ eor
           :locations => [[path, 3]],
           :comments => [],
         }
-      }
+      })
     end
 
     it "should extract paragraphs" do
@@ -229,7 +247,7 @@ eot
       File.stub!(:read).with(path).and_return(text)
       file = YARD::CodeObjects::ExtraFileObject.new(path)
       @generator.parse_files([file])
-      @generator.messages.should == {
+      @generator.messages.should == create_messages({
         paragraph1 => {
           :locations => [[path, 1]],
           :comments => [],
@@ -238,7 +256,7 @@ eot
           :locations => [[path, 4]],
           :comments => [],
         }
-      }
+      })
     end
   end
 end

data/spec/i18n/text_spec.rb

@@ -1,3 +1,5 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
 describe YARD::I18n::Text do
   def extract_messages(input, options={})
     text = YARD::I18n::Text.new(StringIO.new(input), options)

data/spec/verifier_spec.rb

@@ -19,6 +19,26 @@ describe YARD::Verifier do
       Verifier.new('@@return').call(obj)
     end
 
+    it "should allow namespaced tag using @{} syntax" do
+      obj = mock(:object)
+      obj.should_receive(:tag).with('yard.return')
+      Verifier.new('@{yard.return}').call(obj)
+    end
+
+    it "should allow namespaced tags using @{} syntax" do
+      obj = mock(:object)
+      obj.should_receive(:tags).with('yard.return')
+      Verifier.new('@@{yard.return}').call(obj)
+    end
+
+    it "should call methods on tag object" do
+      obj = mock(:object)
+      obj2 = mock(:tag)
+      obj.should_receive(:tag).with('return').and_return obj2
+      obj2.should_receive(:foo)
+      Verifier.new('@return.foo').call(obj)
+    end
+
     it "should send any missing methods to object" do
       obj = mock(:object)
       obj.should_receive(:has_tag?).with('return')