tomparse 0.4.1 → 0.4.2

data/.index

@@ -3,7 +3,6 @@ revision: 2013
 type: ruby
 sources:
 - var
-- VERSION
 authors:
 - name: trans
   email: transfire@gmail.com
@@ -58,11 +57,11 @@ paths:
 created: '2012-03-04'
 summary: TomDoc parser for Ruby
 title: TomParse
+version: 0.4.2
 name: tomparse
 description: ! 'TomParse provides no other functionality than to take a code comment
 
   and parse it in to a convenient object-oriented structure in accordance
 
   with TomDoc standard.'
-version: 0.4.1
-date: '2013-02-14'
+date: '2013-02-15'

data/HISTORY.md

@@ -1,8 +1,18 @@
 # Release History
 
+## 0.4.2 / 2013-02-15
+
+This release fixes description and argument parsing when
+a visibility indicator is used.
+
+Changes:
+
+* Fix desc/arguments parsing given indicator.
+
+
 ## 0.4.1 / 2013-02-14
 
-This release fixes exmaple parsing.
+This release fixes example parsing.
 
 Changes:
 

data/lib/tomparse.yml

@@ -3,7 +3,6 @@ revision: 2013
 type: ruby
 sources:
 - var
-- VERSION
 authors:
 - name: trans
   email: transfire@gmail.com
@@ -58,11 +57,11 @@ paths:
 created: '2012-03-04'
 summary: TomDoc parser for Ruby
 title: TomParse
+version: 0.4.2
 name: tomparse
 description: ! 'TomParse provides no other functionality than to take a code comment
 
   and parse it in to a convenient object-oriented structure in accordance
 
   with TomDoc standard.'
-version: 0.4.1
-date: '2013-02-14'
+date: '2013-02-15'

data/lib/tomparse/argument.rb

@@ -2,6 +2,8 @@ module TomParse
 
   # Encapsulate a method argument.
   #
+  # TODO: Does not yet support default parameter.
+  #
   class Argument
 
     attr_accessor :name
@@ -24,7 +26,7 @@ module TomParse
     #
     # Returns Boolean.
     def optional?
-      @description.downcase.include? 'optional'
+      @optional
     end
 
     # Parse arguments section. Arguments occur subsequent to
@@ -60,8 +62,25 @@ module TomParse
         last_indent = indent
       end
 
-      @description = desc.join
-      @options     = opts
+      # Look for `(optional)` at end of description. If found, mark argument
+      # as @optional and remove from description.
+      #if md = /(\(optional\)\s*)(?:\[|\.\Z|\Z)/.match(desc.last)
+      #  @optional = true
+      #  desc.last[*md.offset(1)] = ''
+      #end
+
+      # Join the desc lines back together and ensure no extraneous whitespace.
+      text = desc.join.strip
+
+      # If the description contains the word "optional" the argument is taken
+      # to be optional. Note, I think this probably should be `(optional)` to
+      # prevent false positives, but the spec suggests otherwise.
+      if /\boptional\b/ =~ text
+        @optional = true
+      end
+
+      @description = text
+      @options = opts
     end
 
   end

data/lib/tomparse/parser.rb

@@ -365,6 +365,8 @@ module TomParse
     end
 
     # Split the documentation up into proper sections.
+    # The method works by building up a list of linenos
+    # of where each section begins.
     #
     # Returns an array section strings. [Array<String>]
     def smart_split(doc)
@@ -379,11 +381,11 @@ module TomParse
       # Keep a copy of the lines for later use.
       doc_lines = lines.dup
      
+
       # The first line may have a `Public`/`Private`/`Deprecated` marker.
-      # We need to remove that for the moment to properly check for 
-      # subsequent labeled sections.
-      #first = lines.first.dup
-      #lines.first.sub(/^[A-Z]\w+\:\s*/, '')
+      # So we just skip the first line.
+      lines.shift
+      index += 1
 
       # The description is always the first section, but it may have
       # multiple paragraphs. And the second section may be an arguments

data/test/test_arguments.rb

@@ -0,0 +1,217 @@
+require_relative 'helper'
+
+testcase "Arguments" do
+
+  context "single line argument without heading" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # text - The String to be duplicated.
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 1
+    end
+    test "knows args name" do
+      @comment.args.first.name.assert == :text
+    end
+    test "knows args description" do
+      @comment.args.first.description.assert == "The String to be duplicated."
+    end
+    test "knows args optionality" do
+      @comment.args.first.refute.optional?
+    end
+    test "know description" do
+      @comment.description == "Duplicate some text an abitrary number of times."
+    end
+  end
+
+  context "multi-line argument without heading" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # text - The String to be duplicated.
+        #        And its description continues.
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 1
+    end
+    test "knows args name" do
+      @comment.args.first.name.assert == :text
+    end
+    test "knows args description" do
+      @comment.args.first.description.assert == "The String to be duplicated. And its description continues."
+    end
+    test "knows args optionality" do
+      @comment.args.first.refute.optional?
+    end
+    test "know description" do
+      @comment.description == "Duplicate some text an abitrary number of times."
+    end
+  end
+
+  context "multiple arguments without heading" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # text - The String to be duplicated.
+        #        And its description continues.
+        # num  - The Number to be duplicated. 
+        #        And it continues too. (optional)
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 2
+    end
+    test "knows args name" do
+      @comment.args[0].name.assert == :text
+      @comment.args[1].name.assert == :num
+    end
+    test "knows args description" do
+      @comment.args[0].description.assert == "The String to be duplicated. And its description continues."
+      @comment.args[1].description.assert == "The Number to be duplicated. And it continues too. (optional)"
+    end
+    test "knows args optionality" do
+      @comment.args[0].refute.optional?
+      @comment.args[1].assert.optional?
+    end
+    test "know description" do
+      @comment.description == "Duplicate some text an abitrary number of times."
+    end
+  end
+
+  context "single line argument with heading" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Arguments
+        #   text - The String to be duplicated.
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 1
+    end
+    test "knows args name" do
+      @comment.args.first.name.assert == :text
+    end
+    test "knows args description" do
+      @comment.args.first.description.assert == "The String to be duplicated."
+    end
+    test "knows args optionality" do
+      @comment.args.first.refute.optional?
+    end
+    test "know description" do
+      @comment.description == "Duplicate some text an abitrary number of times."
+    end
+  end
+
+  context "multi-line argument with heading" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Arguments
+        #   text - The String to be duplicated.
+        #          And its description continues.
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 1
+    end
+    test "knows args name" do
+      @comment.args.first.name.assert == :text
+    end
+    test "knows args description" do
+      @comment.args.first.description.assert == "The String to be duplicated. And its description continues."
+    end
+    test "knows args optionality" do
+      @comment.args.first.refute.optional?
+    end
+    test "know description" do
+      @comment.description == "Duplicate some text an abitrary number of times."
+    end
+  end
+
+  context "multiple arguments without heading" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Arguments
+        #   text - The String to be duplicated.
+        #          And its description continues.
+        #   num  - The Number to be duplicated. 
+        #          And it continues too. (optional)
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 2
+    end
+    test "knows args name" do
+      @comment.args[0].name.assert == :text
+      @comment.args[1].name.assert == :num
+    end
+    test "knows args description" do
+      @comment.args[0].description.assert == "The String to be duplicated. And its description continues."
+      @comment.args[1].description.assert == "The Number to be duplicated. And it continues too. (optional)"
+    end
+    test "knows args optionality" do
+      @comment.args[0].refute.optional?
+      @comment.args[1].assert.optional?
+    end
+    test "know description" do
+      @comment.description == "Duplicate some text an abitrary number of times."
+    end
+  end
+
+  context "when description has visibility indicator" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Public: Duplicate some text an abitrary number of times.
+        #
+        # text - The String to be duplicated.
+        #        And its description continues.
+        # num  - The Number to be duplicated. 
+        #        And it continues too.
+        #
+        # Returns the duplicated String when the count is > 1.
+      }
+    end
+    test "knows args size" do
+      @comment.args.size.assert == 2
+    end
+    test "knows args name" do
+      @comment.args[0].name.assert == :text
+      @comment.args[1].name.assert == :num
+    end
+    test "knows args description" do
+      @comment.args[0].description.assert == "The String to be duplicated. And its description continues."
+      @comment.args[1].description.assert == "The Number to be duplicated. And it continues too."
+    end
+    test "knows args optionality" do
+      @comment.args[0].refute.optional?
+      @comment.args[1].refute.optional?
+    end
+    test "know description" do
+      @comment.description == "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.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citron
@@ -82,6 +82,7 @@ files:
 - lib/tomparse.rb
 - lib/tomparse.yml
 - test/helper.rb
+- test/test_arguments.rb
 - test/test_description.rb
 - test/test_examples.rb
 - test/test_prefixes.rb
@@ -126,4 +127,5 @@ test_files:
 - test/test_tags.rb
 - test/test_tomdoc.rb
 - test/test_prefixes.rb
+- test/test_arguments.rb
 has_rdoc: