yard-value 1.2.4 → 1.2.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README +3 -3
- data/lib/yard-value-1.0.rb +12 -5
- data/lib/yard-value-1.0/version.rb +2 -2
- data/test/unit/yard-value-1.0.rb +2 -2
- metadata +27 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: de1685ebe5b61a4fb47c4a48f20fce7583f66c59
|
4
|
+
data.tar.gz: af94d2bf6d98de92336c8336a209e3fd6f9c8bda
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bc4ebc75fea4f242ddbc05628f68e138d27a9b28d68645c91746a6de4f520e38ffb9201632c4b1d09c8b84b8e64a67be9333dbdffde20a0d9a8b4ca53ccacc1e
|
7
|
+
data.tar.gz: 89d53184f35cb4c90e32685d145973db11586e6ed3c4cc8c08f3ec4bba1bfdfd39e31c1e977401dfad977cec6bbefccf7b48aff181b4f8b1c798c29ed81634ef
|
data/README
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
comparisons, its #initialize method, and its protected accessors.
|
6
6
|
|
7
7
|
¹ See http://yardoc.org/
|
8
|
-
² See http://disu.se/software/value/
|
8
|
+
² See http://disu.se/software/value-1.0/
|
9
9
|
|
10
10
|
You add the documentation to the Module#Value invocation. Any ‹@param› tags
|
11
11
|
are used both for the parameters to the #initialize method and for the
|
@@ -84,7 +84,7 @@
|
|
84
84
|
t.options += %w'--plugin yard-value-1.0'
|
85
85
|
end
|
86
86
|
|
87
|
-
¹ See http://disu.se/software/inventory-rake-tasks-yard/
|
87
|
+
¹ See http://disu.se/software/inventory-rake-tasks-yard-1.0/
|
88
88
|
|
89
89
|
§ Financing
|
90
90
|
|
@@ -99,7 +99,7 @@
|
|
99
99
|
donation to now@disu.se¹. Thanks! Your support won’t go unnoticed!
|
100
100
|
|
101
101
|
¹ Send a donation:
|
102
|
-
https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now
|
102
|
+
https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now@disu.se&item_name=YARD-Value
|
103
103
|
|
104
104
|
§ Reporting Bugs
|
105
105
|
|
data/lib/yard-value-1.0.rb
CHANGED
@@ -21,7 +21,9 @@ class YARD::Handlers::Ruby::ValuesHandler < YARD::Handlers::Ruby::Base
|
|
21
21
|
ancestor 'Value::Comparable'
|
22
22
|
end
|
23
23
|
ancestor 'Value'
|
24
|
-
initialize = define('initialize',
|
24
|
+
initialize = define('initialize',
|
25
|
+
parameters.map{ |e| [e.jump(:ident).source, e.type == :array ? e[0][1].source : nil] },
|
26
|
+
statement.docstring)
|
25
27
|
if initialize.parameters.last.first =~ /\A&/
|
26
28
|
base = initialize.parameters.last.first.sub(/\A&/, '')
|
27
29
|
if tag = initialize.docstring.tags.find{ |e| e.tag_name == 'param' and e.name == base }
|
@@ -45,15 +47,20 @@ class YARD::Handlers::Ruby::ValuesHandler < YARD::Handlers::Ruby::Base
|
|
45
47
|
|
46
48
|
def define(name, parameters, docstring = nil, visibility = :public)
|
47
49
|
YARD::CodeObjects::MethodObject.new(namespace, name).tap{ |m|
|
48
|
-
|
49
|
-
|
50
|
+
m.parameters = parameters
|
51
|
+
register_file_info m
|
52
|
+
register_source m
|
53
|
+
register_visibility m, visibility
|
54
|
+
register_docstring m, docstring
|
55
|
+
register_group m
|
56
|
+
register_module_function m
|
57
|
+
m.parameters = parameters
|
50
58
|
m.signature = 'def %s%s' %
|
51
59
|
[name,
|
52
60
|
parameters.empty? ?
|
53
61
|
'' :
|
54
62
|
'(%s)' % parameters.map{ |n, d| d ? '%s = %s' % [n, d] : n }.join(', ')]
|
55
|
-
m.
|
56
|
-
m.visibility = visibility
|
63
|
+
m.dynamic = true
|
57
64
|
}
|
58
65
|
end
|
59
66
|
|
@@ -3,12 +3,12 @@
|
|
3
3
|
require 'inventory-1.0'
|
4
4
|
|
5
5
|
module YARDValue
|
6
|
-
Version = Inventory.new(1, 2,
|
6
|
+
Version = Inventory.new(1, 2, 5){
|
7
7
|
authors{
|
8
8
|
author 'Nikolai Weibull', 'now@disu.se'
|
9
9
|
}
|
10
10
|
|
11
|
-
homepage 'http://disu.se/software/yard-value/'
|
11
|
+
homepage 'http://disu.se/software/yard-value-1.0/'
|
12
12
|
|
13
13
|
licenses{
|
14
14
|
license 'LGPLv3+',
|
data/test/unit/yard-value-1.0.rb
CHANGED
@@ -62,7 +62,7 @@ EOS
|
|
62
62
|
YARD::Parser::SourceParser.parse_string(<<EOS)
|
63
63
|
class A
|
64
64
|
# @param [String] a
|
65
|
-
# @param [Integer]
|
65
|
+
# @param [Integer] b The b
|
66
66
|
Value(:a, :'*b')
|
67
67
|
end
|
68
68
|
EOS
|
@@ -74,7 +74,7 @@ EOS
|
|
74
74
|
YARD::Parser::SourceParser.parse_string(<<EOS)
|
75
75
|
class A
|
76
76
|
# @param [String] a
|
77
|
-
# @param [Integer]
|
77
|
+
# @param [Integer] b The b
|
78
78
|
Value(:a, :'&b')
|
79
79
|
end
|
80
80
|
EOS
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard-value
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.2.
|
4
|
+
version: 1.2.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nikolai Weibull
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2015-10-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: inventory
|
@@ -83,14 +83,14 @@ dependencies:
|
|
83
83
|
description: |2
|
84
84
|
YARD-Value
|
85
85
|
|
86
|
-
YARD-Value provides YARD
|
86
|
+
YARD-Value provides YARD¹ handlers for Value² objects. It’ll document
|
87
87
|
whether the Value is Comparable and what attributes are used in such
|
88
88
|
comparisons, its #initialize method, and its protected accessors.
|
89
89
|
|
90
|
-
|
91
|
-
|
90
|
+
¹ See http://yardoc.org/
|
91
|
+
² See http://disu.se/software/value-1.0/
|
92
92
|
|
93
|
-
You add the documentation to the Module#Value invocation. Any
|
93
|
+
You add the documentation to the Module#Value invocation. Any ‹@param› tags
|
94
94
|
are used both for the parameters to the #initialize method and for the
|
95
95
|
protected accessors.
|
96
96
|
|
@@ -158,18 +158,18 @@ description: |2
|
|
158
158
|
def initialize(x, y)
|
159
159
|
end
|
160
160
|
|
161
|
-
|
161
|
+
§ Usage
|
162
162
|
|
163
|
-
Add
|
164
|
-
using Inventory-Rake-Tasks-YARD
|
163
|
+
Add ‹--plugin yard-value-1.0› to your YARD command line. If you’re
|
164
|
+
using Inventory-Rake-Tasks-YARD¹, add the following to your Rakefile:
|
165
165
|
|
166
166
|
Inventory::Rake::Tasks::YARD.new do |t|
|
167
167
|
t.options += %w'--plugin yard-value-1.0'
|
168
168
|
end
|
169
169
|
|
170
|
-
|
170
|
+
¹ See http://disu.se/software/inventory-rake-tasks-yard-1.0/
|
171
171
|
|
172
|
-
|
172
|
+
§ Financing
|
173
173
|
|
174
174
|
Currently, most of my time is spent at my day job and in my rather busy
|
175
175
|
private life. Please motivate me to spend time on this piece of software
|
@@ -179,30 +179,30 @@ description: |2
|
|
179
179
|
to have other people give me the things that I need to continue living
|
180
180
|
under the rules of said society. So, if you feel that this piece of
|
181
181
|
software has helped you out enough to warrant a reward, please PayPal a
|
182
|
-
donation to now@disu.se
|
182
|
+
donation to now@disu.se¹. Thanks! Your support won’t go unnoticed!
|
183
183
|
|
184
|
-
|
185
|
-
https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now
|
184
|
+
¹ Send a donation:
|
185
|
+
https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now@disu.se&item_name=YARD-Value
|
186
186
|
|
187
|
-
|
187
|
+
§ Reporting Bugs
|
188
188
|
|
189
|
-
Please report any bugs that you encounter to the {issue tracker}
|
189
|
+
Please report any bugs that you encounter to the {issue tracker}¹.
|
190
190
|
|
191
|
-
|
191
|
+
¹ See https://github.com/now/yard-value/issues
|
192
192
|
|
193
|
-
|
193
|
+
§ Authors
|
194
194
|
|
195
195
|
Nikolai Weibull wrote the code, the tests, and this README.
|
196
196
|
|
197
|
-
|
197
|
+
§ Licensing
|
198
198
|
|
199
199
|
YARD-Value is free software: you may redistribute it and/or modify it under
|
200
|
-
the terms of the {GNU Lesser General Public License, version 3}
|
201
|
-
as published by the {Free Software Foundation}
|
200
|
+
the terms of the {GNU Lesser General Public License, version 3}¹ or later²,
|
201
|
+
as published by the {Free Software Foundation}³.
|
202
202
|
|
203
|
-
|
204
|
-
|
205
|
-
|
203
|
+
¹ See http://disu.se/licenses/lgpl-3.0/
|
204
|
+
² See http://gnu.org/licenses/
|
205
|
+
³ See http://fsf.org/
|
206
206
|
email:
|
207
207
|
- now@disu.se
|
208
208
|
executables: []
|
@@ -215,7 +215,7 @@ files:
|
|
215
215
|
- test/unit/yard-value-1.0/version.rb
|
216
216
|
- README
|
217
217
|
- Rakefile
|
218
|
-
homepage: http://disu.se/software/yard-value/
|
218
|
+
homepage: http://disu.se/software/yard-value-1.0/
|
219
219
|
licenses:
|
220
220
|
- LGPLv3+
|
221
221
|
metadata: {}
|
@@ -235,8 +235,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
235
235
|
version: '0'
|
236
236
|
requirements: []
|
237
237
|
rubyforge_project:
|
238
|
-
rubygems_version: 2.0.
|
238
|
+
rubygems_version: 2.0.14
|
239
239
|
signing_key:
|
240
240
|
specification_version: 4
|
241
|
-
summary: YARD-Value provides YARD
|
241
|
+
summary: YARD-Value provides YARD¹ handlers for Value² objects.
|
242
242
|
test_files: []
|