yard-heuristics 1.0.0

data/README

@@ -0,0 +1,4 @@
+                                  YARD-Heuristics
+
+  YARD-Heuristics heuristically determines types of parameters and return
+  values to YARD.

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory/rake-1.0'
+
+load File.expand_path('../lib/yard-heuristics/version.rb', __FILE__)
+
+Inventory::Rake::Tasks.define YARDHeuristics::Version, :gem => proc{ |_, s|
+  s.author = 'Nikolai Weibull'
+  s.email = 'now@bitwi.se'
+  s.homepage = 'https://github.com/now/yard-heuristics'
+}
+
+Inventory::Rake::Tasks.unless_installing_dependencies do
+  require 'lookout/rake-3.0'
+  # TODO: Silence warnings generated from YARD (remove this once we plug them)
+  Lookout::Rake::Tasks::Test.new :options => []
+end

data/lib/yard-heuristics-1.0.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+# Namespace for YARD heuristics.
+module YARDHeuristics
+  load File.expand_path('../yard-heuristics/version.rb', __FILE__)
+  Version.load
+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' }
+    parser.tags <<
+      YARD::Tags::Tag.new(:param,
+                          '',
+                          parser.object.namespace.namespace ?
+                            parser.object.namespace.relative_path(parser.object.namespace) :
+                            parser.object.namespace,
+                          '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'
+    end
+  end
+end

data/lib/yard-heuristics/version.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory-1.0'
+
+module YARDHeuristics
+  Version = Inventory.new(1, 0, 0){
+    def dependencies
+      super + Inventory::Dependencies.new{
+        development 'inventory-rake', 1, 3, 0
+        development 'lookout', 3, 0, 0
+        development 'lookout-rake', 3, 0, 0
+        runtime 'yard', 0, 8, 0, :feature => 'yard'
+      }
+    end
+  }
+end

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

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+  expect [['other', %w'A']] do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # Placeholder
+  def a(other)
+  end
+end
+EOS
+  YARD::Registry.at('A#a').docstring.tags(:param).map{ |e| [e.name, e.types] }
+  end
+end

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

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: yard-heuristics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nikolai Weibull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inventory
+  requirement: &2152773000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152773000
+- !ruby/object:Gem::Dependency
+  name: inventory-rake
+  requirement: &2152772300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *2152772300
+- !ruby/object:Gem::Dependency
+  name: lookout
+  requirement: &2152771700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152771700
+- !ruby/object:Gem::Dependency
+  name: lookout-rake
+  requirement: &2152771080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152771080
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152770340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152770340
+description: ! "                                  YARD-Heuristics\n\n  YARD-Heuristics
+  heuristically determines types of parameters and return\n  values to YARD.\n"
+email: now@bitwi.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yard-heuristics-1.0.rb
+- lib/yard-heuristics/version.rb
+- test/unit/yard-heuristics-1.0.rb
+- test/unit/yard-heuristics/version.rb
+- README
+- Rakefile
+homepage: https://github.com/now/yard-heuristics
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: values to YARD.
+test_files: []