rroonga 1.2.0 → 1.2.1

data/README.textile

@@ -0,0 +1,71 @@
+h1. README
+
+h2. Name
+
+rroonga
+
+h2. Description
+
+Ruby bindings for groonga that provide full text search and
+column store features.
+
+rroonga is an extension library to use groonga's DB-API
+layer. rroonga provides Rubyish readable and writable API
+not C like API. You can use groonga's fast and highly
+functional features from Ruby with Rubyish form.
+
+See the following URL about groonga.
+
+* "The groonga official site":http://groonga.org/
+
+h2. Authors
+
+* Kouhei Sutou <kou@clear-code.com>
+* Tasuku SUENAGA <a@razil.jp>
+* Daijiro MORI <morita@razil.jp>
+* Yuto HAYAMIZU <y.hayamizu@gmail.com>
+* SHIDARA Yoji <dara@shidara.net>
+
+h2. License
+
+LGPL 2.1. See license/LGPL for details.
+
+(Kouhei Sutou has a right to change the license including
+contributed patches.)
+
+h2. Dependencies
+
+* Ruby >= 1.8 (including 1.9.2)
+* groonga >= 1.2.0
+
+h2. Install
+
+<pre>
+!!!command_line
+% sudo gem install rroonga
+</pre>
+
+h2. Documents
+
+* "Reference manual in English":http://groonga.rubyforge.org/rroonga/en/
+* "Reference manual in Japanese":http://groonga.rubyforge.org/rroonga/ja/
+
+h2. Mailing list
+
+* English: "groonga-users-en":http://rubyforge.org/mailman/listinfo/groonga-users-en
+* Japanese: "groonga-dev":http://lists.sourceforge.jp/mailman/listinfo/groonga-dev
+
+h2. Thanks
+
+* Daijiro MORI: sent patches to support the latest groonga.
+* Tasuku SUENAGA: sent bug reports.
+* niku: sent bug reports.
+* dara:
+** wrote tests.
+** fixed bugs.
+* id:mat_aki: sent bug reports.
+* @yune_kotomi: sent a bug report.
+* m_seki: sent bug reports.
+* ono matope: sent bug reports.
+* @kamipo: send a bug report.
+* ongaeshi: sent a patch to build gem on Windows.

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- coding: utf-8; mode: ruby -*-
 #
-# Copyright (C) 2009-2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2009-2011  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -22,18 +22,18 @@ require 'fileutils'
 require 'pathname'
 require 'erb'
 require 'rubygems'
-if RUBY_VERSION < "1.9"
-  gem 'rdoc'
-end
-require 'hoe'
+require 'yard'
+require 'jeweler'
 require 'rake/extensiontask'
 
-ENV["NODOT"] = "yes"
+if YAML.const_defined?(:ENGINE)
+  begin
+    YAML::ENGINE.yamler = "psych"
+  rescue LoadError
+  end
+end
 
 base_dir = File.join(File.dirname(__FILE__))
-truncate_base_dir = Proc.new do |x|
-  x.gsub(/^#{Regexp.escape(base_dir + File::SEPARATOR)}/, '')
-end
 
 groonga_ext_dir = File.join(base_dir, "ext", "groonga")
 groonga_lib_dir = File.join(base_dir, 'lib')
@@ -54,94 +54,76 @@ def guess_version(groonga_ext_dir)
   [version["major"], version["minor"], version["micro"]].join(".")
 end
 
-manifest = File.join(base_dir, "Manifest.txt")
-manifest_contents = []
-base_dir_included_components = %w(AUTHORS Rakefile
-                                  README.rdoc README.ja.rdoc
-                                  NEWS.rdoc NEWS.ja.rdoc
-                                  rroonga-build.rb extconf.rb)
-excluded_components = %w(.cvsignore .gdb_history CVS depend Makefile doc pkg
-                         .svn .git doc data .test-result tmp vendor)
-excluded_suffixes = %w(.png .ps .pdf .o .so .a .txt .~)
-Find.find(base_dir) do |target|
-  target = truncate_base_dir[target]
-  components = target.split(File::SEPARATOR)
-  if components.size == 1 and !File.directory?(target)
-    next unless base_dir_included_components.include?(components[0])
-  end
-  Find.prune if (excluded_components - components) != excluded_components
-  next if excluded_suffixes.include?(File.extname(target))
-  manifest_contents << target if File.file?(target)
-end
-
-File.open(manifest, "w") do |f|
-  f.puts manifest_contents.sort.join("\n")
-end
-
-# For Hoe's no user friendly default behavior. :<
-File.open("README.txt", "w") {|file| file << "= Dummy README\n== XXX\n"}
-FileUtils.cp("NEWS.rdoc", "History.txt")
-at_exit do
-  FileUtils.rm_f("README.txt")
-  FileUtils.rm_f("History.txt")
-  FileUtils.rm_f(manifest)
-end
-
 def cleanup_white_space(entry)
   entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
 end
 
 ENV["VERSION"] ||= guess_version(groonga_ext_dir)
 version = ENV["VERSION"]
-project = nil
-Hoe.spec('rroonga') do
-  Hoe::Test::SUPPORTED_TEST_FRAMEWORKS[:testunit2] = "test/run-test.rb"
-  project = self
-  project.version = version.dup
-  project.rubyforge_name = 'groonga'
+spec = nil
+Jeweler::Tasks.new do |_spec|
+  spec = _spec
+  spec.name = "rroonga"
+  spec.version = version.dup
+  spec.rubyforge_project = "groonga"
+  spec.homepage = "http://groonga.rubyforge.org/"
   authors = File.join(base_dir, "AUTHORS")
-  project.author = File.readlines(authors).collect do |line|
+  spec.authors = File.readlines(authors).collect do |line|
     if /\s*<[^<>]*>$/ =~ line
       $PREMATCH
     else
       nil
     end
   end.compact
-  project.email = ['groonga-users-en@rubyforge.org',
-                   'groonga-dev@lists.sourceforge.jp']
-  project.url = 'http://groonga.rubyforge.org/'
-  project.testlib = :testunit2
-  project.test_globs = ["test/run-test.rb"]
-  project.spec_extras = {
-    :extensions => ['extconf.rb'],
-    :require_paths => ["lib", "ext/groonga"],
-    :extra_rdoc_files => Dir.glob("**/*.rdoc"),
-  }
-  project.extra_deps << ['pkg-config', '>= 1.0.7']
-  project.readme_file = "README.ja.rdoc"
-
-  news_of_current_release = File.read("NEWS.rdoc").split(/^==\s.*$/)[1]
-  project.changes = cleanup_white_space(news_of_current_release)
-
-  entries = File.read("README.rdoc").split(/^==\s(.*)$/)
+  spec.email = [
+    'groonga-users-en@rubyforge.org',
+    'groonga-dev@lists.sourceforge.jp',
+  ]
+  entries = File.read("README.textile").split(/^h2\.\s(.*)$/)
   description = cleanup_white_space(entries[entries.index("Description") + 1])
-  project.summary, project.description, = description.split(/\n\n+/, 3)
-
-  project.remote_rdoc_dir = "rroonga"
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "LGPLv2"
+  spec.files = FileList["{lib,benchmark,misc}/**/*.rb",
+                        "bin/*",
+                        "*.rb",
+                        "example/*.rb",
+                        "Rakefile",
+                        "ext/**/*"]
+  spec.test_files = FileList["test/**/*.rb"]
 end
 
-project.spec.dependencies.delete_if {|dependency| dependency.name == "hoe"}
+Jeweler::RubygemsDotOrgTasks.new do
+end
 
-ObjectSpace.each_object(Rake::RDocTask) do |rdoc_task|
-  options = rdoc_task.options
-  t_option_index = options.index("--title") || options.index("-t")
-  rdoc_task.options[t_option_index, 2] = nil
-  rdoc_task.title = "rroonga - #{version}"
+module YARD
+  module CodeObjects
+    class Proxy
+      alias_method :initialize_original, :initialize
+      def initialize(namespace, name)
+        name = name.gsub(/\AGrn(.*)\z/) do
+          suffix = $1
+          case suffix
+          when ""
+            "Groonga"
+          when "TableKeySupport"
+            "Groonga::Table::KeySupport"
+          else
+            "Groonga::#{suffix}"
+          end
+        end
+        initialize_original(namespace, name)
+      end
+    end
+  end
+end
 
-  rdoc_task.rdoc_files = ["ext/groonga/rb-groonga.c"]
-  rdoc_task.rdoc_files += Dir.glob("ext/groonga/rb-grn-*.c")
-  rdoc_task.rdoc_files += Dir.glob("lib/**/*.rb")
-  rdoc_task.rdoc_files += Dir.glob("**/*.rdoc")
+YARD::Rake::YardocTask.new do |task|
+  task.options += ["--title", "#{spec.name} - #{version}"]
+  # task.options += ["--charset", "UTF-8"]
+  task.options += ["--readme", "README.textile"]
+  task.options += ["--files", "text/tutorial.textile"]
+  task.files += FileList["ext/groonga/**/*.c"]
+  task.files += FileList["lib/**/*.rb"]
 end
 
 def windows?(platform=nil)
@@ -164,26 +146,32 @@ relative_binary_dir = File.join("vendor", "local")
 vendor_dir = File.join(base_dir, relative_vendor_dir)
 binary_dir = File.join(base_dir, relative_binary_dir)
 
-Rake::ExtensionTask.new("groonga", project.spec) do |ext|
+groonga_win32_i386_p = ENV["GROONGA32"] == "yes"
+
+Rake::ExtensionTask.new("groonga", spec) do |ext|
+  if groonga_win32_i386_p
+    ext.cross_platform = ["x86-mingw32", "i386-mswin32"]
+  else
+    ext.cross_platform = ["x64-mingw32"]
+    # ext.cross_platform << "x64-mswin64" # We need to build with VC++ 2010. :<
+  end
   if windows?
     ext.gem_spec.files += collect_binary_files(relative_binary_dir)
   else
     ext.cross_compile = true
-    ext.cross_compiling do |spec|
-      if windows?(spec.platform.to_s)
-        spec.files += collect_binary_files(relative_binary_dir)
+    ext.cross_compiling do |_spec|
+      if windows?(_spec.platform.to_s)
+        _spec.files += collect_binary_files(relative_binary_dir)
       end
     end
   end
 end
 
-task :publish_docs => [:prepare_docs_for_publishing]
-
 include ERB::Util
 
-def apply_template(file, head, header, footer)
+def apply_template(file, head, header, footer, language)
   content = File.read(file)
-  content = content.sub(/lang="en"/, 'lang="ja"')
+  content = content.sub(/lang="en"/, 'lang="#{language}"')
 
   title = nil
   content = content.sub(/<title>(.+?)<\/title>/) do
@@ -212,47 +200,146 @@ def erb_template(name)
   erb
 end
 
-task :prepare_docs_for_publishing do
-  head = erb_template("head")
-  header = erb_template("header")
-  footer = erb_template("footer")
-  Find.find("doc") do |file|
-    if /\.html\z/ =~ file and /_(?:c|rb)\.html\z/ !~ file
-      apply_template(file, head, header, footer)
+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' --dry-run"
+  rsync_args << " --delete" if options[:delete]
+  remote_dir = "/var/www/gforge-projects/#{spec.rubyforge_name}/"
+  sh("rsync #{rsync_args} #{source} #{host}:#{remote_dir}#{destination}")
+end
+
+namespace :reference do
+  translate_languages = [:ja]
+  supported_languages = [:en, *translate_languages]
+  reference_base_dir = "references"
+  html_files = FileList["doc/**/*.html"].to_a
+
+  directory reference_base_dir
+  CLOBBER.include(reference_base_dir)
+
+  po_dir = "po"
+  namespace :pot do
+    pot_file = "#{po_dir}/#{spec.name}.pot"
+
+    directory po_dir
+    file pot_file => ["po", *html_files] do |t|
+      sh("xml2po", "--keep-entities", "--output", t.name, *html_files)
     end
+
+    desc "Generates pot file."
+    task :generate => pot_file
   end
-  File.open("doc/.htaccess", "w") do |file|
-    file.puts("Redirect permanent /rroonga/text/TUTORIAL_ja_rdoc.html " +
-              "http://groonga.rubyforge.org/rroonga/text/tutorial_ja_rdoc.html")
+
+  namespace :po do
+    translate_languages.each do |language|
+      namespace language do
+        po_file = "#{po_dir}/#{language}.po"
+
+        file po_file do |t|
+          sh("xml2po", "--keep-entities", "--update", t.name, *html_files)
+        end
+
+        desc "Updates po file for #{language}."
+        task :update => po_file
+      end
+    end
   end
-end
 
-desc "Publish HTML to Web site."
-task :publish_html do
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
+  namespace :translate do
+    directory reference_base_dir
+
+    translate_languages.each do |language|
+      po_file = "#{po_dir}/#{language}.po"
+      translate_doc_dir = "#{reference_base_dir}/#{language}"
+
+      doc_dir = Pathname("doc")
+      desc "Translates documents to #{language}."
+      task language => [po_file, reference_base_dir, *html_files] do
+        doc_dir.find do |path|
+          base_path = path.relative_path_from(doc_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] do
+    cp_r("doc", "#{reference_base_dir}/en", :preserve => true)
+  end
 
-  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}"
+  namespace :publication do
+    task :prepare do
+      head = erb_template("head")
+      header = erb_template("header")
+      footer = erb_template("footer")
+      supported_languages.each do |language|
+        doc_dir = "#{reference_base_dir}/#{language}"
+        Find.find(doc_dir) do |file|
+          if /\.html\z/ =~ file and /_(?:c|rb)\.html\z/ !~ file
+            apply_template(file, head, header, footer, language)
+          end
+        end
+      end
+      File.open("#{reference_base_dir}/.htaccess", "w") do |file|
+        file.puts("Redirect permanent /rroonga/text/TUTORIAL_ja_rdoc.html " +
+                  "http://groonga.rubyforge.org/rroonga/ja/file.tutorial.html")
+        file.puts("Redirect permanent /rroonga/ " +
+                  "http://groonga.rubyforge.org/rroonga/en/")
+      end
+    end
+  end
+
+  task :publish => [:generate, "reference:publication:prepare"] do
+    rsync_to_rubyforge(spec, "#{reference_base_dir}/", "/#{spec.name}",
+                       :delete => true)
+  end
 end
 
+namespace :html do
+  desc "Publish HTML to Web site."
+  task :publish do
+    rsync_to_rubyforge(spec, "html/", "")
+  end
+end
+task :publish => ["reference:publish", "html:publish"]
+
 desc "Tag the current revision."
 task :tag do
   sh("git tag -a #{version} -m 'release #{version}!!!'")
 end
 
-# fix Hoe's incorrect guess.
-project.spec.executables.clear
-# project.lib_files = project.spec.files.grep(%r|^src/lib/|)
-
-task(:release).prerequisites.reject! {|name| name == "clean"}
-
 namespace :win32 do
-  if ENV["GROONGA64"] == "yes"
-    host = "amd64-mingw32msvc"
-  else
+  patches_dir = (Pathname.new(base_dir) + "patches").expand_path
+  if groonga_win32_i386_p
     host = "i586-mingw32msvc"
+    mecab_patches = []
+  else
+    host = "x86_64-w64-mingw32"
+    mecab_patches = [
+      "mecab-0.98-mingw-w64.diff",
+      "mecab-0.98-not-use-locale-on-mingw.diff",
+    ]
   end
 
   desc "Build MeCab and groonga and install them into vendor/local/."
@@ -277,12 +364,19 @@ namespace :win32 do
       sh("tar", "xzf", mecab_tar_gz) or exit(false)
     end
     Dir.chdir(File.join(tmp_dir, mecab_base)) do
+      mecab_patches.each do |patch|
+        sh("patch -p1 < #{patches_dir + patch}")
+      end
       sh("./configure",
          "--prefix=#{binary_dir}",
          "--host=#{host}") or exit(false)
       sh("env", "GREP_OPTIONS=--text", "nice", "make", "-j8") or exit(false)
       sh("env", "GREP_OPTIONS=--text", "make", "install") or exit(false)
 
+      mecab_rc_path = File.join(binary_dir, "etc", "mecabrc")
+      win32_mecab_rc_path = File.join(binary_dir, "bin", "mecabrc")
+      mv(mecab_rc_path, win32_mecab_rc_path)
+
       mecab_files_dir = File.join(vendor_dir, "mecab")
       mkdir_p(mecab_files_dir)
       files = ["AUTHORS", "BSD", "COPYING", "GPL", "LGPL"]
@@ -290,7 +384,7 @@ namespace :win32 do
     end
   end
 
-  task(:build_mecab_dict => :build_mecab) do
+  task(:build_mecab_dict) do
     tmp_dir = "tmp/mecab_dict"
     rm_rf(tmp_dir)
     mkdir_p(tmp_dir)
@@ -318,12 +412,12 @@ namespace :win32 do
       files = ["AUTHORS", "COPYING"]
       cp(files, naist_jdic_files_dir)
     end
-    dictionary_dir = '$(rcpath)\..\share/mecab\dic\naist-jdic'
-    mecab_rc_path = File.join(binary_dir, "etc", "mecabrc")
+    dictionary_dir = '$(rcpath)\..\share\mecab\dic\naist-jdic'
+    mecab_rc_path = File.join(binary_dir, "bin", "mecabrc")
     mecab_rc_content = File.read(mecab_rc_path)
     File.open(mecab_rc_path, "w") do |mecab_rc|
-      mecab_rc.print(mecab_rc_content.gsub(/\Adictdir\s*=.+$/,
-                                           "dictdir = #{dictionary_dir}"))
+      mecab_rc.print(mecab_rc_content.gsub(/^dicdir\s*=.+$/,
+                                           "dicdir = #{dictionary_dir}"))
     end
   end
 
@@ -359,12 +453,3 @@ namespace :win32 do
     end
   end
 end
-
-desc "generate rroonga.gemspec"
-task :generate_gemspec do
-  spec = project.spec
-  spec_name = File.join(base_dir, project.spec.spec_name)
-  File.open(spec_name, "w") do |spec_file|
-    spec_file.puts(spec.to_ruby)
-  end
-end