yard-defaultreturn 1.0.1

data/README.md

@@ -0,0 +1,25 @@
+# yard-defaultreturn
+
+Adds `@defaultreturn` tag to classes/modules to define a return tag on every
+method in the namespace.
+
+## Usage
+
+Using `@defaultreturn` will automatically declare `@return` tags on methods
+without any return type defined inside the class/module:
+
+    # @defaultreturn [Boolean] the boolean value
+    class A
+      def foo; end
+      
+      # @return [Array] override default
+      def bar; end
+    end
+
+## Install
+
+    gem install yard-defaultreturn
+
+or checkout source and
+
+    rake install

data/Rakefile

@@ -0,0 +1,15 @@
+WINDOWS = (RUBY_PLATFORM =~ /win32|cygwin/ ? true : false) rescue false
+SUDO = WINDOWS ? '' : 'sudo'
+
+task :default => :install
+
+desc "Builds the gem"
+task :gem do
+  sh "gem build yard-defaultreturn.gemspec"
+end
+
+desc "Installs the gem"
+task :install => :gem do 
+  sh "#{SUDO} gem install yard-defaultreturn-1.0.0.gem --no-rdoc --no-ri"
+end
+

data/lib/yard-defaultreturn.rb

@@ -0,0 +1,22 @@
+module YARD
+  module Plugins
+    module DefaultReturn
+      module MethodHandler
+        def register(*objects)
+          retval = super
+          objects.each do |object|
+            if (tag = namespace.tag(:defaultreturn)) && !object.has_tag?(:return)
+              object.docstring.add_tag Tags::Tag.new(:return, tag.text, tag.types)
+            end
+          end
+          retval
+        end
+      end
+      
+      Handlers::Ruby::MethodHandler.send(:include, MethodHandler)
+      Handlers::Ruby::Legacy::MethodHandler.send(:include, MethodHandler)
+    end
+  end
+end
+
+YARD::Tags::Library.define_tag("Default Return", :defaultreturn, :with_types)

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: yard-defaultreturn
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Loren Segal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-21 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: lsegal@soen.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/yard-defaultreturn.rb
+has_rdoc: true
+homepage: http://github.com/lsegal/yard-defaultreturn
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: YARD plugin to add default return types to methods in a namespace.
+test_files: []
+