inochi 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/bin/inochi +144 -71
- data/doc/api/classes/Array.html +6 -6
- data/doc/api/classes/File.html +1 -1
- data/doc/api/classes/Inochi.html +24 -40
- data/doc/api/classes/Inochi/Manual.html +2 -2
- data/doc/api/classes/Inochi/Phrases.html +5 -5
- data/doc/api/classes/Inochi/Version.html +3 -3
- data/doc/api/classes/TempDir.html +7 -7
- data/doc/api/created.rid +1 -1
- data/doc/api/files/lib/inochi/book_rb.html +1 -5
- data/doc/api/files/lib/inochi/init_rb.html +1 -1
- data/doc/api/files/lib/inochi/main_rb.html +1 -1
- data/doc/api/files/lib/inochi/rake_rb.html +1 -1
- data/doc/api/files/lib/inochi/util/combo_rb.html +1 -1
- data/doc/api/files/lib/inochi/util/tempdir_rb.html +1 -1
- data/doc/api/files/lib/inochi/util_rb.html +1 -1
- data/doc/api/files/lib/inochi_rb.html +1 -1
- data/doc/api/panel/search_index.js +1 -1
- data/doc/api/panel/tree.js +1 -1
- data/doc/history.erb +90 -5
- data/doc/index.erb +2 -2
- data/doc/index.html +3125 -0
- data/doc/intro.erb +53 -75
- data/doc/setup.erb +53 -2
- data/doc/usage.erb +176 -34
- data/lib/inochi.rb +5 -5
- data/lib/inochi/book.rb +2 -2
- data/lib/inochi/init.rb +2 -2
- data/lib/inochi/main.rb +3 -3
- data/lib/inochi/rake.rb +21 -37
- data/lib/inochi/util.rb +2 -2
- data/lib/inochi/util/combo.rb +2 -2
- data/lib/inochi/util/tempdir.rb +2 -2
- data/rakefile +2 -2
- data/test/inochi.rb +2 -2
- metadata +8 -6
- data/doc/index.xhtml +0 -1984
|
@@ -94,7 +94,7 @@ Contains release notes for all project releases.
|
|
|
94
94
|
<p class="source-link">
|
|
95
95
|
Source: <a href="javascript:toggleSource('M000013_source')" id="l_M000013_source">show</a>
|
|
96
96
|
|
|
97
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
97
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/book.rb#L82" target="_blank" class="github_url">on GitHub</a>
|
|
98
98
|
|
|
99
99
|
</p>
|
|
100
100
|
<div id="M000013_source" class="dyn-source">
|
|
@@ -133,7 +133,7 @@ Defines a brief summary of this project.
|
|
|
133
133
|
<p class="source-link">
|
|
134
134
|
Source: <a href="javascript:toggleSource('M000012_source')" id="l_M000012_source">show</a>
|
|
135
135
|
|
|
136
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
136
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/book.rb#L70" target="_blank" class="github_url">on GitHub</a>
|
|
137
137
|
|
|
138
138
|
</p>
|
|
139
139
|
<div id="M000012_source" class="dyn-source">
|
|
@@ -142,7 +142,7 @@ The locale into which the #[] method will translate phrases.
|
|
|
142
142
|
<p class="source-link">
|
|
143
143
|
Source: <a href="javascript:toggleSource('M000026_source')" id="l_M000026_source">show</a>
|
|
144
144
|
|
|
145
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
145
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L175" target="_blank" class="github_url">on GitHub</a>
|
|
146
146
|
|
|
147
147
|
</p>
|
|
148
148
|
<div id="M000026_source" class="dyn-source">
|
|
@@ -201,7 +201,7 @@ phrase will be used as-is, untranslated.
|
|
|
201
201
|
<p class="source-link">
|
|
202
202
|
Source: <a href="javascript:toggleSource('M000029_source')" id="l_M000029_source">show</a>
|
|
203
203
|
|
|
204
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
204
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L223" target="_blank" class="github_url">on GitHub</a>
|
|
205
205
|
|
|
206
206
|
</p>
|
|
207
207
|
<div id="M000029_source" class="dyn-source">
|
|
@@ -228,7 +228,7 @@ phrase will be used as-is, untranslated.
|
|
|
228
228
|
<p class="source-link">
|
|
229
229
|
Source: <a href="javascript:toggleSource('M000027_source')" id="l_M000027_source">show</a>
|
|
230
230
|
|
|
231
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
231
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L198" target="_blank" class="github_url">on GitHub</a>
|
|
232
232
|
|
|
233
233
|
</p>
|
|
234
234
|
<div id="M000027_source" class="dyn-source">
|
|
@@ -272,7 +272,7 @@ the target locale is French.
|
|
|
272
272
|
<p class="source-link">
|
|
273
273
|
Source: <a href="javascript:toggleSource('M000030_source')" id="l_M000030_source">show</a>
|
|
274
274
|
|
|
275
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
275
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L234" target="_blank" class="github_url">on GitHub</a>
|
|
276
276
|
|
|
277
277
|
</p>
|
|
278
278
|
<div id="M000030_source" class="dyn-source">
|
|
@@ -312,7 +312,7 @@ object.
|
|
|
312
312
|
<p class="source-link">
|
|
313
313
|
Source: <a href="javascript:toggleSource('M000028_source')" id="l_M000028_source">show</a>
|
|
314
314
|
|
|
315
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
315
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L210" target="_blank" class="github_url">on GitHub</a>
|
|
316
316
|
|
|
317
317
|
</p>
|
|
318
318
|
<div id="M000028_source" class="dyn-source">
|
|
@@ -103,7 +103,7 @@ Returns the major number in this version.
|
|
|
103
103
|
<p class="source-link">
|
|
104
104
|
Source: <a href="javascript:toggleSource('M000023_source')" id="l_M000023_source">show</a>
|
|
105
105
|
|
|
106
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
106
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L156" target="_blank" class="github_url">on GitHub</a>
|
|
107
107
|
|
|
108
108
|
</p>
|
|
109
109
|
<div id="M000023_source" class="dyn-source">
|
|
@@ -137,7 +137,7 @@ Returns a Gem::Requirement expression.
|
|
|
137
137
|
<p class="source-link">
|
|
138
138
|
Source: <a href="javascript:toggleSource('M000025_source')" id="l_M000025_source">show</a>
|
|
139
139
|
|
|
140
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
140
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L166" target="_blank" class="github_url">on GitHub</a>
|
|
141
141
|
|
|
142
142
|
</p>
|
|
143
143
|
<div id="M000025_source" class="dyn-source">
|
|
@@ -171,7 +171,7 @@ Returns a string describing any version with the current major number.
|
|
|
171
171
|
<p class="source-link">
|
|
172
172
|
Source: <a href="javascript:toggleSource('M000024_source')" id="l_M000024_source">show</a>
|
|
173
173
|
|
|
174
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
174
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/init.rb#L161" target="_blank" class="github_url">on GitHub</a>
|
|
175
175
|
|
|
176
176
|
</p>
|
|
177
177
|
<div id="M000024_source" class="dyn-source">
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
<dd>
|
|
59
59
|
<ul>
|
|
60
60
|
|
|
61
|
-
<li><a href="#
|
|
61
|
+
<li><a href="#M000007">new</a></li>
|
|
62
62
|
|
|
63
63
|
</ul>
|
|
64
64
|
</dd>
|
|
@@ -93,9 +93,9 @@
|
|
|
93
93
|
<div class="sectiontitle">Class Public methods</div>
|
|
94
94
|
|
|
95
95
|
<div class="method">
|
|
96
|
-
<div class="title" id="
|
|
96
|
+
<div class="title" id="M000007">
|
|
97
97
|
|
|
98
|
-
<a name="
|
|
98
|
+
<a name="M000007"></a><b>new</b>(basename = nil, dirname = nil)
|
|
99
99
|
|
|
100
100
|
</div>
|
|
101
101
|
|
|
@@ -104,12 +104,12 @@
|
|
|
104
104
|
|
|
105
105
|
<div class="sourcecode">
|
|
106
106
|
<p class="source-link">
|
|
107
|
-
Source: <a href="javascript:toggleSource('
|
|
107
|
+
Source: <a href="javascript:toggleSource('M000007_source')" id="l_M000007_source">show</a>
|
|
108
108
|
|
|
109
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
109
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/util/tempdir.rb#L12" target="_blank" class="github_url">on GitHub</a>
|
|
110
110
|
|
|
111
111
|
</p>
|
|
112
|
-
<div id="
|
|
112
|
+
<div id="M000007_source" class="dyn-source">
|
|
113
113
|
<pre><span class="ruby-comment cmt"># File lib/inochi/util/tempdir.rb, line 12</span>
|
|
114
114
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">basename</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">dirname</span> = <span class="ruby-keyword kw">nil</span>
|
|
115
115
|
<span class="ruby-identifier">args</span> = [<span class="ruby-identifier">basename</span> <span class="ruby-operator">||</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">$0</span>), <span class="ruby-identifier">dirname</span>].<span class="ruby-identifier">compact</span>
|
|
@@ -145,7 +145,7 @@
|
|
|
145
145
|
<p class="source-link">
|
|
146
146
|
Source: <a href="javascript:toggleSource('M000009_source')" id="l_M000009_source">show</a>
|
|
147
147
|
|
|
148
|
-
| <a href="http://github.com/sunaku/inochi/blob/
|
|
148
|
+
| <a href="http://github.com/sunaku/inochi/blob/94ea085869f0eab9b04917d057bdae5b64157781/lib/inochi/util/tempdir.rb#L26" target="_blank" class="github_url">on GitHub</a>
|
|
149
149
|
|
|
150
150
|
</p>
|
|
151
151
|
<div id="M000009_source" class="dyn-source">
|
data/doc/api/created.rid
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
Sun, 06 Sep 2009 20:43:55 -0700
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
</h1>
|
|
20
20
|
<ul class="files">
|
|
21
21
|
<li>lib/inochi/book.rb</li>
|
|
22
|
-
<li>Last modified:
|
|
22
|
+
<li>Last modified: Mon Aug 24 09:30:39 -0700 2009</li>
|
|
23
23
|
</ul>
|
|
24
24
|
</div>
|
|
25
25
|
|
|
@@ -47,8 +47,6 @@
|
|
|
47
47
|
|
|
48
48
|
<li>erbook</li>
|
|
49
49
|
|
|
50
|
-
<li>sdoc</li>
|
|
51
|
-
|
|
52
50
|
<li>rake/rdoctask</li>
|
|
53
51
|
|
|
54
52
|
<li>tempfile</li>
|
|
@@ -61,8 +59,6 @@
|
|
|
61
59
|
|
|
62
60
|
<li>time</li>
|
|
63
61
|
|
|
64
|
-
<li>rake/gempackagetask</li>
|
|
65
|
-
|
|
66
62
|
</ul>
|
|
67
63
|
|
|
68
64
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
var search_data = {"index":{"info":[["Array","lib
|
|
1
|
+
var search_data = {"index":{"info":[["Array","lib/inochi/util/combo.rb","classes/Array.html"," < Object"," ",1],["File","lib/inochi/util.rb","classes/File.html"," < IO","",1],["Inochi","lib/inochi/init.rb","classes/Inochi.html"," < "," ",1],["Manual","Inochi","classes/Inochi/Manual.html"," < ","",1],["Phrases","Inochi","classes/Inochi/Phrases.html"," < Object","Interface to translations of human text used in a project. ",1],["Version","Inochi","classes/Inochi/Version.html"," < ","",1],["TempDir","lib/inochi/util/tempdir.rb","classes/TempDir.html"," < Object","",1],["[]","Inochi::Phrases","classes/Inochi/Phrases.html#M000029","(phrase, *words)","Translates the given phrase into the target locale (see #locale and #locale=) and then substitutes the",2],["book","Inochi","classes/Inochi.html#M000011","(project_symbol, book_template)","Provides a common configuration for the project's user manual: * Assigns the title, subtitle, date, and",2],["close","TempDir","classes/TempDir.html#M000009","()","",2],["combination","Array","classes/Array.html#M000002","(sample_size = self.length, &sampler)","Returns all possible combinations made from sample_size number of items from this list. ==== Parameters",2],["combinations","Array","classes/Array.html#M000003","(&sampler)","Returns all possible combinations of all possible lengths. ==== Parameters [sampler] If given, each combination",2],["enumeration","Array","classes/Array.html#M000000","(sample_size = self.length, &sampler)","Returns all possible enumerations made from sample_size number of items from this list. ==== Parameters",2],["enumerations","Array","classes/Array.html#M000001","(&sampler)","Returns all possible enumerations of all possible lengths. ==== Parameters [sampler] If given, each enumeration",2],["history","Inochi::Manual","classes/Inochi/Manual.html#M000013","()","Contains release notes for all project releases. ",2],["init","Inochi","classes/Inochi.html#M000022","(project_symbol, project_config = {})","Establishes your project in Ruby's runtime environment by defining the project module (which serves as",2],["locale=","Inochi::Phrases","classes/Inochi/Phrases.html#M000027","(locale)","",2],["main","Inochi","classes/Inochi.html#M000010","(project_symbol, *trollop_args, &trollop_config)","Provides a common configuration for the main project executable: * The program description (the sequence",2],["major","Inochi::Version","classes/Inochi/Version.html#M000023","()","Returns the major number in this version. ",2],["method_missing","Inochi::Phrases","classes/Inochi/Phrases.html#M000030","(meth, *args)","Provides access to translations in any language, regardless of the target locale (see #locale and #locale=).",2],["new","Inochi::Phrases","classes/Inochi/Phrases.html#M000026","(project_install_dir)","",2],["new","TempDir","classes/TempDir.html#M000007","(basename = nil, dirname = nil)","",2],["permutation","Array","classes/Array.html#M000004","(sample_size = self.length, &sampler)","Returns all possible permutations made from sample_size number of items from this list. ==== Parameters",2],["permutations","Array","classes/Array.html#M000005","(&sampler)","Returns all possible permutations of all possible lengths. ==== Parameters [sampler] If given, each permutation",2],["phrases","Inochi::Phrases","classes/Inochi/Phrases.html#M000028","()","Returns all phrases that underwent (or attempted) translation via this object. ",2],["project","Inochi::Manual","classes/Inochi/Manual.html#M000012","()","Defines a brief summary of this project. ",2],["rake","Inochi","classes/Inochi.html#M000014","(project_symbol, options = {})","Provides Rake tasks for packaging, publishing, and announcing your project. * An AUTHORS constant (which",2],["requirement","Inochi::Version","classes/Inochi/Version.html#M000025","()","Returns a Gem::Requirement expression. ",2],["series","Inochi::Version","classes/Inochi/Version.html#M000024","()","Returns a string describing any version with the current major number. ",2],["write","File","classes/File.html#M000021","(path, content)","Writes the given content to the given file. ",2],["CREDITS","files/CREDITS.html","files/CREDITS.html","","* Florian Gilcher ",3],["LICENSE","files/LICENSE.html","files/LICENSE.html","","(the ISC license) Copyright 2008 Suraj N. Kurapati <sunaku@gmail.com> Permission to use, copy, modify,",3],["inochi.rb","files/lib/inochi_rb.html","files/lib/inochi_rb.html",""," ",3],["book.rb","files/lib/inochi/book_rb.html","files/lib/inochi/book_rb.html",""," ",3],["init.rb","files/lib/inochi/init_rb.html","files/lib/inochi/init_rb.html",""," ",3],["main.rb","files/lib/inochi/main_rb.html","files/lib/inochi/main_rb.html",""," ",3],["rake.rb","files/lib/inochi/rake_rb.html","files/lib/inochi/rake_rb.html",""," ",3],["bacon.rb","files/lib/inochi/test/bacon_rb.html","files/lib/inochi/test/bacon_rb.html","","Integration for the [Bacon library](http://github.com/chneukirchen/bacon). ",3],["context.rb","files/lib/inochi/test/context_rb.html","files/lib/inochi/test/context_rb.html","","Integration for the [Context library](http://github.com/jeremymcanally/context). ",3],["dfect.rb","files/lib/inochi/test/dfect_rb.html","files/lib/inochi/test/dfect_rb.html","","Integration for the [Dfect library](http://snk.tuxfamily.org/lib/dfect/). ",3],["matchy.rb","files/lib/inochi/test/matchy_rb.html","files/lib/inochi/test/matchy_rb.html","","Integration for the [Matchy library](http://github.com/jeremymcanally/matchy) ",3],["minitest.rb","files/lib/inochi/test/minitest_rb.html","files/lib/inochi/test/minitest_rb.html","","Integration for the [Minitest library](http://blog.zenspider.com/minitest/). ",3],["mocha.rb","files/lib/inochi/test/mocha_rb.html","files/lib/inochi/test/mocha_rb.html","","Integration for the [Mocha library](http://mocha.rubyforge.org). ",3],["rspec.rb","files/lib/inochi/test/rspec_rb.html","files/lib/inochi/test/rspec_rb.html","","Integration for the [RSpec library](http://rspec.info). ",3],["shoulda.rb","files/lib/inochi/test/shoulda_rb.html","files/lib/inochi/test/shoulda_rb.html","","Integration for the [Shoulda library](http://thoughtbot.com/projects/shoulda/). ",3],["test_spec.rb","files/lib/inochi/test/test_spec_rb.html","files/lib/inochi/test/test_spec_rb.html","","Integration for the [test/spec library](http://chneukirchen.org/repos/testspec/README). ",3],["test_unit.rb","files/lib/inochi/test/test_unit_rb.html","files/lib/inochi/test/test_unit_rb.html","","Integration for the [Test::Unit library](http://test-unit.rubyforge.org). ",3],["util.rb","files/lib/inochi/util_rb.html","files/lib/inochi/util_rb.html",""," ",3],["combo.rb","files/lib/inochi/util/combo_rb.html","files/lib/inochi/util/combo_rb.html",""," ",3],["tempdir.rb","files/lib/inochi/util/tempdir_rb.html","files/lib/inochi/util/tempdir_rb.html",""," ",3]],"searchIndex":["array","file","inochi","manual","phrases","version","tempdir","[]()","book()","close()","combination()","combinations()","enumeration()","enumerations()","history()","init()","locale=()","main()","major()","method_missing()","new()","new()","permutation()","permutations()","phrases()","project()","rake()","requirement()","series()","write()","credits","license","inochi.rb","book.rb","init.rb","main.rb","rake.rb","bacon.rb","context.rb","dfect.rb","matchy.rb","minitest.rb","mocha.rb","rspec.rb","shoulda.rb","test_spec.rb","test_unit.rb","util.rb","combo.rb","tempdir.rb"],"longSearchIndex":["lib/inochi/util/combo.rb","lib/inochi/util.rb","lib/inochi/init.rb","inochi","inochi","inochi","lib/inochi/util/tempdir.rb","inochi::phrases","inochi","tempdir","array","array","array","array","inochi::manual","inochi","inochi::phrases","inochi","inochi::version","inochi::phrases","inochi::phrases","tempdir","array","array","inochi::phrases","inochi::manual","inochi","inochi::version","inochi::version","file","files/credits.html","files/license.html","files/lib/inochi_rb.html","files/lib/inochi/book_rb.html","files/lib/inochi/init_rb.html","files/lib/inochi/main_rb.html","files/lib/inochi/rake_rb.html","files/lib/inochi/test/bacon_rb.html","files/lib/inochi/test/context_rb.html","files/lib/inochi/test/dfect_rb.html","files/lib/inochi/test/matchy_rb.html","files/lib/inochi/test/minitest_rb.html","files/lib/inochi/test/mocha_rb.html","files/lib/inochi/test/rspec_rb.html","files/lib/inochi/test/shoulda_rb.html","files/lib/inochi/test/test_spec_rb.html","files/lib/inochi/test/test_unit_rb.html","files/lib/inochi/util_rb.html","files/lib/inochi/util/combo_rb.html","files/lib/inochi/util/tempdir_rb.html"]}}
|
data/doc/api/panel/tree.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var tree = [["Array","classes
|
|
1
|
+
var tree = [["","","files",[["CREDITS","files/CREDITS.html","",[]],["LICENSE","files/LICENSE.html","",[]],["","","lib",[["","","inochi",[["book.rb","files/lib/inochi/book_rb.html","",[]],["init.rb","files/lib/inochi/init_rb.html","",[]],["main.rb","files/lib/inochi/main_rb.html","",[]],["rake.rb","files/lib/inochi/rake_rb.html","",[]],["","","test",[["bacon.rb","files/lib/inochi/test/bacon_rb.html","",[]],["context.rb","files/lib/inochi/test/context_rb.html","",[]],["dfect.rb","files/lib/inochi/test/dfect_rb.html","",[]],["matchy.rb","files/lib/inochi/test/matchy_rb.html","",[]],["minitest.rb","files/lib/inochi/test/minitest_rb.html","",[]],["mocha.rb","files/lib/inochi/test/mocha_rb.html","",[]],["rspec.rb","files/lib/inochi/test/rspec_rb.html","",[]],["shoulda.rb","files/lib/inochi/test/shoulda_rb.html","",[]],["test_spec.rb","files/lib/inochi/test/test_spec_rb.html","",[]],["test_unit.rb","files/lib/inochi/test/test_unit_rb.html","",[]]]],["","","util",[["combo.rb","files/lib/inochi/util/combo_rb.html","",[]],["tempdir.rb","files/lib/inochi/util/tempdir_rb.html","",[]]]],["util.rb","files/lib/inochi/util_rb.html","",[]]]],["inochi.rb","files/lib/inochi_rb.html","",[]]]]]],["Array","classes/Array.html"," < Object",[]],["File","classes/File.html"," < IO",[]],["Inochi","classes/Inochi.html","",[["Manual","classes/Inochi/Manual.html","",[]],["Phrases","classes/Inochi/Phrases.html"," < Object",[]],["Version","classes/Inochi/Version.html","",[]]]],["TempDir","classes/TempDir.html"," < Object",[]]]
|
data/doc/history.erb
CHANGED
|
@@ -1,19 +1,67 @@
|
|
|
1
1
|
%#--
|
|
2
|
-
%# Copyright
|
|
3
|
-
%# See
|
|
2
|
+
%# Copyright protects this work.
|
|
3
|
+
%# See LICENSE file for details.
|
|
4
4
|
%#++
|
|
5
5
|
|
|
6
|
+
|
|
6
7
|
%|chapter "History"
|
|
8
|
+
|
|
9
|
+
|
|
7
10
|
%|history
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
%|section "Version 1.1.0 (2009-09-06)"
|
|
14
|
+
|
|
15
|
+
This release improves the user manual and scaffold generator output, injects more metadata into gems, adds support for Microsoft web browsers, and fixes some bugs.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
%|paragraph "New features"
|
|
19
|
+
|
|
20
|
+
* Add <%= xref "Build a RubyGem without #{$project} as runtime dependency", "instructions for building gems without Inochi" %> as a runtime dependency.
|
|
21
|
+
|
|
22
|
+
* Put release notes in "description" field of gemspec, as [suggested by Eric Hodel](http://www.ruby-forum.com/topic/190220#830072), so that subscribers of [the RubyForge gems feed](http://gems.rubyforge.org/index.rss) are aware of the changes in a published gem.
|
|
23
|
+
|
|
24
|
+
* Set the "date" field in gemspec to project release date.
|
|
25
|
+
|
|
26
|
+
* Change file extension of generated user manuals from <tt>.xhtml</tt> to <tt>.html</tt> to accomodate Microsoft web browsers' inability to process the <tt>application/xhtml+xml</tt> mime type.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
%|paragraph "Bug fixes"
|
|
30
|
+
|
|
31
|
+
* The sdoc library was necessary to run 'rake test'.
|
|
32
|
+
|
|
33
|
+
* Forgot to add `:develop` option to scaffold generator output.
|
|
34
|
+
|
|
35
|
+
* Make "rake lang:dump" unconditionally overwrite the dump file.
|
|
36
|
+
|
|
37
|
+
* Fix gem not being built and prevent Maruku errors for the dummy "WordCount" project in the user manual.
|
|
38
|
+
|
|
39
|
+
* Use <tt>/usr/bin/env</tt> instead of <tt>/usr/bin/ruby</tt> to launch Ruby for better portability.
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
%|paragraph "Housekeeping"
|
|
43
|
+
|
|
44
|
+
* Use simpler Copyright reminder at the top of every file.
|
|
45
|
+
|
|
46
|
+
* Open source is for fun, so [be nice](http://loiclemeur.com/english/2009/03/never-criticize-your-competitors.html): speak of "related works" instead of "competitors".
|
|
47
|
+
|
|
48
|
+
* Rename "Tutorial" to "General walkthrough" in user manual and add a "Specific topics" section for housing uncommon use cases.
|
|
49
|
+
|
|
50
|
+
* Remove "logistics" section and redistribute its contents in more suitable locations in the user manual.
|
|
51
|
+
|
|
52
|
+
|
|
8
53
|
%|section "Version 1.0.0 (2009-05-03)"
|
|
9
|
-
|
|
54
|
+
|
|
55
|
+
This release <%= xref "Build a RubyGem without #{$project} as runtime dependency", "allows your gems to not depend on #{$project}" %>, lets you choose which unit testing library to use, adds new utility libraries and rake tasks, and fixes some bugs.
|
|
56
|
+
|
|
10
57
|
|
|
11
58
|
%|paragraph "Incompatible changes"
|
|
59
|
+
|
|
12
60
|
* Your program is no longer halted by `Inochi.init()` and `Inochi.rake()` if gem dependencies are not satified. A warning is issued instead.
|
|
13
61
|
|
|
14
|
-
* The `project_summary` and `project_history` nodes, which are provided by `Inochi.book()` to the user manual, have been renamed to `project` and
|
|
62
|
+
* The `project_summary` and `project_history` nodes, which are provided by `Inochi.book()` to the user manual, have been renamed to `project` and `history` respectively.
|
|
15
63
|
|
|
16
|
-
*
|
|
64
|
+
* ERBook 7.1.0 is now used for generating the user manual. This is a major step up from the previous version, and so it has incompatible changes. See its release notes for details.
|
|
17
65
|
|
|
18
66
|
* [SDoc](http://github.com/voloko/sdoc/tree/master) is now used to generate API documentation instead of [YARD](http://yard.rubyforge.org). If you link to particular classes or methods in the generated API documentation, be sure to update your link addresses!
|
|
19
67
|
|
|
@@ -21,7 +69,9 @@
|
|
|
21
69
|
|
|
22
70
|
* The "pak" rake task, which is provided by `Inochi.rake()`, has been renamed to "gem".
|
|
23
71
|
|
|
72
|
+
|
|
24
73
|
%|paragraph "New features"
|
|
74
|
+
|
|
25
75
|
* Add `:inochi_consumer` and `:inochi_producer` options to `Inochi.rake()` which allows you to *avoid* having Inochi as a runtime and development dependency, respectively, for your project's gem.
|
|
26
76
|
|
|
27
77
|
This is useful if you just want to use Inochi facilities for building a gem for a pure Ruby library that does not have any need for Inochi's runtime convenience facilities.
|
|
@@ -40,7 +90,9 @@
|
|
|
40
90
|
|
|
41
91
|
* Add <tt>inochi/util/tempdir</tt> library which really should be in the Ruby standard library.
|
|
42
92
|
|
|
93
|
+
|
|
43
94
|
%|paragraph "Bug fixes"
|
|
95
|
+
|
|
44
96
|
* The "enable email notification" checkbox was not activated properly when posting announcement to ruby-talk mailing list via Ruby-Forum.
|
|
45
97
|
|
|
46
98
|
* Mark gems needed by `Inochi.rake()` as *development* dependencies.
|
|
@@ -51,17 +103,23 @@
|
|
|
51
103
|
|
|
52
104
|
* Fix parsing of stack trace in Ruby 1.9.
|
|
53
105
|
|
|
106
|
+
|
|
54
107
|
%|paragraph "Housekeeping"
|
|
108
|
+
|
|
55
109
|
* Write contributor names in <tt>CREDITS</tt> file instead of in the user manual.
|
|
56
110
|
|
|
57
111
|
* Use completely lowercase name for <tt>Rakefile</tt>.
|
|
58
112
|
|
|
59
113
|
* Add copyright statement at the top of every source file.
|
|
60
114
|
|
|
115
|
+
|
|
61
116
|
%|section "Version 0.3.0 (2009-02-12)"
|
|
117
|
+
|
|
62
118
|
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.
|
|
63
119
|
|
|
120
|
+
|
|
64
121
|
%|paragraph "New features"
|
|
122
|
+
|
|
65
123
|
* Add support for <%= xref "Translate your project", "language translations" %> of phrases used in a project.
|
|
66
124
|
|
|
67
125
|
* Add "lang:dump" Rake task for extracting language phrases from project.
|
|
@@ -72,7 +130,9 @@
|
|
|
72
130
|
|
|
73
131
|
* Notify user when attempting to publish announcements in the "pub" Rake tasks.
|
|
74
132
|
|
|
133
|
+
|
|
75
134
|
%|paragraph "Bug fixes"
|
|
135
|
+
|
|
76
136
|
* In Windows, `ENV['USERPROFILE']` gives the path to the user's home directory and `ENV['HOME']` is not defined.
|
|
77
137
|
|
|
78
138
|
* The only real solution to the circular gem dependency problem is:
|
|
@@ -81,7 +141,9 @@
|
|
|
81
141
|
|
|
82
142
|
You should update <%= xref "Setup" %> in your projects' user manuals accordingly.
|
|
83
143
|
|
|
144
|
+
|
|
84
145
|
%|paragraph "Housekeeping"
|
|
146
|
+
|
|
85
147
|
* Break the huge <tt>lib/inochi/inochi.rb</tt> library into smaller files.
|
|
86
148
|
|
|
87
149
|
* Instead of adding methods to singleton classes directly, define modules and extend to them so that YARDoc documents the methods appropriately.
|
|
@@ -92,10 +154,14 @@
|
|
|
92
154
|
|
|
93
155
|
* Mention that the project license is ISC for the reader's convenience.
|
|
94
156
|
|
|
157
|
+
|
|
95
158
|
%|section "Version 0.2.0 (2009-01-25)"
|
|
159
|
+
|
|
96
160
|
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.
|
|
97
161
|
|
|
162
|
+
|
|
98
163
|
%|paragraph "New features"
|
|
164
|
+
|
|
99
165
|
* Added <%= xref "Test your project", "support for unit testing" %> via the [minitest](http://rubyforge.org/projects/bfts/) library.
|
|
100
166
|
|
|
101
167
|
* The scaffold generator now emits a default unit test for the main project library.
|
|
@@ -117,7 +183,9 @@
|
|
|
117
183
|
|
|
118
184
|
(Florian Gilcher)
|
|
119
185
|
|
|
186
|
+
|
|
120
187
|
%|paragraph "Bug fixes"
|
|
188
|
+
|
|
121
189
|
* Run on both JRuby and normal Ruby in multiple versions and with different executable names on Windows. (Florian Gilcher)
|
|
122
190
|
|
|
123
191
|
* Use `Gem::RubyGemsVersion` instead of a shell command to determine rubygems version for generation of <tt>setup.erb</tt>. (Florian Gilcher)
|
|
@@ -126,26 +194,38 @@
|
|
|
126
194
|
|
|
127
195
|
* Omit LaTeX-style heading numbers from release announcements. They caused confusion, especially in plain-text announcements, when trying to determine which version of a project was released.
|
|
128
196
|
|
|
197
|
+
|
|
129
198
|
%|paragraph "Housekeeping"
|
|
199
|
+
|
|
130
200
|
* Added unit tests for utility methods provided by the **Inochi** module: project name calculation and CamelCase to snake\_case conversion.
|
|
131
201
|
|
|
202
|
+
|
|
132
203
|
%|section "Version 0.1.0 (2009-01-13)"
|
|
204
|
+
|
|
133
205
|
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**.
|
|
134
206
|
|
|
207
|
+
|
|
135
208
|
%|paragraph "New features"
|
|
209
|
+
|
|
136
210
|
* `Inochi.init()` now adds `#major()`, `#series()`, and `#requirement()` instance methods to a project's `VERSION` constant.
|
|
137
211
|
|
|
212
|
+
|
|
138
213
|
%|paragraph "Bug fixes"
|
|
214
|
+
|
|
139
215
|
* Solved circular dependency problem by making inochi gem not dependent on erbook gem. However, ERBook is still required during runtime and is supplied on the `gem install` command for **Inochi**.
|
|
140
216
|
|
|
141
217
|
<%= xref "Installation" %> has been updated accordingly.
|
|
142
218
|
|
|
143
219
|
* Add forgotten Rake dependency for **Inochi** gem.
|
|
144
220
|
|
|
221
|
+
|
|
145
222
|
%|section "Version 0.0.1 (2009-01-13)"
|
|
223
|
+
|
|
146
224
|
This release fixes some show-stopper bugs.
|
|
147
225
|
|
|
226
|
+
|
|
148
227
|
%|paragraph "Bug fixes"
|
|
228
|
+
|
|
149
229
|
* The name of the project library was [being determined incorrectly](http://www.ruby-forum.com/topic/176173#771351). (Florian Gilcher)
|
|
150
230
|
|
|
151
231
|
* There was a [circular dependency problem](http://www.ruby-forum.com/topic/176173#771281) when installing the **Inochi** gem. (Florian Gilcher)
|
|
@@ -154,10 +234,15 @@
|
|
|
154
234
|
|
|
155
235
|
* Generated project scaffolds now check against the major version of the **Inochi** gem, to avoid runtime version conflicts.
|
|
156
236
|
|
|
237
|
+
|
|
157
238
|
%|paragraph "Housekeeping"
|
|
239
|
+
|
|
158
240
|
* Only add project libraries to `$LOAD_PATH` if not already there.
|
|
159
241
|
|
|
242
|
+
|
|
160
243
|
%|section "Version 0.0.0 (2009-01-13)"
|
|
244
|
+
|
|
161
245
|
This is the first release of **Inochi**.
|
|
162
246
|
|
|
163
247
|
Happy birthday!
|
|
248
|
+
|