inochi 4.0.1 → 5.0.0

data/CREDITS

@@ -1,21 +1,14 @@
-%#----------------------------------------------------------------------------
-## AUTHORS
-%#----------------------------------------------------------------------------
+== AUTHORS
 
 Suraj N. Kurapati
 
-%#----------------------------------------------------------------------------
-## CREDITS
-%#----------------------------------------------------------------------------
+=== Credits
 
 Florian Gilcher,
 Peileppe Production
 
-%< "logo/README"
+%< 'logo/README'
 
-%#----------------------------------------------------------------------------
-## LICENSE
-%#----------------------------------------------------------------------------
+=== License
 
-%# See the file named "LICENSE".
-%< "LICENSE"
+%< 'LICENSE'

data/bin/inochi

@@ -3,16 +3,8 @@
 require 'inochi'
 
 if ARGV.delete('-h') or ARGV.delete('--help')
-  # try to display UNIX version of help manual
-  man_path = File.join(Inochi::INSTDIR, 'man')
-  unless system 'man', '-M', man_path, '-a', 'inochi'
-    # try to display HTML version of help manual
-    man_html = man_path + '.html'
-    unless %w[$BROWSER open start].any? {|b| system "#{b} #{man_html}" }
-      # no luck; direct user to project website
-      puts "See #{Inochi::WEBSITE}"
-    end
-  end
+  system 'man', '-M', File.join(Inochi::INSTDIR, 'man'), 'inochi' or
+  warn "Could not display the help manual.\nSee #{Inochi::WEBSITE} instead."
   exit
 elsif ARGV.delete('-v') or ARGV.delete('--version')
   puts Inochi::VERSION

data/lib/inochi/engine.rb

@@ -11,7 +11,13 @@ module Inochi
     include Inochi::Generate
 
     def run
-      register_rake_tasks
+      register_init_task
+
+      if has_project_config?
+        load_project_config
+        register_rake_tasks
+      end
+
       run_rake_tasks
     end
 
@@ -42,6 +48,74 @@ module Inochi
       end
     end
 
+    def register_init_task
+      desc 'Instill Inochi into current directory.'
+      task :init do
+        unless project_name = ENV['project']
+          raise ArgumentError, 'project name not specified'
+        end
+
+        library_name = Engine.calc_library_name(project_name)
+        package_name = ENV['package'] || Engine.calc_package_name(library_name)
+
+        project_version = '0.0.0'
+        project_release = Time.now.strftime('%F')
+
+        command_file = "bin/#{package_name}"
+        create_from_rbs binding, command_file, 'command'
+        chmod 0755, command_file
+
+        create_from_rbs binding, PROJECT_CONFIG_FILE
+
+        create_from_rbs binding, "lib/#{package_name}.rb", 'library'
+        create_from_rbs binding, "lib/#{package_name}/inochi.rb"
+
+        create_from_rbs binding, 'test/runner', 'test_runner'
+        chmod 0755, 'test/runner'
+        create_from_rbs binding, 'test/helper.rb', 'test_helper.rb'
+        create_from_rbs binding, "test/#{package_name}_test.rb", 'library_test.rb'
+
+        create_from_rbs binding, 'LICENSE'
+        create_from_rbs binding, 'MANUAL'
+        create_from_rbs binding, 'SYNOPSIS'
+        create_from_rbs binding, 'README'
+        create_from_rbs binding, 'INSTALL'
+        create_from_rbs binding, 'USAGE'
+        create_from_rbs binding, 'HACKING'
+        create_from_rbs binding, 'HISTORY'
+        create_from_rbs binding, 'CREDITS'
+        create_from_rbs binding, 'BEYOND'
+      end
+    end
+
+    PROJECT_CONFIG_FILE = 'inochi.conf'
+
+    def has_project_config?
+      File.exist? PROJECT_CONFIG_FILE
+    end
+
+    def load_project_config
+      @project_config = YAML.load_file(PROJECT_CONFIG_FILE).to_hash
+
+      # load the project module
+      library_file = Dir['lib/*/inochi.rb'].first
+      package_name = File.basename(File.dirname(library_file))
+      library_name = File.read(library_file)[/\b(module|class)\b\s+(\w+)/, 2]
+
+      $LOAD_PATH.unshift 'lib'
+      require "#{package_name}/inochi"
+
+      @project_module = Object.const_get(library_name)
+      @project_package_name = package_name
+      @project_library_name = library_name
+      @project_gem_file = "#{@project_package_name}-#{@project_module::VERSION}.gem"
+
+    rescue => error
+      error.message.insert 0,
+        "Could not load project configuration file #{PROJECT_CONFIG_FILE.inspect}: "
+      raise error
+    end
+
     TEMPLATE_DIR = File.join(File.dirname(__FILE__), 'templates')
 
     ##

data/lib/inochi/inochi.rb

@@ -18,12 +18,12 @@ module Inochi
   ##
   # Number of this release of this project.
   #
-  VERSION = '4.0.1'
+  VERSION = '5.0.0'
 
   ##
   # Date of this release of this project.
   #
-  RELDATE = '2010-07-28'
+  RELDATE = '2010-08-07'
 
   ##
   # Description of this release of this project.
@@ -44,14 +44,14 @@ module Inochi
   #
   #   RUNTIME = {
   #     # this project needs exactly version 1.2.3 of the "an_example" gem
-  #     "an_example" => [ "1.2.3" ],
+  #     'an_example' => [ '1.2.3' ],
   #
   #     # this project needs at least version 1.2 (but not
   #     # version 1.2.4 or newer) of the "another_example" gem
-  #     "another_example" => [ ">= 1.2" , "< 1.2.4" ],
+  #     'another_example' => [ '>= 1.2' , '< 1.2.4' ],
   #
   #     # this project needs any version of the "yet_another_example" gem
-  #     "yet_another_example" => [],
+  #     'yet_another_example' => [],
   #   }
   #
   RUNTIME = {
@@ -60,7 +60,6 @@ module Inochi
     'mechanize'   => [ '~> 1'     , '< 2' ], # for publishing announcements
     'nokogiri'    => [ '>= 1.4'   , '< 2' ], # for parsing HTML and XML
     'rake'        => [ '>= 0.8.4' , '< 1' ], # for Inochi::Engine
-    'ronn'        => [ '>= 0.7.0' , '< 1' ], # for making UNIX man pages
     'yard'        => [ '>= 0.5.8' , '< 1' ], # for making API documentation
   }
 
@@ -71,11 +70,11 @@ module Inochi
   #
   #   DEVTIME = {
   #     # this project needs exactly version 1.2.3 of the "an_example" gem
-  #     "an_example" => [ "1.2.3" ],
+  #     'an_example' => [ '1.2.3' ],
   #
   #     # this project needs at least version 1.2 (but not
   #     # version 1.2.4 or newer) of the "another_example" gem
-  #     "another_example" => [ ">= 1.2" , "< 1.2.4" ],
+  #     'another_example' => [ '>= 1.2' , '< 1.2.4' ],
   #
   #     # this project needs any version of the "yet_another_example" gem
   #     "yet_another_example" => [],

data/lib/inochi/tasks/2-api.rake

@@ -12,10 +12,7 @@ file @api_dst => FileList['lib/**/*.rb'].include('LICENSE') do
   YARD::Rake::YardocTask.new(inner_task_name) do |yardoc|
     yardoc.options = [
       '--output-dir', @api_dir,
-      '--title', (
-        Rake::Task[:@project].invoke
-        @project_module.inspect
-      ),
+      '--title', @project_module.inspect,
       '--readme', 'LICENSE',
       '--no-private'
     ]

data/lib/inochi/tasks/3-man.rake

@@ -1,70 +1,72 @@
-@man_src = FileList['MANUAL', '[A-Z]*[A-Z]']
+@man_asciidoc_src = FileList['MANUAL', '[A-Z]*[A-Z]']
+@man_asciidoc_dst = 'man.txt'
+
 @man_html_dst = 'man.html'
-@man_ronn_dst = 'man.ronn'
-@man_roff_dst_glob = 'man/man*/*.?{,.gz}'
+@man_roff_dst = "man/man1/#{@project_package_name}.1"
 
 desc 'Build the help manual.'
-task :man => @man_html_dst
+task :man => [@man_html_dst, @man_roff_dst]
 
-file @man_html_dst => @man_src do
-  Rake::Task[:@man_doc].invoke
+#-----------------------------------------------------------------------------
 
-  # write ronn version
+# Run manual through Ember to produce a single input file for AsciiDoc.
+file @man_asciidoc_dst => @man_asciidoc_src do
 
-  # write roff version
-  roff_file = "man/man#{@man_doc.section}/#{@man_doc.basename}"
-  mkdir_p File.dirname(roff_file)
+  input = [
+    ":revdate: #{@project_module::RELDATE}",
+    ":revnumber: #{@project_module::VERSION}",
+    "= #{@project_package_name}(1)",
+    '== NAME',
+    "#{@project_package_name} - #{@project_module::TAGLINE}",
+    "%+ #{@man_asciidoc_src.first.inspect}",
+  ].join("\n\n")
 
-  require 'zlib'
-  Zlib::GzipWriter.open(roff_file + '.gz') do |gz|
-    gz.write @man_doc.to_roff
-  end
+  options = {
+    :shorthand => true,
+    :unindent => true,
+    :infer_end => true
+  }
 
-  # write html version
-  File.write @man_html_dst, @man_doc.to_html
+  require 'ember'
+  output = Ember::Template.new(input, options).render
+
+  File.write @man_asciidoc_dst, output
 end
 
-CLOBBER.include @man_html_dst, @man_ronn_dst, @man_roff_dst_glob
-
-# loads the manual as a Ronn document
-task :@man_doc => @man_src do
-  unless @man_doc
-    Rake::Task[:@project].invoke
-
-    # render eRuby template
-    ember_input =
-      "# #{@project_package_name}(1) - #{@project_module::TAGLINE}\n\n"\
-      "%+ #{@man_src.first.inspect}"
-
-    ember_opts = {
-      :source_file => :@man_doc,
-      :shorthand => true,
-      :unindent => true,
-      :infer_end => true,
-    }
-
-    require 'ember'
-    ronn_input = Ember::Template.new(ember_input, ember_opts).render
-    File.write @man_ronn_dst, ronn_input # for debugging / sanity check
-
-    # build Ronn document
-    require 'date'
-    ronn_opts = {
-      :date => Date.parse(@project_module::RELDATE),
-      :manual => "Version #{@project_module::VERSION}",
-      :styles => %w[ man toc 80c ]
-    }
-    ronn_file = "#{@project_package_name}.1.ronn"
-
-    require 'ronn'
-    @man_doc = Ronn::Document.new(ronn_file, ronn_opts) { ronn_input }
-  end
+CLEAN.include @man_asciidoc_dst
+
+#-----------------------------------------------------------------------------
+
+build_asciidoc_args = lambda do
+  [('-v' if Rake.application.options.trace), @man_asciidoc_dst].compact
+end
+
+file @man_html_dst => @man_asciidoc_dst do
+  atts = %W[data-uri toc stylesheet=#{__FILE__}.css] +
+    Array(@project_config[:man_asciidoc_attributes])
+
+  opts = atts.map {|a| ['-a', a] }.flatten
+  args = opts + build_asciidoc_args.call
+
+  sh 'asciidoc', '-o', @man_html_dst, *args
+end
+
+CLOBBER.include @man_html_dst
+
+file @man_roff_dst => @man_asciidoc_dst do
+  args = build_asciidoc_args.call
+  mkdir_p dir = File.dirname(@man_roff_dst)
+  sh 'a2x', '-f', 'manpage', '-D', dir, *args
 end
 
+CLOBBER.include @man_roff_dst
+
+#-----------------------------------------------------------------------------
+
 task :@man_html do
   unless @man_html
-    Rake::Task[:@man_doc].invoke
-    @man_html = @man_doc.to_html
+    Rake::Task[@man_html_dst].invoke
+    @man_html = File.read(@man_html_dst)
   end
 end
 
@@ -76,4 +78,3 @@ task :@man_html_dom do
     @man_html_dom = Nokogiri::HTML(@man_html)
   end
 end
-

data/lib/inochi/tasks/3-man.rake.css

@@ -0,0 +1,49 @@
+div.sectionbody, body {
+  font-family: sans-serif;
+}
+
+div.sectionbody {
+  line-height: 1.5em;
+}
+
+a {
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+a:visited {
+  color: #800080;
+}
+
+body {
+  max-width: 48em; /* approximately 80 characters wide */
+  margin-left: 15em;
+}
+
+#toc {
+  position: fixed;
+  top: 0;
+  left: 0;
+  bottom: 0;
+  width: 13em;
+  padding: 0.5em;
+  padding-bottom: 1.5em;
+  margin: 0 !important;
+  overflow: auto;
+}
+
+#toc a {
+  color: #083194 !important;
+}
+
+#toc .toclevel1 {
+  margin-top: 1.25em;
+}
+
+#toc .toclevel2 {
+  margin-top: 0.25em;
+  display: list-item;
+}

data/lib/inochi/tasks/4-ann.rake

@@ -7,7 +7,6 @@ task :ann => %w[ ann:html ann:text ann:feed ]
 
 task :@ann_subject do
   unless @ann_subject
-    Rake::Task[:@project].invoke
     @ann_subject = @ann_subject_prefix +
       @project_module::PROJECT + ' ' + @project_module::VERSION
   end
@@ -17,10 +16,12 @@ end
 task :@ann_nfo_html_nodes do
   unless @ann_nfo_html_nodes
     begin
-      head, body = fetch_nodes_between('h2#NAME ~ p', 'h1,h2,h3,h4,h5,h6')
+      head, body = fetch_nodes_between(
+        'h2#_description + div', 'h1,h2,h3,h4,h5,h6'
+      )
     rescue => error
       error.message.insert 0,
-        "The manual lacks a <H2> ABOUT heading.\n"
+        "The manual lacks a <h2> DESCRIPTION heading.\n"
       raise error
     end
 
@@ -39,10 +40,12 @@ end
 task :@ann_rel_html_body_nodes do
   unless @ann_rel_html_body_nodes
     begin
-      head, body = fetch_nodes_between('h2#HISTORY ~ h3', 'h1,h2,h3')
+      head, body = fetch_nodes_between(
+        'h2#_history + div > h3', 'h1,h2,h3'
+      )
     rescue => error
       error.message.insert 0,
-        "The manual lacks a <H3> heading under a <H2> HISTORY heading.\n"
+        "The manual lacks a <h3> heading beneath the <h2> HISTORY heading.\n"
       raise error
     end
 
@@ -55,10 +58,12 @@ end
 task :@project_authors_html_nodes do
   unless @project_authors_html_nodes
     begin
-      head, body = fetch_nodes_between('h2#AUTHORS', 'h1,h2,h3,h4,h5,h6')
+      head, body = fetch_nodes_between(
+        'h2#_authors + div', 'h1,h2,h3,h4,h5,h6'
+      )
     rescue => error
       error.message.insert 0,
-        "The manual lacks content under a <H2> AUTHORS heading.\n"
+        "The manual lacks content under a <h2> AUTHORS heading.\n"
       raise error
     end
 
@@ -87,10 +92,13 @@ task :@ann_html do
       </center>
       #{@ann_nfo_html_nodes.join}
       #{@ann_rel_html_title_node}
-      #{@ann_rel_html_body_nodes.map(&:to_xml).join}
-    }.strip
-
-    @ann_html = resolve_html_links(@ann_html)
+      #{@ann_rel_html_body_nodes.map(&:to_html).join}
+    }.
+    strip.
+    #
+    # resolve internal hyperlinks to the project website
+    #
+    gsub(/<a href=['"]?(?=#)/) { $& + @project_module::WEBSITE }
   end
 end
 
@@ -110,7 +118,7 @@ end
 desc 'Build HTML announcement.'
 task 'ann:html' => @ann_html_dst
 
-file @ann_html_dst => @man_src do
+file @ann_html_dst => @man_asciidoc_src do
   Rake::Task[:@ann_html].invoke
   File.write @ann_html_dst, @ann_html
 end
@@ -126,7 +134,7 @@ CLOBBER.include @ann_html_dst
 desc 'Build plain text announcement.'
 task 'ann:text' => @ann_text_dst
 
-file @ann_text_dst => @man_src do
+file @ann_text_dst => @man_asciidoc_src do
   Rake::Task[:@ann_text].invoke
   File.write @ann_text_dst, @ann_text
 end
@@ -142,8 +150,7 @@ CLOBBER.include @ann_text_dst
 desc 'Build RSS feed announcement.'
 task 'ann:feed' => @ann_feed_dst
 
-file @ann_feed_dst => @man_src do
-  Rake::Task[:@project].invoke
+file @ann_feed_dst => @man_asciidoc_src do
   Rake::Task[:@ann_nfo_html_nodes].invoke
   Rake::Task[:@ann_rel_html_body_nodes].invoke
 
@@ -158,7 +165,7 @@ file @ann_feed_dst => @man_src do
     require 'time'
     item.date = Time.parse(@project_module::RELDATE)
     item.title = @ann_rel_html_title_node.inner_text
-    item.description = @ann_rel_html_body_nodes.join
+    item.description = @ann_rel_html_body_nodes.map(&:to_html).join
   end
 
   File.write @ann_feed_dst, rss
@@ -180,13 +187,13 @@ end
 def fetch_nodes_between head_selector, tail_selector
   Rake::Task[:@man_html_dom].invoke
 
-  head = @man_html_dom.at(head_selector)
+  head = @man_html_dom.at(head_selector) or raise head_selector
   body = []
 
   tail = head
-  while tail = tail.next_sibling and not tail.matches? tail_selector
-    body << tail
-  end
+  body << tail while
+    tail = tail.next_sibling and
+    not tail.matches? tail_selector
 
   [head, body, tail]
 end
@@ -197,34 +204,19 @@ end
 # in the HTML document and (2) it runs on all major platforms
 #
 def convert_html_to_text html
-  # lynx's -dump option requires a .html file
+  # lynx's -dump option requires a *.html file
   require 'tempfile'
   tmp_file = Tempfile.new('inochi').path + '.html'
 
   begin
-    File.write tmp_file, html
-
-    `lynx -dump #{tmp_file} -width 70`.
+    File.write tmp_file, html.to_s.
     #
-    # improve readability of list items
-    # by adding a blank line between them
+    # add space between subsections and list items to improve readability
     #
-    gsub(/(\r?\n)( +\* \S)/, '\1\1\2')
+    gsub(/(?=<div class="title">|<li>)/, '<p>&nbsp;</p>')
+
+    `lynx -dump #{tmp_file} -width 70`
   ensure
     File.delete tmp_file
   end
 end
-
-##
-# Converts relative URLs in the given HTML into
-# absolute URLs bound to the given base URL.
-#
-# http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
-#
-def resolve_html_links html, base_url = nil
-  Rake::Task[:@project].invoke
-  base_url ||= @project_module::WEBSITE
-
-  require 'cgi'
-  "<base href='#{CGI.escapeHTML base_url}'/> #{html}"
-end