exvo_globalize 0.3.2 → 0.4.0

data/README.md

@@ -4,11 +4,13 @@ This gem lets you make use of the Globalize app (http://globalize.exvo.com/)
 to handle the translation of your Rails app into multiple languages.
 
 
+
 ## Requirements
 
 Rails 3.0+
 
 
+
 ## Installation
 
 Install the gem
@@ -29,14 +31,16 @@ bundle
 $ bundle
 ```
 
-and generate the database migration
+finally generate the database migration and the javascript library:
 
 ```bash
-$ rails generate exvo_globalize
+$ rails generate exvo_globalize:install
 ```
 
+If you don’t plan on using I18n in javascript you can just delete the generated `public/javascripts/exvo_globalize_i18n.js` file.
 
-It is advised to have your `/globalize/` actions behind an authorization barrier (besides `/globalize/translations.json`, which is by default publicly accessible).
+
+It is advised to have your `/globalize/` actions behind an authorization barrier (besides `/globalize/translations.json` and `/globalize/translations/js/*.js`, which are by default publicly accessible).
 Create a `config/initializers/exvo_globalize.rb` file with similar contents:
 
 ```ruby
@@ -50,6 +54,27 @@ I18n::Backend::GlobalizeStore.authenticator = proc {
 
 
 
+### Javascript support
+
+Basic support for I18n in the javascript is included. In order for it to work you need to include two javascript files in your application’s layout (the order is important):
+
+```ruby
+= javascript_include_tag 'exvo_globalize_i18n'
+= i18n_translations_javascript_include_tag(I18n.locale)
+```
+
+
+Now you can use translations inside your javascript:
+
+```js
+t("new")
+=> "New"
+```
+
+The above, of course, expects you to have the `:new` key for the current `I18n.locale` in one of your `config/locales/*.yml` files.
+
+
+
 ## Getting back your database stored translations
 
 If you wish to extract your database stored translations to a separate YAML/Ruby file, there are two rake task to help you with that:
@@ -89,4 +114,29 @@ And pressing `Update translations`.
 
 
 
+## Running the tests
+
+Running tests via `Guard` is the recommended way:
+
+```bash
+$ bundle exec guard
+```
+
+But tests can be run separately as well:
+
+```bash
+$ bundle exec rspec spec
+```
+
+and
+
+```bash
+$ jasmine-headless-webkit -c
+```
+
+There is a great guide for setting up `jasmine-headless-webkit` in your OS if you have problems with it:
+http://johnbintz.github.com/jasmine-headless-webkit/
+
+
+
 Copyright © 2011 Exvo.com Development BV, released under the MIT license

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler/gem_tasks'
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
+import 'lib/tasks/jasmine.rake'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end

data/app/assets/javascripts/exvo_globalize_i18n.js

@@ -0,0 +1,90 @@
+var I18n = (function() {
+    // Replace {{foo}} with obj.foo
+    function interpolate(string, object) {
+        return string.replace(/\{\{([^}]+)\}\}/g, function() {
+            return object[arguments[1]] || arguments[0];
+        });
+    };
+
+    // Split "foo.bar" to ["foo", "bar"] if key is a string
+    function keyToArray(key) {
+        if(!key) {
+            return [];
+        }
+        if(typeof key != "string") {
+            return key;
+        }
+        return key.split('.');
+    };
+
+    // Looks up a translation using an array of strings where the last
+    // is the key and any string before that define the scope. The
+    // current locale is always prepended and does not need to be
+    // provided. The second parameter is an array of strings used as
+    // defaults if the key can not be found. If a key starts with ":"
+    // it is used as a key for lookup. This method does not perform
+    // pluralization or interpolation.
+    function lookup(keys, defaults) {
+        var i = 0, value = I18n.translations;
+        defaults = (typeof defaults === "string") ? [defaults] : (defaults || []);
+        while(keys[i]) {
+            value = value && value[keys[i]];
+            i++;
+        }
+        if(value) {
+            return value;
+        } else {
+            if(defaults.length === 0) {
+                return null;
+            } else if (defaults[0].substr(0,1) === ':') {
+                return lookup(keys.slice(0, keys.length - 1).concat(keyToArray(defaults[0].substr(1))), defaults.slice(1));
+            } else {
+                return defaults[0];
+            }
+        }
+    };
+
+    // Returns other when 0 given
+    function pluralize(value, count) {
+        if(count === undefined) return value;
+        return count === 1 ? value.one : value.other;
+    };
+
+    // Works mostly the same as the Ruby equivalent, except there are
+    // no symbols in JavaScript, so keys are always strings. The only
+    // time this makes a difference is when differentiating between
+    // keys and values in the defaultValue option. Strings starting
+    // with ":" will be considered to be keys and used for lookup,
+    // while other strings are returned as-is.
+    function translate(key, options) {
+        if(typeof key != "string") {
+            // Bulk lookup
+            var a = [], i;
+            for(i = 0; i < key.length; i++) {
+                a.push(translate(key[i], options));
+            }
+            return a;
+        } else {
+            options = options || {};
+            options.defaultValue = options.defaultValue || null;
+            key = keyToArray(options.scope).concat(keyToArray(key));
+            var value = lookup(key, options.defaultValue);
+            if(typeof value !== "string" && value) {
+                value = pluralize(value, options.count);
+            }
+            if(typeof value === "string") {
+                value = interpolate(value, options);
+            }
+            return value;
+        }
+    }
+
+    return {
+        translate: translate,
+        t: translate
+    };
+})();
+
+var t = (function(key, options) {
+  return I18n.t(key, options);
+});

data/app/controllers/globalize_translations_controller.rb

@@ -5,10 +5,16 @@ class GlobalizeTranslationsController < ApplicationController
 
   layout 'exvo_globalize'
 
-  respond_to :html, :json
-
+  respond_to :html, :json, :js
+  
   def show
-    @translations = I18n.backend.available_app_translations.merge({ :default_locale => I18n.default_locale })
+    @translations = if params[:id].present?
+        hash = I18n.backend.available_translations
+        hash.has_key?(params[:id].to_sym) ? hash[params[:id].to_sym] : {}
+      else
+        I18n.backend.available_app_translations.merge({ :default_locale => I18n.default_locale })
+      end
+
     respond_with @translations
   end
 
@@ -46,10 +52,10 @@ class GlobalizeTranslationsController < ApplicationController
   end
 
   private
-
+  
   def globalize_translations_authenticator
-    # get :show as JSON does not require authentication
-    return if params[:action].to_s == 'show' and request.format.json?
+    # get :show as JSON or JS does not require authentication
+    return if params[:action].to_s == 'show' and (request.format.json? or request.format.js?)
 
     # call custom authenticator method if available
     if I18n::Backend::GlobalizeStore.authenticator && I18n::Backend::GlobalizeStore.authenticator.respond_to?(:call)

data/app/views/globalize_translations/show.js.erb

@@ -0,0 +1,4 @@
+var I18n = I18n || {};
+I18n.locale = I18n.locale || '<%= I18n.locale %>';
+I18n.default_locale = I18n.locale || '<%= I18n.default_locale %>';
+I18n.translations = I18n.translations || <%= ActiveSupport::JSON.encode(@translations).html_safe %>;

data/config/routes.rb

@@ -1,7 +1,8 @@
 Rails.application.routes.draw do
   scope '/globalize' do
     resource :translations, :only => [:show, :update], :as => 'globalize_translations', :controller => 'globalize_translations' do
-      get :list, :on => :collection
+      resources :js, :only => [:show], :as => 'javascript', :controller => 'globalize_translations'
+      get :list
     end
   end
 end

data/exvo_globalize.gemspec

@@ -25,8 +25,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'awesome_print', ['>= 0.3.2']
   s.add_dependency 'ya2yaml', ['>= 0.30']
   s.add_dependency 'httparty', ['>= 0.6.1']
-  s.add_development_dependency 'guard', ['>= 0.5.0']
-  s.add_development_dependency 'guard-rspec', ['>= 0.4.0']
   s.add_development_dependency 'sqlite3', ['>= 1.3']
   s.add_development_dependency 'rspec', ['>= 2.6']
   s.add_development_dependency 'rspec-rails', ['>= 2.6']
@@ -34,4 +32,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'shoulda-matchers', ['>= 1.0.0.beta3']
   s.add_development_dependency 'capybara', ['>= 1.0.0']
   s.add_development_dependency 'json', ['>= 1.5.1']
+  s.add_development_dependency 'jasmine-headless-webkit'
+  s.add_development_dependency 'therubyracer'
+  s.add_development_dependency 'guard', ['>= 0.5.0']
+  s.add_development_dependency 'guard-rspec', ['>= 0.4.0']
+  s.add_development_dependency 'guard-jasmine-headless-webkit'
 end

data/lib/exvo_globalize/backend/chain.rb

@@ -18,13 +18,13 @@ module I18n
           # load only app translations (Simple I18n backend)
           I18n.load_path = Dir.glob(File.join(Rails.root, 'config/locales', '**', '*.{yml,rb}'))
           simple.reload!
-          simple.load_translations
+          simple.send(:init_translations)
           translations = simple.available_translations
 
           # restore original translations
           I18n.load_path = load_path
           simple.reload!
-          simple.load_translations
+          simple.send(:init_translations)
 
           # return app's translations
           translations

data/lib/exvo_globalize/backend/simple.rb

@@ -6,6 +6,11 @@ module I18n
         # Extend the Simple backend with a custom `available_translations` method
         # returning a combined hash with all translations from this backend
         def available_translations
+          # simple backend is lazy loaded (woken up by first I18n.t() call)
+          # wake it up if it's still sleeping
+          send(:init_translations) unless initialized?
+
+          # nested Hash with all translations
           send(:translations)
         end
       end

data/lib/exvo_globalize/helpers.rb

@@ -28,5 +28,10 @@ module ExvoGlobalize
       out += " " * indent_level + "</ul>\n"
     end
 
+    # Outputs the javascript include tag with translations in the selected language (locale param) in the js format
+    def i18n_translations_javascript_include_tag(locale)
+      javascript_include_tag("/globalize/translations/js/#{locale}.js")
+    end
+
   end
 end

data/lib/exvo_globalize/version.rb

@@ -1,3 +1,3 @@
 module ExvoGlobalize
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/generators/exvo_globalize/install_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators'
+
+module ExvoGlobalize
+
+  # Creates a new migration adding the translations table to the application
+  # and copies the exvo_globalize_i18n.js to public/javascripts/ (for Rails 3.0.x)
+  #
+  # @example
+  # $ rails generate exvo_globalize:install
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    class_option :template_engine
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    desc "Add a 'create_globalize_translations' migration"
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_globalize_translations.rb'
+    end
+
+    if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
+      desc "Copy the exvo_globalize_i18n.js to public/javascripts/"
+      def copy_javascript_library
+        template '../../../../app/assets/javascripts/exvo_globalize_i18n.js', 'public/javascripts/exvo_globalize_i18n.js'
+      end
+    end
+  end
+
+end

data/lib/tasks/jasmine.rake

@@ -0,0 +1,8 @@
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/spec/controllers/globalize_translations_controller_spec.rb

@@ -6,6 +6,26 @@ describe GlobalizeTranslationsController do
   render_views
   let(:page) { Capybara::Node::Simple.new(@response.body) }
 
+  context "JS" do
+
+    describe "GET :show" do
+      before do
+        get :show, :format => :js, :id => 'en'
+      end
+
+      specify { response.content_type.should eq(Mime::JS) }
+
+      it "returns a hash" do
+        assigns(:translations).should be_a(Hash)
+      end
+
+      it "returns a hash with translations" do
+        assigns(:translations)[:name].should eq("YAML Name")
+      end
+    end
+
+  end
+
   context "JSON" do
 
     describe "GET :show" do

data/spec/javascripts/exvo_globalize_i18n_spec.js

@@ -0,0 +1,7 @@
+describe("Translation", function() {
+
+  it("should translate the phrase using the t() function", function() {
+    expect(t("new")).toEqual("New")
+  })
+
+})

data/spec/javascripts/fixtures/translations.js

@@ -0,0 +1,2 @@
+I18n.locale = 'en'
+I18n.translations = { "new": "New" }

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,8 @@
+src_files:
+  - app/assets/javascripts/exvo_globalize_i18n.js
+  - spec/javascripts/fixtures/translations.js
+
+spec_files:
+  - '**/*[sS]pec.js'
+
+spec_dir: spec/javascripts

data/spec/spec_helper.rb

@@ -24,6 +24,6 @@ RSpec.configure do |config|
     CreateGlobalizeTranslations.up unless ActiveRecord::Base.connection.table_exists? 'globalize_translations'
   end
 
-  # run each spec within a transactions
+  # run each spec within a transaction
   config.use_transactional_fixtures = true
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exvo_globalize
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Go\xC5\x9Bcicki"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-06 00:00:00 +02:00
+date: 2011-09-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,42 +113,10 @@ dependencies:
         version: 0.6.1
   type: :runtime
   version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: guard
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 5
-        - 0
-        version: 0.5.0
-  type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 4
-        - 0
-        version: 0.4.0
-  type: :development
-  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: sqlite3
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -159,11 +127,11 @@ dependencies:
         - 3
         version: "1.3"
   type: :development
-  version_requirements: *id009
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -174,11 +142,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id010
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rspec-rails
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -189,11 +157,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id011
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: factory_girl_rails
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -205,11 +173,11 @@ dependencies:
         - 0
         version: 1.1.0
   type: :development
-  version_requirements: *id012
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: shoulda-matchers
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -223,11 +191,11 @@ dependencies:
         - 3
         version: 1.0.0.beta3
   type: :development
-  version_requirements: *id013
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: capybara
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -239,11 +207,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id014
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id015 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -255,7 +223,81 @@ dependencies:
         - 1
         version: 1.5.1
   type: :development
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: jasmine-headless-webkit
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
+  name: therubyracer
+  prerelease: false
+  requirement: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
   version_requirements: *id015
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id016
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id017
+- !ruby/object:Gem::Dependency 
+  name: guard-jasmine-headless-webkit
+  prerelease: false
+  requirement: &id018 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id018
 description: It exposes `/globalize/translations.json` with JSON of all translations in the app
 email: 
 - pawel.goscicki@gmail.com
@@ -272,11 +314,13 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/exvo_globalize_i18n.js
 - app/controllers/globalize_translations_controller.rb
 - app/models/globalize_translation.rb
 - app/views/globalize_translations/_flash_messages.html.haml
 - app/views/globalize_translations/list.html.haml
 - app/views/globalize_translations/show.html.haml
+- app/views/globalize_translations/show.js.erb
 - app/views/layouts/exvo_globalize.html.haml
 - config/locales/ar.yml
 - config/locales/bg.yml
@@ -342,9 +386,10 @@ files:
 - lib/exvo_globalize/globalize_app.rb
 - lib/exvo_globalize/helpers.rb
 - lib/exvo_globalize/version.rb
-- lib/generators/exvo_globalize/exvo_globalize_generator.rb
+- lib/generators/exvo_globalize/install_generator.rb
 - lib/generators/exvo_globalize/templates/migration.rb
 - lib/tasks/dump.rake
+- lib/tasks/jasmine.rake
 - spec/app.rb
 - spec/controllers/globalize_translations_controller_spec.rb
 - spec/exvo_globalize/caching_spec.rb
@@ -355,6 +400,9 @@ files:
 - spec/factories.rb
 - spec/fixtures/locales/en.yml
 - spec/fixtures/locales/pl.yml
+- spec/javascripts/exvo_globalize_i18n_spec.js
+- spec/javascripts/fixtures/translations.js
+- spec/javascripts/support/jasmine.yml
 - spec/models/globalize_translation_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true

data/lib/generators/exvo_globalize/exvo_globalize_generator.rb

@@ -1,23 +0,0 @@
-require 'rails/generators'
-
-class ExvoGlobalizeGenerator < Rails::Generators::Base
-  desc "Add a 'create_globalize_translations' migration"
-
-  include Rails::Generators::Migration
-
-  def self.source_root
-    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
-  end
-
-  def self.next_migration_number(dirname)
-    if ActiveRecord::Base.timestamped_migrations
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
-    else
-      "%.3d" % (current_migration_number(dirname) + 1)
-    end
-  end
-
-  def create_migration_file
-    migration_template 'migration.rb', 'db/migrate/create_globalize_translations.rb'
-  end
-end