yard-method-overrides 0.1.0

data/lib/yard-method-overrides.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+YARD::Templates::Engine.register_template_path File.expand_path('../../templates', __FILE__)
+YARD::Tags::Library.define_tag 'Extending Method', :extension
+YARD::Tags::Library.define_tag 'Overriding Method', :override

data/lib/yard-method-overrides/version.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory'
+
+module YardMethodOverrides
+  Version = Inventory.new(0, 1, 0){
+    def additional_files
+      %w'
+        templates/default/tags/html/extension.erb
+        templates/default/tags/html/override.erb
+        templates/default/tags/setup.rb
+      '
+    end
+
+    def unit_tests
+      []
+    end
+  }
+end

data/templates/default/tags/html/extension.erb

@@ -0,0 +1 @@
+<p>This method is an extension of <%= linkify(object.overridden_method) %>.</p>

data/templates/default/tags/html/override.erb

@@ -0,0 +1 @@
+<p>This method overrides <%= linkify(object.overridden_method) %>.</p>

data/templates/default/tags/setup.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+def init
+  sections.push :extension, :override
+end
+
+def extension
+  erb(:extension) if object.has_tag? :extension and object.respond_to? :overridden_method and object.overridden_method
+end
+
+def override
+  erb(:override) if object.has_tag? :override and object.respond_to? :overridden_method and object.overridden_method
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: yard-method-overrides
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nikolai Weibull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2156376760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156376760
+description: ! "                             YARD Method Overrides\n\n  A YARD plugin
+  that adds tags for specifying method overrides.  The tags added\n  are @extension
+  and @override, which allow you to tag a method as either an\n  extension of a superclass’
+  definition or a complete override of a superclass’\n  definition.  This makes it
+  easy for the reader to see what’s going on may\n  read up on what may be going on
+  in the superclass.\n"
+email: now@bitwi.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yard-method-overrides.rb
+- lib/yard-method-overrides/version.rb
+- templates/default/tags/html/extension.erb
+- templates/default/tags/html/override.erb
+- templates/default/tags/setup.rb
+homepage: https://github.com/now/yard-method-overrides
+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: A YARD plugin that adds tags for specifying method overrides.
+test_files: []