tomparse 0.2.0 → 0.2.1

data/.ruby

@@ -9,7 +9,7 @@ copyrights:
   year: '2012'
   license: BSD-2-Clause
 requirements:
-- name: microtest
+- name: citron
   groups:
   - test
   development: true
@@ -25,10 +25,18 @@ repositories:
   scm: git
   name: upstream
 resources:
-  home: http://rubyworks.github.com/tomparse
-  docs: http://rubydoc.info/gems/tomparse
-  code: http://github.com/rubyworks/tomparse
-  mail: http://groups.google.com/groups/rubyworks-mailinglist
+- uri: http://rubyworks.github.com/tomparse
+  name: home
+  type: home
+- uri: http://rubydoc.info/gems/tomparse
+  name: docs
+  type: doc
+- uri: http://github.com/rubyworks/tomparse
+  name: code
+  type: code
+- uri: http://groups.google.com/groups/rubyworks-mailinglist
+  name: mail
+  type: mail
 extra: {}
 load_path:
 - lib
@@ -36,7 +44,7 @@ revision: 0
 created: '2012-03-04'
 summary: TomDoc parser for Ruby
 title: TomParse
-version: 0.2.0
+version: 0.2.1
 name: tomparse
 description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functionality
 
@@ -44,4 +52,4 @@ description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functiona
 
   TomDoc standard.'
 organization: rubyworks
-date: '2012-03-04'
+date: '2012-04-30'

data/Config.rb

@@ -0,0 +1,19 @@
+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
+

data/HISTORY.md

@@ -1,7 +1,16 @@
 # Release History
 
+## 0.2.1 / 2012-04-30
 
-## 0.2.0 / 2012-03-5
+This release fixes indention with multi-line examples.
+
+Changes:
+
+* Correctly indent multiline code examples.
+* Swtich to Citron for testing.
+
+
+## 0.2.0 / 2012-03-07
 
 This release improves support of TomDoc, in particular, named parameters. It also
 fixes a bug with appending to argument and option descriptions.

data/lib/tomparse.rb

@@ -97,7 +97,7 @@ module TomParse
 
       space = spaces.min || 0
       lines = lines.map do |line|
-        if line.empty?
+        if line.strip.empty?
           line.strip
         else
           line[space..-1]
@@ -312,11 +312,11 @@ module TomParse
     def parse_examples(section, sections)
       examples = []
 
-      section = section.sub('Examples', '').strip
+      section = section.sub('Examples', '').gsub(/^\s{2}/,'')
 
       examples << section unless section.empty?
       while sections.first && sections.first !~ /^\S/
-        examples << sections.shift.strip
+        examples << sections.shift.gsub(/^\s{2}/,'')
       end
 
       @examples = examples

data/lib/tomparse.yml

@@ -9,7 +9,7 @@ copyrights:
   year: '2012'
   license: BSD-2-Clause
 requirements:
-- name: microtest
+- name: citron
   groups:
   - test
   development: true
@@ -25,10 +25,18 @@ repositories:
   scm: git
   name: upstream
 resources:
-  home: http://rubyworks.github.com/tomparse
-  docs: http://rubydoc.info/gems/tomparse
-  code: http://github.com/rubyworks/tomparse
-  mail: http://groups.google.com/groups/rubyworks-mailinglist
+- uri: http://rubyworks.github.com/tomparse
+  name: home
+  type: home
+- uri: http://rubydoc.info/gems/tomparse
+  name: docs
+  type: doc
+- uri: http://github.com/rubyworks/tomparse
+  name: code
+  type: code
+- uri: http://groups.google.com/groups/rubyworks-mailinglist
+  name: mail
+  type: mail
 extra: {}
 load_path:
 - lib
@@ -36,7 +44,7 @@ revision: 0
 created: '2012-03-04'
 summary: TomDoc parser for Ruby
 title: TomParse
-version: 0.2.0
+version: 0.2.1
 name: tomparse
 description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functionality
 
@@ -44,4 +52,4 @@ description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functiona
 
   TomDoc standard.'
 organization: rubyworks
-date: '2012-03-04'
+date: '2012-04-30'

data/test/helper.rb

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

data/test/test_prefixes.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+testcase "Prefixes" do
+
+  context "Internal" do
+
+    setup do
+      @tomdoc = TomParse::TomDoc.new(<<-END)
+        # Internal: Some example text.
+      END
+    end
+
+    test "internal?" do
+      assert @tomdoc.internal?
+    end
+
+    test "description" do
+      @tomdoc.description.assert == "Some example text."
+    end
+
+  end
+
+  context "Public" do
+
+    setup do
+      @tomdoc = TomParse::TomDoc.new(<<-END)
+        # Public: Some example text.
+      END
+    end
+
+    test "public?" do
+      assert @tomdoc.public?
+    end
+
+    test "description" do
+      @tomdoc.description.assert == "Some example text."
+    end
+
+  end
+
+
+end

data/test/test_signatures.rb

@@ -0,0 +1,36 @@
+require '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
+
+  test "knows what the method yields" do
+    @comment.yields.assert == "Yields the Integer index of the iteration."
+  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
+
+    arg = @comment.signature_fields.first
+    arg.name.assert == :field
+    arg.description.assert == "A field name."
+  end
+
+end

data/test/test_tomdoc.rb

@@ -1,175 +1,186 @@
 require 'helper'
 
-class TomDocTestCase < TomParse::Test
-
-  def setup
-    @comment = TomParse::TomDoc.new(<<comment)
-    # Duplicate some text an abitrary number of times.
-    #
-    # text    - The String to be duplicated.
-    # count   - The Integer number of times to
-    #           duplicate the text.
-    # reverse - An optional Boolean indicating
-    #           whether to reverse the result text or not.
-    #
-    # Examples
-    #   multiplex('Tom', 4)
-    #   # => 'TomTomTomTom'
-    #
-    #   multiplex('Bo', 2)
-    #   # => 'BoBo'
-    #
-    #   multiplex('Chris', -1)
-    #   # => nil
-    #
-    # Returns the duplicated String when the count is > 1.
-    # Returns the atomic mass of the element as a Float. The value is in
-    #   unified atomic mass units.
-    # Returns nil when the count is < 1.
-    # Raises ExpectedString if the first argument is not a String.
-    # Raises ExpectedInteger if the second argument is not an Integer.
-comment
-
-    @comment2 = TomParse::TomDoc.new(<<comment2)
-    # Duplicate some text an abitrary number of times.
-    #
-    # Returns the duplicated String.
-comment2
-
-    @comment3 = TomParse::TomDoc.new(<<comment3)
-    # Duplicate some text an abitrary number of times.
-    #
-    # Examples
-    #
-    #   multiplex('Tom', 4)
-    #   # => 'TomTomTomTom'
-    #
-    #   multiplex('Bo', 2)
-    #   # => 'BoBo'
-comment3
-
-    @comment4 = TomParse::TomDoc.new(<<comment4)
-    # 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.
-comment4
-
-    @comment5 = TomParse::TomDoc.new(<<comment5)
-    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.
-comment5
+testcase TomParse::TomDoc do
+
+  context "general parsing" do
+
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # text    - The String to be duplicated.
+        # count   - The Integer number of times to
+        #           duplicate the text.
+        # reverse - An optional Boolean indicating
+        #           whether to reverse the result text or not.
+        #
+        # Examples
+        #   multiplex('Tom', 4)
+        #   # => 'TomTomTomTom'
+        #
+        #   multiplex('Bo', 2)
+        #   # => 'BoBo'
+        #
+        #   multiplex('Chris', -1)
+        #   # => nil
+        #
+        # Returns the duplicated String when the count is > 1.
+        # Returns the atomic mass of the element as a Float. The value is in
+        #   unified atomic mass units.
+        # Returns nil when the count is < 1.
+        # Raises ExpectedString if the first argument is not a String.
+        # Raises ExpectedInteger if the second argument is not an Integer.
+      }
+    end
 
-  end
+    test "parses a description" do
+      @comment.description.assert == "Duplicate some text an abitrary number of times."
+    end
 
-  test "knows when TomDoc is invalid" do
-    assert_raises TomParse::ParseError do
-      @comment3.validate
+    test "parses args" do
+      @comment.args.size.assert == 3
     end
-  end
 
-  test "parses a description" do
-    assert_equal "Duplicate some text an abitrary number of times.",
-      @comment.description
-  end
+    test "knows an arg's name" do
+      @comment.args.first.name.assert == :text
+      @comment.args[1].name.assert == :count
+      @comment.args[2].name.assert == :reverse
+    end
 
-  test "parses args" do
-    assert_equal 3, @comment.args.size
-  end
+    test "knows an arg's description" do
+      @comment.args[1].description.assert == 'The Integer number of times to duplicate the text.'
 
-  test "knows an arg's name" do
-    assert_equal :text, @comment.args.first.name
-    assert_equal :count, @comment.args[1].name
-    assert_equal :reverse, @comment.args[2].name
-  end
+      reverse = 'An optional Boolean indicating whether to reverse the'
+      reverse << ' result text or not.'
+      @comment.args[2].description.assert == reverse
+    end
 
-  test "knows an arg's description" do
-    assert_equal 'The Integer number of times to duplicate the text.',
-      @comment.args[1].description
+    test "knows an arg's optionality" do
+      refute @comment.args.first.optional?
+      assert @comment.args.last.optional?
+    end
 
-    reverse = 'An optional Boolean indicating whether to reverse the'
-    reverse << ' result text or not.'
-    assert_equal reverse, @comment.args[2].description
-  end
+    test "knows how many examples there are" do
+      @comment.examples.size.assert == 3
+    end
 
-  test "knows an arg's optionality" do
-    assert_equal false, @comment.args.first.optional?
-    assert_equal true, @comment.args.last.optional?
-  end
+    test "knows each example" do
+      @comment.examples[1].to_s.assert == "multiplex('Bo', 2)\n# => 'BoBo'"
+    end
 
-  test "knows what to do when there are no args" do
-    assert_equal 0, @comment2.args.size
-  end
+    test "knows how many return examples there are" do
+      @comment.returns.size.assert == 3
+    end
 
-  test "knows how many examples there are" do
-    assert_equal 3, @comment.examples.size
-  end
+    test "knows if the method raises anything" do
+      @comment.raises.size.assert == 2
+    end
 
-  test "knows each example" do
-    assert_equal "multiplex('Bo', 2)\n  # => 'BoBo'",
-      @comment.examples[1].to_s
-  end
+    test "knows each return example" do
+      rtn = @comment.returns.first.to_s
+      rtn.assert == "Returns the duplicated String when the count is > 1."
 
-  test "knows what to do when there are no examples" do
-    assert_equal 0, @comment2.examples.size
-  end
+      string = ''
+      string << "Returns the atomic mass of the element as a Float. "
+      string << "The value is in unified atomic mass units."
+      @comment.returns[1].to_s.assert == string
 
-  test "knows how many return examples there are" do
-    assert_equal 3, @comment.returns.size
-  end
+      @comment.returns[2].to_s.assert == "Returns nil when the count is < 1."
+    end
 
-  test "knows if the method raises anything" do
-    assert_equal 2, @comment.raises.size
   end
 
-  test "knows each return example" do
-    assert_equal "Returns the duplicated String when the count is > 1.",
-      @comment.returns.first.to_s
+  context "handles whitespace in examples" do
+
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Examples
+        #
+        #   def multiplex(str, length)
+        #     str * length
+        #   end
+      }
+    end
 
-    string = ''
-    string << "Returns the atomic mass of the element as a Float. "
-    string << "The value is in unified atomic mass units."
-    assert_equal string, @comment.returns[1].to_s
+    test "correctly handles whitespace with examples" do
+      eg = @comment.examples[0].to_s
+      eg.assert == "def multiplex(str, length)\n  str * length\nend"
+    end
 
-    assert_equal "Returns nil when the count is < 1.",
-      @comment.returns[2].to_s
   end
 
-  test "knows what to do when there are no return examples" do
-    assert_equal 0, @comment2.examples.size
-  end
+  context "without arguments or examples" do
 
-  test "knows what the method yields" do
-    assert_equal "Yields the Integer index of the iteration.", @comment4.yields
-  end
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Returns the duplicated String.
+      }
+    end
+
+    test "knows what to do when there are no args" do
+      @comment.args.size.assert == 0
+    end
+
+    test "knows what to do when there are no examples" do
+      @comment.examples.size.assert == 0
+    end
+
+    test "knows what to do when there are no return examples" do
+      @comment.examples.size.assert == 0
+    end
 
-  test "knows if the method has alternate signatures" do
-    assert_equal 1, @comment4.signatures.size
-    assert_equal "find_by_<field>[_and_<field>...](args)", @comment4.signatures.first
   end
 
-  test "knows the fields associated with signatures" do
-    assert_equal 1, @comment4.signature_fields.size
 
-    arg = @comment4.signature_fields.first
-    assert_equal :field, arg.name
-    assert_equal "A field name.", arg.description
+  context "invalid documentation" do
+
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Examples
+        #
+        #   multiplex('Tom', 4)
+        #   # => 'TomTomTomTom'
+        #
+        #   multiplex('Bo', 2)
+        #   # => 'BoBo'
+      }
+    end
+
+    test "knows when TomDoc is invalid" do
+      expect TomParse::ParseError do
+        @comment.validate
+      end
+    end
+
   end
 
-  test "can hande comments without comment marker" do
-    assert_equal "Duplicate some text an abitrary number of times.",
-      @comment5.description
+
+  context "without comment marker" 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
+
+    test "can handle comments without comment marker" do
+      @comment.description.assert == "Duplicate some text an abitrary number of times."
+    end
+
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tomparse
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: microtest
-  requirement: &28469660 !ruby/object:Gem::Requirement
+  name: citron
+  requirement: &21084040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28469660
+  version_requirements: *21084040
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &28468540 !ruby/object:Gem::Requirement
+  requirement: &21077200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28468540
+  version_requirements: *21077200
 description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functionality
 
   than the ability to take a comment and parse it in accordance to the
@@ -51,10 +51,13 @@ files:
 - lib/tomparse.rb
 - lib/tomparse.yml
 - test/helper.rb
+- test/test_prefixes.rb
+- test/test_signatures.rb
 - test/test_tomdoc.rb
 - LICENSE.txt
 - HISTORY.md
 - README.md
+- Config.rb
 homepage: http://rubyworks.github.com/tomparse
 licenses:
 - BSD-2-Clause