inochi 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +2 -0
- data/bin/inochi +30 -29
- data/doc/api/Inochi.html +439 -323
- data/doc/api/Inochi/Manual.html +230 -0
- data/doc/api/Inochi/Phrases.html +409 -0
- data/doc/api/Inochi/Version.html +222 -0
- data/doc/api/all-methods.html +97 -9
- data/doc/api/all-namespaces.html +7 -1
- data/doc/api/readme.html +3 -0
- data/doc/history.erb +50 -20
- data/doc/index.xhtml +355 -141
- data/doc/intro.erb +14 -14
- data/doc/setup.erb +8 -7
- data/doc/usage.erb +110 -5
- data/lib/inochi.rb +14 -3
- data/lib/inochi/book.rb +84 -0
- data/lib/inochi/init.rb +239 -0
- data/lib/inochi/main.rb +75 -0
- data/lib/inochi/rake.rb +777 -0
- data/lib/inochi/util.rb +77 -0
- data/test/{inochi/inochi.rb → inochi.rb} +0 -0
- metadata +32 -5
- data/lib/inochi/inochi.rb +0 -1064
@@ -0,0 +1,222 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
|
6
|
+
<link rel="stylesheet" href="../style.css" type="text/css" charset="utf-8" />
|
7
|
+
<link rel="stylesheet" href="../syntax_highlight.css" type="text/css" charset="utf-8" />
|
8
|
+
|
9
|
+
<script src="../jquery.js" type="text/javascript" charset="utf-8"></script>
|
10
|
+
<script src="../app.js" type="text/javascript" charset="utf-8"></script>
|
11
|
+
<title>Module: Inochi::Version</title>
|
12
|
+
</head>
|
13
|
+
<body>
|
14
|
+
<div id="content">
|
15
|
+
<div class="section module Inochi_Version">
|
16
|
+
<h1 class="title">Module: Inochi::Version</h1>
|
17
|
+
<div class="section constants">
|
18
|
+
|
19
|
+
</div> <div class="section visibilitygroup public">
|
20
|
+
<h1>Public Visibility</h1>
|
21
|
+
<div class="section methodsummary instance public">
|
22
|
+
<h1>Public Instance Method Summary</h1>
|
23
|
+
<table class="summary">
|
24
|
+
|
25
|
+
<tr>
|
26
|
+
<th class="signature">
|
27
|
+
<span class='name'><a title="#major" href="#major-instance_method">#major</a></span><span class='args'></span>
|
28
|
+
<span class='block'></span>
|
29
|
+
|
30
|
+
</th>
|
31
|
+
<td class="docstring">
|
32
|
+
<p>
|
33
|
+
Returns the major number in this version.
|
34
|
+
</p>
|
35
|
+
|
36
|
+
|
37
|
+
</td>
|
38
|
+
</tr>
|
39
|
+
|
40
|
+
<tr>
|
41
|
+
<th class="signature">
|
42
|
+
<span class='name'><a title="#requirement" href="#requirement-instance_method">#requirement</a></span><span class='args'></span>
|
43
|
+
<span class='block'></span>
|
44
|
+
|
45
|
+
</th>
|
46
|
+
<td class="docstring">
|
47
|
+
<p>
|
48
|
+
Returns a Gem::Requirement expression.
|
49
|
+
</p>
|
50
|
+
|
51
|
+
|
52
|
+
</td>
|
53
|
+
</tr>
|
54
|
+
|
55
|
+
<tr>
|
56
|
+
<th class="signature">
|
57
|
+
<span class='name'><a title="#series" href="#series-instance_method">#series</a></span><span class='args'></span>
|
58
|
+
<span class='block'></span>
|
59
|
+
|
60
|
+
</th>
|
61
|
+
<td class="docstring">
|
62
|
+
<p>
|
63
|
+
Returns a string describing any version with the current major number.
|
64
|
+
</p>
|
65
|
+
|
66
|
+
|
67
|
+
</td>
|
68
|
+
</tr>
|
69
|
+
|
70
|
+
</table>
|
71
|
+
</div>
|
72
|
+
<div class="section methoddetails instance public">
|
73
|
+
<h1>Public Instance Method Details</h1>
|
74
|
+
|
75
|
+
<div class="method">
|
76
|
+
<div class="method_header">
|
77
|
+
<h3>major</h3>
|
78
|
+
</div><div id="major-instance_method" class="section method">
|
79
|
+
<div class="details_title">
|
80
|
+
<div class='section methodsignature'>
|
81
|
+
<tt class='def'>
|
82
|
+
<span class='visibility'>public</span>
|
83
|
+
<span class='return_types'></span>
|
84
|
+
<span class='name'>major</span><span class='args'></span>
|
85
|
+
<span class='block'></span>
|
86
|
+
</tt>
|
87
|
+
</div>
|
88
|
+
|
89
|
+
</div><div class="section docstring">
|
90
|
+
<p>
|
91
|
+
Returns the major number in this version.
|
92
|
+
</p>
|
93
|
+
|
94
|
+
</div><div class="section source">
|
95
|
+
<span>[<a class="source_link" href="#">View source</a>]</span>
|
96
|
+
<div class="source_code">
|
97
|
+
<table>
|
98
|
+
<tr>
|
99
|
+
<td>
|
100
|
+
<pre class="lines">
|
101
|
+
|
102
|
+
|
103
|
+
139
|
104
|
+
140
|
105
|
+
141</pre>
|
106
|
+
</td>
|
107
|
+
<td>
|
108
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/init.rb', line 139</span>
|
109
|
+
|
110
|
+
<span class='def def kw'>def</span> <span class='major identifier id'>major</span>
|
111
|
+
<span class='to_s identifier id'>to_s</span><span class='lbrack token'>[</span><span class='regexp val'>/^\d+/</span><span class='rbrack token'>]</span>
|
112
|
+
<span class='end end kw'>end</span>
|
113
|
+
</pre>
|
114
|
+
</td>
|
115
|
+
</tr>
|
116
|
+
</table>
|
117
|
+
</div>
|
118
|
+
</div>
|
119
|
+
</div>
|
120
|
+
</div>
|
121
|
+
|
122
|
+
<div class="method">
|
123
|
+
<div class="method_header">
|
124
|
+
<h3>requirement</h3>
|
125
|
+
</div><div id="requirement-instance_method" class="section method">
|
126
|
+
<div class="details_title">
|
127
|
+
<div class='section methodsignature'>
|
128
|
+
<tt class='def'>
|
129
|
+
<span class='visibility'>public</span>
|
130
|
+
<span class='return_types'></span>
|
131
|
+
<span class='name'>requirement</span><span class='args'></span>
|
132
|
+
<span class='block'></span>
|
133
|
+
</tt>
|
134
|
+
</div>
|
135
|
+
|
136
|
+
</div><div class="section docstring">
|
137
|
+
<p>
|
138
|
+
Returns a Gem::Requirement expression.
|
139
|
+
</p>
|
140
|
+
|
141
|
+
</div><div class="section source">
|
142
|
+
<span>[<a class="source_link" href="#">View source</a>]</span>
|
143
|
+
<div class="source_code">
|
144
|
+
<table>
|
145
|
+
<tr>
|
146
|
+
<td>
|
147
|
+
<pre class="lines">
|
148
|
+
|
149
|
+
|
150
|
+
149
|
151
|
+
150
|
152
|
+
151</pre>
|
153
|
+
</td>
|
154
|
+
<td>
|
155
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/init.rb', line 149</span>
|
156
|
+
|
157
|
+
<span class='def def kw'>def</span> <span class='requirement identifier id'>requirement</span>
|
158
|
+
<span class='dstring node'>"~> #{major}"</span>
|
159
|
+
<span class='end end kw'>end</span>
|
160
|
+
</pre>
|
161
|
+
</td>
|
162
|
+
</tr>
|
163
|
+
</table>
|
164
|
+
</div>
|
165
|
+
</div>
|
166
|
+
</div>
|
167
|
+
</div>
|
168
|
+
|
169
|
+
<div class="method">
|
170
|
+
<div class="method_header">
|
171
|
+
<h3>series</h3>
|
172
|
+
</div><div id="series-instance_method" class="section method">
|
173
|
+
<div class="details_title">
|
174
|
+
<div class='section methodsignature'>
|
175
|
+
<tt class='def'>
|
176
|
+
<span class='visibility'>public</span>
|
177
|
+
<span class='return_types'></span>
|
178
|
+
<span class='name'>series</span><span class='args'></span>
|
179
|
+
<span class='block'></span>
|
180
|
+
</tt>
|
181
|
+
</div>
|
182
|
+
|
183
|
+
</div><div class="section docstring">
|
184
|
+
<p>
|
185
|
+
Returns a string describing any version with the current major number.
|
186
|
+
</p>
|
187
|
+
|
188
|
+
</div><div class="section source">
|
189
|
+
<span>[<a class="source_link" href="#">View source</a>]</span>
|
190
|
+
<div class="source_code">
|
191
|
+
<table>
|
192
|
+
<tr>
|
193
|
+
<td>
|
194
|
+
<pre class="lines">
|
195
|
+
|
196
|
+
|
197
|
+
144
|
198
|
+
145
|
199
|
+
146</pre>
|
200
|
+
</td>
|
201
|
+
<td>
|
202
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/init.rb', line 144</span>
|
203
|
+
|
204
|
+
<span class='def def kw'>def</span> <span class='series identifier id'>series</span>
|
205
|
+
<span class='dstring node'>"#{major}.x.x"</span>
|
206
|
+
<span class='end end kw'>end</span>
|
207
|
+
</pre>
|
208
|
+
</td>
|
209
|
+
</tr>
|
210
|
+
</table>
|
211
|
+
</div>
|
212
|
+
</div>
|
213
|
+
</div>
|
214
|
+
</div>
|
215
|
+
|
216
|
+
</div>
|
217
|
+
</div>
|
218
|
+
|
219
|
+
</div>
|
220
|
+
</div>
|
221
|
+
</body>
|
222
|
+
</html>
|
data/doc/api/all-methods.html
CHANGED
@@ -16,7 +16,95 @@
|
|
16
16
|
|
17
17
|
|
18
18
|
<li nowrap>
|
19
|
-
<a href="Inochi.html#
|
19
|
+
<a title="#project_history" href="Inochi/Manual.html#project_history-instance_method">#project_history</a>
|
20
|
+
|
21
|
+
<em>(module Manual)</em>
|
22
|
+
|
23
|
+
</li>
|
24
|
+
|
25
|
+
|
26
|
+
<li nowrap>
|
27
|
+
<a title="#project_summary" href="Inochi/Manual.html#project_summary-instance_method">#project_summary</a>
|
28
|
+
|
29
|
+
<em>(module Manual)</em>
|
30
|
+
|
31
|
+
</li>
|
32
|
+
|
33
|
+
|
34
|
+
<li nowrap>
|
35
|
+
<a title="#[]" href="Inochi/Phrases.html#%5B%5D-instance_method">#[]</a>
|
36
|
+
|
37
|
+
<em>(class Phrases)</em>
|
38
|
+
|
39
|
+
</li>
|
40
|
+
|
41
|
+
|
42
|
+
<li nowrap>
|
43
|
+
<a title="#initialize" href="Inochi/Phrases.html#initialize-instance_method">#initialize</a>
|
44
|
+
|
45
|
+
<em>(class Phrases)</em>
|
46
|
+
|
47
|
+
</li>
|
48
|
+
|
49
|
+
|
50
|
+
<li nowrap>
|
51
|
+
<a title="#locale" href="Inochi/Phrases.html#locale-instance_method">#locale</a>
|
52
|
+
|
53
|
+
<em>(class Phrases)</em>
|
54
|
+
|
55
|
+
</li>
|
56
|
+
|
57
|
+
|
58
|
+
<li nowrap>
|
59
|
+
<a title="#method_missing" href="Inochi/Phrases.html#method_missing-instance_method">#method_missing</a>
|
60
|
+
|
61
|
+
<em>(class Phrases)</em>
|
62
|
+
|
63
|
+
</li>
|
64
|
+
|
65
|
+
|
66
|
+
<li nowrap>
|
67
|
+
<a title="#phrases" href="Inochi/Phrases.html#phrases-instance_method">#phrases</a>
|
68
|
+
|
69
|
+
<em>(class Phrases)</em>
|
70
|
+
|
71
|
+
</li>
|
72
|
+
|
73
|
+
|
74
|
+
<li nowrap>
|
75
|
+
<a title="#translate" href="Inochi/Phrases.html#translate-instance_method">#translate</a>
|
76
|
+
|
77
|
+
<em>(class Phrases)</em>
|
78
|
+
|
79
|
+
</li>
|
80
|
+
|
81
|
+
|
82
|
+
<li nowrap>
|
83
|
+
<a title="#major" href="Inochi/Version.html#major-instance_method">#major</a>
|
84
|
+
|
85
|
+
<em>(module Version)</em>
|
86
|
+
|
87
|
+
</li>
|
88
|
+
|
89
|
+
|
90
|
+
<li nowrap>
|
91
|
+
<a title="#requirement" href="Inochi/Version.html#requirement-instance_method">#requirement</a>
|
92
|
+
|
93
|
+
<em>(module Version)</em>
|
94
|
+
|
95
|
+
</li>
|
96
|
+
|
97
|
+
|
98
|
+
<li nowrap>
|
99
|
+
<a title="#series" href="Inochi/Version.html#series-instance_method">#series</a>
|
100
|
+
|
101
|
+
<em>(module Version)</em>
|
102
|
+
|
103
|
+
</li>
|
104
|
+
|
105
|
+
|
106
|
+
<li nowrap>
|
107
|
+
<a title="book" href="Inochi.html#book-class_method">book</a>
|
20
108
|
|
21
109
|
<em>(module Inochi)</em>
|
22
110
|
|
@@ -24,7 +112,7 @@
|
|
24
112
|
|
25
113
|
|
26
114
|
<li nowrap>
|
27
|
-
<a href="Inochi.html#calc_program_name-class_method"
|
115
|
+
<a title="calc_program_name" href="Inochi.html#calc_program_name-class_method">calc_program_name</a>
|
28
116
|
|
29
117
|
<em>(module Inochi)</em>
|
30
118
|
|
@@ -32,7 +120,7 @@
|
|
32
120
|
|
33
121
|
|
34
122
|
<li nowrap>
|
35
|
-
<a href="Inochi.html#calc_project_symbol-class_method"
|
123
|
+
<a title="calc_project_symbol" href="Inochi.html#calc_project_symbol-class_method">calc_project_symbol</a>
|
36
124
|
|
37
125
|
<em>(module Inochi)</em>
|
38
126
|
|
@@ -40,7 +128,7 @@
|
|
40
128
|
|
41
129
|
|
42
130
|
<li nowrap>
|
43
|
-
<a href="Inochi.html#camel_to_snake_case-class_method"
|
131
|
+
<a title="camel_to_snake_case" href="Inochi.html#camel_to_snake_case-class_method">camel_to_snake_case</a>
|
44
132
|
|
45
133
|
<em>(module Inochi)</em>
|
46
134
|
|
@@ -48,7 +136,7 @@
|
|
48
136
|
|
49
137
|
|
50
138
|
<li nowrap>
|
51
|
-
<a href="Inochi.html#fetch_project_module-class_method"
|
139
|
+
<a title="fetch_project_module" href="Inochi.html#fetch_project_module-class_method">fetch_project_module</a>
|
52
140
|
|
53
141
|
<em>(module Inochi)</em>
|
54
142
|
|
@@ -56,7 +144,7 @@
|
|
56
144
|
|
57
145
|
|
58
146
|
<li nowrap>
|
59
|
-
<a href="Inochi.html#first_caller_file-class_method"
|
147
|
+
<a title="first_caller_file" href="Inochi.html#first_caller_file-class_method">first_caller_file</a>
|
60
148
|
|
61
149
|
<em>(module Inochi)</em>
|
62
150
|
|
@@ -64,7 +152,7 @@
|
|
64
152
|
|
65
153
|
|
66
154
|
<li nowrap>
|
67
|
-
<a href="Inochi.html#init-class_method"
|
155
|
+
<a title="init" href="Inochi.html#init-class_method">init</a>
|
68
156
|
|
69
157
|
<em>(module Inochi)</em>
|
70
158
|
|
@@ -72,7 +160,7 @@
|
|
72
160
|
|
73
161
|
|
74
162
|
<li nowrap>
|
75
|
-
<a href="Inochi.html#main-class_method"
|
163
|
+
<a title="main" href="Inochi.html#main-class_method">main</a>
|
76
164
|
|
77
165
|
<em>(module Inochi)</em>
|
78
166
|
|
@@ -80,7 +168,7 @@
|
|
80
168
|
|
81
169
|
|
82
170
|
<li nowrap>
|
83
|
-
<a href="Inochi.html#rake-class_method"
|
171
|
+
<a title="rake" href="Inochi.html#rake-class_method">rake</a>
|
84
172
|
|
85
173
|
<em>(module Inochi)</em>
|
86
174
|
|
data/doc/api/all-namespaces.html
CHANGED
@@ -14,7 +14,13 @@
|
|
14
14
|
<h1>All Modules / Classes</h1>
|
15
15
|
<ul>
|
16
16
|
|
17
|
-
<li><a
|
17
|
+
<li><a title="Inochi" href="Inochi.html">Inochi</a> <em>(module)</em></li>
|
18
|
+
|
19
|
+
<li><a title="Inochi::Manual" href="Inochi/Manual.html">Inochi::Manual</a> <em>(module)</em></li>
|
20
|
+
|
21
|
+
<li><a title="Inochi::Phrases" href="Inochi/Phrases.html">Inochi::Phrases</a> <em>(class)</em></li>
|
22
|
+
|
23
|
+
<li><a title="Inochi::Version" href="Inochi/Version.html">Inochi::Version</a> <em>(module)</em></li>
|
18
24
|
|
19
25
|
</ul>
|
20
26
|
</div>
|
data/doc/api/readme.html
CHANGED
data/doc/history.erb
CHANGED
@@ -1,38 +1,72 @@
|
|
1
|
-
<% chapter "History"
|
1
|
+
<% chapter "History" do %>
|
2
2
|
<% project_history do %>
|
3
|
-
<% section "Version 0.
|
4
|
-
This release adds support for
|
3
|
+
<% section "Version 0.3.0 (2009-02-12)" do %>
|
4
|
+
This release adds support for <%= xref "Translate your project", "language translations / internationalization / multilingualization" %>, improves the user interface, and fixes a show-stopper bug for Windows users.
|
5
|
+
|
6
|
+
<% paragraph "New features" do %>
|
7
|
+
* Add support for <%= xref "Translate your project", "language translations" %> of phrases used in a project.
|
8
|
+
|
9
|
+
* Add "lang:dump" Rake task for extracting language phrases from project.
|
10
|
+
|
11
|
+
* Add "lang:conv" Rake task for translating dumped phrases into various languages using the BabelFish translation service.
|
12
|
+
|
13
|
+
* Add <tt>--locale</tt> option to a project's main executable for setting user's preferred language in spite of the user's locale environment.
|
14
|
+
|
15
|
+
* Notify user when attempting to publish announcements in the "pub" Rake tasks.
|
16
|
+
<% end %>
|
17
|
+
|
18
|
+
<% paragraph "Bug fixes" do %>
|
19
|
+
* In Windows, `ENV['USERPROFILE']` gives the path to the user's home directory and `ENV['HOME']` is not defined.
|
20
|
+
|
21
|
+
* The only real solution to the circular gem dependency problem is:
|
22
|
+
|
23
|
+
gem install --force
|
5
24
|
|
6
|
-
|
7
|
-
|
25
|
+
You should update <%= xref "Setup" %> in your projects' user manuals accordingly.
|
26
|
+
<% end %>
|
27
|
+
|
28
|
+
<% paragraph "Housekeeping" do %>
|
29
|
+
* Break the huge <tt>lib/inochi/inochi.rb</tt> library into smaller files.
|
30
|
+
|
31
|
+
* Instead of adding methods to singleton classes directly, define modules and extend to them so that YARDoc documents the methods appropriately.
|
8
32
|
|
9
|
-
*
|
33
|
+
* List all project contributors globally in the "Credits" section.
|
10
34
|
|
11
|
-
*
|
35
|
+
* Remove "Contributor kudos" paragraph in release notes in favor of crediting contributors inline with each item in the release notes.
|
36
|
+
|
37
|
+
* Mention that the project license is ISC for the reader's convenience.
|
12
38
|
<% end %>
|
39
|
+
<% end %>
|
40
|
+
|
41
|
+
<% section "Version 0.2.0 (2009-01-25)" do %>
|
42
|
+
This release adds support for unit testing, improves the portability of **Inochi** and configurability of your projects, adds new content to the user manual, and fixes some bugs.
|
13
43
|
|
14
44
|
<% paragraph "New features" do %>
|
15
|
-
* Added support for unit testing via the [minitest](http://rubyforge.org/projects/bfts/) library.
|
45
|
+
* Added <%= xref "Test your project", "support for unit testing" %> via the [minitest](http://rubyforge.org/projects/bfts/) library.
|
16
46
|
|
17
|
-
|
47
|
+
* The scaffold generator now emits a default unit test for the main project library.
|
18
48
|
|
19
49
|
* Added optional ProgramName parameter to the scaffold generator. This allows you to specify reasonable program names when your project module has a strange capitalization:
|
20
50
|
|
21
|
-
|
51
|
+
# inochi ERBook
|
22
52
|
create er_book/LICENSE
|
23
53
|
|
24
|
-
|
54
|
+
# inochi ERBook erbook
|
25
55
|
create erbook/LICENSE
|
26
56
|
|
27
|
-
|
57
|
+
# inochi ERBook foobar
|
28
58
|
create foobar/LICENSE
|
29
59
|
|
30
60
|
* Allow project authors to be specified via
|
31
61
|
|
32
|
-
`Inochi.init :YourProject, :authors =>
|
62
|
+
`Inochi.init :YourProject, :authors => [['name', 'mail']]`
|
63
|
+
|
64
|
+
(Florian Gilcher)
|
33
65
|
<% end %>
|
34
66
|
|
35
67
|
<% paragraph "Bug fixes" do %>
|
68
|
+
* Run on both JRuby and normal Ruby in multiple versions and with different executable names on Windows. (Florian Gilcher)
|
69
|
+
|
36
70
|
* Use `Gem::RubyGemsVersion` instead of a shell command to determine rubygems version for generation of <tt>setup.erb</tt>. (Florian Gilcher)
|
37
71
|
|
38
72
|
* Add blank lines between all list items, not just multi-line ones, in the plain-text version of the relase announcement for improved readability.
|
@@ -49,7 +83,7 @@
|
|
49
83
|
This release reattempts to fix the [circular dependency problem](http://www.ruby-forum.com/topic/176173#771281) that occurred when installing either **Inochi** or **ERBook**.
|
50
84
|
|
51
85
|
<% paragraph "New features" do %>
|
52
|
-
*
|
86
|
+
* `Inochi.init()` now adds `#major()`, `#series()`, and `#requirement()` instance methods to a project's `VERSION` constant.
|
53
87
|
<% end %>
|
54
88
|
|
55
89
|
<% paragraph "Bug fixes" do %>
|
@@ -64,14 +98,10 @@
|
|
64
98
|
<% section "Version 0.0.1 (2009-01-13)" do %>
|
65
99
|
This release fixes some show-stopper bugs.
|
66
100
|
|
67
|
-
<% paragraph "Contributor kudos" do %>
|
68
|
-
* Florian Gilcher tried the first release of **Inochi** and reported bugs.
|
69
|
-
<% end %>
|
70
|
-
|
71
101
|
<% paragraph "Bug fixes" do %>
|
72
|
-
*
|
102
|
+
* The name of the project library was [being determined incorrectly](http://www.ruby-forum.com/topic/176173#771351). (Florian Gilcher)
|
73
103
|
|
74
|
-
*
|
104
|
+
* There was a [circular dependency problem](http://www.ruby-forum.com/topic/176173#771281) when installing the **Inochi** gem. (Florian Gilcher)
|
75
105
|
|
76
106
|
The solution is to specify the <tt>--force</tt> option when installing the gem. <%= xref "Installation" %> has been updated accordingly.
|
77
107
|
|