inventory-rake-tasks-yard 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README +21 -0
- data/Rakefile +17 -0
- data/lib/inventory/rake/tasks/yard-1.0.rb +53 -0
- data/lib/inventory/rake/tasks/yard/version.rb +24 -0
- data/test/unit/inventory/rake/tasks/yard-1.0.rb +4 -0
- data/test/unit/inventory/rake/tasks/yard/version.rb +4 -0
- metadata +123 -0
data/README
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
Inventory-Rake-Tasks-YARD
|
2
|
+
|
3
|
+
Inventory-Rake-Tasks-YARD provides Rake¹ tasks for YARD² using your
|
4
|
+
Inventory³.
|
5
|
+
|
6
|
+
¹ Read up on Ruby’s build tool Rake at http://rake.rubyforge.org/
|
7
|
+
² Find out more about the YARD documentation tool at http://yardoc.org/
|
8
|
+
³ Get information on Inventory at http://disu.se/software/inventory/
|
9
|
+
|
10
|
+
§ Installation
|
11
|
+
|
12
|
+
Install Inventory-Rake-Tasks-YARD with
|
13
|
+
|
14
|
+
% gem install inventory-rake-tasks-yard
|
15
|
+
|
16
|
+
§ Usage
|
17
|
+
|
18
|
+
Include the following code in your ‹Rakefile›:
|
19
|
+
|
20
|
+
require 'inventory/rake/tasks/yard-1.0'
|
21
|
+
Inventory::Rake::Tasks::YARD.new
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
|
3
|
+
require 'inventory/rake-1.0'
|
4
|
+
|
5
|
+
$:.unshift File.expand_path('../lib', __FILE__)
|
6
|
+
require 'inventory/rake/tasks/yard-1.0'
|
7
|
+
|
8
|
+
Inventory::Rake::Tasks.define Inventory::Rake::Tasks::YARD::Version, :gem => proc{ |_, s|
|
9
|
+
s.author = 'Nikolai Weibull'
|
10
|
+
s.email = 'now@bitwi.se'
|
11
|
+
s.homepage = 'https://github.com/now/inventory-rake-tasks-yard'
|
12
|
+
}
|
13
|
+
|
14
|
+
Inventory::Rake::Tasks.unless_installing_dependencies do
|
15
|
+
require 'lookout/rake-3.0'
|
16
|
+
Lookout::Rake::Tasks::Test.new
|
17
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
|
3
|
+
# Namespace for Inventory, see {http://disu.se/software/inventory}.
|
4
|
+
class Inventory; end
|
5
|
+
|
6
|
+
# Namespace for Rake integration of Inventory, see
|
7
|
+
# {http://disu.se/software/inventory-rake}.
|
8
|
+
module Inventory::Rake
|
9
|
+
end
|
10
|
+
|
11
|
+
# Namespace for Rake tasks.
|
12
|
+
module Inventory::Rake::Tasks
|
13
|
+
end
|
14
|
+
|
15
|
+
class Inventory::Rake::Tasks::YARD
|
16
|
+
load File.expand_path('../yard/version.rb', __FILE__)
|
17
|
+
Version.load
|
18
|
+
|
19
|
+
include Rake::DSL
|
20
|
+
|
21
|
+
def initialize(options = {})
|
22
|
+
self.name = options.fetch(:name, :html)
|
23
|
+
self.options = options.fetch(:options, Shellwords.split('--no-private --protected --private --query "(!object.docstring.blank?&&!(YARD::CodeObjects::NamespaceObject===object.namespace&&(a=object.namespace.aliases[object])&&object.name==:eql?&&a==:==)&&!(object.visibility!=:public&&((@return.text==\'\'&&@return.types==%w\'Boolean\')||object.docstring.start_with?(\'Returns the value of attribute \', \'Sets the attribute \')||(@raise&&@raise.types=[]))))||object.root?" --markup markdown --no-stats'))
|
24
|
+
self.options += Shellwords.split(ENV['OPTIONS']) if ENV.include? 'OPTIONS'
|
25
|
+
self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
|
26
|
+
self.files = options.fetch(:files){ ENV.include?('FILES') ? FileList[ENV['FILES']] : inventory.lib_files }
|
27
|
+
self.globals = options.fetch(:globals, {})
|
28
|
+
yield self if block_given?
|
29
|
+
define
|
30
|
+
end
|
31
|
+
|
32
|
+
attr_accessor :name, :options, :files, :inventory, :globals
|
33
|
+
|
34
|
+
def define
|
35
|
+
desc name == :html ?
|
36
|
+
'Generate documentation in HTML format' :
|
37
|
+
'Generate documentation for %s in HTML format' % name
|
38
|
+
task name do
|
39
|
+
require 'yard'
|
40
|
+
yardoc = YARD::CLI::Yardoc.new
|
41
|
+
yardoc.parse_arguments(*arguments)
|
42
|
+
yardoc.options.merge! globals
|
43
|
+
Rake.rake_output_message 'yard doc %s' % Shellwords.join(arguments(yardoc.yardopts)) if verbose
|
44
|
+
yardoc.run(nil)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
private
|
49
|
+
|
50
|
+
def arguments(additional = [])
|
51
|
+
options.dup.concat(additional).push('--').concat(files)
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
|
3
|
+
require 'inventory-1.0'
|
4
|
+
|
5
|
+
class Inventory::Rake::Tasks::YARD
|
6
|
+
Version = Inventory.new(1, 0, 0){
|
7
|
+
def dependencies
|
8
|
+
super + Inventory::Dependencies.new{
|
9
|
+
development 'lookout', 3, 0, 0
|
10
|
+
development 'lookout-rake', 3, 0, 0
|
11
|
+
runtime 'inventory-rake', 1, 3, 0
|
12
|
+
optional 'rake', 0, 9, 2
|
13
|
+
optional 'yard', 0, 7, 0
|
14
|
+
}
|
15
|
+
end
|
16
|
+
|
17
|
+
def requires
|
18
|
+
%w'
|
19
|
+
rake
|
20
|
+
shellwords
|
21
|
+
'
|
22
|
+
end
|
23
|
+
}
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,123 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: inventory-rake-tasks-yard
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Nikolai Weibull
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2012-04-27 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: inventory
|
16
|
+
requirement: &10881012 !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.2'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: *10881012
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: lookout
|
27
|
+
requirement: &10879944 !ruby/object:Gem::Requirement
|
28
|
+
none: false
|
29
|
+
requirements:
|
30
|
+
- - ~>
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '3.0'
|
33
|
+
type: :development
|
34
|
+
prerelease: false
|
35
|
+
version_requirements: *10879944
|
36
|
+
- !ruby/object:Gem::Dependency
|
37
|
+
name: lookout-rake
|
38
|
+
requirement: &10879224 !ruby/object:Gem::Requirement
|
39
|
+
none: false
|
40
|
+
requirements:
|
41
|
+
- - ~>
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: '3.0'
|
44
|
+
type: :development
|
45
|
+
prerelease: false
|
46
|
+
version_requirements: *10879224
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: inventory-rake
|
49
|
+
requirement: &14405448 !ruby/object:Gem::Requirement
|
50
|
+
none: false
|
51
|
+
requirements:
|
52
|
+
- - ~>
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.3'
|
55
|
+
type: :runtime
|
56
|
+
prerelease: false
|
57
|
+
version_requirements: *14405448
|
58
|
+
- !ruby/object:Gem::Dependency
|
59
|
+
name: rake
|
60
|
+
requirement: &14404260 !ruby/object:Gem::Requirement
|
61
|
+
none: false
|
62
|
+
requirements:
|
63
|
+
- - ~>
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: 0.9.2
|
66
|
+
type: :runtime
|
67
|
+
prerelease: false
|
68
|
+
version_requirements: *14404260
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: yard
|
71
|
+
requirement: &14402940 !ruby/object:Gem::Requirement
|
72
|
+
none: false
|
73
|
+
requirements:
|
74
|
+
- - ~>
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: 0.7.0
|
77
|
+
type: :runtime
|
78
|
+
prerelease: false
|
79
|
+
version_requirements: *14402940
|
80
|
+
description: ! " Inventory-Rake-Tasks-YARD\n\n Inventory-Rake-Tasks-YARD
|
81
|
+
provides Rake¹ tasks for YARD² using your\n Inventory³.\n\n¹ Read up on Ruby’s
|
82
|
+
build tool Rake at http://rake.rubyforge.org/\n² Find out more about the YARD documentation
|
83
|
+
tool at http://yardoc.org/\n³ Get information on Inventory at http://disu.se/software/inventory/\n\n§
|
84
|
+
Installation\n\n Install Inventory-Rake-Tasks-YARD with\n\n % gem install
|
85
|
+
inventory-rake-tasks-yard\n\n§ Usage\n\n Include the following code in your ‹Rakefile›:\n\n
|
86
|
+
\ require 'inventory/rake/tasks/yard-1.0'\n Inventory::Rake::Tasks::YARD.new\n"
|
87
|
+
email: now@bitwi.se
|
88
|
+
executables: []
|
89
|
+
extensions: []
|
90
|
+
extra_rdoc_files: []
|
91
|
+
files:
|
92
|
+
- lib/inventory/rake/tasks/yard-1.0.rb
|
93
|
+
- lib/inventory/rake/tasks/yard/version.rb
|
94
|
+
- test/unit/inventory/rake/tasks/yard-1.0.rb
|
95
|
+
- test/unit/inventory/rake/tasks/yard/version.rb
|
96
|
+
- README
|
97
|
+
- Rakefile
|
98
|
+
homepage: https://github.com/now/inventory-rake-tasks-yard
|
99
|
+
licenses: []
|
100
|
+
metadata: {}
|
101
|
+
post_install_message:
|
102
|
+
rdoc_options: []
|
103
|
+
require_paths:
|
104
|
+
- lib
|
105
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
106
|
+
none: false
|
107
|
+
requirements:
|
108
|
+
- - ! '>='
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
112
|
+
none: false
|
113
|
+
requirements:
|
114
|
+
- - ! '>='
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '0'
|
117
|
+
requirements: []
|
118
|
+
rubyforge_project:
|
119
|
+
rubygems_version: 1.8.10
|
120
|
+
signing_key:
|
121
|
+
specification_version: 4
|
122
|
+
summary: Inventory³.
|
123
|
+
test_files: []
|