inochi 1.1.1 → 2.0.0

data/lib/inochi/tasks/api.rake

@@ -0,0 +1,28 @@
+@api_dir = 'api'
+@api_dst = "#{@api_dir}/index.html"
+
+desc 'Build API documentation.'
+task :api => @api_dst
+
+file @api_dst => FileList['lib/**/*.rb'].include('LICENSE') do
+  inner_task_name = 'api:yard'
+
+  Inochi.require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new(inner_task_name) do |yardoc|
+    yardoc.options = [
+      '--output-dir', @api_dir,
+      '--title', (
+        Rake::Task[:@project].invoke
+        @project_module.inspect
+      ),
+      '--readme', 'LICENSE',
+      '--no-private'
+    ]
+  end
+
+  Rake::Task[inner_task_name].invoke
+end
+
+CLEAN.include '.yardoc'
+CLOBBER.include @api_dir

data/lib/inochi/tasks/gem.rake

@@ -0,0 +1,46 @@
+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
+
+  gem             = Gem::Specification.new
+  gem.name        = @project_package_name
+  gem.date        = @project_module::RELDATE
+  gem.version     = @project_module::VERSION
+  gem.summary     = @project_module::TAGLINE
+  gem.description = @ann_nfo_text
+  gem.homepage    = @project_module::WEBSITE
+  gem.authors     = @project_authors_text.split(/\s*,\s*/)
+  gem.executables = FileList['bin/*'].pathmap('%f')
+
+  Rake::Task[:man].invoke
+  gem.files = FileList[
+    '{bin,lib,ext}/**/*',
+    'LICENSE',
+    'CREDITS',
+    @man_html_dst,
+    @man_roff_dst_glob
+  ]
+
+  @project_module::DEVTIME.each do |gem_name, gem_version|
+    gem.add_development_dependency gem_name, *Array(gem_version)
+  end
+
+  @project_module::RUNTIME.each do |gem_name, gem_version|
+    gem.add_dependency gem_name, *Array(gem_version)
+  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"
+  end
+
+  # emit gemspec
+  File.write @project_gem_file + 'spec', gem.to_ruby
+
+  # build gem
+  Gem::Builder.new(gem).build
+end
+
+CLOBBER.include '*.gem', '*.gemspec'

data/lib/inochi/tasks/init.rake

@@ -0,0 +1,38 @@
+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, 'inochi.opts'
+
+  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/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, 'README'
+  create_from_rbs binding, 'MANUAL'
+  create_from_rbs binding, 'USAGE'
+  create_from_rbs binding, 'EXAMPLES'
+  create_from_rbs binding, 'HACKING'
+  create_from_rbs binding, 'HISTORY'
+  create_from_rbs binding, 'CREDITS'
+  create_from_rbs binding, 'FURTHER'
+
+end

data/lib/inochi/tasks/man.rake

@@ -0,0 +1,78 @@
+@man_src = FileList['MANUAL', '[A-Z]*[A-Z]']
+@man_html_dst = 'man.html'
+@man_ronn_dst = 'man.ronn'
+@man_roff_dst_glob = 'man/man*/*.?{,.gz}'
+
+desc 'Build the help manual.'
+task :man => @man_html_dst
+
+file @man_html_dst => @man_src do
+  Rake::Task[:@man_doc].invoke
+
+  # write ronn version
+
+  # write roff version
+  roff_file = "man/man#{@man_doc.section}/#{@man_doc.basename}"
+  mkdir_p File.dirname(roff_file)
+
+  require 'zlib'
+  Zlib::GzipWriter.open(roff_file + '.gz') do |gz|
+    gz.write @man_doc.to_roff
+  end
+
+  # write html version
+  File.write @man_html_dst, @man_doc.to_html
+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,
+    }
+
+    Inochi.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}",
+    }
+    ronn_file = "#{@project_package_name}.1.ronn"
+
+    Inochi.require 'ronn'
+    @man_doc = Ronn::Document.new(ronn_file, ronn_opts) { ronn_input }
+  end
+end
+
+task :@man_html do
+  unless @man_html
+    Rake::Task[:@man_doc].invoke
+    @man_html = @man_doc.to_html
+  end
+end
+
+task :@man_html_dom do
+  unless @man_html_dom
+    Rake::Task[:@man_html].invoke
+
+    Inochi.require 'nokogiri'
+    @man_html_dom = Nokogiri::HTML(@man_html)
+  end
+end
+

data/lib/inochi/tasks/project.rake

@@ -0,0 +1,25 @@
+task :@project do
+  begin
+    @project_options_file = 'inochi.opts'
+    @project_options = YAML.load_file(@project_options_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
+    puts
+    puts 'The current directory is not an Inochi project.'
+    puts 'Run the `inochi init` command to make it one.'
+    puts
+    raise
+  end
+end

data/lib/inochi/tasks/pub.rake

@@ -0,0 +1,130 @@
+desc 'Publish a release of this project.'
+task :pub => %w[ pub:gem pub:web pub:ann ]
+
+#-----------------------------------------------------------------------------
+# RubyGems
+#-----------------------------------------------------------------------------
+
+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
+
+#-----------------------------------------------------------------------------
+# website
+#-----------------------------------------------------------------------------
+
+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]
+    sources = [@man_html_dst, @api_dir, @ann_feed_dst,
+      @project_options[:pub_web_extras]].compact
+
+    sh ['rsync', options, sources, target].join(' ')
+  end
+end
+
+#-----------------------------------------------------------------------------
+# announcements
+#-----------------------------------------------------------------------------
+
+desc 'Announce release on all news outlets.'
+task 'pub:ann' => %w[ pub:ann:raa pub:ann:ruby-talk ]
+
+desc 'Announce release on ruby-talk mailing list.'
+task 'pub:ann:ruby-talk' do
+  site = 'http://ruby-forum.com'
+
+  Inochi.require 'mechanize'
+  browser = Mechanize.new
+
+  # fetch login form
+  page = browser.get("#{site}/user/login")
+  form = page.forms_with(:action => '/user/login').first or
+    raise "cannot find login form on Web page: #{page.uri}"
+
+  # fill login information
+  Inochi.require 'highline'
+  highline = HighLine.new
+
+  form['name'] = highline.ask("#{site} username: ")
+  form['password'] = highline.ask("#{site} password: ") {|q| q.echo = false }
+
+  # submit login form
+  page = form.click_button
+  page.at('a[href="/user/logout"]') or
+    raise "invalid login for #{site}"
+
+  # make the announcement
+  page = browser.get("#{site}/topic/new?forum_id=4")
+  form = page.forms_with(:action => '/topic/new#postform').first or
+    raise "cannot find post creation form on Web page: #{page.uri}"
+
+  # enable notification by email whenever
+  # someone replies to this announcement
+  form['post[subscribed_by_author]'] = '1'
+
+  Rake::Task[:@ann_subject].invoke
+  form['post[subject]'] = @ann_subject
+
+  Rake::Task[@ann_text_dst].invoke
+  form['post[text]'] = File.read(@ann_text_dst)
+
+  # submit the announcement
+  page = form.submit
+
+  if error = page.at('.error')
+    raise "Announcement to #{site} failed:\n#{error.text}"
+  else
+    puts "Successfully announced to #{site}:", page.uri
+  end
+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
+
+  Inochi.require 'mechanize'
+  browser = Mechanize.new
+
+  # fetch project information form
+  page = browser.get("#{site}/update.rhtml?name=#{project}")
+  form = page.forms_with(:action => 'regist.rhtml').first or
+    raise "cannot find project information form on Web page: #{page.uri}"
+
+  # fill project information
+  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
+
+  # fill login information
+  Inochi.require 'highline'
+  highline = HighLine.new
+
+  prompt = '%s password for %s project and %s owner: ' %
+    [ site, project.inspect, form.owner.inspect ]
+  form['pass'] = highline.ask(prompt) {|q| q.echo = false }
+
+  # submit project information
+  page = form.submit
+
+  if page.title =~ /error/i
+    error = "#{page.at('h2').text} -- #{page.at('p').text.strip}"
+    raise "Announcement to #{site} failed:\n#{error}"
+  else
+    puts "Successfully announced to #{site}."
+  end
+end

data/lib/inochi/templates/CREDITS.rbs

@@ -0,0 +1,18 @@
+%#----------------------------------------------------------------------------
+## CREDITS
+%#----------------------------------------------------------------------------
+
+> TODO: attribute yourself, your predecessors, and your contributors
+
+Your Name,
+Contributor name,
+[Contributor name](http://the.contributor.url),
+Another contributor <contributor@email.address>,
+Yet another contributor
+
+%#----------------------------------------------------------------------------
+## LICENSE
+%#----------------------------------------------------------------------------
+
+%# See the file named "LICENSE".
+%< "LICENSE"

data/lib/inochi/templates/EXAMPLES.rbs

@@ -0,0 +1,24 @@
+%#----------------------------------------------------------------------------
+## EXAMPLES
+%#----------------------------------------------------------------------------
+
+> TODO: give examples of how to use your
+>       project to perform certain tasks
+
+%#----------------------------------------------------------------------------
+### A task
+%#----------------------------------------------------------------------------
+
+> TODO: explain how to perform this task
+
+%#----------------------------------------------------------------------------
+### Another task
+%#----------------------------------------------------------------------------
+
+> TODO: explain how to perform this task
+
+%#----------------------------------------------------------------------------
+### Yet another task
+%#----------------------------------------------------------------------------
+
+> TODO: explain how to perform this task

data/lib/inochi/templates/FURTHER.rbs

@@ -0,0 +1,17 @@
+%#----------------------------------------------------------------------------
+## SEE ALSO
+%#----------------------------------------------------------------------------
+
+> TODO: list related UNIX man pages here
+
+some_command(1),
+another_command(5),
+yet_another_command(7)
+
+%#----------------------------------------------------------------------------
+%# Markdown link references
+%#----------------------------------------------------------------------------
+
+[Inochi]: <%= Inochi::WEBSITE %>
+[RubyGems]: http://rubygems.org
+[Ruby]: http://ruby-lang.org

data/lib/inochi/templates/HACKING.rbs

@@ -0,0 +1,92 @@
+%#----------------------------------------------------------------------------
+## 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
+
+Install Ruby libraries necessary for development:
+
+    gem install #{package_name} --development
+
+%#----------------------------------------------------------------------------
+### 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 --help     # display help manual
+    inochi --tasks    # list available tasks
+
+%#----------------------------------------------------------------------------
+### $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}
+
+Or by setting the `$RUBYLIB` environment variable:
+
+    export RUBYLIB=lib   # bash, ksh, zsh
+    setenv RUBYLIB lib   # csh
+    set -x RUBYLIB lib   # fish
+
+    ruby bin/#{package_name}
+    irb -r #{package_name}
+
+Or by installing the [ruby-wrapper](http://github.com/chneukirchen/rup) tool.
+
+%#----------------------------------------------------------------------------
+### 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
+`bin/` directory.
+
+This can be achieved by passing an option to Ruby:
+
+    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
+
+%#----------------------------------------------------------------------------
+### Running tests
+%#----------------------------------------------------------------------------
+
+Simply execute the included test runner, which sets up Ruby's `$LOAD_PATH` for
+testing, loads the included `test/test_helper.rb` file, and then evaluates all
+`test/**/*_test.rb` files:
+
+    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/test_helper.rb` file.
+
+%#----------------------------------------------------------------------------
+### Contributing
+%#----------------------------------------------------------------------------
+
+> TODO: explain how someone can contribute their changes to your repository
+
+Fork this project on GitHub (see **Resources** above) and send a pull request.