test-unit 2.3.0 → 2.3.1

data/COPYING

@@ -1,4 +1,7 @@
-Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+test-unit is copyrighted free software by Kouhei Sutou
+<kou@cozmixng.org>, Ryan Davis <ryand-ruby@zenspider.com>
+and Nathaniel Talbott <nathaniel@talbott.ws>.
+
 You can redistribute it and/or modify it under either the terms of the GPL
 version 2 (see the file GPL), or the conditions below:
 
@@ -54,3 +57,8 @@ version 2 (see the file GPL), or the conditions below:
      IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
      PURPOSE.
+
+Exceptions
+----------
+
+  * lib/test/unit/diff.rb: PSFL

data/{README.txt → README.textile}

@@ -1,17 +1,17 @@
-= Test::Unit 2.x
+h1. test-unit 2
 
-* http://rubyforge.org/projects/test-unit/
+http://rubyforge.org/projects/test-unit/
 
-== DESCRIPTION
+h2. Description
 
-Test::Unit 2.x - Improved version of Test::Unit bundled in
-Ruby 1.8.x.
+test-unit 2 - Improved version of Test::Unit bundled in Ruby
+1.8.x.
 
 Ruby 1.9.x bundles minitest not Test::Unit. Test::Unit
 bundled in Ruby 1.8.x had not been improved but unbundled
-Test::Unit (Test::Unit 2.x) will be improved actively.
+Test::Unit (test-unit 2) will be improved actively.
 
-== FEATURES
+h2. Features
 
 * Test::Unit 1.2.3 is the original Test::Unit, taken
   straight from the ruby distribution. It is being
@@ -19,7 +19,7 @@ Test::Unit (Test::Unit 2.x) will be improved actively.
   stand-alone package. (The test framework in ruby is going
   to radically change very soon).
 
-* Test::Unit 2.x will be improved actively and may break
+* test-unit 2 will be improved actively and may break
   compatiblity with Test::Unit 1.2.3. (We will not hope it
   if it isn't needed.)
 
@@ -28,15 +28,19 @@ Test::Unit (Test::Unit 2.x) will be improved actively.
   provides for installing all Test::Unit related gems
   easily.
 
-== INSTALL
+h2. Install
 
-  % sudo gem install test-unit
+<pre>
+% sudo gem install test-unit
+</pre>
 
 If you want to use full Test::Unit features:
 
-  % sudo gem install test-unit-full
+<pre>
+% sudo gem install test-unit-full
+</pre>
 
-== LICENSE
+h2. License
 
 (The Ruby License)
 
@@ -45,23 +49,23 @@ This software is distributed under the same terms as ruby.
 Exception: lib/test/unit/diff.rb is a dual license of the
 Ruby license and PSF license.
 
-== AUTHORS
+h2. Authors
 
-=== Active
+h3. Active
 
 * Kouhei Sutou: The current maintainer
 * Haruka Yoshihara: Data driven test supports.
 
-=== Inactive
+h3. Inactive
 
 * Nathaniel Talbott: The original author
 * Ryan Davis: The second maintainer
 
-=== Images
+h3. Images
 
 * Mayu & Co.: kinotan icons: http://cocooooooon.com/kinotan/
 
-== Thanks
+h2. Thanks
 
 * Daniel Berger: Suggestions and bug reports.
 * Designing Patterns: Suggestions.
@@ -74,3 +78,6 @@ Ruby license and PSF license.
 * Andrew Grimm: A bug report.
 * Champak Ch: A bug report.
 * Florian Frank: A bug report.
+* grafi-tt: A bug fix.
+* Jeremy Stephens: A bug report.
+* Hans de Graaff: Bug reports.

data/Rakefile

@@ -2,51 +2,325 @@
 
 Encoding.default_internal = "UTF-8" if defined?(Encoding.default_internal)
 
-require 'rubygems'
-gem 'rdoc'
-require 'hoe'
-require './lib/test/unit/version.rb'
+require "erb"
+require "yaml"
+require "rubygems"
+require "rake/clean"
+require "yard"
+require "jeweler"
+require "./lib/test/unit/version.rb"
 
-ENV["NODOT"] = "yes"
+def cleanup_white_space(entry)
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
 
-version = Test::Unit::VERSION
+version = Test::Unit::VERSION.dup
 ENV["VERSION"] = version
-project = Hoe.spec('test-unit') do
-  Hoe::Test::SUPPORTED_TEST_FRAMEWORKS[:testunit2] = "test/run-test.rb"
-  self.version = version
-  developer('Kouhei Sutou', 'kou@cozmixng.org')
-  developer('Ryan Davis', 'ryand-ruby@zenspider.com')
+spec = nil
+Jeweler::Tasks.new do |_spec|
+  spec = _spec
+  spec.name = "test-unit"
+  spec.version = version
+  spec.rubyforge_project = "test-unit"
+  spec.homepage = "http://test-unit.rubyforge.org/"
+  spec.authors = ["Kouhei Sutou", "Haruka Yoshihara"]
+  spec.email = ["kou@cozmixng.org", "yoshihara@clear-code.com"]
+  entries = File.read("README.textile").split(/^h2\.\s(.*)$/)
+  description = cleanup_white_space(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "Ruby's and PSFL (lib/test/unit/diff.rb)"
+  spec.files = FileList["lib/**/*.rb",
+                        "bin/*",
+                        "sample/*.rb",
+                        "README.textile",
+                        "TODO",
+                        "Rakefile",
+                        "COPYING",
+                        "GPL",
+                        "PSFL"]
+  spec.test_files = FileList["test/**/*.rb"]
+end
+
+Rake::Task["release"].prerequisites.clear
+Jeweler::RubygemsDotOrgTasks.new do
+end
+
+reference_base_dir = Pathname.new("doc/reference")
+doc_en_dir = reference_base_dir + "en"
+html_base_dir = Pathname.new("doc/html")
+html_reference_dir = html_base_dir + spec.name
+YARD::Rake::YardocTask.new do |task|
+  task.options += ["--title", spec.name]
+  # task.options += ["--charset", "UTF-8"]
+  task.options += ["--readme", "README.textile"]
+  task.options += ["--files", "doc/text/**/*"]
+  task.options += ["--output-dir", doc_en_dir.to_s]
+  task.options += ["--charset", "utf-8"]
+  task.files += FileList["lib/**/*.rb"]
+end
 
-  # Ex-Parrot:
-  # developer('Nathaniel Talbott', 'nathaniel@talbott.ws')
+task :yard do
+  doc_en_dir.find do |path|
+    next if path.extname != ".html"
+    html = path.read
+    html = html.gsub(/<div id="footer">.+<\/div>/m,
+                     "<div id=\"footer\"></div>")
+    path.open("w") do |html_file|
+      html_file.print(html)
+    end
+  end
 end
 
-task :check_manifest => :clean_test_result
-task :check_manifest => :clean_coverage
+include ERB::Util
+
+def apply_template(content, paths, templates, language)
+  content = content.sub(/lang="en"/, "lang=\"#{language}\"")
+
+  title = nil
+  content = content.sub(/<title>(.+?)<\/title>/m) do
+    title = $1
+    templates[:head].result(binding)
+  end
+
+  content = content.sub(/<body(?:.*?)>/) do |body_start|
+    "#{body_start}\n#{templates[:header].result(binding)}\n"
+  end
+
+  content = content.sub(/<\/body/) do |body_end|
+    "\n#{templates[:footer].result(binding)}\n#{body_end}"
+  end
 
-task :clean_test_result do
-  test_results = Dir.glob("**/.test-result")
-  sh("rm", "-rf", *test_results) unless test_results.empty?
+  content
 end
 
-task :clean_coverage do
-  sh("rm", "-rf", "coverage")
+def erb_template(name)
+  file = File.join("doc/templates", "#{name}.html.erb")
+  template = File.read(file)
+  erb = ERB.new(template, nil, "-")
+  erb.filename = file
+  erb
 end
 
-desc "Publish HTML to Web site."
-task :publish_html do
+def rsync_to_rubyforge(spec, source, destination, options={})
   config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
   host = "#{config["username"]}@rubyforge.org"
 
-  rsync_args = "-av --exclude '*.erb' --exclude '*.svg' --exclude .svn"
-  remote_dir = "/var/www/gforge-projects/#{project.rubyforge_name}/"
-  sh "rsync #{rsync_args} html/ #{host}:#{remote_dir}"
+  rsync_args = "-av --exclude '*.erb' --chmod=ug+w"
+  rsync_args << " --delete" if options[:delete]
+  remote_dir = "/var/www/gforge-projects/#{spec.rubyforge_project}/"
+  sh("rsync #{rsync_args} #{source} #{host}:#{remote_dir}#{destination}")
 end
 
+def rake(*arguments)
+  ruby($0, *arguments)
+end
+
+namespace :reference do
+  translate_languages = [:ja]
+  supported_languages = [:en, *translate_languages]
+  html_files = FileList[doc_en_dir + "**/*.html"].to_a
+
+  directory reference_base_dir.to_s
+  CLOBBER.include(reference_base_dir.to_s)
+
+  po_dir = "doc/po"
+  pot_file = "#{po_dir}/#{spec.name}.pot"
+  namespace :pot do
+    directory po_dir
+    file pot_file => [po_dir, *html_files] do |t|
+      sh("xml2po", "--keep-entities", "--output", t.name, *html_files)
+    end
+
+    desc "Generates pot file."
+    task :generate => pot_file
+  end
+
+  namespace :po do
+    translate_languages.each do |language|
+      namespace language do
+        po_file = "#{po_dir}/#{language}.po"
+
+        if File.exist?(po_file)
+          file po_file => html_files do |t|
+            sh("xml2po", "--keep-entities", "--update", t.name, *html_files)
+          end
+        else
+          file po_file => pot_file do |t|
+            sh("msginit",
+               "--input=#{pot_file}",
+               "--output=#{t.name}",
+               "--locale=#{language}")
+          end
+        end
+
+        desc "Updates po file for #{language}."
+        task :update => po_file
+      end
+    end
+
+    desc "Updates po files."
+    task :update do
+      ruby($0, "clobber")
+      ruby($0, "yard")
+      translate_languages.each do |language|
+        ruby($0, "reference:po:#{language}:update")
+      end
+    end
+  end
+
+  namespace :translate do
+    translate_languages.each do |language|
+      po_file = "#{po_dir}/#{language}.po"
+      translate_doc_dir = "#{reference_base_dir}/#{language}"
+
+      desc "Translates documents to #{language}."
+      task language => [po_file, reference_base_dir, *html_files] do
+        doc_en_dir.find do |path|
+          base_path = path.relative_path_from(doc_en_dir)
+          translated_path = "#{translate_doc_dir}/#{base_path}"
+          if path.directory?
+            mkdir_p(translated_path)
+            next
+          end
+          case path.extname
+          when ".html"
+            sh("xml2po --keep-entities " +
+               "--po-file #{po_file} --language #{language} " +
+               "#{path} > #{translated_path}")
+          else
+            cp(path.to_s, translated_path, :preserve => true)
+          end
+        end
+      end
+    end
+  end
+
+  translate_task_names = translate_languages.collect do |language|
+    "reference:translate:#{language}"
+  end
+  desc "Translates references."
+  task :translate => translate_task_names
+
+  desc "Generates references."
+  task :generate => [:yard, :translate]
+
+  namespace :publication do
+    task :prepare do
+      supported_languages.each do |language|
+        raw_reference_dir = reference_base_dir + language.to_s
+        prepared_reference_dir = html_reference_dir + language.to_s
+        rm_rf(prepared_reference_dir.to_s)
+        head = erb_template("head.#{language}")
+        header = erb_template("header.#{language}")
+        footer = erb_template("footer.#{language}")
+        raw_reference_dir.find do |path|
+          relative_path = path.relative_path_from(raw_reference_dir)
+          prepared_path = prepared_reference_dir + relative_path
+          if path.directory?
+            mkdir_p(prepared_path.to_s)
+          else
+            case path.basename.to_s
+            when /(?:file|method|class)_list\.html\z/
+              cp(path.to_s, prepared_path.to_s)
+            when /\.html\z/
+              relative_dir_path = relative_path.dirname
+              current_path = relative_dir_path + path.basename
+              if current_path.basename.to_s == "index.html"
+                current_path = current_path.dirname
+              end
+              top_path = html_base_dir.relative_path_from(prepared_path.dirname)
+              paths = {
+                :top => top_path,
+                :current => current_path,
+              }
+              templates = {
+                :head => head,
+                :header => header,
+                :footer => footer
+              }
+              content = apply_template(File.read(path.to_s),
+                                       paths,
+                                       templates,
+                                       language)
+              File.open(prepared_path.to_s, "w") do |file|
+                file.print(content)
+              end
+            else
+              cp(path.to_s, prepared_path.to_s)
+            end
+          end
+        end
+      end
+      File.open("#{html_reference_dir}/.htaccess", "w") do |file|
+        file.puts("RedirectMatch permanent ^/#{spec.name}/$ " +
+                  "#{spec.homepage}#{spec.name}/en/")
+      end
+    end
+  end
+
+  desc "Upload document to rubyforge."
+  task :publish => [:generate, "reference:publication:prepare"] do
+    rsync_to_rubyforge(spec, "#{html_reference_dir}/", spec.name)
+  end
+end
+
+namespace :html do
+  desc "Publish HTML to Web site."
+  task :publish do
+    rsync_to_rubyforge(spec, "#{html_base_dir}/", "")
+  end
+end
+
+desc "Upload document and HTML to rubyforge."
+task :publish => ["html:publish", "reference:publish"]
+
 desc "Tag the current revision."
 task :tag do
-  message = "Released Test::Unit #{version}!"
-  sh 'git', 'tag', '-a', version, '-m', message
+  sh("git tag -a #{version} -m 'release #{version}!!!'")
+end
+
+namespace :release do
+  namespace :info do
+    desc "update version in index HTML."
+    task :update do
+      old_version = ENV["OLD_VERSION"]
+      old_release_date = ENV["OLD_RELEASE_DATE"]
+      new_release_date = ENV["RELEASE_DATE"] || Time.now.strftime("%Y-%m-%d")
+      new_version = ENV["VERSION"]
+
+      empty_options = []
+      empty_options << "OLD_VERSION" if old_version.nil?
+      empty_options << "OLD_RELEASE_DATE" if old_release_date.nil?
+
+      unless empty_options.empty?
+        raise ArgumentError, "Specify option(s) of #{empty_options.join(", ")}."
+      end
+
+      indexes = ["doc/html/index.html", "doc/html/index.html.ja"]
+      indexes.each do |index|
+        content = replaced_content = File.read(index)
+        [[old_version, new_version],
+         [old_release_date, new_release_date]].each do |old, new|
+          replaced_content = replaced_content.gsub(/#{Regexp.escape(old)}/, new)
+          if /\./ =~ old
+            old_underscore = old.gsub(/\./, '-')
+            new_underscore = new.gsub(/\./, '-')
+            replaced_content =
+              replaced_content.gsub(/#{Regexp.escape(old_underscore)}/,
+                                    new_underscore)
+          end
+        end
+
+        next if replaced_content == content
+        File.open(index, "w") do |output|
+          output.print(replaced_content)
+        end
+      end
+    end
+  end
+
+  desc "Release to RubyForge."
+  task :rubyforge => "release:rubyforge:upload"
 end
 
 # vim: syntax=Ruby