inochi 4.0.1 → 5.0.0

data/lib/inochi/tasks/5-gem.rake

@@ -1,6 +1,5 @@
 desc 'Build release package for RubyGems.'
 task :gem do
-  Rake::Task[:@project].invoke
   Rake::Task[:@ann_nfo_text].invoke
   Rake::Task[:@project_authors_text].invoke
 
@@ -31,8 +30,7 @@ task :gem do
     '{bin,lib,ext}/**/*',
     'LICENSE',
     'CREDITS',
-    @man_html_dst,
-    @man_roff_dst_glob
+    @man_roff_dst
   ]
 
   @project_module::DEVTIME.each do |gem_name, gem_version|
@@ -44,8 +42,8 @@ task :gem do
   end
 
   # allow user to configure the gem before it is built
-  if logic = @project_options[:gem_spec_logic] and not logic.empty?
-    eval logic, binding, "#{@project_options_file} in :gem_spec_logic"
+  if logic = @project_config[:gem_spec_logic] and not logic.empty?
+    eval logic, binding, "#{PROJECT_CONFIG_FILE} in :gem_spec_logic"
   end
 
   # emit gemspec

data/lib/inochi/tasks/6-pub.rake

@@ -7,7 +7,6 @@ task :pub => %w[ pub:gem pub:web pub:ann ]
 
 desc 'Publish gem release package to RubyGems.org.'
 task 'pub:gem' do
-  Rake::Task[:@project].invoke
   Rake::Task[:gem].invoke unless File.exist? @project_gem_file
   sh 'gem', 'push', @project_gem_file
 end
@@ -18,12 +17,10 @@ end
 
 desc 'Publish help manual, API docs, and RSS feed to project website.'
 task 'pub:web' => %w[ man api ann:feed ] do |t|
-  Rake::Task[:@project].invoke
-
-  if target = @project_options[:pub_web_target]
-    options = @project_options[:pub_web_options]
+  if target = @project_config[:pub_web_target]
+    options = @project_config[:pub_web_options]
     sources = [@man_html_dst, @api_dir, @ann_feed_dst,
-      @project_options[:pub_web_extras]].compact
+      @project_config[:pub_web_extras]].compact
 
     sh ['rsync', options, sources, target].join(' ')
   end
@@ -93,8 +90,6 @@ end
 desc 'Announce release on RAA (Ruby Application Archive).'
 task 'pub:ann:raa' do
   site = 'http://raa.ruby-lang.org'
-
-  Rake::Task[:@project].invoke
   project = @project_package_name
 
   require 'mechanize'
@@ -109,8 +104,6 @@ task 'pub:ann:raa' do
   Rake::Task[:@ann_nfo_text].invoke
   form['description']       = @ann_nfo_text
   form['description_style'] = 'Plain'
-
-  Rake::Task[:@project].invoke
   form['short_description'] = @project_module::TAGLINE
   form['version']           = @project_module::VERSION
   form['url']               = @project_module::WEBSITE

data/lib/inochi/templates/BEYOND.rbs

@@ -1,17 +1,18 @@
-%#----------------------------------------------------------------------------
-## SEE ALSO
-%#----------------------------------------------------------------------------
+== SEE ALSO
 
-> TODO: list related UNIX man pages here
+// TODO: list related UNIX man pages and links here
 
-some_command(1),
-another_command(5),
-yet_another_command(7)
+some_command(1), another_command(5), yet_another_command(7)
 
-%#----------------------------------------------------------------------------
-%# Markdown link references
-%#----------------------------------------------------------------------------
+[sect2]
+=== References
 
-[Inochi]: <%= Inochi::WEBSITE %>
-[RubyGems]: http://rubygems.org
-[Ruby]: http://ruby-lang.org
+[horizontal]
+
+// NOTE: keep these sorted alphabetically
+
+[[Inochi]] Inochi:: <%= Inochi::WEBSITE %>
+[[RubyGems]] RubyGems:: http://rubygems.org
+[[Ruby]] Ruby:: http://ruby-lang.org
+
+// TODO: list additional links here

data/lib/inochi/templates/CREDITS.rbs

@@ -1,27 +1,20 @@
-%#----------------------------------------------------------------------------
-## AUTHORS
-%#----------------------------------------------------------------------------
+== AUTHORS
 
-> TODO: attribute yourself, your predecessors, and substantial contributors
+// TODO: attribute yourself, your predecessors, and substantial contributors
 
 Predecessor name,
 Your name,
 Substantial contributor name
 
-%#----------------------------------------------------------------------------
-## CREDITS
-%#----------------------------------------------------------------------------
+=== Credits
 
-> TODO: attribute everyone else who has contributed to this project
+// TODO: attribute everyone else who has contributed to this project
 
 Contributor name,
-[Contributor name](http://the.contributor.url),
+http://the.contributor.url[Contributor name],
 Another contributor <contributor@email.address>,
 Yet another contributor
 
-%#----------------------------------------------------------------------------
-## LICENSE
-%#----------------------------------------------------------------------------
+=== License
 
-%# See the file named "LICENSE".
-%< "LICENSE"
+%< 'LICENSE'

data/lib/inochi/templates/HACKING.rbs

@@ -1,59 +1,55 @@
-%#----------------------------------------------------------------------------
-## HACKING
-%#----------------------------------------------------------------------------
+== HACKING
 
-This section is meant for people who want to develop #{project_name}'s source
-code.
-
-%#----------------------------------------------------------------------------
-### Prerequisites
-%#----------------------------------------------------------------------------
-
-> TODO: list the tools and libraries needed to develop your project
+=== Prerequisites
 
 Install Ruby libraries necessary for development:
 
-    gem install #{package_name} --development
+------------------------------------------------------------------------------
+gem install #{package_name} --development
+------------------------------------------------------------------------------
+
+// TODO: list additional tools and libraries needed to develop your project
 
-%#----------------------------------------------------------------------------
-### Infrastructure
-%#----------------------------------------------------------------------------
+=== Infrastructure
 
-[Inochi] serves as the project infrastructure for #{project_name}.  It handles
-tasks such as building this help manual and API documentation, and packaging,
-announcing, and publishing new releases.  See its help manual and list of
-tasks to get started:
+<<Inochi>> serves as the project infrastructure for #{project_name}.  It
+handles tasks such as building this help manual and API documentation, and
+packaging, announcing, and publishing new releases.  See its help manual and
+list of tasks to get started:
 
-    inochi --help     # display help manual
-    inochi --tasks    # list available tasks
+------------------------------------------------------------------------------
+inochi --help     # display help manual
+inochi --tasks    # list available tasks
+------------------------------------------------------------------------------
 
-%#----------------------------------------------------------------------------
-### $LOAD_PATH setup
-%#----------------------------------------------------------------------------
+=== $LOAD_PATH setup
 
 Ensure that the `lib/` directory is listed in Ruby's `$LOAD_PATH` before you
 use any libraries therein or run any executables in the `bin/` directory.
 
 This can be achieved by passing an option to Ruby:
 
-    ruby -Ilib bin/#{package_name}
-    irb -Ilib -r #{package_name}
+------------------------------------------------------------------------------
+ruby -Ilib bin/#{package_name}
+irb -Ilib -r #{package_name}
+------------------------------------------------------------------------------
 
 Or by setting the `$RUBYLIB` environment variable:
 
-    export RUBYLIB=lib   # bash, ksh, zsh
-    setenv RUBYLIB lib   # csh
-    set -x RUBYLIB lib   # fish
+------------------------------------------------------------------------------
+export RUBYLIB=lib   # bash, ksh, zsh
+setenv RUBYLIB lib   # csh
+set -x RUBYLIB lib   # fish
 
-    ruby bin/#{package_name}
-    irb -r #{package_name}
+ruby bin/#{package_name}
+irb -r #{package_name}
+------------------------------------------------------------------------------
 
-Or by running Ruby through the [ruby-wrapper](
-http://github.com/chneukirchen/rup/blob/master/ruby-wrapper ) tool.
+Or by running Ruby through the
+http://github.com/chneukirchen/rup/blob/master/ruby-wrapper[ruby-wrapper]
+tool.
 
-%#----------------------------------------------------------------------------
-### RubyGems setup
-%#----------------------------------------------------------------------------
+=== RubyGems setup
 
 If you use Ruby 1.8 or older, then ensure that RubyGems is activated before
 you use any libraries in the `lib/` directory or run any executables in the
@@ -61,33 +57,35 @@ you use any libraries in the `lib/` directory or run any executables in the
 
 This can be achieved by passing an option to Ruby:
 
-    ruby -rubygems bin/#{package_name}
-    irb -rubygems -r #{package_name}
+------------------------------------------------------------------------------
+ruby -rubygems bin/#{package_name}
+irb -rubygems -r #{package_name}
+------------------------------------------------------------------------------
 
 Or by setting the `$RUBYOPT` environment variable:
 
-    export RUBYOPT=-rubygems   # bash, ksh, zsh
-    setenv RUBYOPT -rubygems   # csh
-    set -x RUBYOPT -rubygems   # fish
+------------------------------------------------------------------------------
+export RUBYOPT=-rubygems   # bash, ksh, zsh
+setenv RUBYOPT -rubygems   # csh
+set -x RUBYOPT -rubygems   # fish
+------------------------------------------------------------------------------
 
-%#----------------------------------------------------------------------------
-### Running tests
-%#----------------------------------------------------------------------------
+=== Running tests
 
 Simply execute the included test runner, which sets up Ruby's `$LOAD_PATH` for
 testing, loads the `test/helper.rb` file, and then evaluates all
 `test/**/*_test.rb` files:
 
-    ruby test/runner
+------------------------------------------------------------------------------
+ruby test/runner
+------------------------------------------------------------------------------
 
 Its exit status will indicate whether all tests have passed.  It may also
 print additional pass/fail information depending on the testing library used
 in the `test/helper.rb` file.
 
-%#----------------------------------------------------------------------------
-### Contributing
-%#----------------------------------------------------------------------------
+=== Contributing
 
-> TODO: explain how someone can contribute their changes to your repository
+// TODO: explain how someone can contribute their changes to your repository
 
-Fork this project on GitHub (see **Resources** above) and send a pull request.
+<%= @code_repo_url %>[Fork this project on GitHub] and send a pull request.

data/lib/inochi/templates/HISTORY.rbs

@@ -1,55 +1,48 @@
-%#----------------------------------------------------------------------------
-## HISTORY
-%#----------------------------------------------------------------------------
+== HISTORY
 
-This section contains release notes of current and past releases.
+=== Version #{project_version} (#{project_release})
 
-%#----------------------------------------------------------------------------
-### Version #{project_version} (#{project_release})
-%#----------------------------------------------------------------------------
-
-> TODO: write a short summary of the changes in this release
+// TODO: write a short summary of the changes in this release
 
 This release changes TODO, adds TODO, and fixes TODO.
 
-Incompatible changes:
-
-  > TODO: list all backward-incompatible changes in this release
+.Incompatible changes
 
-  * TODO has been TODO to TODO --- contributor name
+// TODO: list all backward-incompatible changes in this release
 
-  * TODO --- contributor name
+* TODO has been TODO to TODO.  Thanks to TODO for reporting this.
 
-  * TODO --- contributor name
+* TODO was TODO.  Thanks to TODO for fixing this.
 
-New features:
+* TODO.  Thanks to TODO for TODO.
 
-  > TODO: list new features added in this release
+.New features
 
-  * TODO --- contributor name
+// TODO: list new features added in this release
 
-  * TODO --- contributor name
+* TODO has been TODO to TODO.  Thanks to TODO for reporting this.
 
-  * TODO --- contributor name
+* TODO was TODO.  Thanks to TODO for fixing this.
 
-Bug fixes:
+* TODO.  Thanks to TODO for TODO.
 
-  > TODO: describe all bugs that are fixed in this release
+.Bug fixes
 
-  * TODO was TODO --- contributor name
+// TODO: describe all bugs that are fixed in this release
 
-  * TODO were TODO --- contributor name
+* TODO has been TODO to TODO.  Thanks to TODO for reporting this.
 
-  * TODO did TODO --- contributor name
+* TODO was TODO.  Thanks to TODO for fixing this.
 
-Housekeeping:
+* TODO.  Thanks to TODO for TODO.
 
-  > TODO: list the refactorings, clean ups, and other
-  >       improvements that were done for this release
+.Housekeeping
 
-  * TODO --- contributor name
+// TODO: list the refactorings, clean ups, and other
+//       improvements that were done for this release
 
-  * TODO --- contributor name
+* TODO has been TODO to TODO.  Thanks to TODO for reporting this.
 
-  * TODO --- contributor name
+* TODO was TODO.  Thanks to TODO for fixing this.
 
+* TODO.  Thanks to TODO for TODO.

data/lib/inochi/templates/INSTALL.rbs

@@ -0,0 +1,27 @@
+== INSTALL
+
+=== Prerequisites
+
+// TODO: list all software necessary to run your project
+
+* <<Ruby>> #{RUBY_VERSION} or newer.
+
+* <<RubyGems>> #{Gem::RubyGemsVersion} or newer.
+
+=== Installing
+
+------------------------------------------------------------------------------
+gem install #{package_name}
+------------------------------------------------------------------------------
+
+=== Upgrading
+
+------------------------------------------------------------------------------
+gem update #{package_name}
+------------------------------------------------------------------------------
+
+=== Removing
+
+------------------------------------------------------------------------------
+gem uninstall #{package_name}
+------------------------------------------------------------------------------

data/lib/inochi/templates/MANUAL.rbs

@@ -1,34 +1,8 @@
-<%
-  proj_home_url = #{library_name}::WEBSITE
-  api_docs_url  = File.join(proj_home_url, 'api/')
-  ann_feed_url  = File.join(proj_home_url, 'ann.xml')
-
-  code_repo_scm = '[Git](http://git-scm.com)'
-  code_repo_url = 'http://github.com/TODO/#{package_name}'
-  bug_track_url = 'http://github.com/TODO/#{package_name}/issues'
-
-  ##
-  # Puts the given content inside <pre> tags in a Markdown-safe way.
-  #
-  def preformatted content
-    if content =~ /\\S/
-      content.gsub(/^/, ' ' * 4)
-    else
-      "<pre>\#{content}</pre>"
-    end
-  end
-%>
-
-%+ "README"
-
-%+ "USAGE"
-
-%+ "EXAMPLES"
-
-%+ "HACKING"
-
-%+ "HISTORY"
-
-%+ "CREDITS"
-
-%+ "BEYOND"
+%+ 'SYNOPSIS'
+%+ 'README'
+%+ 'INSTALL'
+%+ 'USAGE'
+%+ 'HACKING'
+%+ 'HISTORY'
+%+ 'CREDITS'
+%+ 'BEYOND'

data/lib/inochi/templates/README.rbs

@@ -1,8 +1,8 @@
+== DESCRIPTION
+
 #{project_name} is a TODO that TODO.
 
-%#----------------------------------------------------------------------------
-### Features
-%#----------------------------------------------------------------------------
+=== Features
 
 * Does TODO.
 
@@ -12,45 +12,19 @@
 
 * Composed of TODO lines of code.
 
-%#----------------------------------------------------------------------------
-### Resources
-%#----------------------------------------------------------------------------
-
-* Issue tracker (report bugs, request features, get help):
-  <<%= bug_track_url %>>
-
-* Source code (browse online or obtain with <%= code_repo_scm %>):
-  <<%= code_repo_url %>>
-
-* API documentation:
-  <<%= api_docs_url %>>
-
-* Announcements feed:
-  <<%= ann_feed_url %>>
-
-* Official website:
-  <<%= proj_home_url %>>
-
-%#----------------------------------------------------------------------------
-### Setup
-%#----------------------------------------------------------------------------
-
-Prerequisites:
-
-  > TODO: list all software necessary to run your project
-
-  * [Ruby] #{RUBY_VERSION} or newer.
-
-  * [RubyGems] #{Gem::RubyGemsVersion} or newer.
-
-Installing:
+=== Resources
 
-    gem install #{package_name}
+Project website::
+<%= @proj_home_url = #{library_name}::WEBSITE %>
 
-Upgrading:
+Announcements feed::
+<%= @ann_feed_url = File.join(@proj_home_url, 'ann.xml') %>
 
-    gem update #{package_name}
+API documentation::
+<%= @api_docs_url = File.join(@proj_home_url, 'api/') %>
 
-Removing:
+Source code (browse online, download, or checkout)::
+<%= @code_repo_url = 'http://github.com/TODO/#{package_name}' %>
 
-    gem uninstall #{package_name}
+Issue tracker (report bugs, request features, get help)::
+<%= @bug_track_url = File.join(@code_repo_url, 'issues') %>