yard-method-overrides 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ YARD::Templates::Engine.register_template_path File.expand_path('../../templates', __FILE__)
4
+ YARD::Tags::Library.define_tag 'Extending Method', :extension
5
+ YARD::Tags::Library.define_tag 'Overriding Method', :override
@@ -0,0 +1,19 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ require 'inventory'
4
+
5
+ module YardMethodOverrides
6
+ Version = Inventory.new(0, 1, 0){
7
+ def additional_files
8
+ %w'
9
+ templates/default/tags/html/extension.erb
10
+ templates/default/tags/html/override.erb
11
+ templates/default/tags/setup.rb
12
+ '
13
+ end
14
+
15
+ def unit_tests
16
+ []
17
+ end
18
+ }
19
+ end
@@ -0,0 +1 @@
1
+ <p>This method is an extension of <%= linkify(object.overridden_method) %>.</p>
@@ -0,0 +1 @@
1
+ <p>This method overrides <%= linkify(object.overridden_method) %>.</p>
@@ -0,0 +1,13 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ def init
4
+ sections.push :extension, :override
5
+ end
6
+
7
+ def extension
8
+ erb(:extension) if object.has_tag? :extension and object.respond_to? :overridden_method and object.overridden_method
9
+ end
10
+
11
+ def override
12
+ erb(:override) if object.has_tag? :override and object.respond_to? :overridden_method and object.overridden_method
13
+ end
metadata ADDED
@@ -0,0 +1,65 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: yard-method-overrides
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Nikolai Weibull
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-04-06 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: yard
16
+ requirement: &2156376760 !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: 0.7.0
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: *2156376760
25
+ description: ! " YARD Method Overrides\n\n A YARD plugin
26
+ that adds tags for specifying method overrides. The tags added\n are @extension
27
+ and @override, which allow you to tag a method as either an\n extension of a superclass’
28
+ definition or a complete override of a superclass’\n definition. This makes it
29
+ easy for the reader to see what’s going on may\n read up on what may be going on
30
+ in the superclass.\n"
31
+ email: now@bitwi.se
32
+ executables: []
33
+ extensions: []
34
+ extra_rdoc_files: []
35
+ files:
36
+ - lib/yard-method-overrides.rb
37
+ - lib/yard-method-overrides/version.rb
38
+ - templates/default/tags/html/extension.erb
39
+ - templates/default/tags/html/override.erb
40
+ - templates/default/tags/setup.rb
41
+ homepage: https://github.com/now/yard-method-overrides
42
+ licenses: []
43
+ post_install_message:
44
+ rdoc_options: []
45
+ require_paths:
46
+ - lib
47
+ required_ruby_version: !ruby/object:Gem::Requirement
48
+ none: false
49
+ requirements:
50
+ - - ! '>='
51
+ - !ruby/object:Gem::Version
52
+ version: '0'
53
+ required_rubygems_version: !ruby/object:Gem::Requirement
54
+ none: false
55
+ requirements:
56
+ - - ! '>='
57
+ - !ruby/object:Gem::Version
58
+ version: '0'
59
+ requirements: []
60
+ rubyforge_project:
61
+ rubygems_version: 1.8.11
62
+ signing_key:
63
+ specification_version: 3
64
+ summary: A YARD plugin that adds tags for specifying method overrides.
65
+ test_files: []