gettext_i18n_rails_js 0.0.9 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e826dcad9f42c2d8174bc464a82311b316452392
+  data.tar.gz: 903eea917ab8c3da12239881b08e4b535539f4d8
+SHA512:
+  metadata.gz: d01e882ca2b2d58357277a5248a24ef865ef939ea53d2233dd7d12ca5a6aeca495240e2ea77a859d667f23a61791c7016bc6a708bd3d880848e139fbf95c3dce
+  data.tar.gz: e4f0055692e3a56bc5383c0d84397f921d33437680a05b6cc84ad8dc67ad2eea5557363e278a97d24625a71d26883688617158015f3bc60ef3b32f19b0656047

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.1.0](https://github.com/webhippie/gettext_i18n_rails_js/releases/tag/v0.1.0) - 2015-02-24
+
+* Transfer from github.com/nubis/gettext_i18n_rails_js
+* Added TravisCI, Rubocop and Coveralls
+* Updated structure to my opinionated gem style
+* Changed default handlebars function to ```__```
+* Added extended ```gettext_i18n_rails_js.yml```

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+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.

data/README.md

@@ -1,49 +1,114 @@
 # GettextI18nRailsJs
-[![Build Status](https://secure.travis-ci.org/nubis/gettext_i18n_rails_js.png?branch=master)](https://travis-ci.org/nubis/gettext_i18n_rails_js)
 
-GettextI18nRailsJs extends [gettext_i18n_rails](https://github.com/grosser/gettext_i18n_rails) making your .po files available to client side javascript as JSON
+[![Gem Version](http://img.shields.io/gem/v/gettext_i18n_rails_js.svg)](https://rubygems.org/gems/gettext_i18n_rails_js)
+[![Build Status](https://secure.travis-ci.org/webhippie/gettext_i18n_rails_js.svg)](https://travis-ci.org/webhippie/gettext_i18n_rails_js)
+[![Code Climate](https://codeclimate.com/github/webhippie/gettext_i18n_rails_js.svg)](https://codeclimate.com/github/webhippie/gettext_i18n_rails_js)
+[![Test Coverage](https://codeclimate.com/github/webhippie/gettext_i18n_rails_js/badges/coverage.svg)](https://codeclimate.com/github/webhippie/gettext_i18n_rails_js)
+[![Dependency Status](https://gemnasium.com/webhippie/gettext_i18n_rails_js.svg)](https://gemnasium.com/webhippie/gettext_i18n_rails_js)
+
+Extends [gettext_i18n_rails](https://github.com/grosser/gettext_i18n_rails),
+making your .PO files available to client side javascript as JSON. It will find
+translations inside your .js, .coffee, .handlebars and .mustache files, then it
+will create JSON versions of your .PO files so you can serve them with the rest
+of your assets, thus letting you access all your translations offline from
+client side javascript.
+
+
+## Versions
+
+This gem is tested on the following versions:
+
+* Ruby
+  * 1.9.3
+  * 2.0.0
+  * 2.1.0
+* Rails
+  * 3.2.21
+  * 4.0.13
+  * 4.1.9
+  * 4.2.0
 
-It will find translations inside your .js and .coffee files, then it will create JSON versions of your .PO files so you can serve them with the rest of your assets, thus letting you access all your translations offline from client side javascript.
 
 ## Installation
 
-Requires rails 3.2 or later.
+```ruby
+gem "gettext_i18n_rails_js", "~> 1.0.0"
+```
+
+
+## Usage
+
+set up you rails application with gettext support as usual, afterwards just
+execute the following rake task to export your translations to JSON:
+
+```bash
+rake gettext:po_to_json
+```
+
+Per default this will reconstruct the ```locale/<lang>/app.po``` structure as
+javascript files inside ```app/assets/javascripts/locale/<lang>/app.js```
+
+The gem provides the [Jed](https://github.com/SlexAxton/Jed) library to use the
+generated javascript files. It also provides a global ```__``` function that
+maps to `Jed#gettext`. The Jed instance used by the client side ```__```
+function is pre-configured with the ```lang``` attribute specified in your main
+HTML tag. Before anything, make sure your page's HTML tag includes a valid
+```lang``` attribute, for example:
+
+```haml
+%html{ manifest: "", lang: I18n.locale }
+```
+
+Once you're sure your page is configured with a locale, then you should add
+both your javascript locale files and the provided javascripts to your
+application.js
+
+```js
+//= require_tree ./locale
+//= require gettext/all
+```
+
+The default function name is ```window.__```, to avoid conflicts with
+underscore.js. If you want to alias the function to something else in your
+javascript you should also instruct the javascript and coffeescript parser to
+look for a different function when finding your translations within the config
+file ```config/gettext_i18n_rails_js.yml```, these are valid available options:
+
+```yml
+output_path: "app/assets/javascripts/locale"
+handlebars_function: "__"
+javascript_function: "__"
+jed_options:
+  pretty: false
+```
 
-#### Add the following to your gemfile:
 
-    gem 'gettext_i18n_rails_js'
+## Todo
 
-## To convert your PO files into javascript files you can run:
+* More deep testing against multiple Rails versions
+* Extend the current test suite, especially handlebars
 
-    rake gettext:po_to_json
 
-This will reconstruct the `locale/<lang>/app.po` structure as javascript files inside `app/assets/javascripts/locale/<lang>/app.js`
+## Contributing
 
-## Using translations in your javascript
+Fork -> Patch -> Spec -> Push -> Pull Request
 
-The gem provides the Jed library to use the generated javascript files. (http://slexaxton.github.com/Jed/some) 
-It also provides a global `__` function that maps to `Jed#gettext`.
-The Jed instance used by the client side `__` function is pre-configured with the 'lang' specified in your main html tag.
-Before anything, make sure your page's html tag includes a valid 'lang' attribute, for example:
 
-    %html{:manifest => '', :lang => "#{I18n.locale}"}
+## Authors
 
-Once you're sure your page is configured with a locale, then you should add both your javascript locale files and the provided javascripts to your application.js
+* [Thomas Boerger](https://github.com/tboerger)
+* [Nubis](https://github.com/nubis)
+* [Other contributors](https://github.com/webhippie/gettext_i18n_rails_js/graphs/contributors)
 
-    //= require_tree ./locale 
-    //= require gettext/all
 
-## Avoiding conflicts with other libraries
+## License
 
-The default function name is 'window.__', to avoid conflicts with 'underscore.js'. If you want to alias the function to something
-else in your javascript you should also instruct the javascript and coffeescript parser to look for a different function
-when finding your translations:
+MIT
 
-lib/tasks/gettext.rake:
 
-    namespace :gettext do
-      def js_gettext_function
-        '_' #just revert to the traditional underscore.
-      end
-    end
+## Copyright
 
+```
+Copyright (c) 2012-2015 Dropmysite.com <https://dropmyemail.com>
+Copyright (c) 2015 Webhippie <http://www.webhippie.de>
+```

data/lib/gettext_i18n_rails_js.rb

@@ -1,6 +1,48 @@
-require 'gettext_i18n_rails'
-require 'gettext_i18n_rails_js/engine'
-require 'gettext_i18n_rails_js/js_and_coffee_parser' if RUBY_PLATFORM != 'java'
+# -*- 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.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+if File.exist? ENV["BUNDLE_GEMFILE"]
+  require "bundler"
+  Bundler.setup(:default)
+else
+  gem "rails", version: ">= 3.2.0"
+  gem "gettext", version: ">= 3.0.2"
+  gem "gettext_i18n_rails", version: ">= 0.7.1"
+  gem "po_to_json", version: ">= 0.1.0"
+end
+
+require "rails"
+require "gettext"
+require "gettext_i18n_rails"
+require "po_to_json"
+
+require_relative "gettext_i18n_rails_js/version"
+require_relative "gettext_i18n_rails_js/parser"
+require_relative "gettext_i18n_rails_js/engine"
 
 module GettextI18nRailsJs
 end

data/lib/gettext_i18n_rails_js/engine.rb

@@ -1,6 +1,28 @@
-# We need a rails engine so that the asset pipeline knows there are assets
-# provided by this gem
-require 'rails'
+# -*- 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
   module Rails
     class Engine < ::Rails::Engine

data/lib/gettext_i18n_rails_js/parser.rb

@@ -0,0 +1,33 @@
+# -*- 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_relative "parser/base"
+require_relative "parser/javascript"
+require_relative "parser/handlebars"
+
+module GettextI18nRailsJs
+  module Parser
+  end
+end

data/lib/gettext_i18n_rails_js/parser/base.rb

@@ -0,0 +1,111 @@
+# -*- 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"
+
+module GettextI18nRailsJs
+  module Parser
+    module Base
+      extend self
+
+      # The gettext function name can be configured at the module level as
+      # gettext_function. This is to provide a way to avoid
+      # conflicts with other javascript libraries. You only need to define
+      # the base function name to replace "_" and all the other variants
+      # (s_, n_, N_) will be deduced automatically.
+      attr_accessor :gettext_function
+
+      def gettext_function
+        @gettext_function ||= "__"
+      end
+
+      # We're lazy and klumsy, so this is a regex based parser that looks for
+      # invocations of the various gettext functions. Once captured, we scan
+      # them once again to fetch all the function arguments. Invoke regex
+      # captures like this:
+      #
+      # javascript source: "#{ __('hello') } #{ __("wor)ld") }"
+      # matches:
+      # [0]: __('hello')
+      # [1]: __
+      # [2]: 'hello'
+      #
+      # javascript source: __('item', 'items', 33)
+      # matches:
+      # [0]: __('item', 'items', 33)
+      # [1]: __
+      # [2]: 'item', 'items', 33
+      #
+      # handlebars source: "{{ _ "foo"}}"
+      # matches:
+      # [0]: __('foo')
+      # [1]: __
+      # [2]: 'foo'
+      #
+      # handlebars source: "{{ _ "foo" "foos" 3}}"
+      # matches:
+      # [0]: __('foo', 'foos', 3)
+      # [1]: __
+      # [2]: 'foo', 'foos', 3
+      def parse(file, _msgids = [])
+        collect_for(file) do |function, arguments, line|
+          key = arguments.scan(
+            /('(?:[^'\\]|\\.)*'|"(?:[^"\\]|\\.)*")/
+          ).collect do |match|
+            match.first[1..-2]
+          end.join(separator_for(function))
+
+          next if key == ""
+          results_for(key, file, line)
+        end
+      end
+
+      protected
+
+      def cleanup_value(value)
+        value
+          .gsub("\n", "\n")
+          .gsub("\t", "\t")
+          .gsub("\0", "\0")
+      end
+
+      def separator_for(value)
+        if value == "n#{gettext_function}"
+          "\000"
+        else
+          "\004"
+        end
+      end
+
+      def results_for(key, file, line)
+        [
+          cleanup_value(key),
+          [file, line].join(":")
+        ]
+      end
+    end
+  end
+end

data/lib/gettext_i18n_rails_js/parser/handlebars.rb

@@ -0,0 +1,84 @@
+# -*- 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 Handlebars
+      include Base
+      extend self
+
+      def target?(file)
+        [
+          /\.handlebars\Z/,
+          /\.handlebars.erb\Z/,
+          /\.hbs\Z/,
+          /\.hbs.erb\Z/,
+          /\.mustache\Z/,
+          /\.mustache.erb\Z/
+        ].any? { |regexp| file.match regexp }
+      end
+
+      protected
+
+      def collect_for(value)
+        ::File.read(
+          value
+        ).scan(invoke_regex).collect do |_whole, function, arguments|
+          yield(function, arguments, 1)
+        end.compact
+      end
+
+      def invoke_regex
+        #
+        # * Matches the function handlebars helper call grouping "{{"
+        # * A parenthesis to start the arguments to the function
+        # * Then double quote string
+        # * Remaining arguments
+        # * Function call closing parenthesis
+        #
+
+        /
+          \B[{]{2}(
+            ([snN]?#{gettext_function})
+            \s+
+            (
+              ".*?"
+              .*?
+            )
+          )
+          [}]{2}
+        /x
+      end
+    end
+  end
+end
+
+GettextI18nRails::GettextHooks.add_parser(
+  GettextI18nRailsJs::Parser::Handlebars
+)