inochi 0.1.0 → 0.2.0

data/doc/setup.erb

@@ -1,5 +1,3 @@
-<% STDERR.puts "hey: #{ERBook::VERSION.object_id}" %>
-
 <% chapter "Setup" do %>
   <% section "Requirements" do %>
     Your system needs the following software to run **<%= $project %>**.

data/doc/usage.erb

@@ -24,7 +24,7 @@
               output_file=$1
               shift
 
-              kdiff3 --auto "$old_file" "$new_file" --output "$output_file"
+              kdiff3 --merge "$old_file" "$new_file" --output "$output_file"
 
       2.  Make the file executable:
 
@@ -120,47 +120,60 @@
         <% cd "word_count" %>
         </pre>
 
-        View the available Rake tasks:
+        <% paragraph "View Rake tasks" do %>
+          <pre>
+          # rake -T
+          <%= verbatim `rake -T` %>
+          </pre>
+        <% end %>
 
-        <pre>
-        # rake -T
-        <%= verbatim `rake -T` %>
-        </pre>
+        <% paragraph "Run unit tests" do %>
+          <pre>
+          # rake test
+          <%= verbatim `rake test` %>
+          </pre>
+        <% end %>
 
-        Try the main project executable:
+        <% paragraph "Run project executable" do %>
+          <pre>
+          <% command = main_executable %>
+          # ruby <%= command %>
+          <%= verbatim `ruby #{command}` %>
+          </pre>
 
-        <pre>
-        <% command = main_executable %>
-        # ruby <%= command %>
-        <%= verbatim `ruby #{command}` %>
-        </pre>
+          See usage information:
 
-        See usage information:
+          <pre>
+          <% command = "#{main_executable} --help" %>
+          # ruby <%= command %>
+          <%= verbatim `ruby #{command}` %>
+          </pre>
 
-        <pre>
-        <% command = "#{main_executable} --help" %>
-        # ruby <%= command %>
-        <%= verbatim `ruby #{command}` %>
-        </pre>
+          See project & version information:
 
-        See project & version information:
+          <pre>
+          <% command = "#{main_executable} --version" %>
+          # ruby <%= command %>
+          <%= verbatim `ruby #{command}` %>
+          </pre>
+        <% end %>
 
-        <pre>
-        <% command = "#{main_executable} --version" %>
-        # ruby <%= command %>
-        <%= verbatim `ruby #{command}` %>
-        </pre>
+        <% paragraph "Show user manual" do %>
+          Build the user manual (please disregard any "unclosed span" warnings):
 
-        See the user manual:
+          <pre>
+          # rake doc:man
+          </pre>
 
-        <pre>
-        # rake doc:man 2>/dev/null
+          Launch the user manual:
 
-        <% command = "#{main_executable} --manual" %>
-        # ruby <%= command %>
-        </pre>
+          <pre>
+          <% command = "#{main_executable} --manual" %>
+          # ruby <%= command %>
+          </pre>
 
-        The manual will now appear in your default web browser.
+          The manual will now appear in your default web browser.
+        <% end %>
       <% end %>
 
       <% section "Configure your project" do %>
@@ -224,7 +237,7 @@
       <% end %>
 
       <% section "Implement your project" do %>
-        Add the following code to the bottom of the main project library:
+        Add the following code to the bottom of <tt>lib/word_count.rb</tt>, the main project library:
 
         <code>
         module WordCount
@@ -235,7 +248,7 @@
         end
         </code>
 
-        Add the following code to the bottom of the main project executable:
+        Add the following code to the bottom of <tt>bin/word_count</tt>, the main project executable:
 
         <code>
         input = ARGF.read
@@ -243,6 +256,39 @@
         puts "There are #{total} words in the input."
         </code>
 
+        Add the following code to the bottom of <tt>test/word_count.rb</tt>, a unit test for the main project library:
+
+        <code>
+        describe WordCount do
+          it 'handles empty input' do
+            WordCount.count(nil).must_equal(0)
+            WordCount.count('').must_equal(0)
+            WordCount.count(' ').must_equal(0)
+          end
+
+          it 'handles single words' do
+            WordCount.count('a').must_equal(1)
+            WordCount.count('foo').must_equal(1)
+            WordCount.count('bar').must_equal(1)
+          end
+
+          it 'handles multiple words' do
+            WordCount.count('a b').must_equal(2)
+            WordCount.count('a-b').must_equal(2)
+            WordCount.count('a/b').must_equal(2)
+          end
+
+          it 'ignores punctuation and space' do
+            WordCount.count('!').must_equal(0)
+            WordCount.count('! @ # % #!@#').must_equal(0)
+            WordCount.count(' !').must_equal(0)
+            WordCount.count('! ').must_equal(0)
+            WordCount.count(' ! ').must_equal(0)
+            WordCount.count('   !   ').must_equal(0)
+          end
+        end
+        </code>
+
         <% paragraph "Goodbye `$LOAD_PATH`, hello `require()`" do %>
           Notice that, in the Ruby files that you modified so far, there were no `$LOAD_PATH` manipulations and no explicit `require()` statements to pull in the various parts of your project.  That is because **<%= $project %>** does this for you automatically.
 
@@ -261,9 +307,41 @@
       <% end %>
 
       <% section "Test your project" do %>
-        > TODO: show how to write a unit test for the code
+        To reduce the amount of code you have to write, **<%= $project %>** defines the following convention for unit tests.
+
+        <% paragraph "Units and tests" do %>
+          Every Ruby source file in your project's <tt>lib/</tt> directory is considered to be a **unit**.  Likewise, every Ruby source file in your project's <tt>test/</tt> is considered to be a **test**.
+
+          As a result, your project's <tt>test/</tt> directory structure *mirrors* the structure of your project's <tt>lib/</tt> directory.  For example, if your project has a <tt>lib/foo/bar.rb</tt> unit, then <tt>test/foo/bar.rb</tt> would be its the corresponding test.
+        <% end %>
 
-        > TODO: integrate minitest tasks into Inochi.rake()
+        <% paragraph "Test execution" do %>
+          <pre>rake test</pre>
+
+          The above command begins the testing process, during which:
+
+          * Tests which lack corresponding units are *skipped* and not executed.  A message specifying which test file was skipped is printed to the standard error stream whenever this occurs.
+
+          * Before a test is executed, its corresponding unit is automatically loaded into the Ruby environment using `require()`.
+
+          As for the details of test execution:
+
+          * Tests are executed by the [minitest] library, which allows you to write unit tests in a combination of styles: traditional TDD, modern BDD, alternative rSpec BDD, and mock-based validation styles.
+
+          * Within each test, test cases are executed in random order.  This is the default behavior of the [minitest] library.
+
+          [minitest]: http://rubyforge.org/projects/bfts/
+        <% end %>
+
+        <% paragraph "Helper libraries" do %>
+          Your project's main directory is added to Ruby's load path.  So if your tests have helper libraries stored in your project's <tt>test/</tt> directory, you can load them into your tests by adding a "test/" prefix.
+
+          For example, if your <tt>test/foo/bar.rb</tt> test has a <tt>test/foo/qux.rb</tt> helper library, then you would write the following code inside the test to load the helper library:
+
+          <code>
+          require 'test/foo/qux'
+          </code>
+        <% end %>
       <% end %>
 
       <% section "Publish your project" do %>

data/lib/inochi.rb

@@ -1,16 +1,18 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'inochi', 'inochi')
+$LOAD_PATH << File.dirname(__FILE__)
+require 'inochi/inochi'
 
 Inochi.init :Inochi,
-  :version => '0.1.0',
-  :release => '2009-01-19',
-  :tagline => 'Gives life to RubyGems-based software',
+  :version => '0.2.0',
+  :release => '2009-01-25',
   :website => 'http://snk.tuxfamily.org/lib/inochi',
+  :tagline => 'Gives life to RubyGems-based software',
   :require => {
     'rake'        => '~> 0',
-    'rubyforge'   => '~> 1',  # for publishing gems to RubyForge
-    'mechanize'   => '~> 0',  # for automating web browsing
-    'trollop'     => '~> 1',  # for parsing command-line options
-    'launchy'     => '~> 0',  # for launching a web browser
-    'yard'        => nil,     # for generating API documentation
-    'addressable' => '~> 2',  # for parsing URIs properly
+    'rubyforge'   => '~> 1',              # for publishing gems to RubyForge
+    'mechanize'   => '~> 0',              # for automating web browsing
+    'trollop'     => '~> 1',              # for parsing command-line options
+    'launchy'     => '~> 0',              # for launching a web browser
+    'yard'        => nil,                 # for generating API documentation
+    'addressable' => '~> 2',              # for parsing URIs properly
+    'minitest'    => ['>= 1.3.1', '< 2'], # for unit testing
   }

data/lib/inochi/inochi.rb

@@ -228,9 +228,10 @@ class << self
   #   where "name" is the name of a copyright holder and "info" is
   #   their contact information) is added to the project module.
   #
-  #   This information is extracted from copyright notices in
-  #   the project license file.  NOTE that the first copyright
-  #   notice must correspond to the primary project maintainer.
+  #   Unless this information is supplied via the :authors option,
+  #   it is automatically extracted from copyright notices in the
+  #   project license file, where the first copyright notice is
+  #   expected to correspond to the primary project maintainer.
   #
   #   Copyright notices must be in the following form:
   #
@@ -247,6 +248,11 @@ class << self
   # @param [Hash] options
   #   Additional method parameters, which are all optional:
   #
+  #   [Array] :authors =>
+  #     A list of project authors and their contact information.  This
+  #     list must have the form "[[name, info]]" where "name" is the name
+  #     of a project author and "info" is their contact information.
+  #
   #   [String] :license_file =>
   #     Path (relative to the main project directory which contains the
   #     project Rakefile) to the file which contains the project license.
@@ -305,24 +311,24 @@ class << self
 
     # load the project module
       program_name = File.basename(program_home)
+      project_libs = File.join('lib', program_name)
 
-      require File.join('lib', program_name)
+      require project_libs
       project_module = fetch_project_module(project_symbol)
 
     # supply default options
       options[:rubyforge_project] ||= program_name
       options[:rubyforge_section] ||= program_name
-      options[:raa_project] ||= program_name
-      options[:license_file] ||= 'LICENSE'
-      options[:logins_file] ||= File.join(ENV['HOME'], '.config', 'inochi', 'logins.yaml')
-      options[:upload_delete] ||= false
-      options[:upload_options] ||= []
+      options[:raa_project]       ||= program_name
+      options[:license_file]      ||= 'LICENSE'
+      options[:logins_file]       ||= File.join(ENV['HOME'], '.config', 'inochi', 'logins.yaml')
+      options[:upload_delete]     ||= false
+      options[:upload_options]    ||= []
 
     # add AUTHORS constant to the project module
-      license = File.read(options[:license_file])
-
-      copyright_holders =
-        license.scan(/Copyright.*?\d+\s+(.*)/).flatten.
+      copyright_holders = options[:authors] ||
+        File.read(options[:license_file]).
+        scan(/Copyright.*?\d+\s+(.*)/).flatten.
         map {|s| (s =~ /\s*<(.*?)>/) ? [$`, $1] : [s, ''] }
 
       project_module.const_set :AUTHORS, copyright_holders
@@ -333,6 +339,38 @@ class << self
       Rake::Task[name].instance_variable_set :@comment, nil
     end
 
+    # testing
+      desc 'Run all unit tests.'
+      task :test do
+        ruby '-w', '-I.', '-Ilib', '-r', program_name, '-e', %q{
+          # set title of test suite
+          $0 = File.basename(Dir.pwd)
+
+          require 'minitest/unit'
+          require 'minitest/spec'
+          require 'minitest/mock'
+          MiniTest::Unit.autorun
+
+          Dir['test/**/*.rb'].sort.each do |test|
+            unit = test.sub('test/', 'lib/')
+
+            if File.exist? unit
+              # strip file extension because require()
+              # does not normalize its input and it
+              # will think that the two paths (with &
+              # without file extension) are different
+              unit_path = unit.sub(/\.rb$/, '').sub('lib/', '')
+              test_path = test.sub(/\.rb$/, '')
+
+              require unit_path
+              require test_path
+            else
+              warn "Skipped test #{test.inspect} because it lacks a corresponding #{unit.inspect} unit."
+            end
+          end
+        }
+      end
+
     # documentation
       desc 'Build all documentation.'
       task :doc => %w[ doc:api doc:man ]
@@ -434,9 +472,9 @@ class << self
             File.delete tmp_file
           end
 
-          # improve readability of list items that span multiple
-          # lines by adding a blank line between such items
-          text.gsub! %r{^( *[^\*\s].*)(\r?\n)( *\* \S)}, '\1\2\2\3'
+          # improve readability of list items
+          # by adding a blank line between them
+          text.gsub! %r{(\r?\n)( +\* \S)}, '\1\1\2'
 
           text
         end
@@ -482,6 +520,9 @@ class << self
             # remove heading navigation menus
             ann_html.gsub! %r{<div class="nav"[^>]*>(.*?)</div>}, ''
 
+            # remove latex-style heading numbers
+            ann_html.gsub! %r"(<(h\d)[^>]*>).+?(?:&nbsp;){2}(.+?)(</\2>)"m, '\1\3\4'
+
             ann_html = resolve_html_links[ann_html]
           end
         end

data/test/inochi/inochi.rb

@@ -0,0 +1,106 @@
+describe 'Inochi.calc_program_name' do
+  it 'converts input into lower-case' do
+    c('foo').must_equal('foo')
+    c('foO').must_equal('foo')
+    c('Foo').must_equal('foo')
+    c('FoO').must_equal('foo')
+  end
+
+  it 'converts camel case into snake case' do
+    c('FooBar').must_equal('foo_bar')
+    c('AnXMLParser').must_equal('an_xml_parser')
+    c('fOo').must_equal('f_oo')
+    c('FOo').must_equal('f_oo')
+  end
+
+  private
+
+  def c *args
+    Inochi.calc_program_name(*args)
+  end
+end
+
+describe 'Inochi.calc_project_symbol' do
+  it 'capitalizes first letter like a ruby constant' do
+    c('foo').must_equal('Foo')
+  end
+
+  it 'preserves exisitng capitalization' do
+    c('FoO').must_equal('FoO')
+    c('fooBaR').must_equal('FooBaR')
+  end
+
+  it 'converts non-word characters into underscores' do
+    c('a!b#c').must_equal('A_b_c')
+  end
+
+  it 'squeezes mulitple underscores' do
+    c('foo!!bar$$qux').must_equal('Foo_bar_qux')
+  end
+
+  it 'ignores surrounding whitespace' do
+    c('  a  ').must_equal('A')
+  end
+
+  it 'ignores surrounding underscores' do
+    c('_a').must_equal('A')
+    c('a_').must_equal('A')
+    c('_a_').must_equal('A')
+    c('__a__').must_equal('A')
+  end
+
+  it 'ignores surrounding non-word characters' do
+    c('!a').must_equal('A')
+    c('a!').must_equal('A')
+    c('!a!').must_equal('A')
+    c('!!a!!').must_equal('A')
+    c('!@a#$').must_equal('A')
+  end
+
+  private
+
+  def c *args
+    Inochi.calc_project_symbol(*args).to_s
+  end
+end
+
+describe 'Inochi.camel_to_snake_case' do
+  it 'supports empty input' do
+    c('').must_equal('')
+  end
+
+  it 'supports normal camel case' do
+    c('fooBar').must_equal('foo_Bar')
+    c('FooBar').must_equal('Foo_Bar')
+    c('Foobar').must_equal('Foobar')
+  end
+
+  it 'supports nested abbreviations' do
+    c('AnXMLParser').must_equal('An_XML_Parser')
+    c('ANXMLParser').must_equal('ANXML_Parser')
+    c('AnXmLPaRsEr').must_equal('An_Xm_L_Pa_Rs_Er')
+  end
+
+  it 'preserves non-word characters' do
+    c(' a!!b#c').must_equal(' a!!b#c')
+  end
+
+  it 'preserves exsiting underscores' do
+    c('foo_bar').must_equal('foo_bar')
+    c('foo_Bar').must_equal('foo_Bar')
+    c('Foo_Bar').must_equal('Foo_Bar')
+    c('Foo_bar').must_equal('Foo_bar')
+
+    c('Foo___b_a__r').must_equal('Foo___b_a__r')
+    c('_').must_equal('_')
+    c('_a').must_equal('_a')
+    c('a_').must_equal('a_')
+    c('_a_').must_equal('_a_')
+  end
+
+  private
+
+  def c *args
+    Inochi.camel_to_snake_case(*args)
+  end
+end