packnga 0.9.0

data/doc/text/news.textile

@@ -0,0 +1,5 @@
+h1. NEWS
+
+h2. 0.9.0: 2011-08-19
+
+The first release!

data/doc/text/tutorial.textile

@@ -0,0 +1,91 @@
+h1. Tutorial
+
+We introduce how to use Packnga with Packnga's Rakefile in this page.
+
+h2. Install
+
+You can install Packnga from Rubygems.
+
+<pre>
+!!!command_line
+% sudo gem install packnga
+</pre>
+
+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.
+
+<pre>
+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
+</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.
+  =:
+
+- 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 also create tasks for uploading rubyforge if you set @rubyforge_project@ in @spec@ .
+  =:
+
+See below for creating tasks.
+
+<pre>
+Packnga::DocumentTask.new(spec)
+Packnga::ReleaseTask.new(spec)
+</pre>
+
+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.
+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>
+Packnga::DocumentTask.new(spec) do |task|
+  task.base_dir = "doc/"
+end
+
+Packnga::ReleaseTask.new(spec) do |task|
+  task.base_dir = "doc/"
+end
+</pre>
+
+You can set other parameters.
+Please see Packnga's reference manual in detail.

data/lib/packnga.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  yoshihara haruka <yoshihara@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
+
+require "rake"
+
+require "packnga/version"
+require "packnga/document-task"
+require "packnga/reference-task"
+require "packnga/release-task"

data/lib/packnga/document-task.rb

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  yoshihara haruka <yoshihara@clear-code.com>
+# 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
+
+require "pathname"
+require "packnga/yard-task"
+require "packnga/reference-task"
+
+module Packnga
+  # This class creates docment tasks.
+  # They generate YARD doucment or references.
+  #
+  # @since 0.9.0
+  class DocumentTask
+    include Rake::DSL
+    # Defines tasks to generate YARD documentation
+    # and to translate references.
+    # @param [Jeweler::Task] spec created by Jeweler::Task.new.
+    def initialize(spec)
+      @spec = spec
+      @yard_task = YARDTask.new(@spec)
+      @reference_task = ReferenceTask.new(@spec)
+      self.base_dir = "doc"
+      if block_given?
+        yield(self)
+        define
+      end
+    end
+
+    # @private
+    def define
+      set_default_values
+      define_tasks
+    end
+
+    # Sets base directory for documents. Default value is "doc".
+    # @param [String] base direcory path
+    def base_dir=(dir)
+      dir = Pathname.new(dir)
+      @yard_task.base_dir = dir
+      @reference_task.base_dir = dir
+    end
+
+    # Runs block to task for YARD documentation.
+    def yard
+      yield(@yard_task)
+    end
+
+    # Runs block to tasks for references.
+    def reference
+      yield(@reference_task)
+    end
+
+    private
+    def set_default_values
+    end
+
+    def define_tasks
+      @yard_task.define
+      @reference_task.define
+    end
+  end
+end

data/lib/packnga/reference-task.rb

@@ -0,0 +1,263 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  yoshihara haruka <yoshihara@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
+
+module Packnga
+  # This class creates reference tasks.
+  # They generate, translate and prepare to publish references.
+  #
+  # @since 0.9.0
+  class ReferenceTask
+    include Rake::DSL
+    include ERB::Util
+    # This attribute is path of base directory of document.
+    # @param [String] path of base directory of document
+    attr_writer :base_dir
+    # @private
+    def initialize(spec)
+      @spec = spec
+      @base_dir = nil
+      @translate_languages = nil
+      @supported_languages = nil
+      @html_files = nil
+      @po_dir = nil
+      @pot_file = nil
+      if block_given?
+        yield(self)
+        define
+      end
+    end
+
+    # @private
+    def define
+      set_default_values
+      define_tasks
+    end
+
+    private
+    def set_default_values
+      @base_dir ||= Pathname.new("doc")
+      @translate_languages ||= [:ja]
+      @supported_languages = [:en, *@translate_languages]
+      @html_files = FileList[(doc_en_dir + "**/*.html").to_s].to_a
+
+      @po_dir = "doc/po"
+      @pot_file = "#{@po_dir}/#{@spec.name}.pot"
+
+    end
+
+    def reference_base_dir
+      @base_dir + "reference"
+    end
+
+    def doc_en_dir
+      @base_dir + "reference/en"
+    end
+
+    def html_base_dir
+      @base_dir + "html"
+    end
+
+    def html_reference_dir
+      html_base_dir + @spec.name
+    end
+
+    def define_tasks
+      namespace :reference do
+        define_pot_tasks
+        define_po_tasks
+        define_translate_task
+        define_generate_task
+        define_publication_task
+      end
+    end
+
+    def define_pot_tasks
+      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 do |t|
+        end
+      end
+    end
+
+    def define_po_tasks
+      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
+    end
+
+    def define_translate_task
+      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
+    end
+
+    def define_generate_task
+      desc "Generates references."
+      task :generate => [:yard, :translate]
+    end
+
+    def define_publication_task
+      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("Redirect permanent /#{@spec.name}/text/TUTORIAL_ja_rdoc.html " +
+                      "#{@spec.homepage}#{@spec.name}/ja/file.tutorial.html")
+            file.puts("RedirectMatch permanent ^/#{@spec.name}/$ " +
+                      "#{@spec.homepage}#{@spec.name}/en/")
+          end
+        end
+      end
+    end
+
+    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
+
+      content
+    end
+
+    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
+  end
+end