yard-tomdoc 0.6.0 → 0.7.0

data/.index

@@ -10,13 +10,17 @@ authors:
 organizations: []
 requirements:
 - name: yard
-- version: 0.3.0+
+- version: 0.4.0+
   name: tomparse
-- name: rc
 - groups:
   - build
   development: true
   name: detroit
+- groups:
+  - build
+  - test
+  development: true
+  name: dotopts
 - groups:
   - test
   development: true
@@ -53,10 +57,10 @@ customs: []
 paths:
   lib:
   - lib
-version: 0.6.0
+version: 0.7.0
 name: yard-tomdoc
 title: YARD TomDoc
 summary: TomDoc for YARD
 description: Use TomDoc documentation format with YARD.
 webcvs: https://github.com/rubyworks/yard-tomdoc/tree/master
-date: '2013-01-22'
+date: '2013-02-11'

data/HISTORY.md

@@ -1,5 +1,17 @@
 # RELEASE HISTORY
 
+## 0.7.0 / 2013-02-12
+
+New major release uses the new major release of TomParse.
+So there you go. Oh, it improves class parsing for `Return`
+sections too. That's all.
+
+Changes:
+
+* Upgrade TomParse requirement to 0.4.0+.
+* Imporove class parsing for return tags.
+
+
 ## 0.6.0 / 2013-01-22
 
 This new major release adds support for most YARD tags thanks to TomParse's

data/README.md

@@ -1,4 +1,4 @@
-# YARD::TomDoc
+# YARD TomDoc
 
 [Website](http://rubyworks.github.com/yard-tomdoc) /
 [Development](http://github.com/rubyworks/yard-tomdoc) /
@@ -23,13 +23,12 @@ Since `yard-tomdoc` is a standard YARD plugin, utilize it with yard's
 
 ## Documentation
 
-### API
-
-* Shomen -
-  [Rebecca](http://rubyworks.github.com/rebecca?doc=http://rubyworks.github.com/yard-tomdoc/docs/current.json) /
-  [Hypervisor](http://rubyworks.github.com/hypervisor?doc=http://rubyworks.github.com/yard-tomdoc/docs/current.json) /
-  [Rubyfaux](http://rubyworks.github.com/rubyfaux?doc=http://rubyworks.github.com/yard-tomdoc/docs/current.json)
-* YARD - [RubyDoc.info](http://rubydoc.info/gems/yard-tomdoc/frames)
+* API
+  * YARD - [RubyDoc.info](http://rubydoc.info/gems/yard-tomdoc/frames)
+  * Shomen - (out of date)
+    [Rebecca](http://rubyworks.github.com/rebecca?doc=http://rubyworks.github.com/yard-tomdoc/docs/current.json) /
+    [Hypervisor](http://rubyworks.github.com/hypervisor?doc=http://rubyworks.github.com/yard-tomdoc/docs/current.json) /
+    [Rubyfaux](http://rubyworks.github.com/rubyfaux?doc=http://rubyworks.github.com/yard-tomdoc/docs/current.json)
 
 
 ## Limitations
@@ -37,19 +36,27 @@ Since `yard-tomdoc` is a standard YARD plugin, utilize it with yard's
 Before you use yard-tomdoc you should read about the differences between YARD
 and TomDoc syntax [here](http://gnuu.org/2010/05/12/whats-missing-from-tomdoc/).
 
+Note that the YARD TomDoc plugin now supports a superset of TomDoc's syntax which
+provides additional YARD functionality via *cap-tags*. For example using 
+`Author: James Deam` in the documentation is equivalent to using `@author James Dean`
+in regular YARD syntax. Support is limited but it opens up much more of the YARD
+goodness to TomDoc users then the old blog post geiven above suggests.
+
 
 ## Acknowledgements
 
-Huge thanks to Loren Segal, the creator of YARD and the original author of this plugin.
-Without his patient assistance and coding genius, this library would not have been possible.
+Huge thanks to Loren Segal, the creator of YARD and the original author of this
+plugin. Without his patient assistance and coding genius, this library would not
+have been possible.
 
 
 ## Licensing
 
-Yard::TomDoc is copyrighted open-source software.
+YARD TomDoc is copyrighted open-source software.
 
 Copyright (c) 2010 Rubyworks. All rights reserved.
 
-YARD::TomDoc can be modified and redistributed in accordance with the ters of the **MIT** licsnse.
+YARD TomDoc can be modified and redistributed in accordance with the terms
+of the **MIT** licsnse.
 
 See the `LICENSE.txt` file for details.

data/lib/yard-tomdoc.rb

@@ -11,10 +11,12 @@ module YARD
 
     # Parse comments with TomDoc and then provide YARD with results. 
     #
-    # yard    - [Docstring,DocstringParser] instance of yard object
-    # comment - [String] comment string
+    # Arguments
     #
-    # Returns [TomDoc] instance of TomDoc 
+    #   yard    - [Docstring,DocstringParser] instance of yard object
+    #   comment - [String] comment string
+    #
+    # Returns instance of [TomDoc].
     def self.yard_parse(yard, comment)
       tomdoc = TomParse.parse(comment)
 
@@ -33,8 +35,15 @@ module YARD
       tomdoc.raises.each {|r| yard.create_tag(:raise, r.sub(/\ARaises\s+/, '')) }
 
       tomdoc.returns.each do |r|
-        # TODO: improve how we figure out class of argument
-        if md = /\AReturns\s+([A-Z].*?)\s+/.match(r)
+        if md = /\[(.*?)\]\Z/.match(r)
+          klass = md[1]
+          desc  = md.pre_match
+          yard.create_tag(:return, "[#{klass}] #{desc}")
+        elsif md = /\[(.*?)\]/.match(r)
+          klass = md[1]
+          desc  = r.sub("[#{md[1]}]", md[1])
+          yard.create_tag(:return, "[#{klass}] #{desc}")
+        elsif md = /\AReturns\s+([A-Z].*?)\s+/.match(r)
           klass = md[1]
           desc  = md.post_match
           yard.create_tag(:return, "[#{klass}] #{desc}")
@@ -51,9 +60,10 @@ module YARD
       yard.create_tag(:api, 'public')  if tomdoc.public?
       yard.create_tag(:api, 'private') if tomdoc.internal?
 
-      tomdoc.tags.each do |label, desc|
-        if TAGS.include?(label.to_s)
-          yard.create_tag(label.to_sym, desc.to_s)
+      tomdoc.tags.each do |(label, desc)|
+        tag = label.to_s.downcase
+        if TAGS.include?(tag)
+          yard.create_tag(tag.to_sym, desc.to_s)
         end
       end
 
@@ -65,27 +75,22 @@ module YARD
       metadata[name.to_s.downcase] || super(name)
     end
 
-    # TODO: The #to_s on the gemspec return value is a bit too simplistic. But how to fix?
-    #       The goal is reduce the value to a basic type (String, Hash, Array, Numeric).
-
     # When a constant is missing, see if it is a metadata entry.
     # Metadata comes from the RubyGem, and fallsback to project index file.
     #
-    # name - [Symbol] constant name
+    # Arguments
+    #
+    #   name - [Symbol] constant name
     #
     # Returns metadata value.
     def self.const_missing(const_name)
       name = const_name.to_s.downcase
-      #begin
-      #  Gem.loaded_specs[NAME].send(name).to_s
-      #rescue StandardError
-        index[name] || super(const_name)
-      #end
+      index[name] || super(const_name)
     end
 
     # Metadata from the `yard-tomdoc.yml` or `.index` file.
-    # 
-    # Returns [Hash] of metadata.
+    #
+    # Returns metadata. [Hash]
     def self.index
       @index ||= (
         require 'yaml'

data/lib/yard-tomdoc.yml

@@ -10,13 +10,17 @@ authors:
 organizations: []
 requirements:
 - name: yard
-- version: 0.3.0+
+- version: 0.4.0+
   name: tomparse
-- name: rc
 - groups:
   - build
   development: true
   name: detroit
+- groups:
+  - build
+  - test
+  development: true
+  name: dotopts
 - groups:
   - test
   development: true
@@ -53,10 +57,10 @@ customs: []
 paths:
   lib:
   - lib
-version: 0.6.0
+version: 0.7.0
 name: yard-tomdoc
 title: YARD TomDoc
 summary: TomDoc for YARD
 description: Use TomDoc documentation format with YARD.
 webcvs: https://github.com/rubyworks/yard-tomdoc/tree/master
-date: '2013-01-22'
+date: '2013-02-11'

data/test/helper.rb

@@ -1,2 +1,12 @@
+require 'spectroscope'
+require 'ae'
 require 'fileutils'
 
+if ENV['simplecov']
+  require 'simplecov'
+  SimpleCov.command_name 'Ruby Tests'
+  SimpleCov.start do
+    coverage_dir('log/coverage')
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-tomdoc
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,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: yard
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,16 +43,16 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: rc
+  name: detroit
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -61,7 +61,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: detroit
+  name: dotopts
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: