inochi 0.0.0 → 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/api/Inochi.html +31 -29
- data/doc/history.erb +22 -0
- data/doc/index.xhtml +53 -15
- data/doc/setup.erb +1 -1
- data/lib/inochi.rb +2 -2
- data/lib/inochi/inochi.rb +6 -4
- metadata +1 -1
data/doc/api/Inochi.html
CHANGED
@@ -241,8 +241,6 @@ The eRuby template which serves as the documentation for the project.
|
|
241
241
|
<pre class="lines">
|
242
242
|
|
243
243
|
|
244
|
-
887
|
245
|
-
888
|
246
244
|
889
|
247
245
|
890
|
248
246
|
891
|
@@ -279,10 +277,12 @@ The eRuby template which serves as the documentation for the project.
|
|
279
277
|
922
|
280
278
|
923
|
281
279
|
924
|
282
|
-
925
|
280
|
+
925
|
281
|
+
926
|
282
|
+
927</pre>
|
283
283
|
</td>
|
284
284
|
<td>
|
285
|
-
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line
|
285
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line 889</span>
|
286
286
|
|
287
287
|
<span class='def def kw'>def</span> <span class='book identifier id'>book</span> <span class='project_symbol identifier id'>project_symbol</span><span class='comma token'>,</span> <span class='book_template identifier id'>book_template</span>
|
288
288
|
<span class='project_module identifier id'>project_module</span> <span class='assign token'>=</span> <span class='fetch_project_module identifier id'>fetch_project_module</span><span class='lparen token'>(</span><span class='project_symbol identifier id'>project_symbol</span><span class='rparen token'>)</span>
|
@@ -361,12 +361,12 @@ project name fully in lowercase.
|
|
361
361
|
<pre class="lines">
|
362
362
|
|
363
363
|
|
364
|
-
|
365
|
-
|
366
|
-
|
364
|
+
933
|
365
|
+
934
|
366
|
+
935</pre>
|
367
367
|
</td>
|
368
368
|
<td>
|
369
|
-
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line
|
369
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line 933</span>
|
370
370
|
|
371
371
|
<span class='def def kw'>def</span> <span class='calc_program_name identifier id'>calc_program_name</span> <span class='project_symbol identifier id'>project_symbol</span>
|
372
372
|
<span class='camel_to_snake_case identifier id'>camel_to_snake_case</span><span class='lparen token'>(</span><span class='project_symbol identifier id'>project_symbol</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='downcase identifier id'>downcase</span>
|
@@ -408,13 +408,13 @@ Calculates the name of the project module from the given project name.
|
|
408
408
|
<pre class="lines">
|
409
409
|
|
410
410
|
|
411
|
-
938
|
412
|
-
939
|
413
411
|
940
|
414
|
-
941
|
412
|
+
941
|
413
|
+
942
|
414
|
+
943</pre>
|
415
415
|
</td>
|
416
416
|
<td>
|
417
|
-
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line
|
417
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line 940</span>
|
418
418
|
|
419
419
|
<span class='def def kw'>def</span> <span class='calc_project_symbol identifier id'>calc_project_symbol</span> <span class='project_name identifier id'>project_name</span>
|
420
420
|
<span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='project_name identifier id'>project_name</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='regexp val'>/\W+/</span><span class='comma token'>,</span> <span class='string val'>'_'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='squeeze identifier id'>squeeze</span><span class='lparen token'>(</span><span class='string val'>'_'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='regexp val'>/^_|_$/</span><span class='comma token'>,</span> <span class='string val'>''</span><span class='rparen token'>)</span>
|
@@ -457,8 +457,6 @@ Transforms the given input from CamelCase to snake_case.
|
|
457
457
|
<pre class="lines">
|
458
458
|
|
459
459
|
|
460
|
-
946
|
461
|
-
947
|
462
460
|
948
|
463
461
|
949
|
464
462
|
950
|
@@ -469,10 +467,12 @@ Transforms the given input from CamelCase to snake_case.
|
|
469
467
|
955
|
470
468
|
956
|
471
469
|
957
|
472
|
-
958
|
470
|
+
958
|
471
|
+
959
|
472
|
+
960</pre>
|
473
473
|
</td>
|
474
474
|
<td>
|
475
|
-
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line
|
475
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line 948</span>
|
476
476
|
|
477
477
|
<span class='def def kw'>def</span> <span class='camel_to_snake_case identifier id'>camel_to_snake_case</span> <span class='input identifier id'>input</span>
|
478
478
|
<span class='input identifier id'>input</span> <span class='assign token'>=</span> <span class='input identifier id'>input</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='dup identifier id'>dup</span>
|
@@ -758,7 +758,7 @@ The newly configured project module.
|
|
758
758
|
<span class='comment val'># put project on Ruby load path</span>
|
759
759
|
<span class='project_file identifier id'>project_file</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='expand_path identifier id'>expand_path</span><span class='lparen token'>(</span><span class='first_caller_file identifier id'>first_caller_file</span><span class='rparen token'>)</span>
|
760
760
|
<span class='project_libs identifier id'>project_libs</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='dirname identifier id'>dirname</span><span class='lparen token'>(</span><span class='project_file identifier id'>project_file</span><span class='rparen token'>)</span>
|
761
|
-
<span class='$LOAD_PATH gvar id'>$LOAD_PATH</span><span class='dot token'>.</span><span class='
|
761
|
+
<span class='$LOAD_PATH gvar id'>$LOAD_PATH</span> <span class='lshft op'><<</span> <span class='project_libs identifier id'>project_libs</span> <span class='unless unless_mod kw'>unless</span> <span class='$LOAD_PATH gvar id'>$LOAD_PATH</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='project_libs identifier id'>project_libs</span>
|
762
762
|
|
763
763
|
<span class='comment val'># supply configuration defaults</span>
|
764
764
|
<span class='project_config identifier id'>project_config</span><span class='lbrack token'>[</span><span class='symbol val'>:project</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='project_symbol identifier id'>project_symbol</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span>
|
@@ -836,6 +836,10 @@ program’s help information.
|
|
836
836
|
|
837
837
|
</li>
|
838
838
|
</ul>
|
839
|
+
<p>
|
840
|
+
It is assumed that this method is invoked from only within the main project
|
841
|
+
executable (in the project bin/ directory).
|
842
|
+
</p>
|
839
843
|
|
840
844
|
</div><div class="section tags">
|
841
845
|
<h2>Meta Tags</h2>
|
@@ -891,9 +895,6 @@ The result of Trollop::options().
|
|
891
895
|
<pre class="lines">
|
892
896
|
|
893
897
|
|
894
|
-
161
|
895
|
-
162
|
896
|
-
163
|
897
898
|
164
|
898
899
|
165
|
899
900
|
166
|
@@ -933,18 +934,19 @@ The result of Trollop::options().
|
|
933
934
|
200
|
934
935
|
201
|
935
936
|
202
|
936
|
-
203
|
937
|
+
203
|
938
|
+
204
|
939
|
+
205</pre>
|
937
940
|
</td>
|
938
941
|
<td>
|
939
|
-
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line
|
942
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line 164</span>
|
940
943
|
|
941
944
|
<span class='def def kw'>def</span> <span class='main identifier id'>main</span> <span class='project_symbol identifier id'>project_symbol</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='trollop_args identifier id'>trollop_args</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='trollop_config identifier id'>trollop_config</span>
|
942
945
|
<span class='program_file identifier id'>program_file</span> <span class='assign token'>=</span> <span class='first_caller_file identifier id'>first_caller_file</span>
|
946
|
+
<span class='program_name identifier id'>program_name</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='basename identifier id'>basename</span><span class='lparen token'>(</span><span class='program_file identifier id'>program_file</span><span class='rparen token'>)</span>
|
943
947
|
<span class='program_home identifier id'>program_home</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='dirname identifier id'>dirname</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='dirname identifier id'>dirname</span><span class='lparen token'>(</span><span class='program_file identifier id'>program_file</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
944
948
|
|
945
949
|
<span class='comment val'># load the project module</span>
|
946
|
-
<span class='program_name identifier id'>program_name</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='basename identifier id'>basename</span><span class='lparen token'>(</span><span class='program_home identifier id'>program_home</span><span class='rparen token'>)</span>
|
947
|
-
|
948
950
|
<span class='require identifier id'>require</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='program_home identifier id'>program_home</span><span class='comma token'>,</span> <span class='string val'>'lib'</span><span class='comma token'>,</span> <span class='program_name identifier id'>program_name</span><span class='rparen token'>)</span>
|
949
951
|
<span class='project_module identifier id'>project_module</span> <span class='assign token'>=</span> <span class='fetch_project_module identifier id'>fetch_project_module</span><span class='lparen token'>(</span><span class='project_symbol identifier id'>project_symbol</span><span class='rparen token'>)</span>
|
950
952
|
|
@@ -1175,8 +1177,6 @@ the gem specification
|
|
1175
1177
|
<pre class="lines">
|
1176
1178
|
|
1177
1179
|
|
1178
|
-
283
|
1179
|
-
284
|
1180
1180
|
285
|
1181
1181
|
286
|
1182
1182
|
287
|
@@ -1744,10 +1744,12 @@ the gem specification
|
|
1744
1744
|
849
|
1745
1745
|
850
|
1746
1746
|
851
|
1747
|
-
852
|
1747
|
+
852
|
1748
|
+
853
|
1749
|
+
854</pre>
|
1748
1750
|
</td>
|
1749
1751
|
<td>
|
1750
|
-
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line
|
1752
|
+
<pre class="code"><span class="info file"># File 'lib/inochi/inochi.rb', line 285</span>
|
1751
1753
|
|
1752
1754
|
<span class='def def kw'>def</span> <span class='rake identifier id'>rake</span> <span class='project_symbol identifier id'>project_symbol</span><span class='comma token'>,</span> <span class='options identifier id'>options</span> <span class='assign token'>=</span> <span class='semicolon token'>;</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='gem_config identifier id'>gem_config</span>
|
1753
1755
|
<span class='program_file identifier id'>program_file</span> <span class='assign token'>=</span> <span class='first_caller_file identifier id'>first_caller_file</span>
|
@@ -2073,7 +2075,7 @@ the gem specification
|
|
2073
2075
|
<span class='gem identifier id'>gem</span><span class='dot token'>.</span><span class='has_rdoc identifier id'>has_rdoc</span> <span class='assign token'>=</span> <span class='true true kw'>true</span>
|
2074
2076
|
|
2075
2077
|
<span class='unless unless kw'>unless</span> <span class='project_module identifier id'>project_module</span> <span class='eq op'>==</span> <span class='Inochi constant id'>Inochi</span>
|
2076
|
-
<span class='gem identifier id'>gem</span><span class='dot token'>.</span><span class='add_dependency identifier id'>add_dependency</span> <span class='string val'>'inochi'</span><span class='comma token'>,</span> <span class='
|
2078
|
+
<span class='gem identifier id'>gem</span><span class='dot token'>.</span><span class='add_dependency identifier id'>add_dependency</span> <span class='string val'>'inochi'</span><span class='comma token'>,</span> <span class='dstring node'>"~> #{Inochi::VERSION[/^\d+/]}"</span>
|
2077
2079
|
<span class='end end kw'>end</span>
|
2078
2080
|
|
2079
2081
|
<span class='project_module identifier id'>project_module</span><span class='colon2 op'>::</span><span class='REQUIRE constant id'>REQUIRE</span><span class='dot token'>.</span><span class='each_pair identifier id'>each_pair</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='gem_name identifier id'>gem_name</span><span class='comma token'>,</span> <span class='version_reqs identifier id'>version_reqs</span><span class='bitor op'>|</span>
|
data/doc/history.erb
CHANGED
@@ -1,6 +1,28 @@
|
|
1
1
|
<% chapter "History", "history" do %>
|
2
2
|
<% project_history do %>
|
3
3
|
<% section "Version 0.0.1 (2009-01-13)" do %>
|
4
|
+
This release fixes some show-stopper bugs.
|
5
|
+
|
6
|
+
<% paragraph "Contributor kudos" do %>
|
7
|
+
* Florian Gilcher tried the first release of **<%= $project %>** and reported bugs.
|
8
|
+
<% end %>
|
9
|
+
|
10
|
+
<% paragraph "Bug fixes" do %>
|
11
|
+
* Florian Gilcher reported that the name of the project library was [being determined incorrectly](http://www.ruby-forum.com/topic/176173#771351).
|
12
|
+
|
13
|
+
* Florian Gilcher reported that there was a [circular dependency problem](http://www.ruby-forum.com/topic/176173#771281) problem when installing the **<%= $project %>** gem.
|
14
|
+
|
15
|
+
The solution is to specify the <tt>--force</tt> option when installing the gem. <%= xref "Installation" %> has been updated accordingly.
|
16
|
+
|
17
|
+
* Generated project scaffolds now check against the major version of the **<%= $project %>** gem, to avoid runtime version conflicts.
|
18
|
+
<% end %>
|
19
|
+
|
20
|
+
<% paragraph "Housekeeping" do %>
|
21
|
+
* Only add project libraries to `$LOAD_PATH` if not already there.
|
22
|
+
<% end %>
|
23
|
+
<% end %>
|
24
|
+
|
25
|
+
<% section "Version 0.0.0 (2009-01-13)" do %>
|
4
26
|
This is the first release of **<%= $project %>**.
|
5
27
|
|
6
28
|
Happy birthday!
|
data/doc/index.xhtml
CHANGED
@@ -14,7 +14,7 @@
|
|
14
14
|
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
15
15
|
<meta name="generator" content="ERBook 6.0.0"/>
|
16
16
|
|
17
|
-
<title>Inochi 0.0.
|
17
|
+
<title>Inochi 0.0.1</title>
|
18
18
|
|
19
19
|
<meta name="author" content="Suraj N. Kurapati"/>
|
20
20
|
|
@@ -642,7 +642,7 @@
|
|
642
642
|
|
643
643
|
<div class="logo"><img src='inochi.png' alt='project logo' /></div>
|
644
644
|
|
645
|
-
<h1 class="title">Inochi 0.0.
|
645
|
+
<h1 class="title">Inochi 0.0.1</h1>
|
646
646
|
|
647
647
|
<h2 class="subtitle">Gives life to RubyGems-based software</h2>
|
648
648
|
|
@@ -663,7 +663,7 @@
|
|
663
663
|
<a name="Contents"/><div class="nav" id="Contents"><a title="Reverse jump to listing" href="#rev:Contents">≡</a>△▽<a title="Jump to this segment" href="#Contents">◎</a></div>
|
664
664
|
<h1 class="title">Contents</h1>
|
665
665
|
<ul>
|
666
|
-
<li>1 <a id="rev:Introduction" href="#Introduction">Introduction</a><ul><li><a id="rev:Etymology" href="#Etymology">Etymology</a></li><li>1.1 <a id="rev:Logistics" href="#Logistics">Logistics</a><ul><li><a id="rev:Version-numbers" href="#Version-numbers">Version numbers</a></li></ul></li><li>1.2 <a id="rev:License" href="#License">License</a></li><li>1.3 <a id="rev:Credits" href="#Credits">Credits</a></li></ul></li><li>2 <a id="rev:Setup" href="#Setup">Setup</a><ul><li>2.1 <a id="rev:Requirements" href="#Requirements">Requirements</a></li><li>2.2 <a id="rev:Installation" href="#Installation">Installation</a></li><li>2.3 <a id="rev:Manifest" href="#Manifest">Manifest</a></li></ul></li><li>3 <a id="rev:Usage" href="#Usage">Usage</a><ul><li>3.1 <a id="rev:Command-line-interface" href="#Command-line-interface">Command-line interface</a></li><li>3.2 <a id="rev:Ruby-library-interface" href="#Ruby-library-interface">Ruby library interface</a></li><li>3.3 <a id="rev:Tutorial" href="#Tutorial">Tutorial</a><ul><li>3.3.1 <a id="rev:Have-a-brilliant-idea" href="#Have-a-brilliant-idea">Have a brilliant idea</a></li><li>3.3.2 <a id="rev:Generate-your-project" href="#Generate-your-project">Generate your project</a></li><li>3.3.3 <a id="rev:Configure-your-project" href="#Configure-your-project">Configure your project</a><ul><li>3.3.3.1 <a id="rev:Project-information" href="#Project-information">Project information</a></li><li>3.3.3.2 <a id="rev:Project-executable" href="#Project-executable">Project executable</a></li><li>3.3.3.3 <a id="rev:Rake-tasks" href="#Rake-tasks">Rake tasks</a></li><li>3.3.3.4 <a id="rev:User-manual" href="#User-manual">User manual</a><ul><li><a id="rev:doc-index.erb" href="#doc-index.erb"><tt>doc/index.erb</tt></a></li><li><a id="rev:doc-intro.erb" href="#doc-intro.erb"><tt>doc/intro.erb</tt></a></li><li><a id="rev:doc-setup.erb" href="#doc-setup.erb"><tt>doc/setup.erb</tt></a></li><li><a id="rev:doc-theory.erb" href="#doc-theory.erb"><tt>doc/theory.erb</tt></a></li><li><a id="rev:doc-usage.erb" href="#doc-usage.erb"><tt>doc/usage.erb</tt></a></li><li><a id="rev:doc-history.erb" href="#doc-history.erb"><tt>doc/history.erb</tt></a></li></ul></li></ul></li><li>3.3.4 <a id="rev:Implement-your-project" href="#Implement-your-project">Implement your project</a><ul><li><a id="rev:Goodbye-LOAD_PATH-hello-require" href="#Goodbye-LOAD_PATH-hello-require">Goodbye <code class="code"><span style="color:#d70;font-weight:bold">$LOAD_PATH</span></code>, hello <code class="code">require()</code></a></li></ul></li><li>3.3.5 <a id="rev:Test-your-project" href="#Test-your-project">Test your project</a></li><li>3.3.6 <a id="rev:Publish-your-project" href="#Publish-your-project">Publish your project</a><ul><li>3.3.6.1 <a id="rev:Build-a-RubyGem" href="#Build-a-RubyGem">Build a RubyGem</a></li><li>3.3.6.2 <a id="rev:Publish-a-RubyGem" href="#Publish-a-RubyGem">Publish a RubyGem</a></li><li>3.3.6.3 <a id="rev:Announce-a-release" href="#Announce-a-release">Announce a release</a><ul><li><a id="rev:Login-information" href="#Login-information">Login information</a></li><li>3.3.6.3.1 <a id="rev:Manual-release-announcement" href="#Manual-release-announcement">Manual release announcement</a></li></ul></li><li>3.3.6.4 <a id="rev:Publish-the-documentation" href="#Publish-the-documentation">Publish the documentation</a></li></ul></li></ul></li></ul></li><li>4 <a id="rev:history" href="#history">History</a><ul><li>4.1 <a id="rev:Version-0.0.1-2009-01-13" href="#Version-0.0.1-2009-01-13">Version 0.0.1 (2009-01-13)</a></li></ul></li>
|
666
|
+
<li>1 <a id="rev:Introduction" href="#Introduction">Introduction</a><ul><li><a id="rev:Etymology" href="#Etymology">Etymology</a></li><li>1.1 <a id="rev:Logistics" href="#Logistics">Logistics</a><ul><li><a id="rev:Version-numbers" href="#Version-numbers">Version numbers</a></li></ul></li><li>1.2 <a id="rev:License" href="#License">License</a></li><li>1.3 <a id="rev:Credits" href="#Credits">Credits</a></li></ul></li><li>2 <a id="rev:Setup" href="#Setup">Setup</a><ul><li>2.1 <a id="rev:Requirements" href="#Requirements">Requirements</a></li><li>2.2 <a id="rev:Installation" href="#Installation">Installation</a></li><li>2.3 <a id="rev:Manifest" href="#Manifest">Manifest</a></li></ul></li><li>3 <a id="rev:Usage" href="#Usage">Usage</a><ul><li>3.1 <a id="rev:Command-line-interface" href="#Command-line-interface">Command-line interface</a></li><li>3.2 <a id="rev:Ruby-library-interface" href="#Ruby-library-interface">Ruby library interface</a></li><li>3.3 <a id="rev:Tutorial" href="#Tutorial">Tutorial</a><ul><li>3.3.1 <a id="rev:Have-a-brilliant-idea" href="#Have-a-brilliant-idea">Have a brilliant idea</a></li><li>3.3.2 <a id="rev:Generate-your-project" href="#Generate-your-project">Generate your project</a></li><li>3.3.3 <a id="rev:Configure-your-project" href="#Configure-your-project">Configure your project</a><ul><li>3.3.3.1 <a id="rev:Project-information" href="#Project-information">Project information</a></li><li>3.3.3.2 <a id="rev:Project-executable" href="#Project-executable">Project executable</a></li><li>3.3.3.3 <a id="rev:Rake-tasks" href="#Rake-tasks">Rake tasks</a></li><li>3.3.3.4 <a id="rev:User-manual" href="#User-manual">User manual</a><ul><li><a id="rev:doc-index.erb" href="#doc-index.erb"><tt>doc/index.erb</tt></a></li><li><a id="rev:doc-intro.erb" href="#doc-intro.erb"><tt>doc/intro.erb</tt></a></li><li><a id="rev:doc-setup.erb" href="#doc-setup.erb"><tt>doc/setup.erb</tt></a></li><li><a id="rev:doc-theory.erb" href="#doc-theory.erb"><tt>doc/theory.erb</tt></a></li><li><a id="rev:doc-usage.erb" href="#doc-usage.erb"><tt>doc/usage.erb</tt></a></li><li><a id="rev:doc-history.erb" href="#doc-history.erb"><tt>doc/history.erb</tt></a></li></ul></li></ul></li><li>3.3.4 <a id="rev:Implement-your-project" href="#Implement-your-project">Implement your project</a><ul><li><a id="rev:Goodbye-LOAD_PATH-hello-require" href="#Goodbye-LOAD_PATH-hello-require">Goodbye <code class="code"><span style="color:#d70;font-weight:bold">$LOAD_PATH</span></code>, hello <code class="code">require()</code></a></li></ul></li><li>3.3.5 <a id="rev:Test-your-project" href="#Test-your-project">Test your project</a></li><li>3.3.6 <a id="rev:Publish-your-project" href="#Publish-your-project">Publish your project</a><ul><li>3.3.6.1 <a id="rev:Build-a-RubyGem" href="#Build-a-RubyGem">Build a RubyGem</a></li><li>3.3.6.2 <a id="rev:Publish-a-RubyGem" href="#Publish-a-RubyGem">Publish a RubyGem</a></li><li>3.3.6.3 <a id="rev:Announce-a-release" href="#Announce-a-release">Announce a release</a><ul><li><a id="rev:Login-information" href="#Login-information">Login information</a></li><li>3.3.6.3.1 <a id="rev:Manual-release-announcement" href="#Manual-release-announcement">Manual release announcement</a></li></ul></li><li>3.3.6.4 <a id="rev:Publish-the-documentation" href="#Publish-the-documentation">Publish the documentation</a></li></ul></li></ul></li></ul></li><li>4 <a id="rev:history" href="#history">History</a><ul><li>4.1 <a id="rev:Version-0.0.1-2009-01-13" href="#Version-0.0.1-2009-01-13">Version 0.0.1 (2009-01-13)</a><ul><li><a id="rev:Contributor-kudos" href="#Contributor-kudos">Contributor kudos</a></li><li><a id="rev:Bug-fixes" href="#Bug-fixes">Bug fixes</a></li><li><a id="rev:Housekeeping" href="#Housekeeping">Housekeeping</a></li></ul></li><li>4.1 <a id="rev:Version-0.0.0-2009-01-13" href="#Version-0.0.0-2009-01-13">Version 0.0.0 (2009-01-13)</a></li></ul></li>
|
667
667
|
|
668
668
|
</ul>
|
669
669
|
</div>
|
@@ -842,7 +842,7 @@
|
|
842
842
|
</h2>
|
843
843
|
<div class="content"><p>You can install <strong>Inochi</strong> by running this command:</p>
|
844
844
|
|
845
|
-
<pre>gem install inochi</pre>
|
845
|
+
<pre>gem install inochi --force</pre>
|
846
846
|
|
847
847
|
<p>To check whether the installation was sucessful, run this command:</p>
|
848
848
|
|
@@ -851,7 +851,7 @@
|
|
851
851
|
<p>If the installation was successful, you will see output like this:</p>
|
852
852
|
|
853
853
|
<p><pre>project: Inochi
|
854
|
-
version: 0.0.
|
854
|
+
version: 0.0.1
|
855
855
|
release: 2009-01-19
|
856
856
|
website: http://snk.tuxfamily.org/lib/inochi
|
857
857
|
install: /home/sun/src/inochi</pre></p>
|
@@ -1095,7 +1095,7 @@ kdiff3 --auto "$old_file" "$new_file" --output "$output
|
|
1095
1095
|
<p>View the available Rake tasks:</p>
|
1096
1096
|
|
1097
1097
|
<p><pre># rake -T
|
1098
|
-
(in /tmp/Inochi20090119-
|
1098
|
+
(in /tmp/Inochi20090119-24865-uajivf-0/word_count)
|
1099
1099
|
rake ann # Build all release announcements.
|
1100
1100
|
rake ann:feed # Build RSS announcement: doc/ann.xml
|
1101
1101
|
rake ann:html # Build HTML announcement: ANN.html
|
@@ -1119,7 +1119,7 @@ rake pub:pak # Publish release packages to RubyForge.
|
|
1119
1119
|
<p>Try the main project executable:</p>
|
1120
1120
|
|
1121
1121
|
<p><pre># ruby bin/word_count
|
1122
|
-
Command-line options: {:
|
1122
|
+
Command-line options: {:version=>false, :help=>false, :manual=>false}
|
1123
1123
|
Command-line arguments: []
|
1124
1124
|
</pre></p>
|
1125
1125
|
|
@@ -1146,7 +1146,7 @@ project: WordCount
|
|
1146
1146
|
version: 0.0.0
|
1147
1147
|
release: 2009-01-19
|
1148
1148
|
website: http://word_count.rubyforge.org
|
1149
|
-
install: /tmp/Inochi20090119-
|
1149
|
+
install: /tmp/Inochi20090119-24865-uajivf-0/word_count
|
1150
1150
|
</pre></p>
|
1151
1151
|
|
1152
1152
|
<p>See the user manual:</p>
|
@@ -1603,8 +1603,8 @@ puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">
|
|
1603
1603
|
<div class="content"><p>Build a RubyGem by running:</p>
|
1604
1604
|
|
1605
1605
|
<p><pre># rake pak
|
1606
|
-
(in /tmp/Inochi20090119-
|
1607
|
-
(in /tmp/Inochi20090119-
|
1606
|
+
(in /tmp/Inochi20090119-24865-uajivf-0/word_count)
|
1607
|
+
(in /tmp/Inochi20090119-24865-uajivf-0/word_count)
|
1608
1608
|
Successfully built RubyGem
|
1609
1609
|
Name: word_count
|
1610
1610
|
Version: 0.0.0
|
@@ -1634,9 +1634,9 @@ puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">
|
|
1634
1634
|
<span style="color:#808">version_requirement</span>:
|
1635
1635
|
<span style="color:#808">version_requirements</span>: <span style="color:#339;font-weight:bold">!ruby/object</span>:<span style="color:#B06;font-weight:bold">Gem::Requirement</span>
|
1636
1636
|
<span style="color:#808">requirements</span>:
|
1637
|
-
- <span style="background-color:#fff0f0;color:#D20">-
|
1637
|
+
- <span style="background-color:#fff0f0;color:#D20">- ~></span>
|
1638
1638
|
- <span style="color:#339;font-weight:bold">!ruby/object</span>:<span style="color:#B06;font-weight:bold">Gem::Version</span>
|
1639
|
-
<span style="color:#808">version</span>: <span style="background-color:#fff0f0;color:#D20">0
|
1639
|
+
<span style="color:#808">version</span>: <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">0</span><span style="color:#710">"</span></span>
|
1640
1640
|
<span style="color:#808">version</span>:
|
1641
1641
|
<span style="color:#808">description</span>: <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">TODO: put a single line description of your project here.</span><span style="color:#710">"</span></span>
|
1642
1642
|
<span style="color:#808">email</span>: <span style="background-color:#fff0f0;color:#D20">your@email.here</span>
|
@@ -1744,7 +1744,7 @@ puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">
|
|
1744
1744
|
<div class="content"><p>Build release announcements by running:</p>
|
1745
1745
|
|
1746
1746
|
<p><pre># rake ann
|
1747
|
-
(in /tmp/Inochi20090119-
|
1747
|
+
(in /tmp/Inochi20090119-24865-uajivf-0/word_count)
|
1748
1748
|
</pre></p>
|
1749
1749
|
|
1750
1750
|
<p>This produces the following files in your project directory:</p>
|
@@ -1780,10 +1780,48 @@ puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">
|
|
1780
1780
|
<big>History</big>
|
1781
1781
|
</h1>
|
1782
1782
|
<div class="content"><p><p><div class="section">
|
1783
|
-
<a name="Version-0.0.1-2009-01-13"/><div class="nav" id="Version-0.0.1-2009-01-13"><a title="Reverse jump to listing" href="#rev:Version-0.0.1-2009-01-13">≡</a><a title="Jump to previous segment" href="#history">△</a>▽
|
1783
|
+
<a name="Version-0.0.1-2009-01-13"/><div class="nav" id="Version-0.0.1-2009-01-13"><a title="Reverse jump to listing" href="#rev:Version-0.0.1-2009-01-13">≡</a><a title="Jump to previous segment" href="#history">△</a><a title="Jump to next segment" href="#Contributor-kudos">▽</a><a title="Jump to this segment" href="#Version-0.0.1-2009-01-13">◎</a></div>
|
1784
1784
|
<h2 class="title">
|
1785
1785
|
4.1 Version 0.0.1 (2009-01-13)
|
1786
1786
|
</h2>
|
1787
|
+
<div class="content"><p>This release fixes some show-stopper bugs.</p>
|
1788
|
+
|
1789
|
+
<p><div class="paragraph">
|
1790
|
+
<a name="Contributor-kudos"/><div class="nav" id="Contributor-kudos"><a title="Reverse jump to listing" href="#rev:Contributor-kudos">≡</a><a title="Jump to previous segment" href="#Version-0.0.1-2009-01-13">△</a><a title="Jump to next segment" href="#Bug-fixes">▽</a><a title="Jump to this segment" href="#Contributor-kudos">◎</a></div>
|
1791
|
+
<p class="title">Contributor kudos</p>
|
1792
|
+
<div class="content"><ul>
|
1793
|
+
<li>Florian Gilcher tried the first release of <strong>Inochi</strong> and reported bugs.</li>
|
1794
|
+
</ul></div>
|
1795
|
+
</div> <div class="paragraph">
|
1796
|
+
<a name="Bug-fixes"/><div class="nav" id="Bug-fixes"><a title="Reverse jump to listing" href="#rev:Bug-fixes">≡</a><a title="Jump to previous segment" href="#Contributor-kudos">△</a><a title="Jump to next segment" href="#Housekeeping">▽</a><a title="Jump to this segment" href="#Bug-fixes">◎</a></div>
|
1797
|
+
<p class="title">Bug fixes</p>
|
1798
|
+
<div class="content"><ul>
|
1799
|
+
<li>
|
1800
|
+
<p>Florian Gilcher reported that the name of the project library was <a href='http://www.ruby-forum.com/topic/176173#771351'>being determined incorrectly</a>.</p>
|
1801
|
+
</li>
|
1802
|
+
|
1803
|
+
<li>
|
1804
|
+
<p>Florian Gilcher reported that there was a <a href='http://www.ruby-forum.com/topic/176173#771281'>circular dependency problem</a> problem when installing the <strong>Inochi</strong> gem.</p>
|
1805
|
+
|
1806
|
+
<p>The solution is to specify the <tt>--force</tt> option when installing the gem. <a class="xref" href="#Installation">Section 2.2. Installation</a> has been updated accordingly.</p>
|
1807
|
+
</li>
|
1808
|
+
|
1809
|
+
<li>
|
1810
|
+
<p>Generated project scaffolds now check against the major version of the <strong>Inochi</strong> gem, to avoid runtime version conflicts.</p>
|
1811
|
+
</li>
|
1812
|
+
</ul></div>
|
1813
|
+
</div> <div class="paragraph">
|
1814
|
+
<a name="Housekeeping"/><div class="nav" id="Housekeeping"><a title="Reverse jump to listing" href="#rev:Housekeeping">≡</a><a title="Jump to previous segment" href="#Bug-fixes">△</a><a title="Jump to next segment" href="#Version-0.0.0-2009-01-13">▽</a><a title="Jump to this segment" href="#Housekeeping">◎</a></div>
|
1815
|
+
<p class="title">Housekeeping</p>
|
1816
|
+
<div class="content"><ul>
|
1817
|
+
<li>Only add project libraries to <code class="code"><span style="color:#d70;font-weight:bold">$LOAD_PATH</span></code> if not already there.</li>
|
1818
|
+
</ul></div>
|
1819
|
+
</div></p></div>
|
1820
|
+
</div> <div class="section">
|
1821
|
+
<a name="Version-0.0.0-2009-01-13"/><div class="nav" id="Version-0.0.0-2009-01-13"><a title="Reverse jump to listing" href="#rev:Version-0.0.0-2009-01-13">≡</a><a title="Jump to previous segment" href="#Housekeeping">△</a>▽<a title="Jump to this segment" href="#Version-0.0.0-2009-01-13">◎</a></div>
|
1822
|
+
<h2 class="title">
|
1823
|
+
4.1 Version 0.0.0 (2009-01-13)
|
1824
|
+
</h2>
|
1787
1825
|
<div class="content"><p>This is the first release of <strong>Inochi</strong>.</p>
|
1788
1826
|
|
1789
1827
|
<p>Happy birthday!</p></div>
|
@@ -1798,7 +1836,7 @@ puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">
|
|
1798
1836
|
|
1799
1837
|
<div id="footer">
|
1800
1838
|
|
1801
|
-
Generated by <a href="http://snk.tuxfamily.org/lib/erbook/">ERBook 6.0.0</a> on Mon Jan 19
|
1839
|
+
Generated by <a href="http://snk.tuxfamily.org/lib/erbook/">ERBook 6.0.0</a> on Mon Jan 19 11:20:33 -0800 2009.
|
1802
1840
|
|
1803
1841
|
<div id="footer-credits">
|
1804
1842
|
<p>
|
data/doc/setup.erb
CHANGED
data/lib/inochi.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
require File.join(File.dirname(__FILE__), 'inochi', 'inochi')
|
1
|
+
require File.join(File.dirname(File.expand_path(__FILE__)), 'inochi', 'inochi')
|
2
2
|
|
3
3
|
Inochi.init :Inochi,
|
4
|
-
:version => '0.0.
|
4
|
+
:version => '0.0.1',
|
5
5
|
:release => '2009-01-19',
|
6
6
|
:tagline => 'Gives life to RubyGems-based software',
|
7
7
|
:website => 'http://snk.tuxfamily.org/lib/inochi',
|
data/lib/inochi/inochi.rb
CHANGED
@@ -96,7 +96,7 @@ class << self
|
|
96
96
|
# put project on Ruby load path
|
97
97
|
project_file = File.expand_path(first_caller_file)
|
98
98
|
project_libs = File.dirname(project_file)
|
99
|
-
$LOAD_PATH.
|
99
|
+
$LOAD_PATH << project_libs unless $LOAD_PATH.include? project_libs
|
100
100
|
|
101
101
|
# supply configuration defaults
|
102
102
|
project_config[:project] ||= project_symbol.to_s
|
@@ -146,6 +146,9 @@ class << self
|
|
146
146
|
# * A list of command-line options is displayed at
|
147
147
|
# the bottom of the program's help information.
|
148
148
|
#
|
149
|
+
# It is assumed that this method is invoked from only within
|
150
|
+
# the main project executable (in the project bin/ directory).
|
151
|
+
#
|
149
152
|
# @param [Symbol] project_symbol
|
150
153
|
# Name of the Ruby constant which serves
|
151
154
|
# as a namespace for the entire project.
|
@@ -160,11 +163,10 @@ class << self
|
|
160
163
|
#
|
161
164
|
def main project_symbol, *trollop_args, &trollop_config
|
162
165
|
program_file = first_caller_file
|
166
|
+
program_name = File.basename(program_file)
|
163
167
|
program_home = File.dirname(File.dirname(program_file))
|
164
168
|
|
165
169
|
# load the project module
|
166
|
-
program_name = File.basename(program_home)
|
167
|
-
|
168
170
|
require File.join(program_home, 'lib', program_name)
|
169
171
|
project_module = fetch_project_module(project_symbol)
|
170
172
|
|
@@ -604,7 +606,7 @@ class << self
|
|
604
606
|
gem.has_rdoc = true
|
605
607
|
|
606
608
|
unless project_module == Inochi
|
607
|
-
gem.add_dependency 'inochi', Inochi::VERSION
|
609
|
+
gem.add_dependency 'inochi', "~> #{Inochi::VERSION[/^\d+/]}"
|
608
610
|
end
|
609
611
|
|
610
612
|
project_module::REQUIRE.each_pair do |gem_name, version_reqs|
|