tomparse 0.3.0 → 0.4.0

data/test/helper.rb

@@ -1,25 +1,5 @@
-#require 'microtest/testunit'
-#require 'microtest/assertions'
-#require 'test/fixtures/multiplex'
-
 require 'citron'
 require 'ae'
 
 require 'tomparse'
 
-#module TomParse
-#  class Test < ::Test::Unit::TestCase
-#    def self.test(name, &block)
-#      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
-#    end
-#
-#    def default_test
-#    end
-#
-#    def fixture(name)
-#      @fixtures ||= {}
-#      @fixtures[name] ||= File.read("test/fixtures/#{name}.rb")
-#    end
-#  end
-#end
-

data/test/test_description.rb

@@ -0,0 +1,54 @@
+require_relative 'helper'
+
+testcase "Description" do
+
+  context "description only" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Has this initial paragraph.
+      }
+    end
+
+    test "correctly handles description only" do
+      @comment.description.assert == "Has this initial paragraph."
+    end
+  end
+
+  context "simple description with other things" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Has this initial paragraph, that continues on to
+        # a new line.
+        #
+        # Examples
+        #
+        #   foo('bar')
+      }
+    end
+
+    test "correctly handles description" do
+      @comment.description.assert == "Has this initial paragraph, that continues on to\na new line."
+    end
+  end
+
+  context "handles multiple paragraph descriptions" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Has an initial paragraph.
+        #
+        # Has another paragraph in the description.
+        #
+        # Examples
+        #
+        #   def multiplex(str, length)
+        #     str * length
+        #   end
+      }
+    end
+
+    test "correctly handles multiple paragraphs" do
+      @comment.description.assert == "Has an initial paragraph.\n\nHas another paragraph in the description."
+    end
+  end
+
+end

data/test/test_prefixes.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require_relative 'helper'
 
 testcase "Prefixes" do
 
@@ -11,7 +11,7 @@ testcase "Prefixes" do
     end
 
     test "internal?" do
-      assert @tomdoc.internal?
+      @tomdoc.assert.internal?
     end
 
     test "description" do
@@ -29,7 +29,7 @@ testcase "Prefixes" do
     end
 
     test "public?" do
-      assert @tomdoc.public?
+      @tomdoc.assert.public?
     end
 
     test "description" do

data/test/test_signatures.rb

@@ -1,36 +1,55 @@
-require 'helper'
+require_relative 'helper'
 
 testcase "Signatures" do
 
-  setup do  
-    @comment = TomParse::TomDoc.new %{
-      # Duplicate some text an abitrary number of times.
-      #
-      # Yields the Integer index of the iteration.
-      #
-      # Signature
-      #
-      #   find_by_<field>[_and_<field>...](args)
-      #
-      # field - A field name.
-    }
-  end
+  context "singular term" do
 
-  test "knows what the method yields" do
-    @comment.yields.assert == "Yields the Integer index of the iteration."
-  end
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Signature
+        #
+        #   find(name)
+        #   find(name=>pattern)
+        #
+      }
+    end
+
+    test "knows if the method has alternate signatures" do
+      @comment.signatures.size.assert == 2
+      @comment.signatures.first.assert == "find(name)"
+      @comment.signatures.last.assert == "find(name=>pattern)"
+    end
 
-  test "knows if the method has alternate signatures" do
-    @comment.signatures.size.assert == 1
-    @comment.signatures.first.assert == "find_by_<field>[_and_<field>...](args)"
   end
 
-  test "knows the fields associated with signatures" do
-    @comment.signature_fields.size.assert == 1
+  context "plural term" do
+
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Signatures
+        #
+        #   find_by_<field>[_and_<field>...](args)
+        #
+      }
+    end
+
+    test "knows if the method has alternate signatures" do
+      @comment.signatures.size.assert == 1
+      @comment.signatures.first.assert == "find_by_<field>[_and_<field>...](args)"
+    end
 
-    arg = @comment.signature_fields.first
-    arg.name.assert == :field
-    arg.description.assert == "A field name."
   end
 
+  #test "knows the fields associated with signatures" do
+  #  @comment.signature_fields.size.assert == 1
+  #
+  #  arg = @comment.signature_fields.first
+  #  arg.name.assert == :field
+  #  arg.description.assert == "A field name."
+  #end
+
 end

data/test/test_tags.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require_relative 'helper'
 
 testcase "Tags" do
 
@@ -13,7 +13,8 @@ testcase "Tags" do
     end
 
     test "tags has todo" do
-      assert @tomdoc.tags['todo'] == "Something we have to do."
+      @tomdoc.tags.size.assert == 1
+      @tomdoc.tags.assert.include? ['TODO', 'Something we have to do.']
     end
 
   end
@@ -24,12 +25,13 @@ testcase "Tags" do
       @tomdoc = TomParse::TomDoc.new(<<-END)
         # This is an example of tags.
         #
-        # FOO: They can be anything really.
+        # Foo: They can be anything really.
       END
     end
 
     test "tags has foo" do
-      assert @tomdoc.tags['foo'] == "They can be anything really."
+      @tomdoc.tags.size.assert == 1
+      @tomdoc.tags.assert.include? ['Foo', 'They can be anything really.']
     end
 
   end

data/test/test_tomdoc.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require_relative 'helper'
 
 testcase TomParse::TomDoc do
 
@@ -14,8 +14,8 @@ testcase TomParse::TomDoc do
         # reverse - An optional Boolean indicating
         #           whether to reverse the result text or not.
         # options - Options (default: {})
-        #         :insert_spaces - Whether to insert spaces
-        #         :upcase - Convert the string to upper case
+        #           :insert_spaces - Whether to insert spaces
+        #           :upcase - Convert the string to upper case
         # blk - The block.
         #
         # Examples

data/test/test_yields.rb

@@ -0,0 +1,17 @@
+require_relative 'helper'
+
+testcase "Yields" do
+
+  setup do  
+    @comment = TomParse::TomDoc.new %{
+      # Duplicate some text an abitrary number of times.
+      #
+      # Yields the Integer index of the iteration.
+    }
+  end
+
+  test "knows what the method yields" do
+    @comment.yields.assert == "Yields the Integer index of the iteration."
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tomparse
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citron
@@ -74,13 +74,20 @@ extra_rdoc_files:
 - README.md
 files:
 - .index
-- .rubyrc
+- .yardopts
+- lib/tomparse/argument.rb
+- lib/tomparse/option.rb
+- lib/tomparse/parse_error.rb
+- lib/tomparse/parser.rb
 - lib/tomparse.rb
+- lib/tomparse.yml
 - test/helper.rb
+- test/test_description.rb
 - test/test_prefixes.rb
 - test/test_signatures.rb
 - test/test_tags.rb
 - test/test_tomdoc.rb
+- test/test_yields.rb
 - HISTORY.md
 - README.md
 - LICENSE.txt
@@ -110,7 +117,9 @@ signing_key:
 specification_version: 3
 summary: TomDoc parser for Ruby
 test_files:
+- test/test_description.rb
 - test/helper.rb
+- test/test_yields.rb
 - test/test_signatures.rb
 - test/test_tags.rb
 - test/test_tomdoc.rb

data/.rubyrc

@@ -1,19 +0,0 @@
-config 'rubytest' do |run|
-  run.files << 'test/test_*.rb'
-
-  $:.unshift('test')
-  $:.unshift('lib') 
-end
-
-config 'rubytest', :profile=>'coverage' do |run|
-  run.files << 'test/test_*.rb'
-
-  $:.unshift('test')
-  $:.unshift('lib')
-
-  require 'simplecov'
-  SimpleCov.start do
-    coverage_dir 'log/coverage'
-  end
-end
-