detroit-yard 0.1.0 → 0.2.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.
data/.ruby CHANGED
@@ -1,4 +1,6 @@
1
1
  ---
2
+ source:
3
+ - meta
2
4
  authors:
3
5
  - name: T. Sawyer
4
6
  email: transfire@gmail.com
@@ -6,28 +8,29 @@ copyrights:
6
8
  - holder: Thomas Sawyer, Rubyworks
7
9
  year: '2011'
8
10
  license: GPL-3
9
- replacements: []
10
- conflicts: []
11
11
  requirements:
12
12
  - name: detroit
13
+ version: 0.3.0+
13
14
  - name: yard
14
15
  dependencies: []
16
+ alternatives: []
17
+ conflicts: []
15
18
  repositories: []
16
19
  resources:
17
20
  home: http://detroit.github.com/
18
21
  code: http://github.com/detroit/detroit-yard
19
22
  mail: http://groups.google.com/group/rubyworks-mailinglist
23
+ extra: {}
20
24
  load_path:
21
25
  - lib
22
- extra: {}
23
- source:
24
- - Profile
25
- alternatives: []
26
26
  revision: 0
27
- name: detroit-yard
28
- title: Detroit YARD
29
- version: 0.1.0
27
+ created: '2011-10-16'
30
28
  summary: YARD plugin for Detroit
29
+ title: Detroit YARD
30
+ version: 0.2.0
31
+ name: detroit-yard
32
+ suite: detroit
31
33
  description: YARD plugin for Detroit build system. The plugin generates YARD documentation
32
34
  during the document phase.
33
- date: '2011-10-16'
35
+ organization: rubyworks
36
+ date: '2012-04-01'
File without changes
@@ -96,26 +96,26 @@ module Detroit
96
96
  attr_accessor :extra
97
97
 
98
98
 
99
- # A S S E M B L Y S T A T I O N S
99
+ # A S S E M B L Y M E T H O D S
100
100
 
101
- # Attach document method to assembly.
102
- def station_document
103
- document
104
- end
105
-
106
- # Attach reset method to assembly.
107
- def station_reset
108
- reset
109
- end
110
-
111
- # Attach clean method to assembly.
112
- def station_clean
113
- clean
101
+ #
102
+ def assemble?(station, options={})
103
+ case station
104
+ when :document then true
105
+ when :reset then true
106
+ when :clean then true
107
+ when :purge then true
108
+ end
114
109
  end
115
110
 
116
- # Attach purge method to assembly.
117
- def station_purge
118
- purge
111
+ #
112
+ def assemble(station, options={})
113
+ case station
114
+ when :document then document
115
+ when :reset then reset
116
+ when :clean then clean
117
+ when :purge then purge
118
+ end
119
119
  end
120
120
 
121
121
 
@@ -0,0 +1,107 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "DETROIT\-YARD" "5" "October 2011" "" ""
5
+ .
6
+ .SH "NAME"
7
+ \fBdetroit\-yard\fR \- generate yard api documentation via detroit
8
+ .
9
+ .SH "DESCRIPTION"
10
+ The YARD plug\-in for Detroit utilizes the \fByard\fR documentation tool to generate API documentation for a project\. It will also generate yri documentation files\.
11
+ .
12
+ .SH "OPTIONS"
13
+ The following options can be used in the Detroit assembly file to define a YARD service\.
14
+ .
15
+ .IP "\(bu" 4
16
+ \fByardopts\fR \- If set to true, use \fB\.yardopts\fR file and ignore other settings\. This defaults to \fBtrue\fR if no other settings are given and a \fB\.yardopts\fR file exists\.
17
+ .
18
+ .IP "\(bu" 4
19
+ \fBtitle\fR \- Title of documents\. Defaults to general metadata title field\.
20
+ .
21
+ .IP "\(bu" 4
22
+ \fBoutput\fR \- Where to save generated documentation\. The default is \fBdoc/\fR\.
23
+ .
24
+ .IP "\(bu" 4
25
+ \fBtemplate\fR \- Template to use\. This defaults to \fBENV[\'YARD_TEMPLATE\']\fR\.
26
+ .
27
+ .IP "\(bu" 4
28
+ \fBfiles\fR/\fBinclude\fR \- Which files to document\. The default is \fBlib/\fR\.
29
+ .
30
+ .IP "\(bu" 4
31
+ \fBexclude\fR \- Paths to specifically exclude\.
32
+ .
33
+ .IP "\(bu" 4
34
+ \fBignore\fR \- File patterns to ignore\.
35
+ .
36
+ .IP "\(bu" 4
37
+ \fBdocs\fR \- Which project document files to include, e\.g\. \fBCOPYING\fR\.
38
+ .
39
+ .IP "\(bu" 4
40
+ \fBreadme\fR \- Main file\. This can be a file pattern\. This default is matched to \fBREADME{,\.*}\fR\.
41
+ .
42
+ .IP "\(bu" 4
43
+ \fBextra\fR \- Additional options passed to the \fBrdoc\fR command\.
44
+ .
45
+ .IP "" 0
46
+ .
47
+ .SH "EXAMPLES"
48
+ Usually \fB\.yardopts\fR is used, in which case the simplest entry would be:
49
+ .
50
+ .IP "" 4
51
+ .
52
+ .nf
53
+
54
+ yard:
55
+ priority: 1
56
+ .
57
+ .fi
58
+ .
59
+ .IP "" 0
60
+ .
61
+ .P
62
+ We set the priority lower than the default (highest is \fB0\fR) in case some other documentation tool generates files that should be included in the YARD docs\.
63
+ .
64
+ .P
65
+ A more complex example might look like:
66
+ .
67
+ .IP "" 4
68
+ .
69
+ .nf
70
+
71
+ yard:
72
+ title: MyApp API
73
+ readme: INTRO\.rdoc
74
+ include:
75
+ \- lib
76
+ docs:
77
+ \- [A\-Z]*\.*
78
+ ignore:
79
+ \- \'*\.yml\'
80
+ output: site/api
81
+ priority: 1
82
+ .
83
+ .fi
84
+ .
85
+ .IP "" 0
86
+ .
87
+ .P
88
+ The above examples use the YAML\-base assembly format\. Assembly files can also be Ruby\-based\. See Detroit documentation for more details\.
89
+ .
90
+ .SH "RESOURCES"
91
+ .
92
+ .IP "\(bu" 4
93
+ API Documentation \fIhttp://rubydoc\.info/gems/detroit\-yard\fR
94
+ .
95
+ .IP "\(bu" 4
96
+ Development Site \fIhttp://github\.com/detroit/detroit\-yard\fR
97
+ .
98
+ .IP "" 0
99
+ .
100
+ .SH "COPYRIGHT"
101
+ Copyright (c) 2010 Thomas Sawyer, Rubyworks
102
+ .
103
+ .P
104
+ Detroit YARD is distributable in accordance with the GPL v\.3 license\.
105
+ .
106
+ .SH "SEE ALSO"
107
+ detroit(1), yard(1)
@@ -0,0 +1,161 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
+ <title>detroit-yard(5) - generate yard api documentation via detroit</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ </head>
45
+ <!--
46
+ The following styles are deprecated and will be removed at some point:
47
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
48
+
49
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
50
+ .man-navigation should be used instead.
51
+ -->
52
+ <body id='manpage'>
53
+ <div class='mp' id='man'>
54
+
55
+ <div class='man-navigation' style='display:none'>
56
+ <a href="#NAME">NAME</a>
57
+ <a href="#DESCRIPTION">DESCRIPTION</a>
58
+ <a href="#OPTIONS">OPTIONS</a>
59
+ <a href="#EXAMPLES">EXAMPLES</a>
60
+ <a href="#RESOURCES">RESOURCES</a>
61
+ <a href="#COPYRIGHT">COPYRIGHT</a>
62
+ <a href="#SEE-ALSO">SEE ALSO</a>
63
+ </div>
64
+
65
+ <ol class='man-decor man-head man head'>
66
+ <li class='tl'>detroit-yard(5)</li>
67
+ <li class='tc'></li>
68
+ <li class='tr'>detroit-yard(5)</li>
69
+ </ol>
70
+
71
+ <h2 id="NAME">NAME</h2>
72
+ <p class="man-name">
73
+ <code>detroit-yard</code> - <span class="man-whatis">generate yard api documentation via detroit</span>
74
+ </p>
75
+
76
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
77
+
78
+ <p>The YARD plug-in for Detroit utilizes the <code>yard</code> documentation
79
+ tool to generate API documentation for a project. It will also
80
+ generate yri documentation files.</p>
81
+
82
+ <h2 id="OPTIONS">OPTIONS</h2>
83
+
84
+ <p>The following options can be used in the Detroit assembly file
85
+ to define a YARD service.</p>
86
+
87
+ <ul>
88
+ <li><p><code>yardopts</code> - If set to true, use <code>.yardopts</code> file and ignore other settings.
89
+ This defaults to <code>true</code> if no other settings are given and a <code>.yardopts</code>
90
+ file exists.</p></li>
91
+ <li><p><code>title</code> - Title of documents. Defaults to general metadata title field.</p></li>
92
+ <li><p><code>output</code> - Where to save generated documentation. The default is <code>doc/</code>.</p></li>
93
+ <li><p><code>template</code> - Template to use. This defaults to <code>ENV['YARD_TEMPLATE']</code>.</p></li>
94
+ <li><p><code>files</code>/<code>include</code> - Which files to document. The default is <code>lib/</code>.</p></li>
95
+ <li><p><code>exclude</code> - Paths to specifically exclude.</p></li>
96
+ <li><p><code>ignore</code> - File patterns to ignore.</p></li>
97
+ <li><p><code>docs</code> - Which project document files to include, e.g. <code>COPYING</code>.</p></li>
98
+ <li><p><code>readme</code> - Main file. This can be a file pattern. This default is matched
99
+ to <code>README{,.*}</code>.</p></li>
100
+ <li><p><code>extra</code> - Additional options passed to the <code>rdoc</code> command.</p></li>
101
+ </ul>
102
+
103
+
104
+ <h2 id="EXAMPLES">EXAMPLES</h2>
105
+
106
+ <p>Usually <code>.yardopts</code> is used, in which case the simplest entry would be:</p>
107
+
108
+ <pre><code>yard:
109
+ priority: 1
110
+ </code></pre>
111
+
112
+ <p>We set the priority lower than the default (highest is <code>0</code>) in case some other
113
+ documentation tool generates files that should be included in the YARD docs.</p>
114
+
115
+ <p>A more complex example might look like:</p>
116
+
117
+ <pre><code>yard:
118
+ title: MyApp API
119
+ readme: INTRO.rdoc
120
+ include:
121
+ - lib
122
+ docs:
123
+ - [A-Z]*.*
124
+ ignore:
125
+ - '*.yml'
126
+ output: site/api
127
+ priority: 1
128
+ </code></pre>
129
+
130
+ <p>The above examples use the YAML-base assembly format. Assembly
131
+ files can also be Ruby-based. See Detroit documentation for more
132
+ details.</p>
133
+
134
+ <h2 id="RESOURCES">RESOURCES</h2>
135
+
136
+ <ul>
137
+ <li><p><a href="http://rubydoc.info/gems/detroit-yard">API Documentation</a></p></li>
138
+ <li><p><a href="http://github.com/detroit/detroit-yard">Development Site</a></p></li>
139
+ </ul>
140
+
141
+
142
+ <h2 id="COPYRIGHT">COPYRIGHT</h2>
143
+
144
+ <p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
145
+
146
+ <p>Detroit YARD is distributable in accordance with the GPL v.3 license.</p>
147
+
148
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
149
+
150
+ <p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">yard<span class="s">(1)</span></span></p>
151
+
152
+
153
+ <ol class='man-decor man-foot man foot'>
154
+ <li class='tl'></li>
155
+ <li class='tc'>October 2011</li>
156
+ <li class='tr'>detroit-yard(5)</li>
157
+ </ol>
158
+
159
+ </div>
160
+ </body>
161
+ </html>
@@ -0,0 +1,85 @@
1
+ detroit-yard(5) - generate yard api documentation via detroit
2
+ =============================================================
3
+
4
+ ## DESCRIPTION
5
+
6
+ The YARD plug-in for Detroit utilizes the `yard` documentation
7
+ tool to generate API documentation for a project. It will also
8
+ generate yri documentation files.
9
+
10
+
11
+ ## OPTIONS
12
+
13
+ The following options can be used in the Detroit assembly file
14
+ to define a YARD service.
15
+
16
+ * `yardopts` - If set to true, use `.yardopts` file and ignore other settings.
17
+ This defaults to `true` if no other settings are given and a `.yardopts`
18
+ file exists.
19
+
20
+ * `title` - Title of documents. Defaults to general metadata title field.
21
+
22
+ * `output` - Where to save generated documentation. The default is `doc/`.
23
+
24
+ * `template` - Template to use. This defaults to `ENV['YARD_TEMPLATE']`.
25
+
26
+ * `files`/`include` - Which files to document. The default is `lib/`.
27
+
28
+ * `exclude` - Paths to specifically exclude.
29
+
30
+ * `ignore` - File patterns to ignore.
31
+
32
+ * `docs` - Which project document files to include, e.g. `COPYING`.
33
+
34
+ * `readme` - Main file. This can be a file pattern. This default is matched
35
+ to `README{,.*}`.
36
+
37
+ * `extra` - Additional options passed to the `rdoc` command.
38
+
39
+
40
+ ## EXAMPLES
41
+
42
+ Usually `.yardopts` is used, in which case the simplest entry would be:
43
+
44
+ yard:
45
+ priority: 1
46
+
47
+ We set the priority lower than the default (highest is `0`) in case some other
48
+ documentation tool generates files that should be included in the YARD docs.
49
+
50
+ A more complex example might look like:
51
+
52
+ yard:
53
+ title: MyApp API
54
+ readme: INTRO.rdoc
55
+ include:
56
+ - lib
57
+ docs:
58
+ - [A-Z]*.*
59
+ ignore:
60
+ - '*.yml'
61
+ output: site/api
62
+ priority: 1
63
+
64
+ The above examples use the YAML-base assembly format. Assembly
65
+ files can also be Ruby-based. See Detroit documentation for more
66
+ details.
67
+
68
+
69
+ ## RESOURCES
70
+
71
+ * [API Documentation](http://rubydoc.info/gems/detroit-yard)
72
+
73
+ * [Development Site](http://github.com/detroit/detroit-yard)
74
+
75
+
76
+ ## COPYRIGHT
77
+
78
+ Copyright (c) 2010 Thomas Sawyer, Rubyworks
79
+
80
+ Detroit YARD is distributable in accordance with the GPL v.3 license.
81
+
82
+
83
+ ## SEE ALSO
84
+
85
+ detroit(1), yard(1)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: detroit-yard
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,22 +9,22 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2011-10-19 00:00:00.000000000 Z
12
+ date: 2012-04-02 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: detroit
16
- requirement: &18489100 !ruby/object:Gem::Requirement
16
+ requirement: &15076900 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
20
20
  - !ruby/object:Gem::Version
21
- version: '0'
21
+ version: 0.3.0
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *18489100
24
+ version_requirements: *15076900
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: yard
27
- requirement: &18488360 !ruby/object:Gem::Requirement
27
+ requirement: &15075980 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
32
32
  version: '0'
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *18488360
35
+ version_requirements: *15075980
36
36
  description: YARD plugin for Detroit build system. The plugin generates YARD documentation
37
37
  during the document phase.
38
38
  email:
@@ -40,17 +40,21 @@ email:
40
40
  executables: []
41
41
  extensions: []
42
42
  extra_rdoc_files:
43
- - GPL3.txt
43
+ - LICENSE.txt
44
44
  - README.rdoc
45
45
  - COPYING.rdoc
46
46
  files:
47
47
  - .ruby
48
48
  - lib/detroit-yard.rb
49
+ - man/detroit-yard.5
50
+ - man/detroit-yard.5.html
51
+ - man/detroit-yard.5.ronn
52
+ - LICENSE.txt
49
53
  - README.rdoc
50
- - GPL3.txt
51
54
  - COPYING.rdoc
52
55
  homepage: http://detroit.github.com/
53
- licenses: []
56
+ licenses:
57
+ - GPL-3
54
58
  post_install_message:
55
59
  rdoc_options: []
56
60
  require_paths:
@@ -69,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
69
73
  version: '0'
70
74
  requirements: []
71
75
  rubyforge_project:
72
- rubygems_version: 1.8.5
76
+ rubygems_version: 1.8.11
73
77
  signing_key:
74
78
  specification_version: 3
75
79
  summary: YARD plugin for Detroit