racknga 0.9.1 → 0.9.2

data/Gemfile

@@ -0,0 +1,30 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 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
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+source "http://rubygems.org/"
+
+gem "rroonga"
+gem "rack"
+
+group :development, :test do
+  gem "test-unit"
+  gem "test-unit-notify"
+  gem "test-unit-capybara"
+  gem "rake"
+  gem "jeweler"
+  gem "yard"
+end

data/README.textile

@@ -0,0 +1,52 @@
+h1. README
+
+h2. Name
+
+racknga
+
+h2. Description
+
+Rack middlewares that use rroonga features and
+middlewares/utilities that don't use rroonga features.
+
+  * "rroonga":http://groonga.rubyforge.org/
+  * "Rack":http://rack.rubyforge.org/
+
+h2. Authors
+
+  * Kouhei Sutou <kou@clear-code.com>
+
+h2. License
+
+LGPL 2.1 or later. See license/lgpl-2.1.txt for details.
+
+(Kouhei Sutou has a right to change the license
+including contributed patches.)
+
+h2. Dependencies
+
+  * Ruby >= 1.9.1
+  * rroonga
+  * Rack
+
+h2. Suggested libraries
+
+  * jpmobile
+
+h2. Install
+
+<pre>
+% sudo gem install racknga
+</pre>
+
+h2. Documents
+
+http://groonga.rubyforge.org/racknga/en/
+
+h2. Mailing list
+
+http://rubyforge.org/mailman/listinfo/groonga-users-en
+
+h2. Thanks
+
+  * ...

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- coding: utf-8; mode: ruby -*-
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-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
@@ -17,21 +17,15 @@
 
 require 'English'
 
-require 'find'
 require 'fileutils'
 require 'pathname'
 require 'erb'
 require 'rubygems'
-gem 'rdoc'
-require 'hoe'
-
-ENV["NODOT"] = "yes"
-
-base_dir = Pathname(__FILE__).dirname
-truncate_base_dir = Proc.new do |path|
-  path.relative_path_from(base_dir)
-end
+require 'jeweler'
+require "rake/clean"
+require "yard"
 
+base_dir = Pathname.new(__FILE__).dirname
 racknga_lib_dir = base_dir + 'lib'
 $LOAD_PATH.unshift(racknga_lib_dir.to_s)
 
@@ -40,150 +34,276 @@ def guess_version
   Racknga::VERSION
 end
 
-manifest = 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 pkg-config.rb)
-excluded_components = %w(.cvsignore .gdb_history CVS depend Makefile doc pkg
-                         .svn .git doc data .test-result tmp)
-excluded_suffixes = %w(.png .ps .pdf .o .so .a .txt .~)
-unless ENV["RUBY_CC_VERSION"]
-  excluded_components << "vendor"
-end
-base_dir.find do |target|
-  target = truncate_base_dir[target]
-  components = target.to_s.split(File::SEPARATOR)
-  if components.size == 1 and !target.directory?
-    next unless base_dir_included_components.include?(components[0])
+ENV["VERSION"] ||= guess_version
+version = ENV["VERSION"].dup
+project = nil
+spec = nil
+Jeweler::Tasks.new do |_spec|
+  spec = _spec
+  spec.name = 'racknga'
+  spec.version = version
+  spec.rubyforge_project = 'groonga'
+  spec.homepage = "http://groonga.rubyforge.org/"
+  authors_file = File.join(base_dir, "AUTHORS")
+  authors = []
+  emails = []
+  File.readlines(authors_file).each do |line|
+    if /\s*<([^<>]*)>$/ =~ line
+      authors << $PREMATCH
+      emails << $1
+    end
   end
-  Find.prune if (excluded_components - components) != excluded_components
-  next if excluded_suffixes.include?(File.extname(target))
-  manifest_contents << target if File.file?(target)
+  spec.authors = authors
+  spec.email = emails
+  spec.summary = "A Rack middleware collection for rroonga features."
+  spec.description = <<-EOD.gsub(/\n/, ' ').strip
+Racknga is a Rack middlewares that uses rroonga features.
+EOD
+  spec.license = "LGPLv2.1 or later"
+  spec.files = FileList["lib/**/*.rb",
+                        "{license,munin,doc/text/}/**/*",
+                        "example/*.rb",
+                        "AUTHORS",
+                        "Rakefile",
+                        "Gemfile",
+                        "README*"]
+  spec.test_files = FileList["test/**/*.rb"]
 end
 
-File.open(manifest, "w") do |f|
-  f.puts manifest_contents.sort.join("\n")
+Rake::Task["release"].prerequisites.clear
+Jeweler::RubygemsDotOrgTasks.new do
 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)
+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 += ["--readme", "README.textile"]
+  task.options += ["--files", "doc/text/**/*"]
+  task.options += ["--output-dir", doc_en_dir.to_s]
+  task.options += ["--charset", "utf-8"]
 end
 
-def cleanup_white_space(entry)
-  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
-end
-
-ENV["VERSION"] ||= guess_version
-version = ENV["VERSION"]
-project = nil
-Hoe.spec('racknga') do
-  Hoe::Test::SUPPORTED_TEST_FRAMEWORKS[:testunit2] = "test/run-test.rb"
-  project = self
-  project.version = version.dup
-  project.rubyforge_name = 'groonga'
-  authors = File.join(base_dir, "AUTHORS")
-  project.author = File.readlines(authors).collect do |line|
-    if /\s*<[^<>]*>$/ =~ line
-      $PREMATCH
-    else
-      nil
+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.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.extra_deps += [["rroonga"],
-                         ["rack"]]
-  project.spec_extras = {
-    :extra_rdoc_files => Dir.glob("**/*.rdoc"),
-    :licenses => ["LGPL 2.1 or later"]
-  }
-  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(.*)$/)
-  description = cleanup_white_space(entries[entries.index("Description") + 1])
-  project.summary, project.description, = description.split(/\n\n+/, 3)
-
-  project.remote_rdoc_dir = "racknga"
-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] = [] if t_option_index
-  rdoc_task.title = "racknga - #{version}"
+  end
 end
 
-task :publish_docs => [:prepare_docs_for_publishing]
-
-
 include ERB::Util
 
-def apply_template(file, head, header, footer)
-  content = File.read(file)
-  content = content.sub(/lang="en"/, 'lang="ja"')
+def apply_template(content, paths, templates, language)
+  content = content.sub(/lang="en"/, "lang=\"#{language}\"")
 
   title = nil
-  content = content.sub(/<title>(.+?)<\/title>/) do
+  content = content.sub(/<title>(.+?)<\/title>/m) do
     title = $1
-    head.result(binding)
+    templates[:head].result(binding)
   end
 
   content = content.sub(/<body(?:.*?)>/) do |body_start|
-    "#{body_start}\n#{header.result(binding)}\n"
+    "#{body_start}\n#{templates[:header].result(binding)}\n"
   end
 
   content = content.sub(/<\/body/) do |body_end|
-    "\n#{footer.result(binding)}\n#{body_end}"
+    "\n#{templates[:footer].result(binding)}\n#{body_end}"
   end
 
-  File.open(file, "w") do |file|
-    file.print(content)
-  end
+  content
 end
 
 def erb_template(name)
-  file = File.join("html", "#{name}.html.erb")
+  file = File.join("doc/templates", "#{name}.html.erb")
   template = File.read(file)
   erb = ERB.new(template, nil, "-")
   erb.filename = file
   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' --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
-end
 
-task :publish_html do
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
+  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
+      rake("clobber")
+      rake("yard")
+      translate_languages.each do |language|
+        rake("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)
+              package_path = top_path + spec.name
+              paths = {
+                :top => top_path,
+                :current => current_path,
+                :package => package_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
 
-  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}"
+  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 to rubyforge."
+task :publish => ["reference:publish"]
+
+desc "Tag the current revision."
 task :tag do
   sh("git tag -a #{version} -m 'release #{version}!!!'")
 end
-
-task(:release).prerequisites.reject! {|name| name == "clean"}

data/doc/text/news.textile

@@ -0,0 +1,32 @@
+h1. NEWS
+
+h2. 0.9.2: 2011-08-07
+
+h3. Improvments
+
+  * [munin] Supported Passenger 3 support.
+  * [munin] Removed Passenger 2 support.
+  * [middleware][jsonp] Improved browser compatibility by using
+    "text/javascript" for Content-Type.
+  * [middleware][cache] Improved checksum robustness by using
+    SHA1 instead of MD5.
+  * [middleware][cache] Supported 4096 >= length URL.
+  * [exception-mail-notifier] Supported limited mailing.
+  * [middleware][instance-name] Added.
+  * Added NginixAccessLogParser.
+  * Documented middlewares.
+
+h2. 0.9.1: 2010-11-11
+
+  * Improved cache validation.
+  * Supported caches per User-Agent.
+  * Added a JSONP middleware.
+  * Added a HTTP Range support middleware.
+  * Added a logging access to groogna databsae middleware.
+  * Added Munin plugins for Passenger.
+  * Changed license to LGPLv2.1 or later from LGPLv2.1.
+  * Supported will_paginate.
+
+h2. 0.9.0: 2010-07-04
+
+  * Initial release!

data/lib/racknga/cache_database.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-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
@@ -21,7 +21,13 @@ require 'fileutils'
 require 'groonga'
 
 module Racknga
+  # This is a cache database based on groonga. It is used by
+  # Racknga::Middleware::Cache.
+  #
+  # Normally, #purge_old_responses is only used for cache
+  # maintenance.
   class CacheDatabase
+    # @param [String] database_path the path for cache database.
     def initialize(database_path)
       @database_path = database_path
       @context = Groonga::Context.new(:encoding => :none)
@@ -40,14 +46,23 @@ module Racknga
       configurations["default"]
     end
 
+    # Purges old responses. To clear old caches, you should
+    # call this method periodically or after data update.
+    #
+    # You can call this method by the different
+    # process from your Rack application
+    # process. (e.g. cron.) It's multi process safe.
     def purge_old_responses
       age_modulo = 2 ** 32
       age = configuration.age
       previous_age = (age - 1).modulo(age_modulo)
       configuration.age = (age + 1).modulo(age_modulo)
 
-      responses.each do |response|
-        response.delete if response.age == previous_age
+      target_responses = responses.select do |record|
+        record.age == previous_age
+      end
+      target_responses.each do |response|
+        response.key.delete
       end
     end