yard 0.5.7 → 0.5.8
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- data/ChangeLog +8 -0
- data/README.md +27 -5
- data/lib/yard.rb +1 -1
- data/lib/yard/cli/yardoc.rb +2 -1
- data/spec/cli/yardoc_spec.rb +22 -0
- metadata +4 -4
data/ChangeLog
CHANGED
@@ -1,3 +1,11 @@
|
|
1
|
+
2010-06-22 Loren Segal <lsegal@soen.ca>
|
2
|
+
|
3
|
+
* spec/cli/yardoc_spec.rb: Add specs for --no-private Closes gh-146
|
4
|
+
|
5
|
+
2010-06-19 Loren Segal <lsegal@soen.ca>
|
6
|
+
|
7
|
+
* lib/yard/cli/yardoc.rb: Fix verifier for --no-private
|
8
|
+
|
1
9
|
2010-06-21 Loren Segal <lsegal@soen.ca>
|
2
10
|
|
3
11
|
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump to version 0.5.7
|
data/README.md
CHANGED
@@ -5,12 +5,11 @@ YARD: Yay! A Ruby Documentation Tool
|
|
5
5
|
**IRC**: [irc://irc.freenode.net/yard](irc.freenode.net / #yard)
|
6
6
|
**Git**: [http://github.com/lsegal/yard](http://github.com/lsegal/yard)
|
7
7
|
**Author**: Loren Segal
|
8
|
-
**Contributors**:
|
9
|
-
Postmodern, Michael Edgar
|
8
|
+
**Contributors**: See Contributors section below
|
10
9
|
**Copyright**: 2007-2010
|
11
10
|
**License**: MIT License
|
12
|
-
**Latest Version**: 0.5.
|
13
|
-
**Release Date**: June
|
11
|
+
**Latest Version**: 0.5.8 (codename "The Longest")
|
12
|
+
**Release Date**: June 22nd 2010
|
14
13
|
|
15
14
|
Synopsis
|
16
15
|
--------
|
@@ -243,6 +242,9 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
|
|
243
242
|
Changelog
|
244
243
|
---------
|
245
244
|
|
245
|
+
- **June.22.10**: 0.5.8 release
|
246
|
+
- Merge fix from 0.6 branch for --no-private visibility checking
|
247
|
+
|
246
248
|
- **June.21.10**: 0.5.7 release
|
247
249
|
- Fixed visibility flag parsing in `yardoc`
|
248
250
|
- Updated Parser Architecture documentation with new SourceParser API
|
@@ -321,7 +323,27 @@ Changelog
|
|
321
323
|
to get people testing YARD on their code because there are too many possible
|
322
324
|
code styles to fit into a sane amount of test cases. It also demonstrates the
|
323
325
|
power of YARD and what to expect from the syntax (Yardoc style meta tags).
|
324
|
-
|
326
|
+
|
327
|
+
|
328
|
+
Contributors
|
329
|
+
------------
|
330
|
+
|
331
|
+
Special thanks to the following people for submitting patches:
|
332
|
+
|
333
|
+
* Aman Gupta
|
334
|
+
* Benjamin Bock
|
335
|
+
* Denis Defreyne
|
336
|
+
* Duane Johnson
|
337
|
+
* Elliottcable
|
338
|
+
* James Rosen
|
339
|
+
* Jeff Rafter
|
340
|
+
* Leonid Borisenko
|
341
|
+
* Loren Segal
|
342
|
+
* Michael Edgar
|
343
|
+
* Nathan Weizenbaum
|
344
|
+
* Postmodern
|
345
|
+
* Yehuda Katz
|
346
|
+
|
325
347
|
|
326
348
|
Copyright
|
327
349
|
---------
|
data/lib/yard.rb
CHANGED
data/lib/yard/cli/yardoc.rb
CHANGED
@@ -320,7 +320,8 @@ module YARD
|
|
320
320
|
end
|
321
321
|
|
322
322
|
opts.on('--no-private', "Hide objects with @private tag") do
|
323
|
-
options[:verifier].add_expressions '!object.tag(:private) &&
|
323
|
+
options[:verifier].add_expressions '!object.tag(:private) &&
|
324
|
+
(object.namespace.type == :proxy || !object.namespace.tag(:private))'
|
324
325
|
end
|
325
326
|
|
326
327
|
opts.on('--no-highlight', "Don't highlight code in docs as Ruby.") do
|
data/spec/cli/yardoc_spec.rb
CHANGED
@@ -137,6 +137,28 @@ describe YARD::CLI::Yardoc do
|
|
137
137
|
@yardoc.options[:verifier].call(obj).should == false
|
138
138
|
end
|
139
139
|
|
140
|
+
it "should hide object if namespace is @private with --no-private" do
|
141
|
+
ns = mock(:namespace)
|
142
|
+
ns.stub!(:type).and_return(:module)
|
143
|
+
ns.should_receive(:tag).ordered.with(:private).and_return(true)
|
144
|
+
obj = mock(:object)
|
145
|
+
obj.stub!(:namespace).and_return(ns)
|
146
|
+
obj.should_receive(:tag).ordered.with(:private).and_return(false)
|
147
|
+
@yardoc.optparse *%w( --no-private )
|
148
|
+
@yardoc.options[:verifier].call(obj).should == false
|
149
|
+
end
|
150
|
+
|
151
|
+
it "should not call #tag on namespace if namespace is proxy with --no-private" do
|
152
|
+
ns = mock(:namespace)
|
153
|
+
ns.stub!(:type).and_return(:proxy)
|
154
|
+
ns.should_not_receive(:tag)
|
155
|
+
obj = mock(:object)
|
156
|
+
obj.stub!(:namespace).and_return(ns)
|
157
|
+
obj.should_receive(:tag).ordered.with(:private).and_return(false)
|
158
|
+
@yardoc.optparse *%w( --no-private )
|
159
|
+
@yardoc.options[:verifier].call(obj).should == true
|
160
|
+
end
|
161
|
+
|
140
162
|
it "should hide methods inside a 'private' class/module with --no-private" do
|
141
163
|
Registry.clear
|
142
164
|
YARD.parse_string <<-eof
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 27
|
5
5
|
prerelease: false
|
6
6
|
segments:
|
7
7
|
- 0
|
8
8
|
- 5
|
9
|
-
-
|
10
|
-
version: 0.5.
|
9
|
+
- 8
|
10
|
+
version: 0.5.8
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- Loren Segal
|
@@ -15,7 +15,7 @@ autorequire:
|
|
15
15
|
bindir: bin
|
16
16
|
cert_chain: []
|
17
17
|
|
18
|
-
date: 2010-06-
|
18
|
+
date: 2010-06-22 00:00:00 -04:00
|
19
19
|
default_executable:
|
20
20
|
dependencies: []
|
21
21
|
|