tomparse 0.4.0 → 0.4.1

data/.index

@@ -64,5 +64,5 @@ description: ! 'TomParse provides no other functionality than to take a code com
   and parse it in to a convenient object-oriented structure in accordance
 
   with TomDoc standard.'
-version: 0.4.0
-date: '2013-02-11'
+version: 0.4.1
+date: '2013-02-14'

data/HISTORY.md

@@ -1,5 +1,15 @@
 # Release History
 
+## 0.4.1 / 2013-02-14
+
+This release fixes exmaple parsing.
+
+Changes:
+
+* Handle variable indention in examples.
+* Do not remove newlines for single example.
+
+
 ## 0.4.0 / 2013-02-10
 
 For this release, the document parser has been substantially refactored.

data/lib/tomparse.yml

@@ -64,5 +64,5 @@ description: ! 'TomParse provides no other functionality than to take a code com
   and parse it in to a convenient object-oriented structure in accordance
 
   with TomDoc standard.'
-version: 0.4.0
-date: '2013-02-11'
+version: 0.4.1
+date: '2013-02-14'

data/lib/tomparse/parser.rb

@@ -540,33 +540,28 @@ module TomParse
 
     # Parse example.
     #
-    # section  - String starting with `Examples`.
-    # sections - All sections subsequent to section.
+    # section  - String starting with `Example`.
     #
     # Returns nothing.
     def parse_example(section)
-      examples = []
-
-      # TODO: make the unidention smarter (could be more than 2 spaces)
-      section = section.sub('Example', '').gsub(/^\s{2}/,'')
-
-      @examples << section unless section.strip.empty?
+      # remove the initial `Example` line and right strip
+      section = section.sub(/.*?\n/, '')
+      example = clean_example(section)
+      @examples << example unless example.strip.empty?
     end
 
     # Parse examples.
     #
     # section  - String starting with `Examples`.
-    # sections - All sections subsequent to section.
     #
     # Returns nothing.
     def parse_examples(section)
-      #examples = []
-
-      # TODO: make the unidention smarter (could be more than 2 spaces)
-      section = section.sub('Examples', '')
-
+      # remove the initial `Examples` line and right strip
+      section = section.sub(/.*?\n/, '')
       section.split("\n\n").each do |ex|
-        @examples << ex.gsub(/^\s{2}/,'') unless ex.strip.empty?
+        next if ex.strip.empty?
+        example = clean_example(ex)
+        @examples << example
       end
     end
 
@@ -587,27 +582,6 @@ module TomParse
     def parse_returns(section)
       text = section.gsub(/\s+/, ' ').strip
       @returns << text
-
-      #returns, raises, current = [], [], []
-      #
-      #lines = section.split("\n")  
-      #lines.each do |line|
-      #  case line
-      #  when /^Returns/
-      #    returns << line
-      #    current = returns
-      #  when /^Raises/
-      #    raises << line
-      #    current = raises
-      #  when /^\s+/
-      #    current.last << line.squeeze(' ')
-      #  else
-      #    current << line  # TODO: What to do with non-compliant line?
-      #  end
-      #end
-      #
-      #@returns.concat(returns)
-      #@raises.concat(raises)
     end
 
     # Parse raises section.
@@ -694,6 +668,33 @@ module TomParse
       @tags << [label, desc.strip] if label
     end
 
+  private
+
+    def clean_example(text)
+      lines = text.rstrip.lines.to_a
+      # remove blank lines from top
+      lines.shift while lines.first.strip.empty?
+      # determine the indention
+      indent = least_indent(lines)
+      # remove the indention
+      tab = " " * indent
+      lines = lines.map{ |line| line.sub(tab, '') }
+      # put the lines back together
+      lines.join
+    end
+
+    # Given a multi-line string, determine the minimum indention.
+    def least_indent(lines)
+      indents = []
+      lines.map do |line|
+        next if line.strip.empty?
+        if md = /^\ */.match(line)
+          indents << md[0].size
+        end
+      end
+      indents.min || 0
+    end
+
   end
 
 end

data/test/helper.rb

@@ -1,5 +1,13 @@
 require 'citron'
 require 'ae'
 
+if ENV['coverage']
+  require 'simplecov'
+  SimpleCov.command_name 'tomparse'
+  SimpleCov.start do
+    coverage_dir 'log/coverage'
+  end
+end
+
 require 'tomparse'
 

data/test/test_examples.rb

@@ -0,0 +1,124 @@
+require_relative 'helper'
+
+testcase "Examples" do
+
+  context "plural form one example" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Examples
+        #   multiplex('Tom', 4)
+        #   # => 'TomTomTomTom'
+        #
+        # Returns something or another.
+      }
+    end
+
+    test "there is one examples" do
+      @comment.examples.size.assert == 1
+    end
+
+    test "the example" do
+      @comment.examples.first.assert == "multiplex('Tom', 4)\n# => 'TomTomTomTom'"
+    end
+  end
+
+  context "plural form multiple examples" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Examples
+        #   multiplex('Tom', 4)
+        #   # => 'TomTomTomTom'
+        #
+        #   multiplex('Bo', 2)
+        #   # => 'BoBo'
+        #
+        # Returns something or another.
+      }
+    end
+
+    test "there are two examples" do
+      @comment.examples.size.assert == 2
+    end
+
+    test "the first example" do
+      @comment.examples.first.assert == "multiplex('Tom', 4)\n# => 'TomTomTomTom'"
+    end
+
+    test "the second example" do
+      @comment.examples.last.assert == "multiplex('Bo', 2)\n# => 'BoBo'"
+    end
+  end
+
+  context "singular form" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Example
+        #   answer = multiplex('Tom', 4)
+        #
+        #   return answer
+        #
+        # Returns something or another.
+      }
+    end
+
+    test "there is one example" do
+      @comment.examples.size.assert == 1
+    end
+
+    test "the example" do
+      @comment.examples.first.assert == "answer = multiplex('Tom', 4)\n\nreturn answer"
+    end
+  end
+
+  context "multiple example clauses" do
+    setup do
+      @comment = TomParse::TomDoc.new %{
+        # Duplicate some text an abitrary number of times.
+        #
+        # Examples
+        #   multiplex('Tom', 4)
+        #   # => 'TomTomTomTom'
+        #
+        #   multiplex('Bo', 2)
+        #   # => 'BoBo'
+        #
+        # Example
+        #   answer = multiplex('Tom', 4)
+        #
+        #   return answer
+        #
+        # Returns something or another.
+      }
+    end
+
+    test "there are three examples" do
+      @comment.examples.size.assert == 3
+    end
+  end
+
+  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
+
+    test "correctly handles whitespace with examples" do
+      eg = @comment.examples[0].to_s
+      eg.assert == "def multiplex(str, length)\n  str * length\nend"
+    end
+  end
+
+end

data/test/test_tomdoc.rb

@@ -104,7 +104,6 @@ testcase TomParse::TomDoc do
   end
 
   context "handles multiple paragraph descriptions" do
-
     setup do
       @comment = TomParse::TomDoc.new %{
         # Has an initial paragraph.
@@ -122,11 +121,9 @@ testcase TomParse::TomDoc do
     test "correctly handles multiple paragraphs" do
       @comment.description.assert == "Has an initial paragraph.\n\nHas another paragraph in the description."
     end
-
   end
 
   context "handles whitespace in examples" do
-
     setup do
       @comment = TomParse::TomDoc.new %{
         # Duplicate some text an abitrary number of times.
@@ -143,7 +140,6 @@ testcase TomParse::TomDoc do
       eg = @comment.examples[0].to_s
       eg.assert == "def multiplex(str, length)\n  str * length\nend"
     end
-
   end
 
   context "without arguments or examples" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tomparse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citron
@@ -83,6 +83,7 @@ files:
 - lib/tomparse.yml
 - test/helper.rb
 - test/test_description.rb
+- test/test_examples.rb
 - test/test_prefixes.rb
 - test/test_signatures.rb
 - test/test_tags.rb
@@ -119,6 +120,7 @@ summary: TomDoc parser for Ruby
 test_files:
 - test/test_description.rb
 - test/helper.rb
+- test/test_examples.rb
 - test/test_yields.rb
 - test/test_signatures.rb
 - test/test_tags.rb