inochi 1.1.1 → 2.0.0

data/lib/inochi.rb

@@ -1,41 +1 @@
-#--
-# Copyright protects this work.
-# See LICENSE file for details.
-#++
-
-require 'rubygems'
-
-module Inochi
-  libs = File.dirname(__FILE__)
-  $LOAD_PATH << libs unless $LOAD_PATH.include? libs
-end
-
-require 'inochi/init'
-require 'inochi/main'
-require 'inochi/rake'
-require 'inochi/book'
-require 'inochi/util'
-
-Inochi.init :Inochi,
-  :version => '1.1.1',
-  :release => '2009-10-03',
-  :website => 'http://snk.tuxfamily.org/lib/inochi/',
-  :tagline => 'Gives life to RubyGems-based software',
-  :require => {
-    'trollop'        => '~> 1',                 # for parsing command-line
-    'launchy'        => ['~> 0', '>= 0.3.3'],   # for launching a browser
-  },
-  :develop => {
-    'rake'           => ['~> 0', '>= 0.8.4'],
-    'rubyforge'      => '~> 2',                 # for publishing gems
-    'mechanize'      => '~> 0',                 # for web automation
-    'voloko-sdoc'    => ['~> 0', '>= 0.2.10'],  # for API docs
-    'addressable'    => '~> 2',                 # for parsing URIs properly
-    'erbook'         => '~> 7',                 # for generating user manual
-    'babelfish'      => '~> 0',                 # for language translation
-    'relevance-rcov' => nil,                    # for code coverage statistics
-    'flay'           => nil,                    # for code quality analysis
-    'reek'           => nil,                    # for code quality analysis
-    'roodi'          => nil,                    # for code quality analysis
-    'ZenTest'        => '~> 4',                 # for the `multiruby` tool
-  }
+require 'inochi/inochi'

data/lib/inochi/engine.rb

@@ -0,0 +1,101 @@
+require 'yaml'
+require 'time'
+require 'rake'
+require 'rake/clean'
+require 'shellwords'
+
+module Inochi
+  class Engine
+
+    require 'inochi/generate'
+    include Inochi::Generate
+
+    def run
+      register_rake_tasks
+      run_rake_tasks
+    end
+
+    ##
+    # Renders the given RBS (ruby string) file
+    # and/or template inside the given binding.
+    #
+    def self.render_rbs binding, filename, template = File.read(filename)
+      here = "TEMPORARY_HERE_DOC#{object_id}TEMPORARY_HERE_DOC"
+      eval("<<#{here}\n#{template}\n#{here}", binding, filename).chomp
+    end
+
+    private
+
+    def run_rake_tasks
+      task :default do
+        Rake.application.options.show_task_pattern = //
+        Rake.application.display_tasks_and_comments
+      end
+
+      Rake.application.init 'inochi'
+      Rake.application.top_level
+    end
+
+    def register_rake_tasks
+      Dir[File.dirname(__FILE__) + '/tasks/*.rake'].each do |file|
+        instance_eval File.read(file), file
+      end
+    end
+
+    TEMPLATE_DIR = File.join(File.dirname(__FILE__), 'templates')
+
+    ##
+    # Renders the given RBS template file (found in the
+    # TEMPLATE_DIR directory) to the given output file.
+    #
+    def create_from_rbs binding, output_file, template_file = File.basename(output_file)
+      actual_template_file = "#{TEMPLATE_DIR}/#{template_file}.rbs"
+      create output_file, self.class.render_rbs(binding, actual_template_file)
+    end
+
+    ##
+    # Writes the given contents to the file at the given
+    # path.  If the given path already exists, then a
+    # backup is created before invoking the merging tool.
+    #
+    def create path, body, merger = ENV[:merger]
+      generate path, body do |*files|
+        system "#{merger} #{Shellwords.join files}" if merger
+      end
+    end
+
+    ##
+    # Returns the name of the main program executable, which
+    # is the same as the project name fully in lowercase.
+    #
+    def self.calc_package_name library_name
+      camel_to_snake_case(library_name).downcase
+    end
+
+    ##
+    # Calculates the name of the project module from the given project name.
+    #
+    def self.calc_library_name project_name
+      name = project_name.to_s.gsub(/\W+/, '_').squeeze('_').gsub(/^_|_$/, '')
+      (name[0,1].upcase + name[1..-1]).to_sym
+    end
+
+    ##
+    # Transforms the given input from CamelCase to snake_case.
+    #
+    def self.camel_to_snake_case input
+      input = input.to_s.dup
+
+      # handle camel case like FooBar => Foo_Bar
+      while input.gsub!(/([a-z]+)([A-Z])(\w+)/) { $1 + '_' + $2 + $3 }
+      end
+
+      # handle abbreviations like XMLParser => XML_Parser
+      while input.gsub!(/([A-Z]+)([A-Z])([a-z]+)/) { $1 + '_' + $2 + $3 }
+      end
+
+      input
+    end
+
+  end
+end

data/lib/inochi/generate.rb

@@ -0,0 +1,52 @@
+require 'fileutils'
+require 'digest/sha1'
+
+module Inochi
+  module Generate
+    extend self
+
+    ##
+    # Notify the user about some action being performed.
+    #
+    def notify action, message
+      printf "%16s  %s\n", action, message
+    end
+
+    ##
+    # Writes the given contents to the file at the given
+    # path.  If the given path already exists, then a
+    # backup is created before invoking the given block.
+    #
+    def generate path, content # :yields: old_file, new_file, output_file
+      if File.exist? path
+        old_digest = Digest::SHA1.digest(File.read(path))
+        new_digest = Digest::SHA1.digest(content)
+
+        if old_digest == new_digest
+          notify :skip, path
+        else
+          notify :update, path
+          cur, old, new = path, "#{path}.old", "#{path}.new"
+
+          FileUtils.cp cur, old, :preserve => true
+          File.write new, content
+
+          yield old, new, cur if block_given?
+        end
+      else
+        notify :create, path
+        FileUtils.mkdir_p File.dirname(path)
+        File.write path, content
+      end
+    end
+  end
+end
+
+unless File.respond_to? :write
+  ##
+  # Writes the given content to the given file.
+  #
+  def File.write path, content
+    open(path, 'wb') {|f| f.write content }
+  end
+end

data/lib/inochi/inochi.rb

@@ -0,0 +1,109 @@
+module Inochi
+
+  ##
+  # Official name of this project.
+  #
+  PROJECT = 'Inochi'
+
+  ##
+  # Short single-line description of this project.
+  #
+  TAGLINE = 'Gives life to Ruby projects'
+
+  ##
+  # Address of this project's official home page.
+  #
+  WEBSITE = 'http://snk.tuxfamily.org/lib/inochi/'
+
+  ##
+  # Number of this release of this project.
+  #
+  VERSION = '2.0.0'
+
+  ##
+  # Date of this release of this project.
+  #
+  RELDATE = '2010-04-24'
+
+  ##
+  # Description of this release of this project.
+  #
+  def self.inspect
+    "#{PROJECT} #{VERSION} (#{RELDATE})"
+  end
+
+  ##
+  # Location of this release of this project.
+  #
+  INSTDIR = File.expand_path('../../..', __FILE__)
+
+  ##
+  # RubyGems required by this project during runtime.
+  #
+  # @example
+  #
+  #   RUNTIME = {
+  #     # this project needs exactly version 1.2.3 of the "an_example" gem
+  #     "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" ],
+  #
+  #     # this project needs any version of the "yet_another_example" gem
+  #     "yet_another_example" => [],
+  #   }
+  #
+  RUNTIME = {
+    'highline'    => [ '>= 1.5'   , '< 2' ], # for echoless password entry
+    'mechanize'   => [ '~> 1'             ], # for publishing announcements
+    'nokogiri'    => [ '>= 1.4'   , '< 2' ], # for parsing HTML and XML
+    'rake'        => [ '>= 0.8.4' , '< 1' ], # for Inochi::Engine
+    'ronn'        => [ '>= 0.5'   , '< 1' ], # for making UNIX man pages
+    'yard'        => [                    ], # for making API documentation
+  }
+
+  ##
+  # RubyGems required by this project during development.
+  #
+  # @example
+  #
+  #   DEVTIME = {
+  #     # this project needs exactly version 1.2.3 of the "an_example" gem
+  #     "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" ],
+  #
+  #     # this project needs any version of the "yet_another_example" gem
+  #     "yet_another_example" => [],
+  #   }
+  #
+  DEVTIME = {
+    'dfect' => [ '>= 1.1.0', '< 2' ], # for unit testing
+  }
+
+  ##
+  # Loads the correct version (as defined by the {RUNTIME} or {DEVTIME}
+  # constant in this module) of the given gem or the gem that contains
+  # the given library.
+  #
+  def self.require gem_name_or_library
+    # prepare the correct version of the gem for loading
+    if respond_to? :gem
+      gem_name = gem_name_or_library.to_s.sub(%r{/.*$}, '')
+      if gem_version = RUNTIME[gem_name] || DEVTIME[gem_name]
+        begin
+          gem gem_name, *gem_version
+        rescue LoadError => error
+          warn "#{self.inspect}: #{error}"
+        end
+      end
+    end
+
+    # do the loading
+    super
+  end
+
+end

data/lib/inochi/tasks/ann.rake

@@ -0,0 +1,230 @@
+desc 'Build all release announcements.'
+task :ann => %w[ ann:html ann:text ann:feed ]
+
+# it has long been a tradition to use an "[ANN]" prefix
+# when announcing things on the ruby-talk mailing list
+@ann_subject_prefix = '[ANN] '
+
+task :@ann_subject do
+  unless @ann_subject
+    Rake::Task[:@project].invoke
+    @ann_subject = @ann_subject_prefix +
+      @project_module::PROJECT + ' ' + @project_module::VERSION
+  end
+end
+
+# fetch project description from manual
+task :@ann_nfo_html_nodes do
+  unless @ann_nfo_html_nodes
+    begin
+      head, body = fetch_nodes_between('h2#ABOUT', 'h1,h2,h3,h4,h5,h6')
+    rescue => error
+      error.message.insert 0,
+        "The manual lacks a <H2> ABOUT heading.\n"
+      raise error
+    end
+
+    @ann_nfo_html_nodes = body
+  end
+end
+
+task :@ann_nfo_text do
+  unless @ann_nfo_text
+    Rake::Task[:@ann_nfo_html_nodes].invoke
+    @ann_nfo_text = nodes_inner_text(@ann_nfo_html_nodes)
+  end
+end
+
+# fetch release notes from manual
+task :@ann_rel_html_body_nodes do
+  unless @ann_rel_html_body_nodes
+    begin
+      head, body = fetch_nodes_between('h2#VERSIONS ~ h3', 'h1,h2,h3')
+    rescue => error
+      error.message.insert 0,
+        "The manual lacks a <H3> heading under a <H2> VERSIONS heading.\n"
+      raise error
+    end
+
+    @ann_rel_html_title_node = head
+    @ann_rel_html_body_nodes = body
+  end
+end
+
+# fetch authors list from manual
+task :@project_authors_html_nodes do
+  unless @project_authors_html_nodes
+    begin
+      head, body = fetch_nodes_between('h2#AUTHORS,h2#CREDITS',
+                                       'h1,h2,h3,h4,h5,h6')
+    rescue => error
+      error.message.insert 0,
+        "The manual lacks content under a <H2> AUTHORS or CREDITS heading.\n"
+      raise error
+    end
+
+    @project_authors_html_nodes = body
+  end
+end
+
+task :@project_authors_text do
+  unless @project_authors_text
+    Rake::Task[:@project_authors_html_nodes].invoke
+    @project_authors_text = nodes_inner_text(@project_authors_html_nodes)
+  end
+end
+
+# build release announcement
+task :@ann_html do
+  unless @ann_html
+    Rake::Task[:@ann_nfo_html_nodes].invoke
+    Rake::Task[:@ann_rel_html_body_nodes].invoke
+
+    @ann_html = %{
+      <center>
+        <h1>#{@project_module::PROJECT}</h1>
+        <h2>#{@project_module::TAGLINE}</h2>
+        <p>#{@project_module::WEBSITE}</p>
+      </center>
+      #{@ann_nfo_html_nodes.join}
+      #{@ann_rel_html_body_nodes.join}
+    }.strip
+
+    @ann_html = resolve_html_links(@ann_html)
+  end
+end
+
+task :@ann_text do
+  unless @ann_text
+    Rake::Task[:@ann_html].invoke
+    @ann_text = convert_html_to_text(@ann_html)
+  end
+end
+
+#-----------------------------------------------------------------------------
+# HTML
+#-----------------------------------------------------------------------------
+
+@ann_html_dst = 'ann.html'
+
+desc 'Build HTML announcement.'
+task 'ann:html' => @ann_html_dst
+
+file @ann_html_dst => @man_src do
+  Rake::Task[:@ann_html].invoke
+  File.write @ann_html_dst, @ann_html
+end
+
+CLOBBER.include @ann_html_dst
+
+#-----------------------------------------------------------------------------
+# plain text
+#-----------------------------------------------------------------------------
+
+@ann_text_dst = 'ann.txt'
+
+desc 'Build plain text announcement.'
+task 'ann:text' => @ann_text_dst
+
+file @ann_text_dst => @man_src do
+  Rake::Task[:@ann_text].invoke
+  File.write @ann_text_dst, @ann_text
+end
+
+CLOBBER.include @ann_text_dst
+
+#-----------------------------------------------------------------------------
+# RSS feed
+#-----------------------------------------------------------------------------
+
+@ann_feed_dst = 'ann.xml'
+
+desc 'Build RSS feed announcement.'
+task 'ann:feed' => @ann_feed_dst
+
+file @ann_feed_dst => @man_src do
+  Rake::Task[:@project].invoke
+  Rake::Task[:@ann_nfo_html_nodes].invoke
+  Rake::Task[:@ann_rel_html_body_nodes].invoke
+
+  require 'rss/maker'
+  rss = RSS::Maker.make('2.0') do |feed|
+    feed.channel.title = @ann_subject_prefix + @project_module::PROJECT
+    feed.channel.link = @project_module::WEBSITE
+    feed.channel.description = @ann_nfo_html_nodes.join
+
+    item = feed.items.new_item
+    item.link = @project_module::WEBSITE
+    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
+  end
+
+  File.write @ann_feed_dst, rss
+end
+
+CLOBBER.include @ann_feed_dst
+
+#-----------------------------------------------------------------------------
+# helper logic
+#-----------------------------------------------------------------------------
+
+def nodes_inner_text nodes
+  nodes.map {|n| n.inner_text }.join(' ').gsub(/\n/, ' ').squeeze(' ').strip
+end
+
+##
+# Fetches all nodes between those matching the given head and tail selectors.
+#
+def fetch_nodes_between head_selector, tail_selector
+  Rake::Task[:@man_html_dom].invoke
+
+  head = @man_html_dom.at(head_selector)
+  body = []
+
+  tail = head
+  while tail = tail.next_sibling and not tail.matches? tail_selector
+    body << tail
+  end
+
+  [head, body, tail]
+end
+
+##
+# Converts the given HTML into plain text.  we do this using
+# lynx because (1) it outputs a list of all hyperlinks used
+# 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
+  require 'tempfile'
+  tmp_file = Tempfile.new($$).path + '.html'
+
+  begin
+    File.write tmp_file, html
+
+    `lynx -dump #{tmp_file} -width 70`.
+    #
+    # improve readability of list items
+    # by adding a blank line between them
+    #
+    gsub(/(\r?\n)( +\* \S)/, '\1\1\2')
+  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