yardstick 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +1 -1
- data/.gitignore +1 -0
- data/{README.markdown → README.rdoc} +38 -41
- data/Rakefile +24 -12
- data/VERSION +1 -1
- data/lib/yardstick/cli.rb +2 -2
- data/lib/yardstick/measurable.rb +2 -2
- data/lib/yardstick/measurement.rb +1 -1
- data/lib/yardstick/ordered_set.rb +5 -5
- data/lib/yardstick/processor.rb +3 -3
- data/lib/yardstick/rake/measurement.rb +3 -0
- data/lib/yardstick/rake/verify.rb +25 -20
- data/lib/yardstick.rb +2 -2
- data/spec/rcov.opts +1 -1
- data/spec/spec_helper.rb +2 -3
- data/tasks/metrics.rake +33 -1
- data/tasks/spec.rake +3 -0
- data/tasks/yard.rake +9 -0
- data/yardstick.gemspec +33 -11
- metadata +127 -14
- data/deps.rip +0 -1
- data/tasks/rdoc.rake +0 -15
data/.document
CHANGED
data/.gitignore
CHANGED
@@ -1,52 +1,43 @@
|
|
1
|
-
Yardstick 0.1.0
|
2
|
-
===============
|
1
|
+
= Yardstick 0.1.0
|
3
2
|
|
4
|
-
|
5
|
-
* [Git](http://github.com/dkubb/yardstick)
|
6
|
-
* [Bug Tracker](http://github.com/dkubb/yardstick/issues)
|
7
|
-
* [Mailing List](http://groups.google.com/group/yardstick)
|
8
|
-
* [IRC](irc://irc.freenode.net/yardstick)
|
3
|
+
Yardstick is a tool that verifies documentation coverage of Ruby code. It will measure the source and provide feedback on what is missing from the documentation and what can be improved.
|
9
4
|
|
10
|
-
|
11
|
-
|
5
|
+
* {Homepage}[http://yardstick.rubyforge.org/]
|
6
|
+
* {Git}[http://github.com/dkubb/yardstick]
|
7
|
+
* {Bug Tracker}[http://github.com/dkubb/yardstick/issues]
|
8
|
+
* {Mailing List}[http://groups.google.com/group/yardstick]
|
9
|
+
* {IRC}[irc://irc.freenode.net/yardstick]
|
12
10
|
|
13
|
-
|
14
|
-
|
15
|
-
It will measure the source and provide feedback on what is missing from
|
16
|
-
the documentation and what can be improved.
|
17
|
-
|
18
|
-
Installation
|
19
|
-
------------
|
11
|
+
== Installation
|
20
12
|
|
21
13
|
With Rubygems:
|
22
14
|
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
15
|
+
$ sudo gem install yardstick
|
16
|
+
$ irb -rubygems
|
17
|
+
>> require 'yardstick'
|
18
|
+
=> true
|
27
19
|
|
28
|
-
With the
|
20
|
+
With the {Rip package manager}[http://hellorip.com/]:
|
29
21
|
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
22
|
+
$ rip install git://github.com/dkubb/yardstick.git 0.1.0
|
23
|
+
$ irb -rrip
|
24
|
+
>> require 'yardstick'
|
25
|
+
=> true
|
34
26
|
|
35
27
|
With git and local working copy:
|
36
28
|
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
29
|
+
$ git clone git://github.com/dkubb/yardstick.git
|
30
|
+
$ cd yardstick
|
31
|
+
$ rake build && sudo rake install
|
32
|
+
$ irb -rubygems
|
33
|
+
>> require 'yardstick'
|
34
|
+
=> true
|
43
35
|
|
44
|
-
Usage
|
45
|
-
-----
|
36
|
+
== Usage
|
46
37
|
|
47
38
|
Yardstick may be used three ways:
|
48
39
|
|
49
|
-
|
40
|
+
=== 1. Command-line Tool
|
50
41
|
|
51
42
|
This is the simplest way to run yardstick. Provide it a list of files
|
52
43
|
and it will measure all of them and output suggestions for improvement,
|
@@ -54,7 +45,7 @@ eg:
|
|
54
45
|
|
55
46
|
$ yardstick 'lib/**/*.rb' 'app/**/*.rb' ...etc...
|
56
47
|
|
57
|
-
|
48
|
+
=== 2. Rake task
|
58
49
|
|
59
50
|
Yardstick may be integrated with existing Rakefile and build processes,
|
60
51
|
and is especially useful when used with a continuous integration system.
|
@@ -80,7 +71,7 @@ increased. It uses a simple DSL to configure the task eg:
|
|
80
71
|
end
|
81
72
|
|
82
73
|
|
83
|
-
|
74
|
+
=== 3. Libraries
|
84
75
|
|
85
76
|
Yardstick comes with several libraries that will allow you to process
|
86
77
|
lists of files, or String code fragments, eg:
|
@@ -105,13 +96,19 @@ lists of files, or String code fragments, eg:
|
|
105
96
|
end
|
106
97
|
RUBY
|
107
98
|
|
108
|
-
TODO
|
109
|
-
----
|
99
|
+
== TODO
|
110
100
|
|
111
|
-
|
101
|
+
* Add more measurements, especially for @param, @yield and type
|
112
102
|
validation
|
113
|
-
|
103
|
+
* Update yardstick_measure task to use the Yardstick::CLI library
|
114
104
|
underneath.
|
115
|
-
|
105
|
+
* Output results as HTML from command line tool and Rake task
|
106
|
+
* Specify method_missing to allow public, semipublic or private even
|
107
|
+
if its visibility is private
|
108
|
+
* Allow initialize to be public, semipublic or private regardless of
|
109
|
+
its visibility. A constructor may not necessarily be public, and may
|
110
|
+
not be used externally.
|
111
|
+
* Allow @return type to be "self" to specify the return value is
|
112
|
+
the object itself. Ask argv[0] if it can be made a YARD convention.
|
116
113
|
|
117
114
|
Copyright (c) 2009 Dan Kubb. See LICENSE for details.
|
data/Rakefile
CHANGED
@@ -1,24 +1,36 @@
|
|
1
1
|
require 'rubygems'
|
2
2
|
require 'rake'
|
3
|
-
require 'pathname'
|
4
|
-
|
5
|
-
Pathname.glob('tasks/**/*.rake').each { |task| load task.expand_path }
|
6
3
|
|
7
4
|
begin
|
5
|
+
gem 'jeweler', '~> 1.4'
|
8
6
|
require 'jeweler'
|
9
7
|
|
10
8
|
Jeweler::Tasks.new do |gem|
|
11
|
-
gem.name
|
12
|
-
gem.summary
|
13
|
-
gem.email
|
14
|
-
gem.homepage
|
15
|
-
gem.authors
|
9
|
+
gem.name = 'yardstick'
|
10
|
+
gem.summary = 'A tool for verifying YARD documentation coverage'
|
11
|
+
gem.email = 'dan.kubb@gmail.com'
|
12
|
+
gem.homepage = 'http://github.com/dkubb/yardstick'
|
13
|
+
gem.authors = [ 'Dan Kubb' ]
|
14
|
+
gem.has_rdoc = 'yard'
|
15
|
+
|
16
16
|
gem.rubyforge_project = 'yardstick'
|
17
17
|
|
18
|
-
gem.add_dependency
|
18
|
+
gem.add_dependency 'yard', '~> 0.6.1'
|
19
|
+
|
20
|
+
gem.add_development_dependency 'flay', '~> 1.4.1'
|
21
|
+
gem.add_development_dependency 'flog', '~> 2.5.0'
|
22
|
+
gem.add_development_dependency 'metric_fu', '~> 1.5.1'
|
23
|
+
gem.add_development_dependency 'reek', '~> 1.2.8'
|
24
|
+
gem.add_development_dependency 'roodi', '~> 2.1.0'
|
25
|
+
gem.add_development_dependency 'rspec', '~> 1.3.1'
|
19
26
|
end
|
20
27
|
|
21
|
-
Jeweler::
|
22
|
-
|
23
|
-
|
28
|
+
Jeweler::GemcutterTasks.new
|
29
|
+
|
30
|
+
FileList['tasks/**/*.rake'].each { |task| import task }
|
31
|
+
|
32
|
+
rescue LoadError => e
|
33
|
+
puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
|
34
|
+
puts '-----------------------------------------------------------------------------'
|
35
|
+
puts e.backtrace # Let's help by actually showing *which* dependency is missing
|
24
36
|
end
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.
|
1
|
+
0.2.0
|
data/lib/yardstick/cli.rb
CHANGED
@@ -11,7 +11,7 @@ module Yardstick
|
|
11
11
|
# @param [Array] *args
|
12
12
|
# arguments passed in from the command line
|
13
13
|
#
|
14
|
-
# @return [MeasurementSet]
|
14
|
+
# @return [Yardstick::MeasurementSet]
|
15
15
|
# the measurement for each file
|
16
16
|
#
|
17
17
|
# @api public
|
@@ -44,7 +44,7 @@ module Yardstick
|
|
44
44
|
# @param [Hash] options
|
45
45
|
# the options to set when parsing the command-line arguments
|
46
46
|
#
|
47
|
-
# @return [OptionParser]
|
47
|
+
# @return [Yardstick::OptionParser]
|
48
48
|
# the option parser instance
|
49
49
|
#
|
50
50
|
# @api private
|
data/lib/yardstick/measurable.rb
CHANGED
@@ -6,7 +6,7 @@ module Yardstick
|
|
6
6
|
|
7
7
|
# List of rules for this class
|
8
8
|
#
|
9
|
-
# @return [RuleSet<Rule>]
|
9
|
+
# @return [Yardstick::RuleSet<Rule>]
|
10
10
|
# the rules for this class
|
11
11
|
#
|
12
12
|
# @api private
|
@@ -66,7 +66,7 @@ module Yardstick
|
|
66
66
|
# @example
|
67
67
|
# docstring.measure # => [ Measurement ]
|
68
68
|
#
|
69
|
-
# @return [MeasurementSet]
|
69
|
+
# @return [Yardstick::MeasurementSet]
|
70
70
|
# a collection of measurements
|
71
71
|
#
|
72
72
|
# @api public
|
@@ -7,14 +7,14 @@ module Yardstick
|
|
7
7
|
# @param [Array] entries
|
8
8
|
# optional entries
|
9
9
|
#
|
10
|
-
# @return [OrderedSet]
|
10
|
+
# @return [Yardstick::OrderedSet]
|
11
11
|
# the ordered set instance
|
12
12
|
#
|
13
13
|
# @api private
|
14
14
|
def initialize(entries = nil)
|
15
15
|
@entries = []
|
16
16
|
@index = {}
|
17
|
-
merge(entries
|
17
|
+
merge(entries || [])
|
18
18
|
end
|
19
19
|
|
20
20
|
# Append to the OrderedSet
|
@@ -22,7 +22,7 @@ module Yardstick
|
|
22
22
|
# @param [Object] entry
|
23
23
|
# the object to append
|
24
24
|
#
|
25
|
-
# @return [OrderedSet]
|
25
|
+
# @return [Yardstick::OrderedSet]
|
26
26
|
# returns self
|
27
27
|
#
|
28
28
|
# @api private
|
@@ -39,7 +39,7 @@ module Yardstick
|
|
39
39
|
# @param [#each] other
|
40
40
|
# the other ordered set
|
41
41
|
#
|
42
|
-
# @return [OrderedSet]
|
42
|
+
# @return [Yardstick::OrderedSet]
|
43
43
|
# returns self
|
44
44
|
#
|
45
45
|
# @api private
|
@@ -56,7 +56,7 @@ module Yardstick
|
|
56
56
|
# @yieldparam [Object] entry
|
57
57
|
# an entry in the ordered set
|
58
58
|
#
|
59
|
-
# @return [OrderedSet]
|
59
|
+
# @return [Yardstick::OrderedSet]
|
60
60
|
# returns self
|
61
61
|
#
|
62
62
|
# @api private
|
data/lib/yardstick/processor.rb
CHANGED
@@ -6,7 +6,7 @@ module Yardstick
|
|
6
6
|
# @param [Array<#to_s>, #to_s] path
|
7
7
|
# the files to measure
|
8
8
|
#
|
9
|
-
# @return [MeasurementSet]
|
9
|
+
# @return [Yardstick::MeasurementSet]
|
10
10
|
# a collection of measurements
|
11
11
|
#
|
12
12
|
# @api private
|
@@ -20,7 +20,7 @@ module Yardstick
|
|
20
20
|
# @param [#to_str] string
|
21
21
|
# the string to measure
|
22
22
|
#
|
23
|
-
# @return [MeasurementSet]
|
23
|
+
# @return [Yardstick::MeasurementSet]
|
24
24
|
# a collection of measurements
|
25
25
|
#
|
26
26
|
# @api private
|
@@ -31,7 +31,7 @@ module Yardstick
|
|
31
31
|
|
32
32
|
# Measure method objects in YARD registry
|
33
33
|
#
|
34
|
-
# @return [MeasurementSet]
|
34
|
+
# @return [Yardstick::MeasurementSet]
|
35
35
|
# a collection of measurements
|
36
36
|
#
|
37
37
|
# @api private
|
@@ -96,17 +96,7 @@ module Yardstick
|
|
96
96
|
assert_matches_threshold
|
97
97
|
end
|
98
98
|
|
99
|
-
|
100
|
-
|
101
|
-
# Define the task
|
102
|
-
#
|
103
|
-
# @return [undefined]
|
104
|
-
#
|
105
|
-
# @api private
|
106
|
-
def define
|
107
|
-
desc "Verify that yardstick coverage is at least #{@threshold}%"
|
108
|
-
task(@name) { verify_measurements }
|
109
|
-
end
|
99
|
+
protected
|
110
100
|
|
111
101
|
# The total YARD coverage
|
112
102
|
#
|
@@ -116,20 +106,19 @@ module Yardstick
|
|
116
106
|
# @api private
|
117
107
|
def total_coverage
|
118
108
|
measurements = Yardstick.measure(@path)
|
119
|
-
round_percentage(measurements.coverage * 100)
|
109
|
+
self.class.round_percentage(measurements.coverage * 100)
|
120
110
|
end
|
121
111
|
|
122
|
-
|
123
|
-
|
124
|
-
#
|
125
|
-
# the percentage to round
|
112
|
+
private
|
113
|
+
|
114
|
+
# Define the task
|
126
115
|
#
|
127
|
-
# @return [
|
128
|
-
# the rounded percentage
|
116
|
+
# @return [undefined]
|
129
117
|
#
|
130
118
|
# @api private
|
131
|
-
def
|
132
|
-
|
119
|
+
def define
|
120
|
+
desc "Verify that yardstick coverage is at least #{@threshold}%"
|
121
|
+
task(@name) { verify_measurements }
|
133
122
|
end
|
134
123
|
|
135
124
|
# Raise an exception if threshold is not set
|
@@ -155,6 +144,7 @@ module Yardstick
|
|
155
144
|
#
|
156
145
|
# @api private
|
157
146
|
def assert_meets_threshold
|
147
|
+
total_coverage = self.total_coverage
|
158
148
|
if total_coverage < @threshold
|
159
149
|
raise "Coverage must be at least #{@threshold}% but was #{total_coverage}%"
|
160
150
|
end
|
@@ -169,11 +159,26 @@ module Yardstick
|
|
169
159
|
#
|
170
160
|
# @api private
|
171
161
|
def assert_matches_threshold
|
162
|
+
total_coverage = self.total_coverage
|
172
163
|
if @require_exact_threshold && total_coverage > @threshold
|
173
164
|
raise "Coverage has increased above the threshold of #{@threshold}% to #{total_coverage}%. You should update your threshold value."
|
174
165
|
end
|
175
166
|
end
|
176
167
|
|
168
|
+
|
169
|
+
# Round percentage to 1/10th of a percent
|
170
|
+
#
|
171
|
+
# @param [Float] percentage
|
172
|
+
# the percentage to round
|
173
|
+
#
|
174
|
+
# @return [Float]
|
175
|
+
# the rounded percentage
|
176
|
+
#
|
177
|
+
# @api private
|
178
|
+
def self.round_percentage(percentage)
|
179
|
+
(percentage * 10).ceil / 10.0
|
180
|
+
end
|
181
|
+
|
177
182
|
end # class Verify
|
178
183
|
end # module Rake
|
179
184
|
end # module Yardstick
|
data/lib/yardstick.rb
CHANGED
@@ -15,7 +15,7 @@ module Yardstick
|
|
15
15
|
# @param [Hash] options
|
16
16
|
# optional configuration
|
17
17
|
#
|
18
|
-
# @return [MeasurementSet]
|
18
|
+
# @return [Yardstick::MeasurementSet]
|
19
19
|
# the measurements for each file
|
20
20
|
#
|
21
21
|
# @api public
|
@@ -35,7 +35,7 @@ module Yardstick
|
|
35
35
|
# @param [Hash] options
|
36
36
|
# optional configuration
|
37
37
|
#
|
38
|
-
# @return [MeasurementSet]
|
38
|
+
# @return [Yardstick::MeasurementSet]
|
39
39
|
# the measurements for the string
|
40
40
|
#
|
41
41
|
# @api public
|
data/spec/rcov.opts
CHANGED
data/spec/spec_helper.rb
CHANGED
@@ -9,17 +9,16 @@ Pathname.glob(Yardstick::ROOT.join('lib', '**', '*.rb').to_s).sort.each do |file
|
|
9
9
|
end
|
10
10
|
|
11
11
|
Spec::Runner.configure do |config|
|
12
|
-
clear_tasks =
|
12
|
+
clear_tasks = proc { Rake::Task.clear }
|
13
13
|
|
14
14
|
config.before(:all, &clear_tasks)
|
15
15
|
config.before( &clear_tasks)
|
16
16
|
|
17
|
-
clear_yard_registry =
|
17
|
+
clear_yard_registry = proc { YARD::Registry.clear }
|
18
18
|
|
19
19
|
config.before(:all, &clear_yard_registry)
|
20
20
|
config.before( &clear_yard_registry)
|
21
21
|
|
22
|
-
|
23
22
|
def capture_stdout
|
24
23
|
$stdout = StringIO.new
|
25
24
|
yield
|
data/tasks/metrics.rake
CHANGED
@@ -1,5 +1,37 @@
|
|
1
1
|
begin
|
2
2
|
require 'metric_fu'
|
3
3
|
rescue LoadError
|
4
|
-
|
4
|
+
namespace :metrics do
|
5
|
+
task :all do
|
6
|
+
abort 'metric_fu is not available. In order to run metrics:all, you must: gem install metric_fu'
|
7
|
+
end
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
begin
|
12
|
+
require 'reek/adapters/rake_task'
|
13
|
+
|
14
|
+
Reek::RakeTask.new do |t|
|
15
|
+
t.fail_on_error = true
|
16
|
+
t.verbose = false
|
17
|
+
t.source_files = 'lib/**/*.rb'
|
18
|
+
end
|
19
|
+
rescue LoadError
|
20
|
+
task :reek do
|
21
|
+
abort 'Reek is not available. In order to run reek, you must: gem install reek'
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
begin
|
26
|
+
require 'roodi'
|
27
|
+
require 'rake/tasklib'
|
28
|
+
require 'roodi_task'
|
29
|
+
|
30
|
+
RoodiTask.new do |t|
|
31
|
+
t.verbose = false
|
32
|
+
end
|
33
|
+
rescue LoadError
|
34
|
+
task :roodi do
|
35
|
+
abort 'Roodi is not available. In order to run roodi, you must: gem install roodi'
|
36
|
+
end
|
5
37
|
end
|
data/tasks/spec.rake
CHANGED
data/tasks/yard.rake
ADDED
data/yardstick.gemspec
CHANGED
@@ -1,28 +1,30 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
1
4
|
# -*- encoding: utf-8 -*-
|
2
5
|
|
3
6
|
Gem::Specification.new do |s|
|
4
7
|
s.name = %q{yardstick}
|
5
|
-
s.version = "0.
|
8
|
+
s.version = "0.2.0"
|
6
9
|
|
7
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
8
11
|
s.authors = ["Dan Kubb"]
|
9
|
-
s.date = %q{
|
12
|
+
s.date = %q{2010-11-07}
|
10
13
|
s.default_executable = %q{yardstick}
|
11
14
|
s.email = %q{dan.kubb@gmail.com}
|
12
15
|
s.executables = ["yardstick"]
|
13
16
|
s.extra_rdoc_files = [
|
14
17
|
"LICENSE",
|
15
|
-
"README.
|
18
|
+
"README.rdoc"
|
16
19
|
]
|
17
20
|
s.files = [
|
18
21
|
".document",
|
19
22
|
".gitignore",
|
20
23
|
"LICENSE",
|
21
|
-
"README.
|
24
|
+
"README.rdoc",
|
22
25
|
"Rakefile",
|
23
26
|
"VERSION",
|
24
27
|
"bin/yardstick",
|
25
|
-
"deps.rip",
|
26
28
|
"lib/yardstick.rb",
|
27
29
|
"lib/yardstick/autoload.rb",
|
28
30
|
"lib/yardstick/cli.rb",
|
@@ -52,16 +54,17 @@ Gem::Specification.new do |s|
|
|
52
54
|
"tasks/ci.rake",
|
53
55
|
"tasks/heckle.rake",
|
54
56
|
"tasks/metrics.rake",
|
55
|
-
"tasks/rdoc.rake",
|
56
57
|
"tasks/spec.rake",
|
58
|
+
"tasks/yard.rake",
|
57
59
|
"tasks/yardstick.rake",
|
58
60
|
"yardstick.gemspec"
|
59
61
|
]
|
62
|
+
s.has_rdoc = %q{yard}
|
60
63
|
s.homepage = %q{http://github.com/dkubb/yardstick}
|
61
64
|
s.rdoc_options = ["--charset=UTF-8"]
|
62
65
|
s.require_paths = ["lib"]
|
63
66
|
s.rubyforge_project = %q{yardstick}
|
64
|
-
s.rubygems_version = %q{1.3.
|
67
|
+
s.rubygems_version = %q{1.3.7}
|
65
68
|
s.summary = %q{A tool for verifying YARD documentation coverage}
|
66
69
|
s.test_files = [
|
67
70
|
"spec/public/yardstick/cli_spec.rb",
|
@@ -79,12 +82,31 @@ Gem::Specification.new do |s|
|
|
79
82
|
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
80
83
|
s.specification_version = 3
|
81
84
|
|
82
|
-
if Gem::Version.new(Gem::
|
83
|
-
s.add_runtime_dependency(%q<yard>, ["~> 0.
|
85
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
86
|
+
s.add_runtime_dependency(%q<yard>, ["~> 0.6.1"])
|
87
|
+
s.add_development_dependency(%q<flay>, ["~> 1.4.1"])
|
88
|
+
s.add_development_dependency(%q<flog>, ["~> 2.5.0"])
|
89
|
+
s.add_development_dependency(%q<metric_fu>, ["~> 1.5.1"])
|
90
|
+
s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
|
91
|
+
s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
|
92
|
+
s.add_development_dependency(%q<rspec>, ["~> 1.3.1"])
|
84
93
|
else
|
85
|
-
s.add_dependency(%q<yard>, ["~> 0.
|
94
|
+
s.add_dependency(%q<yard>, ["~> 0.6.1"])
|
95
|
+
s.add_dependency(%q<flay>, ["~> 1.4.1"])
|
96
|
+
s.add_dependency(%q<flog>, ["~> 2.5.0"])
|
97
|
+
s.add_dependency(%q<metric_fu>, ["~> 1.5.1"])
|
98
|
+
s.add_dependency(%q<reek>, ["~> 1.2.8"])
|
99
|
+
s.add_dependency(%q<roodi>, ["~> 2.1.0"])
|
100
|
+
s.add_dependency(%q<rspec>, ["~> 1.3.1"])
|
86
101
|
end
|
87
102
|
else
|
88
|
-
s.add_dependency(%q<yard>, ["~> 0.
|
103
|
+
s.add_dependency(%q<yard>, ["~> 0.6.1"])
|
104
|
+
s.add_dependency(%q<flay>, ["~> 1.4.1"])
|
105
|
+
s.add_dependency(%q<flog>, ["~> 2.5.0"])
|
106
|
+
s.add_dependency(%q<metric_fu>, ["~> 1.5.1"])
|
107
|
+
s.add_dependency(%q<reek>, ["~> 1.2.8"])
|
108
|
+
s.add_dependency(%q<roodi>, ["~> 2.1.0"])
|
109
|
+
s.add_dependency(%q<rspec>, ["~> 1.3.1"])
|
89
110
|
end
|
90
111
|
end
|
112
|
+
|
metadata
CHANGED
@@ -1,7 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yardstick
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
|
4
|
+
hash: 23
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 2
|
9
|
+
- 0
|
10
|
+
version: 0.2.0
|
5
11
|
platform: ruby
|
6
12
|
authors:
|
7
13
|
- Dan Kubb
|
@@ -9,19 +15,121 @@ autorequire:
|
|
9
15
|
bindir: bin
|
10
16
|
cert_chain: []
|
11
17
|
|
12
|
-
date:
|
18
|
+
date: 2010-11-07 00:00:00 -07:00
|
13
19
|
default_executable: yardstick
|
14
20
|
dependencies:
|
15
21
|
- !ruby/object:Gem::Dependency
|
16
22
|
name: yard
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 5
|
30
|
+
segments:
|
31
|
+
- 0
|
32
|
+
- 6
|
33
|
+
- 1
|
34
|
+
version: 0.6.1
|
17
35
|
type: :runtime
|
18
|
-
|
19
|
-
|
36
|
+
version_requirements: *id001
|
37
|
+
- !ruby/object:Gem::Dependency
|
38
|
+
name: flay
|
39
|
+
prerelease: false
|
40
|
+
requirement: &id002 !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
hash: 5
|
46
|
+
segments:
|
47
|
+
- 1
|
48
|
+
- 4
|
49
|
+
- 1
|
50
|
+
version: 1.4.1
|
51
|
+
type: :development
|
52
|
+
version_requirements: *id002
|
53
|
+
- !ruby/object:Gem::Dependency
|
54
|
+
name: flog
|
55
|
+
prerelease: false
|
56
|
+
requirement: &id003 !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
hash: 27
|
62
|
+
segments:
|
63
|
+
- 2
|
64
|
+
- 5
|
65
|
+
- 0
|
66
|
+
version: 2.5.0
|
67
|
+
type: :development
|
68
|
+
version_requirements: *id003
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: metric_fu
|
71
|
+
prerelease: false
|
72
|
+
requirement: &id004 !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ~>
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
hash: 1
|
78
|
+
segments:
|
79
|
+
- 1
|
80
|
+
- 5
|
81
|
+
- 1
|
82
|
+
version: 1.5.1
|
83
|
+
type: :development
|
84
|
+
version_requirements: *id004
|
85
|
+
- !ruby/object:Gem::Dependency
|
86
|
+
name: reek
|
87
|
+
prerelease: false
|
88
|
+
requirement: &id005 !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ~>
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
hash: 15
|
94
|
+
segments:
|
95
|
+
- 1
|
96
|
+
- 2
|
97
|
+
- 8
|
98
|
+
version: 1.2.8
|
99
|
+
type: :development
|
100
|
+
version_requirements: *id005
|
101
|
+
- !ruby/object:Gem::Dependency
|
102
|
+
name: roodi
|
103
|
+
prerelease: false
|
104
|
+
requirement: &id006 !ruby/object:Gem::Requirement
|
105
|
+
none: false
|
106
|
+
requirements:
|
107
|
+
- - ~>
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
hash: 11
|
110
|
+
segments:
|
111
|
+
- 2
|
112
|
+
- 1
|
113
|
+
- 0
|
114
|
+
version: 2.1.0
|
115
|
+
type: :development
|
116
|
+
version_requirements: *id006
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: rspec
|
119
|
+
prerelease: false
|
120
|
+
requirement: &id007 !ruby/object:Gem::Requirement
|
121
|
+
none: false
|
20
122
|
requirements:
|
21
123
|
- - ~>
|
22
124
|
- !ruby/object:Gem::Version
|
23
|
-
|
24
|
-
|
125
|
+
hash: 25
|
126
|
+
segments:
|
127
|
+
- 1
|
128
|
+
- 3
|
129
|
+
- 1
|
130
|
+
version: 1.3.1
|
131
|
+
type: :development
|
132
|
+
version_requirements: *id007
|
25
133
|
description:
|
26
134
|
email: dan.kubb@gmail.com
|
27
135
|
executables:
|
@@ -30,16 +138,15 @@ extensions: []
|
|
30
138
|
|
31
139
|
extra_rdoc_files:
|
32
140
|
- LICENSE
|
33
|
-
- README.
|
141
|
+
- README.rdoc
|
34
142
|
files:
|
35
143
|
- .document
|
36
144
|
- .gitignore
|
37
145
|
- LICENSE
|
38
|
-
- README.
|
146
|
+
- README.rdoc
|
39
147
|
- Rakefile
|
40
148
|
- VERSION
|
41
149
|
- bin/yardstick
|
42
|
-
- deps.rip
|
43
150
|
- lib/yardstick.rb
|
44
151
|
- lib/yardstick/autoload.rb
|
45
152
|
- lib/yardstick/cli.rb
|
@@ -69,11 +176,11 @@ files:
|
|
69
176
|
- tasks/ci.rake
|
70
177
|
- tasks/heckle.rake
|
71
178
|
- tasks/metrics.rake
|
72
|
-
- tasks/rdoc.rake
|
73
179
|
- tasks/spec.rake
|
180
|
+
- tasks/yard.rake
|
74
181
|
- tasks/yardstick.rake
|
75
182
|
- yardstick.gemspec
|
76
|
-
has_rdoc:
|
183
|
+
has_rdoc: yard
|
77
184
|
homepage: http://github.com/dkubb/yardstick
|
78
185
|
licenses: []
|
79
186
|
|
@@ -83,21 +190,27 @@ rdoc_options:
|
|
83
190
|
require_paths:
|
84
191
|
- lib
|
85
192
|
required_ruby_version: !ruby/object:Gem::Requirement
|
193
|
+
none: false
|
86
194
|
requirements:
|
87
195
|
- - ">="
|
88
196
|
- !ruby/object:Gem::Version
|
197
|
+
hash: 3
|
198
|
+
segments:
|
199
|
+
- 0
|
89
200
|
version: "0"
|
90
|
-
version:
|
91
201
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
202
|
+
none: false
|
92
203
|
requirements:
|
93
204
|
- - ">="
|
94
205
|
- !ruby/object:Gem::Version
|
206
|
+
hash: 3
|
207
|
+
segments:
|
208
|
+
- 0
|
95
209
|
version: "0"
|
96
|
-
version:
|
97
210
|
requirements: []
|
98
211
|
|
99
212
|
rubyforge_project: yardstick
|
100
|
-
rubygems_version: 1.3.
|
213
|
+
rubygems_version: 1.3.7
|
101
214
|
signing_key:
|
102
215
|
specification_version: 3
|
103
216
|
summary: A tool for verifying YARD documentation coverage
|
data/deps.rip
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
git://github.com/lsegal/yard.git 0.2.3.3
|
data/tasks/rdoc.rake
DELETED
@@ -1,15 +0,0 @@
|
|
1
|
-
require 'rake/rdoctask'
|
2
|
-
|
3
|
-
Rake::RDocTask.new do |rdoc|
|
4
|
-
version = if File.exist?('VERSION.yml')
|
5
|
-
config = YAML.load(File.read('VERSION.yml'))
|
6
|
-
"#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
|
7
|
-
else
|
8
|
-
''
|
9
|
-
end
|
10
|
-
|
11
|
-
rdoc.rdoc_dir = 'rdoc'
|
12
|
-
rdoc.title = "yardstick #{version}"
|
13
|
-
rdoc.rdoc_files.include('README*')
|
14
|
-
rdoc.rdoc_files.include('lib/**/*.rb')
|
15
|
-
end
|