tomparse 0.1.0 → 0.2.0

data/.ruby

@@ -36,7 +36,7 @@ revision: 0
 created: '2012-03-04'
 summary: TomDoc parser for Ruby
 title: TomParse
-version: 0.1.0
+version: 0.2.0
 name: tomparse
 description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functionality
 

data/HISTORY.md

@@ -1,5 +1,17 @@
 # Release History
 
+
+## 0.2.0 / 2012-03-5
+
+This release improves support of TomDoc, in particular, named parameters. It also
+fixes a bug with appending to argument and option descriptions.
+
+Changes:
+
+* Ass support for named parameters.
+* Fix appending to argument description issue.
+
+
 ## 0.1.0 / 2012-03-04
 
 TomParse is stand-alone TomDoc parser, spun-off and rewritten from the original

data/README.md

@@ -18,12 +18,6 @@ See [TomDoc](https://github.com/mojombo/tomdoc) for more information about
 the TomDoc format.
 
 
-## Limitations
-
-Current implmentation doesn't yet support named parameters. Hopefully
-that will be fixed soon in an upcoming release --any volunteers?
-
-
 ## Installation
 
     $ gem install tomparse

data/lib/tomparse.rb

@@ -8,33 +8,6 @@ module TomParse
     TomDoc.new(comment, parse_options)
   end
 
-  # Raised when comment can't be parsed, which means it's most
-  # likely not valid TomDoc.
-  #
-  class ParseError < RuntimeError
-    # Create new ParseError object.
-    #
-    # doc - document string
-    #
-    def initialize(doc)
-      @doc = doc
-    end
-
-    # Provide access to document string.
-    #
-    # Returns String.
-    def message
-      @doc
-    end
-
-    # Provide access to document string.
-    #
-    # Returns String.
-    def to_s
-      @doc
-    end
-  end
-
   # Encapsulate parsed tomdoc documentation.
   #
   # TODO: Currently uses lazy evaluation, eventually this should
@@ -132,7 +105,7 @@ module TomParse
       end
 
       # put first line back
-      lines.unshift(first.sub(/^\s*/,''))
+      lines.unshift(first.sub(/^\s*/,'')) if first
 
       lines.compact.join("\n")
     end
@@ -306,7 +279,7 @@ module TomParse
     # Parse arguments section. Arguments occur subsequent to
     # the description.
     #
-    # section - String containing agument definitions.
+    # section - String containing argument definitions.
     #
     # Returns nothing.
     def parse_arguments(section)
@@ -318,7 +291,7 @@ module TomParse
         indent = line.scan(/^\s*/)[0].to_s.size
 
         if last_indent && indent > last_indent
-          args.last.description += line.squeeze(" ")
+          args.last.description << line.squeeze(" ")
         else
           param, desc = line.split(" - ")
           args << Argument.new(param.strip, desc.strip) if param && desc
@@ -382,7 +355,8 @@ module TomParse
         end
       end
 
-      @returns, @raises = returns, raises
+      @returns.concat(returns)
+      @raises.concat(raises)
     end
 
     # Parse signature section.
@@ -427,7 +401,7 @@ module TomParse
         indent = line.scan(/^\s*/)[0].to_s.size
 
         if last_indent && indent > last_indent
-          args.last.description += line.squeeze(" ")
+          args.last.description << line.squeeze(" ")
         else
           param, desc = line.split(" - ")
           args << Argument.new(param.strip, desc.strip) if param && desc
@@ -445,7 +419,11 @@ module TomParse
   #
   class Argument
 
-    attr_accessor :name, :description
+    attr_accessor :name
+
+    attr_accessor :description
+
+    attr_accessor :options
 
     # Create new Argument object.
     #
@@ -454,7 +432,7 @@ module TomParse
     #
     def initialize(name, description = '')
       @name = name.to_s.intern
-      @description = description
+      parse(description)
     end
 
     # Is this an optional argument?
@@ -464,6 +442,97 @@ module TomParse
       @description.downcase.include? 'optional'
     end
 
+    # Parse arguments section. Arguments occur subsequent to
+    # the description.
+    #
+    # section - String containing argument definitions.
+    #
+    # Returns nothing.
+    def parse(description)
+      desc = []
+      opts = []
+
+      lines = description.lines.to_a
+
+      until lines.empty? or /^\s+\:(\w+)\s+-\s+(.*?)$/ =~ lines.first
+        desc << lines.shift
+      end
+
+      opts = []
+      last_indent = nil
+
+      lines.each do |line|
+        next if line.strip.empty?
+        indent = line.scan(/^\s*/)[0].to_s.size
+
+        if last_indent && indent > last_indent
+          args.last.description << line.squeeze(" ")
+        else
+          param, desc = line.split(" - ")
+          opts << Option.new(param.strip, desc.strip) if param && desc
+        end
+
+        last_indent = indent
+      end
+
+      @description = desc.join
+      @options     = opts
+    end
+
+  end
+
+  # Encapsulate a named parameter.
+  #
+  class Option
+
+    attr_accessor :name
+
+    attr_accessor :description
+
+    # Create new Argument object.
+    #
+    # name        - name of option
+    # description - option description
+    #
+    def initialize(name, description = '')
+      @name = name.to_s.intern
+      @description = description
+    end
+
+    # Is this a required option?
+    #
+    # Returns Boolean.
+    def required?
+      @description.downcase.include? 'required'
+    end
+
+  end
+
+  # Raised when comment can't be parsed, which means it's most
+  # likely not valid TomDoc.
+  #
+  class ParseError < RuntimeError
+    # Create new ParseError object.
+    #
+    # doc - document string
+    #
+    def initialize(doc)
+      @doc = doc
+    end
+
+    # Provide access to document string.
+    #
+    # Returns String.
+    def message
+      @doc
+    end
+
+    # Provide access to document string.
+    #
+    # Returns String.
+    def to_s
+      @doc
+    end
   end
 
 end

data/lib/tomparse.yml

@@ -36,7 +36,7 @@ revision: 0
 created: '2012-03-04'
 summary: TomDoc parser for Ruby
 title: TomParse
-version: 0.1.0
+version: 0.2.0
 name: tomparse
 description: ! 'TomParse is a Ruby TomDoc parser. It contains no other functionality
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tomparse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-04 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: microtest
-  requirement: &23546980 !ruby/object:Gem::Requirement
+  requirement: &28469660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23546980
+  version_requirements: *28469660
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &23545320 !ruby/object:Gem::Requirement
+  requirement: &28468540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23545320
+  version_requirements: *28468540
 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