gettext_i18n_rails_js 0.0.9 → 1.0.0

data/lib/gettext_i18n_rails_js/parser/javascript.rb

@@ -0,0 +1,100 @@
+# -*- coding: UTF-8 -*-
+#
+# Copyright (c) 2012-2015 Dropmysite.com <https://dropmyemail.com>
+# Copyright (c) 2015 Webhippie <http://www.webhippie.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+require "gettext/tools/xgettext"
+require "gettext_i18n_rails/gettext_hooks"
+require_relative "base"
+
+module GettextI18nRailsJs
+  module Parser
+    module Javascript
+      include Base
+      extend self
+
+      def target?(file)
+        [
+          ".js",
+          ".coffee"
+        ].include? ::File.extname(file)
+      end
+
+      protected
+
+      def collect_for(value)
+        ::File.new(
+          value
+        ).each_line.each_with_index.collect do |line, idx|
+          line.scan(invoke_regex).collect do |function, arguments|
+            yield(function, arguments, idx + 1)
+          end
+        end.inject(:+).compact
+      end
+
+      def invoke_regex
+        #
+        # * Matches the function call grouping the method used (__, n__, N__)
+        # * A parenthesis to start the arguments to the function.
+        # * There may be many arguments to the same function call
+        # * Then the last, or only argument to the function call.
+        # * Function call closing parenthesis
+        #
+
+        /
+          (\b[snN]?#{gettext_function})
+          \(
+            (
+              (#{arg_regex},)*
+              #{arg_regex}
+            )?
+          \)
+        /x
+      end
+
+      def arg_regex
+        #
+        # * Some whitespace
+        # * A token inside the argument list, like a single quoted string
+        # * Double quote string, both support escapes
+        # * A number, variable name, or called function lik: 33, foo, Foo.bar()
+        # * More whitespace
+        #
+
+        /
+          \s*
+          (
+            '(?:[^'\\]|\\.)*?'|
+            "(?:[^"\\]|\\.)*?"|
+            [a-zA-Z0-9_\.()]*?
+          )
+          \s*
+        /x
+      end
+    end
+  end
+end
+
+GettextI18nRails::GettextHooks.add_parser(
+  GettextI18nRailsJs::Parser::Javascript
+)

data/lib/gettext_i18n_rails_js/version.rb

@@ -1,3 +1,40 @@
+# -*- coding: UTF-8 -*-
+#
+# Copyright (c) 2012-2015 Dropmysite.com <https://dropmyemail.com>
+# Copyright (c) 2015 Webhippie <http://www.webhippie.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
 module GettextI18nRailsJs
-  VERSION = "0.0.9"
+  class Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    PRE = nil
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join(".")
+      end
+    end
+  end
 end

data/lib/tasks/gettext_i18n_rails_js_tasks.rake

@@ -1,7 +1,153 @@
-if RUBY_PLATFORM != 'java'
-  dir = File.dirname(__FILE__)
-  require File.join(dir, '../gettext_i18n_rails_js/js_and_coffee_parser')
-  require File.join(dir, '../gettext_i18n_rails_js/handlebars_parser')
-  require 'gettext_i18n_rails/tasks'
-  require File.join(dir, '../gettext_i18n_rails_js/tasks')
+# -*- coding: UTF-8 -*-
+#
+# Copyright (c) 2012-2015 Dropmysite.com <https://dropmyemail.com>
+# Copyright (c) 2015 Webhippie <http://www.webhippie.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+require "gettext_i18n_rails/tasks"
+
+namespace :gettext do
+  desc "Convert PO files to JS files"
+  task po_to_json: :environment do
+    GettextI18nRailsJs::Parser::Javascript
+      .gettext_function = config[:javascript_function]
+
+    GettextI18nRailsJs::Parser::Handlebars
+      .gettext_function = config[:handlebars_function]
+
+    if files_list.empty?
+      puts "Couldn't find PO files in #{locale_path}, run 'rake gettext:find'"
+    else
+      files_list.each do |input|
+        # Language is used for filenames, while language code is used as the
+        # in-app language code. So for instance, simplified chinese will live
+        # in app/assets/locale/zh_CN/app.js but inside the file the language
+        # will be referred to as locales['zh-CN']. This is to adapt to the
+        # existing gettext_rails convention.
+
+        language = input.dirname.basename.to_s
+        language_code = language.gsub("_", "-")
+
+        destination = output_path.join(language)
+        destination.mkpath
+
+        json = PoToJson.new(
+          input.to_s
+        ).generate_for_jed(
+          language_code,
+          config[:jed_options].symbolize_keys
+        )
+
+        destination.join("app.js").open("w") do |f|
+          f.rewind
+          f.write(json)
+        end
+
+        puts "Created app.js in #{destination}"
+      end
+
+      puts
+      puts "All files created, make sure they are being added to your assets."
+      puts "If they are not, you can add them with this line (configurable):"
+      puts
+      puts "//= require_tree ./locale"
+      puts "//= require gettext/all"
+      puts
+    end
+  end
+
+  def files_list
+    Pathname.glob(
+      ::File.join(
+        locale_path,
+        "**",
+        "*.po"
+      )
+    )
+  end
+
+  def output_path
+    Rails.root.join(
+      config[:output_path]
+    )
+  end
+
+  def config
+    @config ||= begin
+      file = Rails.root.join(
+        "config",
+        "gettext_i18n_rails_js.yml"
+      )
+
+      defaults = {
+        output_path: File.join(
+          "app",
+          "assets",
+          "javascripts",
+          "locale"
+        ),
+        handlebars_function: "__",
+        javascript_function: "__",
+        jed_options: {
+          pretty: false
+        }
+      }
+
+      if file.exist?
+        yaml = YAML.load_file(file) || {}
+
+        defaults.deep_merge(
+          yaml
+        ).with_indifferent_access
+      else
+        defaults.with_indifferent_access
+      end
+    end
+  end
+
+  # Required for gettext to filter the files
+  def files_to_translate
+    folders = [
+      "app",
+      "lib",
+      "config",
+      locale_path
+    ].join(",")
+
+    exts = [
+      "rb",
+      "erb",
+      "haml",
+      "slim",
+      "rhtml",
+      "js",
+      "coffee",
+      "handlebars",
+      "hbs",
+      "mustache"
+    ].join(",")
+
+    Dir.glob(
+      "{#{folders}}/**/*.{#{exts}}"
+    )
+  end
 end

data/spec/fixtures/example.coffee

@@ -0,0 +1,15 @@
+pepito = ->
+  string = "this" + __('json') + 'should be translated'
+  alert(n__('item', 'items', 3))
+
+example_template( __('Hello {yourname}'), { yourname: 'bob' })
+
+object =
+ one: N__('new-trans')
+ two: s__('namespaced', 'trans')
+
+"#{ __("Hello\nBuddy") }"
+
+"""
+  #{ __("Multi-line") }
+"""

data/spec/fixtures/example.handlebars

@@ -0,0 +1,11 @@
+<div class="content-main">
+  <div class="content-header">
+    <label>{{__ "Locale"}}</label>
+    <h1>{{__ "Profile"}}</h1>
+    <div class="btn-toolbar pull-right">
+      <div class="btn-group">
+        <a href="#" {{action "updateUser" target="controller"}} class="btn btn-success">{{__ "Update" "Updates" 2}}</a>
+      </div>
+    </div>
+  </div>
+</div>

data/spec/fixtures/example.js

@@ -0,0 +1,12 @@
+function pepito() {
+  var string = "this" + __('json') + 'should be translated';
+  alert(n__('item', 'items', 3));
+}
+
+example_template(__('Hello {yourname}'), { yourname: 'bob' });
+
+object = {
+  one: N__('new-trans'),
+  two: s__('namespaced', 'trans')
+  three: __("Hello\nBuddy")
+}

data/spec/gettext_i18n_rails_js/parser/handlebars_spec.rb

@@ -0,0 +1,301 @@
+# -*- coding: UTF-8 -*-
+#
+# Copyright (c) 2012-2015 Dropmysite.com <https://dropmyemail.com>
+# Copyright (c) 2015 Webhippie <http://www.webhippie.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+require "spec_helper"
+
+describe GettextI18nRailsJs::Parser::Handlebars do
+  let(:parser) { GettextI18nRailsJs::Parser::Handlebars }
+
+  describe "#target?" do
+    it "targets .handlebars" do
+      expect(parser.target?("foo/bar/xxx.handlebars")).to be_truthy
+    end
+
+    it "targets .handlebars.erb" do
+      expect(parser.target?("foo/bar/xxx.handlebars.erb")).to be_truthy
+    end
+    it "targets .hbs" do
+      expect(parser.target?("foo/bar/xxx.hbs")).to be_truthy
+    end
+
+    it "targets .hbs.erb" do
+      expect(parser.target?("foo/bar/xxx.hbs.erb")).to be_truthy
+    end
+
+    it "targets .mustache" do
+      expect(parser.target?("foo/bar/xxx.mustache")).to be_truthy
+    end
+
+    it "targets .mustache.erb" do
+      expect(parser.target?("foo/bar/xxx.mustache.erb")).to be_truthy
+    end
+
+    it "does not target cows" do
+      expect(parser.target?("foo/bar/xxx.cows")).to be_falsey
+    end
+  end
+
+  describe "#parse" do
+    it "finds plural messages" do
+      content = <<-EOF
+        <div>{{n__ "xxxx" "yyyy\" "zzzz" some_count}}</div>
+      EOF
+
+      with_file content do |path|
+        expect(parser.parse(path, [])).to(
+          eq(
+            [
+              ["xxxx\000yyyy\000zzzz", "#{path}:1"]
+            ]
+          )
+        )
+      end
+    end
+
+    it "finds namespaced messages" do
+      content = <<-EOF
+        <div>{{__ "xxxx", "yyyy"}}</div>
+      EOF
+
+      with_file content do |path|
+        expect(parser.parse(path, [])).to(
+          eq(
+            [
+              ["xxxx\004yyyy", "#{path}:1"]
+            ]
+          )
+        )
+      end
+    end
+
+    it "finds simple messages" do
+      content = <<-EOF
+        <div>{{__ "blah"}}</div>
+      EOF
+
+      with_file content do |path|
+        expect(parser.parse(path, [])).to(
+          eq(
+            [
+              ["blah", "#{path}:1"]
+            ]
+          )
+        )
+      end
+    end
+
+    # it "finds messages with newlines/tabs" do
+    #   content = <<-EOF
+    #     bla = __("xxxx\n\tfoo")
+    #   EOF
+
+    #   with_file content do |path|
+    #     expect(parser.parse(path, [])).to(
+    #       eq(
+    #         [
+    #           ["xxxx\n\tfoo", "#{path}:1"]
+    #         ]
+    #       )
+    #     )
+    #   end
+    # end
+
+    # it "finds messages with newlines/tabs (single quotes)" do
+    #   content = <<-EOF
+    #     bla = __('xxxx\n\tfoo')
+    #   EOF
+
+    #   with_file content do |path|
+    #     parser.parse(path, []).should == [
+    #       ["xxxx\n\tfoo", "#{path}:1"]
+    #     ]
+    #   end
+    # end
+
+    # it "finds interpolated multi-line messages" do
+    #   content = <<-EOF
+    #     """ Parser should grab
+    #       #{ __("This") } __("known bug")
+    #     """
+    #   EOF
+
+    #   with_file content do |path|
+    #     expect(parser.parse(path, [])).to(
+    #       eq(
+    #         [
+    #           ["This", "#{path}:3"],
+    #           ["known bug", "#{path}:3"]
+    #         ]
+    #       )
+    #     )
+    #   end
+    # end
+
+    # it "finds strings that use some templating" do
+    #   content = <<-EOF
+    #     __("hello {yourname}")
+    #   EOF
+
+    #   with_file content do |path|
+    #     expect(parser.parse(path, [])).to(
+    #       eq(
+    #         [
+    #           ["hello {yourname}", "#{path}:1"]
+    #         ]
+    #       )
+    #     )
+    #   end
+    # end
+
+    # it "finds strings that use escaped strings" do
+    #   content = <<-EOF
+    #     __("hello \"dude\"") + __('how is it \'going\' ')
+    #   EOF
+
+    #   with_file content do |path|
+    #     expect(parser.parse(path, [])).to(
+    #       eq(
+    #         [
+    #           ["hello \"dude\"", "#{path}:1"],
+    #           ["how is it 'going' ", "#{path}:1"]
+    #         ]
+    #       )
+    #     )
+    #   end
+    # end
+
+    # it "does not capture a false positive" do
+    #   content = <<-EOF
+    #     bla = this_should_not_be_registered__("xxxx", "yyyy")
+    #   EOF
+
+    #   with_file content do |path|
+    #     expect(parser.parse(path, [])).to(
+    #       eq(
+    #         []
+    #       )
+    #     )
+    #   end
+    # end
+
+    it "does not find nonstring messages" do
+      content = <<-EOF
+        <div>{{__ bar}}</div>
+      EOF
+
+      with_file content do |path|
+        expect(parser.parse(path, [])).to(
+          eq(
+            []
+          )
+        )
+      end
+    end
+
+    it "does not parse internal parentheses" do
+      content = <<-EOF
+        <div>
+          {{__ "text (which is great) and parentheses()"}}
+          {{__ "foobar"}}
+        </div>
+      EOF
+
+      with_file content do |path|
+        expect(parser.parse(path, [])).to(
+          eq(
+            [
+              ["text (which is great) and parentheses()", "#{path}:1"],
+              ["foobar", "#{path}:1"]
+            ]
+          )
+        )
+      end
+    end
+
+    # it "does not parse internal functions" do
+    #   content = <<-EOF
+    #     bla = n__("items (single)", "i (more)", item.count()) + __('foobar')
+    #   EOF
+
+    #   with_file content do |path|
+    #     parser.parse(path, []).should == [
+    #       ["items (single)\000i (more)", "#{path}:1"],
+    #       ['foobar', "#{path}:1"]
+    #     ]
+    #   end
+    # end
+  end
+
+  describe "parses handlebars files" do
+    let(:example) do
+      File.expand_path(
+        "../../../fixtures/example.handlebars",
+        __FILE__
+      )
+    end
+
+    let(:parsed_example) do
+      parser.parse(example, [])
+    end
+
+    it "parses all translations" do
+      expect(parsed_example.collect(&:first)).to(
+        eq(["Locale", "Profile", "Update\004Updates"])
+      )
+    end
+
+    it "parses the file paths" do
+      parsed_example.collect(&:last).each do |path|
+        expect(path).to end_with("fixtures/example.handlebars:1")
+      end
+    end
+
+    it "accepts changing the translate method" do
+      parser.gettext_function = "gettext"
+
+      content = <<-EOF
+        <div>
+          {{gettext \"Hello {yourname}\"}}
+          <span>
+            {{ngettext \"item\", \"items\", 44}}
+          </span>
+        </div>
+      EOF
+
+      with_file content do |path|
+        expect(parser.parse(path, [])).to(
+          eq(
+            [
+              ["Hello {yourname}", "#{path}:1"],
+              ["item\000items", "#{path}:1"]
+            ]
+          )
+        )
+      end
+
+      parser.gettext_function = "__"
+    end
+  end
+end