yard-heuristics 1.0.1 → 1.1.0

data/lib/yard-heuristics-1.0.rb

@@ -25,6 +25,7 @@ module YARDHeuristics
     :/ => :type,
     :each => %w'self',
     :each_with_index => %w'self',
+    :hash => %w'Integer',
     :inspect => %w'String',
     :length => %w'Integer',
     :size => %w'Integer',
@@ -53,6 +54,7 @@ end
 YARD::DocstringParser.after_parse do |parser|
   next unless YARD::CodeObjects::MethodObject === parser.object
   next if parser.text.empty? and parser.tags.empty?
+  next if parser.raw_text =~ /\A\(see.*\)\z/
   name = parser.object.namespace ?
     (parser.object.namespace.namespace ?
      parser.object.namespace.relative_path(parser.object.namespace) :
@@ -99,3 +101,22 @@ YARD::DocstringParser.after_parse do |parser|
     end
   end
 end
+
+module YARD::Templates::Helpers::HtmlHelper
+  alias yardheuristics_saved_htmlify htmlify
+  def htmlify(text, markup = options.markup)
+    yardheuristics_saved_htmlify(text, markup).gsub(/\b([[:upper:]]+)(th)?\b/){
+      if $`.end_with?('$') or not YARD::CodeObjects::MethodObject === object
+        $&
+      else
+        parameter = $1.downcase
+        ((object.parameters.assoc(parameter) ||
+          object.parameters.assoc('*' + parameter) ||
+          object.parameters.assoc('&' + parameter) ||
+          object.tags.find{ |e| e.tag_name == 'yieldparam' and e.name == parameter }) ?
+         '<em class="parameter">%s</em>' % parameter :
+         $1) + $2.to_s
+      end
+    }
+  end
+end

data/lib/yard-heuristics/version.rb

@@ -3,7 +3,7 @@
 require 'inventory-1.0'
 
 module YARDHeuristics
-  Version = Inventory.new(1, 0, 1){
+  Version = Inventory.new(1, 1, 0){
     def dependencies
       super + Inventory::Dependencies.new{
         development 'inventory-rake', 1, 3, 0

data/test/unit/yard-heuristics-1.0.rb

@@ -107,4 +107,114 @@ end
 EOS
     YARD::Registry.at('#a').docstring.tags(:param).last.types
   end
+
+  expect [%w'self'] do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# @return [self]
+def b(&block)
+end
+# (see #b)
+def <<(&block)
+end
+EOS
+  YARD::Registry.at('#<<').docstring.tags(:return).map{ |e| e.types }
+  end
+
+  expect 'Emphasizes <em class="parameter">parameter</em>.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# Emphasizes PARAMETER.
+def a(parameter)
+end
+EOS
+    Module.new{
+      class << self
+        include YARD::Templates::Helpers::HtmlHelper
+        def options
+          YARD::Templates::TemplateOptions.new{ |o|
+            o.reset_defaults
+          }
+        end
+        def object
+          YARD::Registry.at('#a')
+        end
+      end
+    }.instance_eval{
+      htmlify(YARD::Registry.at('#a').docstring)
+    }
+  end
+
+  expect 'The <em class="parameter">index</em>th element.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# The INDEXth element.
+def a(index)
+end
+EOS
+    Module.new{
+      class << self
+        include YARD::Templates::Helpers::HtmlHelper
+        def options
+          YARD::Templates::TemplateOptions.new{ |o|
+            o.reset_defaults
+          }
+        end
+        def object
+          YARD::Registry.at('#a')
+        end
+      end
+    }.instance_eval{
+      htmlify(YARD::Registry.at('#a').docstring)
+    }
+  end
+
+  expect 'The value of $VERBOSE.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# The value of $VERBOSE.
+def a(verbose)
+end
+EOS
+    Module.new{
+      class << self
+        include YARD::Templates::Helpers::HtmlHelper
+        def options
+          YARD::Templates::TemplateOptions.new{ |o|
+            o.reset_defaults
+          }
+        end
+        def object
+          YARD::Registry.at('#a')
+        end
+      end
+    }.instance_eval{
+      htmlify(YARD::Registry.at('#a').docstring)
+    }
+  end
+
+  expect 'Yields the <em class="parameter">exception</em>.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# Yields the EXCEPTION.
+# @yieldparam [Exception] exception
+def a
+end
+EOS
+    Module.new{
+      class << self
+        include YARD::Templates::Helpers::HtmlHelper
+        def options
+          YARD::Templates::TemplateOptions.new{ |o|
+            o.reset_defaults
+          }
+        end
+        def object
+          YARD::Registry.at('#a')
+        end
+      end
+    }.instance_eval{
+      htmlify(YARD::Registry.at('#a').docstring)
+    }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-heuristics
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 Z
+date: 2012-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inventory
-  requirement: &15064488 !ruby/object:Gem::Requirement
+  requirement: &15442740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *15064488
+  version_requirements: *15442740
 - !ruby/object:Gem::Dependency
   name: inventory-rake
-  requirement: &15063012 !ruby/object:Gem::Requirement
+  requirement: &15441408 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *15063012
+  version_requirements: *15441408
 - !ruby/object:Gem::Dependency
   name: lookout
-  requirement: &15061752 !ruby/object:Gem::Requirement
+  requirement: &15440268 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *15061752
+  version_requirements: *15440268
 - !ruby/object:Gem::Dependency
   name: lookout-rake
-  requirement: &15061260 !ruby/object:Gem::Requirement
+  requirement: &15438504 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *15061260
+  version_requirements: *15438504
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &15091644 !ruby/object:Gem::Requirement
+  requirement: &15436296 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *15091644
+  version_requirements: *15436296
 description: ! "                                  YARD-Heuristics\n\n  YARD-Heuristics
   heuristically determines types of parameters and return\n  values to YARD.\n"
 email: now@bitwi.se