i18n_template 0.0.1

data/lib/i18n_template/extractor.rb

@@ -0,0 +1,4 @@
+require 'i18n_template/extractor/base'
+require 'i18n_template/extractor/plain'
+require 'i18n_template/extractor/gettext'
+require 'i18n_template/extractor/yaml'

data/lib/i18n_template/extractor/base.rb

@@ -0,0 +1,44 @@
+require "fileutils"
+
+module I18nTemplate
+  module Extractor
+    class Base
+      class << self
+        def default_options
+          {
+            :glob       => ['app/views/**/*.{erb,rhtml}'],
+            :format     => 'gettext'
+          }
+        end
+      end
+
+      def initialize(options)
+        @options = self.class.default_options.dup
+        @options.merge!(options)
+      end
+
+      def call(source)
+        raise NotImplementedError, "'call' is not implemented by #{self.class.name}"
+      end
+
+      protected
+
+      def log(message)
+        puts message if @options[:verbose]
+      end
+
+      def extract_phrases(filename)
+        log "Processing #{filename}"
+        source = File.read(filename)
+        document = ::I18nTemplate::Document.new(source)
+        document.preprocess!
+
+        document.warnings.each { |warning| log(warning) } if @options[:verbose]
+
+        document.phrases
+      end
+
+    end
+  end
+end
+

data/lib/i18n_template/extractor/gettext.rb

@@ -0,0 +1,127 @@
+module I18nTemplate
+  module Extractor
+    #
+    # Extract phrases to gettext format. E.g. pot/po files
+    #
+    # Extractor creates and updates:
+    #  * {po_root}/{textdomain}.pot
+    #  * {pr_root}/{lang}/{textdomain}.po
+    class Gettext < Base
+
+      I18nTemplate.extractors << self
+
+      class << self
+        def format
+          'gettext'
+        end
+
+        def default_options
+          super.merge({
+            :po_root    => 'po',
+            :textdomain => 'phrases'
+          })
+        end
+      end
+
+      def initialize(options)
+        super(options)
+
+        @version = 'version 0.0.1'
+        @pot_file = File.join(@options[:po_root], "#{@options[:textdomain]}.pot")
+        @pot_file_tmp = "#{@pot_file}.tmp"
+      end
+
+      def call(paths)
+        # ensure root directory exists
+        FileUtils.mkdir_p(@options[:po_root])
+
+        # generate new temporary pot file
+        File.open(@pot_file_tmp, "w") do |f|
+          f.puts generate_pot_header
+          f.puts ""
+          f.puts generate_pot_body(paths)
+        end
+
+        # merge pot file
+        log("Merging #{@pot_file}")
+        if File.exist?(@pot_file)
+          merge_po_files(@pot_file, @pot_file_tmp)
+        else
+          FileUtils.cp(@pot_file_tmp, @pot_file)
+        end
+
+        # merge po files
+        Dir.glob("#{@options[:po_root]}/*/#{@options[:textdomain]}.po") do |po_file|
+          log("Merging #{po_file}")
+          concate_po_files(po_file, @pot_file_tmp)
+        end
+
+        # remove temporary pot file
+        FileUtils.rm(@pot_file_tmp)
+      end
+
+      protected
+
+      def generate_pot_header
+        time = Time.now.strftime("%Y-%m-%d %H:%M")
+        off = Time.now.utc_offset
+        sign = off <= 0 ? '-' : '+'
+        time += sprintf('%s%02d%02d', sign, *(off.abs / 60).divmod(60))
+
+        <<-TITLE
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\\n"
+"POT-Creation-Date: #{time}\\n"
+"PO-Revision-Date: #{time}\\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n"
+"Language-Team: LANGUAGE <LL@li.org>\\n"
+"MIME-Version: 1.0\\n"
+"Content-Type: text/plain; charset=UTF-8\\n"
+"Content-Transfer-Encoding: 8bit\\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\\n"
+TITLE
+      end
+
+      def generate_pot_body(paths)
+        sources = {}
+
+        paths.each do |path|
+          phrases = extract_phrases(path)
+          phrases.each do |phrase|
+            sources[phrase] ||= []
+            sources[phrase] << path 
+          end
+        end
+
+        log("Extracted #{sources.keys.size} phrases")
+
+        data = ""
+        sources.sort.each do |phrase, paths|
+          data << "# #{paths.join(",")}\n"
+          data << "msgid #{phrase.inspect}\n"
+          data << "msgstr \"\"\n"
+          data << "\n"
+        end
+        data
+      end
+
+      def concate_po_files(def_po, ref_po)
+        command = "msgcat --output-file #{def_po} --use-first #{def_po} #{ref_po}"
+        system(command) or raise RuntimeError, "can't run #{command.inspect}"
+      end
+
+      def merge_po_files(def_po, ref_po)
+        command = "msgmerge --quiet --update #{def_po} #{ref_po}"
+        system(command) or raise RuntimeError, "can't run #{command.inspect}"
+      end
+
+    end
+  end
+end

data/lib/i18n_template/extractor/plain.rb

@@ -0,0 +1,43 @@
+module I18nTemplate
+  module Extractor
+    # Extract phrases to plain format:
+    # Each phrase per line
+    class Plain < Base
+
+      I18nTemplate.extractors << self
+
+      class << self
+        def format
+          'plain'
+        end
+
+        def default_options
+          super.merge({
+            :output_file => 'phrases.txt'
+          })
+        end
+      end
+
+      def call(paths)
+        sources = {}
+
+        paths.each do |path|
+          phrases = extract_phrases(path)
+          phrases.each do |phrase|
+            sources[phrase] ||= []
+            sources[phrase] << path 
+          end
+        end
+
+        log "Extracting #{sources.keys.size} phrases to #{@options[:output_file]}"
+        File.open(@options[:output_file], "w") do |f|
+          sources.sort.each do |phrase, paths|
+            f << "# #{paths.join(",")}\n"
+            f << phrase
+            f << "\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n_template/extractor/yaml.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+
+module I18nTemplate
+  module Extractor
+    # Extract phrases to yaml format. E.g:
+    # config/locales/templates.yml
+    class Yaml < Base
+
+      I18nTemplate.extractors << self
+
+      class << self
+        def format
+          'yaml'
+        end
+
+        def default_options
+          super.merge({
+            :locales_root => 'config/locales'
+          })
+        end
+      end
+
+      def call(paths)
+        # ensure root directory exists
+        FileUtils.mkdir_p(@options[:locales_root])
+        output_file = File.join(@options[:locales_root], 'phrases.yml')
+
+        # extract phrases
+        phrases = []
+        paths.each do |path|
+          phrases += extract_phrases(path)
+        end
+        phrases.uniq!
+
+        # update phrases
+        log "Extracting #{phrases.size} phrases to #{output_file}"
+        data = File.exists?(output_file) ? YAML.load_file(output_file) : {}
+        data['en'] ||= {}
+        data.keys.each do |locale|
+          phrases.each do |phrase|
+            data[locale][phrase] ||= nil
+          end
+        end
+
+        # store data
+        File.open(output_file, "w") do |f|
+          f << data.to_yaml
+        end
+      end
+    end
+  end
+end
+

data/lib/i18n_template/handler.rb

@@ -0,0 +1,61 @@
+module I18nTemplate
+  ##
+  # Handler is ActionView wrapper for erb handler.
+  # If internationalize? returns true
+  # it calls erb handler with internationalized template
+  # otherwise it calls handler with regular template
+  class Handler
+    def initialize(options = {})
+      @options = options
+      @default_format = ::Mime::HTML
+      init_erb_handler
+    end
+
+    # default format
+    attr_reader :default_format
+
+    # erb handler
+    attr_reader :erb_handler
+
+    # call method implements ActionView::Template handler interface
+    def call(template)
+      if internationalize?(template)
+        document = ::I18nTemplate::Document.new(template.source)
+        document.process!
+        document.warnings.each { |warning| $stderr.puts warning } if @options[:verbose]
+
+        erb_handler.call(document)
+      else
+        erb_handler.call(template)
+      end
+    end
+
+    protected
+
+    # check if template source should be internationalized
+    #
+    # @note 
+    #   if you need more control inherite and override this method
+    def internationalize?(template)
+      true
+    end
+
+    private
+
+    # init action_view erb handler
+    def init_erb_handler
+      require 'action_pack/version'
+
+      case ActionPack::VERSION::MAJOR
+      when 2
+        require 'action_view/template_handlers/erb'
+        @erb_handler = ::ActionView::TemplateHandlers::ERB
+      when 3
+        require 'action_view/template/handlers/erb'
+        @erb_handler = ::ActionView::Template::Handlers::ERB
+      else
+        raise NotImplementedError, "Can't init erb_handler for action_pack v#{ActionPack::VERSION::STRING}"
+      end
+    end
+  end
+end

data/lib/i18n_template/node.rb

@@ -0,0 +1,74 @@
+module I18nTemplate
+  ## 
+  # Document processing node
+  class Node
+    # The array of children of this node. Not all nodes have children.
+    attr_reader :children
+
+    # The parent node of this node. All nodes have a parent, except for the
+    # root node.
+    attr_reader :parent
+
+    # The line number of the input where this node was begun
+    attr_reader :line
+
+    # The byte position in the input where this node was begun
+    attr_reader :position
+
+    # Node token
+    attr_reader :token
+
+    attr_accessor :tag
+    attr_accessor :phrase
+
+    # Create a new node as a child of the given parent.
+    def initialize(parent, line = 0, position = 0, token = nil, tag = nil, &block)
+      @parent = parent
+      @children = []
+      @line, @position = line, position
+      @token = token
+      @tag = tag
+      instance_eval(&block) if block_given?
+    end
+
+    # tag node?
+    def tag?
+      !@tag.nil?
+    end
+
+    # text node?
+    def text?
+      @tag.nil?
+    end
+
+    # root node?
+    def root?
+      parent == self
+    end
+
+    # Return descendant text if tag node is wrapper node for some text node
+    # @return 'text' for
+    # <div><span><b>text</b></span><div>
+    # @return nil for
+    # <div><span><b>text</b></span><p>data</p><div>
+    def wrapped_node_text
+      node = self
+      while node.children.size == 1
+        node = node.children.first
+        return node.token if node.text?
+      end
+      return nil
+    end
+
+    def descendants_text
+      output = ""
+      children.each do |child|
+        output << child.token if child.text?
+        child.children.each do |node|
+          output << node.descendants_text
+        end
+      end
+      output
+    end
+  end
+end

data/lib/i18n_template/railtie.rb

@@ -0,0 +1,7 @@
+module I18nTemplate
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      require 'i18n_template/tasks'
+    end
+  end
+end if defined?(Rails::Railtie)

data/lib/i18n_template/runner.rb

@@ -0,0 +1,61 @@
+require 'i18n_template/runner/base'
+require 'i18n_template/runner/extract_phrases'
+
+require 'optparse'
+module I18nTemplate
+  module Runner
+    class << self
+
+      def run
+        options = {}
+
+        option_parser = OptionParser.new do |op|
+          op.banner = "Usage: #{File.basename($0)} COMMAND [OPTIONS]"
+
+          I18nTemplate.runners.each do |runner|
+            op.separator ""
+            op.separator "#{runner.command} - #{runner.description}"
+            runner.add_options!(op, options)
+          end
+
+          op.separator ""
+          op.on(
+            "--verbose",
+            "turn on verbosity"
+          ) { |v| options[:verbose] = true }
+
+          op.separator ""
+          op.on_tail("-h", "--help", "Show this message") { puts op; exit }
+          op.on_tail('-v', '--version', "Show version")   { puts I18nTemplate::VERSION; exit }
+        end
+
+        begin
+          option_parser.parse!(ARGV)
+        rescue OptionParser::ParseError => e
+          warn e.message
+          puts option_parser
+          exit 1
+        end
+
+        I18nTemplate.runners.each do |runner|
+          runner.default_options.each do |key, value|
+            options[key] = value unless options.key?(key)
+          end
+        end
+
+        command = ARGV.first
+
+        runner = I18nTemplate.runners.detect { |klass| klass.command == command }
+
+        unless runner
+          warn "Unknown command '#{command}'"
+          puts option_parser
+          exit 1
+        end
+
+        runner.new(options).run
+      end
+    end
+
+  end
+end