yard-heuristics 1.0.0 → 1.0.1

data/lib/yard-heuristics-1.0.rb

@@ -4,25 +4,98 @@
 module YARDHeuristics
   load File.expand_path('../yard-heuristics/version.rb', __FILE__)
   Version.load
+
+  ParamTypes = {
+    'index' => %w'Integer',
+    'object' => %w'Object',
+    'range' => %w'Range',
+    'string' => %w'String'
+  }
+
+  ReturnTypes = {
+    :<< => :self_or_type,
+    :>> => :self_or_type,
+    :== => %w'Boolean',
+    :=== => %w'Boolean',
+    :=~ => %w'Boolean',
+    :<=> => %w'Integer nil',
+    :+ => :type,
+    :- => :type,
+    :* => :type,
+    :/ => :type,
+    :each => %w'self',
+    :each_with_index => %w'self',
+    :inspect => %w'String',
+    :length => %w'Integer',
+    :size => %w'Integer',
+    :to_s => %w'String',
+    :to_str => %w'String'
+  }
+
+  class << self
+    def set_or_add_param_tag(overload, name, types)
+      base = name.sub(/\A[&*]/, '')
+      if tag = overload.tags.find{ |e| e.tag_name == 'param' and e.name == base }
+        tag.types = types unless tag.types
+      else
+        tag = YARD::Tags::Tag.new(:param, '', types, base)
+        if overload.respond_to? :docstring
+          overload.docstring.add_tag tag
+        else
+          overload.tags << tag
+        end
+      end
+      self
+    end
+  end
 end
 
 YARD::DocstringParser.after_parse do |parser|
   next unless YARD::CodeObjects::MethodObject === parser.object
-  if parser.object.parameters.assoc('other') and not parser.tags.select{ |e| e.tag_name == 'param' }.find{ |e| e.name == 'other' }
+  next if parser.text.empty? and parser.tags.empty?
+  name = parser.object.namespace ?
+    (parser.object.namespace.namespace ?
+     parser.object.namespace.relative_path(parser.object.namespace) :
+     parser.object.namespace.name) :
+    parser.object.name
+  if parser.object.parameters.assoc('other') and
+      not parser.tags.select{ |e| e.tag_name == 'param' }.
+        find{ |e| YARD::Tags::RefTagList === e or e.name == 'other' }
     parser.tags <<
-      YARD::Tags::Tag.new(:param,
-                          '',
-                          parser.object.namespace.namespace ?
-                            parser.object.namespace.relative_path(parser.object.namespace) :
-                            parser.object.namespace,
-                          'other')
+      YARD::Tags::Tag.new(:param, '', name, 'other')
   end
-  returns = parser.tags.select{ |e| e.tag_name == 'return' }
-  if [:===, :==, :=~].include? parser.object.name and returns.size < 2
-    if returns.empty?
-      parser.tags << YARD::Tags::Tag.new(:return, '', %w'Boolean')
-    elsif not returns.first.types
-      returns.first.types = %w'Boolean'
+  ([parser] + parser.tags.select{ |e| YARD::Tags::OverloadTag === e }).each do |overload|
+    parameters = (YARD::Tags::OverloadTag === overload and overload.parameters) ||
+      parser.object.parameters
+    parameters.each do |name, _|
+      types = YARDHeuristics::ParamTypes[name] and
+        YARDHeuristics.set_or_add_param_tag(overload, name, types)
+    end
+    YARDHeuristics.set_or_add_param_tag(overload, parameters.last.first, %w'Proc') if
+      parameters.last and parameters.last.first =~ /\A&/
+
+    returns = overload.tags.select{ |e| e.tag_name == 'return' }
+    types = YARDHeuristics::ReturnTypes[(YARD::Tags::OverloadTag === overload and
+                                         overload.name) || parser.object.name]
+    case types
+    when :self_or_type
+      types = parser.tags.select{ |e| e.tag_name == 'param' }.find{ |e| e.name == 'other' } ?
+        [name] :
+        %w'self'
+    when :type
+      types = [name]
+    end
+    if types and returns.size < 2
+      if returns.size == 0
+        tag = YARD::Tags::Tag.new(:return, '', types)
+        if overload.respond_to? :docstring
+          overload.docstring.add_tag tag
+        else
+          overload.tags << tag
+        end
+      elsif not returns.first.types
+        returns.first.types = types
+      end
     end
   end
 end

data/lib/yard-heuristics/version.rb

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

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

@@ -10,6 +10,101 @@ class A
   end
 end
 EOS
-  YARD::Registry.at('A#a').docstring.tags(:param).map{ |e| [e.name, e.types] }
+    YARD::Registry.at('A#a').docstring.tags(:param).map{ |e| [e.name, e.types] }
+  end
+
+  expect %w'self' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # Placeholder
+  def each
+  end
+end
+EOS
+    YARD::Registry.at('A#each').docstring.tags(:return).first.types
+  end
+
+  expect %w'self' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # @overload
+  #   Enumerates objects
+  #
+  #   @yieldparam [Object] object
+  # @overload
+  #   @return [Enumerator<Object>] An Enumerator
+  def each
+  end
+end
+EOS
+    YARD::Registry.at('A#each').docstring.tags(:overload).first.tag(:return).types
+  end
+
+  expect %w'A' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # @return The addition of the receiver and _other_
+  def +(other)
+  end
+end
+EOS
+    YARD::Registry.at('A#+').docstring.tags(:return).first.types
+  end
+
+  expect %w'A' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # @return The shifted value
+  def <<(other)
+  end
+end
+EOS
+    YARD::Registry.at('A#<<').docstring.tags(:return).first.types
+  end
+
+  expect %w'self' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # @return The shifted value
+  def <<(element)
+  end
+end
+EOS
+    YARD::Registry.at('A#<<').docstring.tags(:return).first.types
+  end
+
+  expect %w'Range' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# A
+def a(range)
+end
+EOS
+    YARD::Registry.at('#a').docstring.tags(:param).last.types
+  end
+
+  expect %w'Integer' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# A
+def a(index)
+end
+EOS
+    YARD::Registry.at('#a').docstring.tags(:param).last.types
+  end
+
+  expect %w'Proc' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+# @return The shifted value
+def a(&block)
+end
+EOS
+    YARD::Registry.at('#a').docstring.tags(:param).last.types
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-heuristics
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inventory
-  requirement: &2152773000 !ruby/object:Gem::Requirement
+  requirement: &15064488 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2152773000
+  version_requirements: *15064488
 - !ruby/object:Gem::Dependency
   name: inventory-rake
-  requirement: &2152772300 !ruby/object:Gem::Requirement
+  requirement: &15063012 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *2152772300
+  version_requirements: *15063012
 - !ruby/object:Gem::Dependency
   name: lookout
-  requirement: &2152771700 !ruby/object:Gem::Requirement
+  requirement: &15061752 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2152771700
+  version_requirements: *15061752
 - !ruby/object:Gem::Dependency
   name: lookout-rake
-  requirement: &2152771080 !ruby/object:Gem::Requirement
+  requirement: &15061260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2152771080
+  version_requirements: *15061260
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152770340 !ruby/object:Gem::Requirement
+  requirement: &15091644 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152770340
+  version_requirements: *15091644
 description: ! "                                  YARD-Heuristics\n\n  YARD-Heuristics
   heuristically determines types of parameters and return\n  values to YARD.\n"
 email: now@bitwi.se
@@ -81,6 +81,7 @@ files:
 - Rakefile
 homepage: https://github.com/now/yard-heuristics
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -99,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: values to YARD.
 test_files: []