packnga 0.9.4 → 0.9.5

data/Gemfile

@@ -17,13 +17,4 @@
 
 source "http://rubygems.org/"
 
-gem "rake"
-gem "yard"
-gem "rubyforge"
-
-group :development, :test do
-  gem "test-unit"
-  gem "test-unit-notify"
-  gem "jeweler"
-  gem "RedCloth"
-end
+gemspec

data/README.textile

@@ -8,11 +8,11 @@ h2. Description
 
 An utility library to package i18n-ed library.
 
-Packnga is an library to translate to many languages by YARD.
+Packnga is a library to translate to many languages by YARD.
 
 h2. Authors
 
-  * yoshihara haruka <yoshihara@clear-code.com>
+  * Haruka Yoshihara <yoshihara@clear-code.com>
   * Kouhei Sutou <kou@clear-code.com>
 
 h2. License
@@ -43,3 +43,6 @@ h2. Mailing list
   * comming soon...
 
 h2. Thanks
+
+  * SHIMADA Koji: send a patch.
+  * tetradice: report bugs.

data/Rakefile

@@ -21,8 +21,7 @@ require 'English'
 require 'pathname'
 require 'rubygems'
 require 'rubygems/package_task'
-require "rake/clean"
-require 'jeweler'
+require 'bundler/gem_helper'
 
 base_dir = File.join(File.dirname(__FILE__))
 
@@ -32,59 +31,25 @@ ENV["RUBYLIB"] = "#{packnga_lib_dir}:#{ENV['RUBYLIB']}"
 
 require "packnga"
 
-def guess_version
-  Packnga::VERSION.dup
-end
-
-def cleanup_white_space(entry)
-  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
-end
-
-ENV["VERSION"] ||= guess_version
-version = ENV["VERSION"].dup
-spec = nil
-Jeweler::Tasks.new do |_spec|
-  spec = _spec
-  spec.name = "packnga"
-  spec.version = version
-  spec.rubyforge_project = "groonga"
-  spec.homepage = "http://groonga.rubyforge.org/"
-  spec.authors = ["Haruka Yoshihara", "Kouhei Sutou"]
-  spec.email = ["yoshihara@clear-code.com", "kou@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 = "LGPLv2"
-  spec.files = FileList["lib/**/*.rb",
-                        "Rakefile",
-                        "README.textile",
-                        "Gemfile",
-                        "doc/text/**"]
-  spec.test_files = FileList["test/**/*.rb"]
-end
-
+helper = Bundler::GemHelper.new(base_dir)
+helper.install
+spec = helper.gemspec
 Rake::Task["release"].prerequisites.clear
-Jeweler::RubygemsDotOrgTasks.new do
-end
 
 Gem::PackageTask.new(spec) do |pkg|
   pkg.need_tar_gz = true
 end
 
-Packnga::DocumentTask.new(spec) do |task|
-end
+Packnga::DocumentTask.new(spec)
 
 Packnga::ReleaseTask.new(spec) do |task|
   task.index_html_dir = "../rroonga/doc/html"
   task.changes = File.read("doc/text/news.textile").split(/^h2\.\s(.*)$/)[2]
 end
 
-namespace :requirement do
-  task :ruby18 do
-    if RUBY_VERSION.to_f >= 1.9
-      raise "This task must be run with ruby1.8."
-    end
-  end
+desc "Run tests."
+task :test do
+  ruby("-rubygems", "test/run-test.rb")
 end
 
-task "build" => "requirement:ruby18"
+task :default => :test

data/doc/text/news.textile

@@ -1,5 +1,32 @@
 h1. NEWS
 
+h2. 0.9.5: 2012-08-30
+
+h3. Improvements
+
+ * [reference-task] Created and update a pot/po file by YARD::CLI::I18n instead of xml2po command.
+ * [reference-task] Translated HTML documents with a po file, source files(lib/**/*.rb, ext/**/*.c) and extra files(doc/text/*.*) and README file in spec.
+ * [reference-task] Used GetText::Tools::MsgInit.run instead of msginit in GNU gettext.
+ * Assigned default files for HTML documents by DocumentTask to YARDTask and ReferenceTask.
+ * [tutorial] Added example to use gemspec with Gem::Specification.new.
+ * Defined accessors for readme in YARDTask and ReferenceTask.
+ * Updated documents.
+
+h3. Changes
+
+ * [reference-task] Created the po directory under specified directory instead of "doc".
+
+h3. Fixes
+
+ * [document-task] Fixed not to require block on new.
+ * Fixed not to run blocks when objects of YARDTask and ReferenceTask are initialized.
+ * [reference-task] Used Rake::Task to invoke rake tasks instead of another process.
+
+h3. Thanks
+
+ * tetradice
+ * SHIMADA Koji
+
 h2. 0.9.4: 2011-09-27
 
 h3. Improvements
@@ -12,7 +39,7 @@ h3. Changes
 
 h3. Fixes
 
-* Fixed bug of posting no news to RubyForge in task "release:po:ja:update".
+* Fixed bug of posting no news to RubyForge in task "release:rubyforge:news:post".
 
 h2. 0.9.3: 2011-09-22
 

data/doc/text/release.textile

@@ -1,22 +1,26 @@
 h1. リリース手順
 
-h2. news.textileに前回リリースからの変更点のまとめ
+h2. news.textileに変更点のまとめ
 
 前回のリリース時から現在までの変更点をnews.textileにまとめるため、下記コマンドを実行してgitのコミットログを表示する。
 
 <pre>
+!!!command_line
 $ git log -p --reverse （前回のリリースバージョン)..
 </pre>
 
 ログを"Author:"で検索しながら、ユーザにとって知る必要があるもの（ユーザに見える情報）のコミットログのみを抜き出す。
-その動詞を過去形にし、頭文字を大文字にする。
-それらログをそれぞれを次のようにまとめる。
+次に、抜き出したコミットログを１つずつ見て、その先頭にカテゴリ名がある場合は、":"を削除してカテゴリ名を"["と"]"で囲む。
+カテゴリ名を除いたログの先頭にある単語を過去形にし、頭文字を大文字にする。
+その後、ログを次のように分類する。
 機能などに新しく追加されたものに関してはImprovement,
 動作の変更などはChanges,
 バグの修正など前バージョンまでにあった問題を修正したものはFixesに記述する。
 また、コミットログの行末に[人名]がある場合はその人名をThanks以下に書く。
+さらにREADMEにあるThanks以下にも名前を追加する。
+
 この作業をリリース予定日よりも前に行った場合は、目に見えるところにコミットIDをメモしておく。
-news.textileだと次のrake reference:po:updateで翻訳対象になってしまいノイズになってしまうので注意すること。
+ただし、news.textileだと次のrake reference:po:updateで翻訳対象になってしまいノイズになってしまうので注意すること。
 
 h3. news.textileの1リリース分のテンプレート
 
@@ -43,27 +47,30 @@ h2. 日本語訳の作成
 下記コマンドを実行してja.poを更新する。
 
 <pre>
+!!!command_line
 $ rake reference:po:update
 </pre>
 
-その後、ja.poを開いて、各msgid（コミットログ）に対応するmsgstrにコミットログの和訳を作成する。
-fuzzyを検索して見つかったらC-iで消す。
+その後、ja.poを開いて、各msgid（翻訳対象となる文章）に対応するmsgstrに対応する和訳を作成する。
+fuzzyを検索して見つかったら訳を確認し必要なら修正を行う。その後fuzzyを消す。
 
 h2. リファレンスの確認
 
 下記コマンドを実行して、リファレンスの翻訳を行う。
 
 <pre>
+!!!command_line
 $ rake reference:translate
 </pre>
 
-doc/reference/ja/file.news.htmlなどのja.poを編集した箇所を確認する。
+doc/reference/ja/file.news.htmlなどのja.poを編集した箇所が正しく翻訳されているか確認する。
 
 h2. バージョンとリリース日の更新
 
-下記コマンドを入力して、プロジェクトページ（html/index.html、html/index.html.ja）のrroongaの項にある最新バージョンとリリース日をそれぞれ今回のリリースに合わせたものに更新する。
+下記コマンドを入力して、プロジェクトページ（html/index.html、html/index.html.ja）の最新バージョンとリリース日をそれぞれ今回のリリースに合わせたものに更新する。
 
 <pre>
+!!!command_line
 $ rake release:info:update OLD_VERSION=（前回リリース時のバージョン） OLD_RELEASE_DATE=（前回リリース日） RELEASE_DATE=（今回のリリース日）
 </pre>
 
@@ -72,8 +79,9 @@ h2. gemパッケージの作成
 下記コマンドを打ってアップロード用のgemパッケージをビルドする。
 
 <pre>
+!!!command_line
 $ make clean
-$ ruby1.8 -S rake build
+$ rake build
 </pre>
 
 h2. gemパッケージの動作確認
@@ -81,6 +89,7 @@ h2. gemパッケージの動作確認
 そのgemパッケージの動作を確認するため、下記コマンドを打ってローカル環境にインストールする。
 
 <pre>
+!!!command_line
 $ gem1.9.1 install pkg/（パッケージ名）-（今回リリースバージョン番号）.gem --user-install
 </pre>
 
@@ -88,54 +97,60 @@ $ gem1.9.1 install pkg/（パッケージ名）-（今回リリースバージ
 このディレクトリに移動して、テストを実行し動作を確認する。
 
 <pre>
+!!!command_line
 $ NO_MAKE=yes ruby1.9.1 test/run-test.rb
 </pre>
 
-h2. news.textileの再まとめ
 
-news.textileの行頭にコミットIDが残っている場合、
-下記コマンドを実行してログを表示する。
+h2. news.textileの最終的なまとめとリファレンス作成
+
+コミットIDをメモしていた場合、下記コマンドを実行してログを表示する。
 
 <pre>
-git log --reverse -p （前回のリリース時のバージョン）..（残っていたコミットID）
+!!!command_line
+git log --reverse -p （前回のリリース時のバージョン）..（メモしていたコミットID）
 </pre>
 
-上記ログを"Author:"で検索しながら、ユーザにとって知る必要があるもの（ユーザに見える情報）のコミットログのみを抜き出す。
-その動詞を過去形にし、頭文字を大文字にする。
-それらログをそれぞれを次のようにまとめる。
+ログを"Author:"で検索しながら、ユーザにとって知る必要があるもの（ユーザに見える情報）のコミットログのみを抜き出す。
+次に、抜き出したコミットログを１つずつ見て、その先頭にカテゴリ名がある場合は、":"を削除してカテゴリ名を"["と"]"で囲む。
+カテゴリ名を除いたログの先頭にある単語を過去形にし、頭文字を大文字にする。
+その後、ログを次のように分類する。
 機能などに新しく追加されたものに関してはImprovement,
 動作の変更などはChanges,
 バグの修正など前バージョンまでにあった問題を修正したものはFixesに記述する。
 また、コミットログの行末に[人名]がある場合はその人名をThanks以下に書く。
+さらにREADMEにあるThanks以下にも名前を追加する。
 
-その後、下記コマンドを実行してja.poを更新する。
+下記コマンドを実行してja.poを更新する。
 
 <pre>
+!!!command_line
 $ rake reference:po:update
 </pre>
 
-その後、ja.poを開いて、各msgid（追加したコミットログ）に対応するmsgstrにコミットログの和訳を作成する。
-fuzzyを検索して見つかったらC-iで消す。
+その後、ja.poを開いて、各msgid（翻訳対象となる文章）に対応するmsgstrに対応する和訳を作成する。
+fuzzyを検索して見つかったら訳を確認し必要なら修正を行う。その後fuzzyを消す。
 
-h2. これまでの変更をpush
+さらに下記コマンドを実行して、リファレンスの翻訳を行う。
 
-ここまでに行った変更をcommitしてgit pushする。
+<pre>
+!!!command_line
+$ rake reference:translate
+</pre>
 
-h2. リリースバージョンのタグを作成
+doc/reference/ja/file.news.htmlなどのja.poを編集した箇所が正しく翻訳されているか確認する。
 
-下記コマンドを入力して、今回リリースするバージョンのタグを打ってgit pushする。
+h2. これまでの変更をpush
 
-<pre>
-$ rake release:tag
-$ git push --tag
-</pre>
+ここまでに行った変更をcommitしてgit pushする。
 
-h2. rubygems.orgにパッケージをアップロード
+h2. リリースバージョンのタグの作成とrubygems.orgへのパッケージのアップロード
 
-下記コマンドを実行してパッケージをアップロードする。
+下記コマンドを実行してリリースバージョンのタグを作成し、パッケージをrubygems.orgへアップロードする。
 
 <pre>
-$ ruby1.8 -S rake gemcutter:release
+!!!command_line
+$ rake release
 </pre>
 
 h2. rubyforgeにパッケージをアップロード
@@ -143,6 +158,7 @@ h2. rubyforgeにパッケージをアップロード
 下記コマンドを実行してアップロードする。
 
 <pre>
+!!!command_line
 $ ruby1.8 -S rake release:rubyforge:upload
 $ ruby1.8 -S rake release:reference:publish
 </pre>
@@ -150,7 +166,8 @@ $ ruby1.8 -S rake release:reference:publish
 rroonga以外の場合、index.html関連はrake release:html:publishでアップロードされないので、rroongaに移動してから下記コマンドを実行する。
 
 <pre>
-$ ruby1.8 -S rake release:html:publish
+!!!command_line
+$ ruby1.9.1 -S rake release:html:publish
 </pre>
 
 h2. メーリングリストにリリースの周知
@@ -160,6 +177,7 @@ h2. メーリングリストにリリースの周知
 
 h3.日本語でのメールの具体例
 
+<pre>
 吉原です。
 
 （最新バージョンをリリースしたことを書く）
@@ -215,14 +233,15 @@ irbを使ったrroongaのチュートリアルはこちらにあります。
 
 感謝
     mallowlabsさん
+</pre>
 
 h3. 英語でのメールの具体例
 
 <pre>
 Everyone,
 
-（rroongaの再榛バージョンをリリースしたことを書く）
-We relesed rroonga 1.2.3.
+（rroongaの最新バージョンをリリースしたことを書く）
+We released rroonga 1.2.3.
 
 （インデックスページのURLを書く）
   http://groonga.rubyforge.org/#about-rroonga
@@ -291,6 +310,7 @@ rroonga以外の場合、もとのディレクトリに戻る。
 下記コマンドを入力してrubyforgeの最新ニュースを更新する。
 
 <pre>
+!!!command_line
 $ rake releace:rubyforge:news:post
 </pre>
 

data/doc/text/tutorial.textile

@@ -1,6 +1,6 @@
 h1. Tutorial
 
-We introduce how to use Packnga with Packnga's Rakefile in this page.
+We introduce how to use Packnga with Packnga's Rakefile and gemspec in this page.
 
 h2. Install
 
@@ -13,11 +13,92 @@ You can install Packnga from Rubygems.
 
 h2. Prepare to create tasks
 
-Before using Packnga, you should create @spec@ variable with Jeweler::Task.new.
-Packnga create tasks with @spec@.
-Please see below example.
+Before using Packnga, you should create @spec@ variable with
+ Gem::Specification.new or Jeweler::Tasks.new.
+Packnga create tasks with @spec@ in Rakefile.
+
+h3. Create spec with Gem::Specification.new
+
+We introduce to create @spec@ with Gem::Specification.new in a gemspec file.
+Please see below gemspec example with Gem::Specification.new.
 
 <pre>
+!!!ruby
+version = Packnga::VERSION.dup
+
+readme_path = File.join(base_dir, "README.textile")
+entries = File.read(readme_path).split(/^h2\.\s(.*)$/)
+entry = lambda do |entry_title|
+  entries[entries.index(entry_title) + 1]
+end
+
+authors = []
+emails = []
+entry.call("Authors").each_line do |line|
+  if /\*\s*(.+)\s<([^<>]*)>$/ =~ line
+    authors << $1
+    emails << $2
+  end
+end
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+description = clean_white_space.call(entry.call("Description"))
+summary, description = description.split(/\n\n+/, 2)
+
+Gem::Specification.new do |s|
+  s.name = "packnga"
+  s.version = version
+  s.authors = authors
+  s.email = emails
+  s.summary = summary
+  s.description = description
+
+  s.extra_rdoc_files = ["README.textile"]
+  s.files = ["README.textile", "Rakefile", "Gemfile"]
+  Dir.chdir(base_dir) do
+    s.files += Dir.glob("lib/**/*.rb")
+    s.files += Dir.glob("doc/text/*.*")
+  end
+
+  s.homepage = "http://groonga.rubyforge.org/"
+  s.licenses = ["LGPLv2"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "groonga"
+
+  s.add_runtime_dependency("rake")
+  s.add_runtime_dependency("yard")
+  s.add_runtime_dependency("rubyforge")
+  s.add_runtime_dependency("gettext")
+  s.add_development_dependency("test-unit")
+  s.add_development_dependency("test-unit-notify")
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("RedCloth")
+end
+</pre>
+
+If you set the attribute @rubyforge_project@ of @spec@ value,
+"Packnga::ReleaseTask" class creates tasks for rubyforge.
+
+Next, we should get @spec@ value in Rakefile from gemspec,
+ so we write below source code in  Rakefile.
+
+<pre>
+!!!ruby
+helper = Bundler::GemHelper.new(base_dir)
+helper.install
+spec = helper.gemspec
+</pre>
+
+h3. Create spec with Jeweler::Tasks.new
+
+If you want to create @spec@ with Jeweler::Tasks.new in your Rakefile,
+please see below example.
+This source code is written in old Packnga's Rakefile.
+
+<pre>
+!!!ruby
 spec = nil
 Jeweler::Tasks.new do |_spec|
   spec = _spec
@@ -40,29 +121,24 @@ Jeweler::Tasks.new do |_spec|
 end
 </pre>
 
-If you set the attribute @rubyforge_project@ of @spec@,
-@Release Task@ create tasks for rubyforge.
-See below in detail.
-
 h2. Create tasks
 
 Packnga's classes has charge of each tasks.
-They are given block with .new method in order to set parameters of tasks.
 This table describes Packnga's classes.
 
 - Packnga::DocumentTask :=
   This class create tasks for generating references.
-  It define tasks to generate YARD documentation, po files, and 
-  to translate documents by po files.
+  It define tasks to generate YARD documentation and po files.
+  It also defines tasks to translate documents with po files.
   =:
 
 - Packnga::ReleaseTask :=
   This class create tasks for uploading references and package and preparing to upload them.
-  It defines task to tag the current version in git and task to user-install gem for test.
+  It defines a task to tag the current version in git and a task to user-install gem for test.
   It also create tasks for uploading rubyforge if you set @rubyforge_project@ in @spec@ .
   =:
 
-See below for creating tasks.
+Please see below for creating tasks.
 
 <pre>
 Packnga::DocumentTask.new(spec)
@@ -71,10 +147,11 @@ Packnga::ReleaseTask.new(spec)
 
 h3. Set the document path.
 
-You can set parameters with block when creating object of Packnga::DocumentTask and Releaesask.
-For example, We introduce to how to set document base directory.
+You can set parameters with block when creating object of Packnga::DocumentTask and Releasetask.
+For example, We introduce to how to set base directory for document.
 Document is created in this directory.
 You can write Rakefile to set this directory path, see below.
+
 NOTE: Please set same path to each clasess.
 
 <pre>