yard 0.2.0

data/test/fixtures/docstring.txt

@@ -0,0 +1,23 @@
+
+
+= Introduction 
+
+This is a sample docstring for testing purposes
+
+  It includes most of the RDoc syntax, though
+
+@param normal a normal parameter with no type
+  
+  * It shouldn't matter
+  * What the RDoc data is
+  
+Finally:: It also contains meta data tags:
+
+@raise IOError an ioerror if things go wrong
+@author Loren Segal
+@deprecated
+@param [String] obj the first object in the list
+@param [String, Array<String>] obj2
+@return [Object] it really will
+                 return anything 
+                 it wants.

data/test/fixtures/docstring2.txt

@@ -0,0 +1,4 @@
+Returns a list of tags specified by +name+ or all tags if +name+ is not specified.
+
+@param name the tag name to return data for, or nil for all tags
+@return [Array<BaseTag>] the list of tags by the specified tag name

data/test/test_code_object.rb

@@ -0,0 +1,66 @@
+require "test/unit"
+require File.dirname(__FILE__) + '/../lib/code_object'
+
+class TestCodeObject < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '/fixtures/'
+  
+  def setup
+    @doc = YARD::CodeObject.new('node', 'module') do |obj|
+      obj.attach_docstring read_fixture('docstring.txt')
+    end
+  end
+  
+  def test_return
+    @doc = YARD::CodeObject.new('node', 'method') do |obj|
+      obj.attach_docstring read_fixture('docstring2.txt')
+    end
+    assert @doc.has_tag?("return")
+  end
+  
+  def test_source
+    assert_equal 'node', @doc.name
+    assert_equal '#node', @doc.path
+  end
+  
+  def test_docstring
+    assert_no_match /@param/, @doc.docstring
+  end
+  
+  def test_tags
+    assert_equal 3, @doc.tags("param").size
+  end
+  
+  def test_has_tag
+    assert @doc.has_tag?("deprecated")
+    assert !@doc.has_tag?("notdefined")
+  end
+  
+  def test_tag
+    assert_equal "Loren Segal", @doc.tag("author").text
+  end
+  
+  def test_tag_definition_on_multiple_lines
+    assert_equal "it really will return anything it wants.", @doc.tag("return").text
+  end
+  
+  def test_typed_tag
+    assert 2, @doc.tags("param").last.types.size
+    assert_equal ["String", "Array<String>"], @doc.tags("param").last.types
+    assert_equal "String", @doc.tags("param")[1].type
+    assert_equal [], @doc.tag("param").types
+  end
+  
+  def test_named_tag
+    assert_equal "normal", @doc.tags("param")[0].name
+    assert_equal "obj", @doc.tags("param")[1].name
+    assert_equal "obj2", @doc.tags("param")[2].name
+    
+    assert_equal "IOError", @doc.tag("raise").name
+    assert_match "if things go wrong", @doc.tag("raise").text
+  end
+  
+  protected
+    def read_fixture(file)
+      IO.read(File.join(FIXTURES_PATH, file))
+    end
+end

data/test/test_namespace.rb

@@ -0,0 +1,10 @@
+require "test/unit"
+
+require File.dirname(__FILE__) + "/../lib/namespace"
+
+class TestNamespace < Test::Unit::TestCase
+  def test_root_namespace
+    assert :root, YARD::Namespace.root.type
+    assert :root, YARD::Namespace.at('').type
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: yard
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+date: 2007-03-01 00:00:00 -05:00
+summary: A documentation tool for consistent and usable documentation in Ruby.
+require_paths: 
+- lib
+email: lsegal@soen.ca
+homepage: http://yard.soen.ca
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Loren Segal
+files: 
+- bin/yardoc
+- bin/yri
+- lib/code_object.rb
+- lib/formatter.rb
+- lib/handlers
+- lib/namespace.rb
+- lib/quick_doc.rb
+- lib/ruby_lex.rb
+- lib/source_parser.rb
+- lib/tag_library.rb
+- lib/tag_type.rb
+- lib/yard.rb
+- lib/handlers/all_handlers.rb
+- lib/handlers/attribute_handler.rb
+- lib/handlers/class_handler.rb
+- lib/handlers/class_variable_handler.rb
+- lib/handlers/code_object_handler.rb
+- lib/handlers/constant_handler.rb
+- lib/handlers/exception_handler.rb
+- lib/handlers/method_handler.rb
+- lib/handlers/mixin_handler.rb
+- lib/handlers/module_handler.rb
+- lib/handlers/visibility_handler.rb
+- lib/handlers/yield_handler.rb
+- test/fixtures
+- test/test_code_object.rb
+- test/test_namespace.rb
+- test/fixtures/docstring.txt
+- test/fixtures/docstring2.txt
+- templates/html_formatter.erb
+- LICENSE.txt
+- README.pdf
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- yardoc
+- yri
+extensions: []
+
+requirements: []
+
+dependencies: []
+