exvo_globalize 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -1,7 +1,48 @@
 # Exvo Globalize
 
-This plugin lets you make use of the Globalize app (http://store.exvo.com/teams/companies/globalize/positions/translator)
+This plugin lets you make use of the Globalize app (http://globalize.exvo.com/)
 to handle the translation of your Rails app into multiple languages.
 
 
+## Installation
+
+Install the gem
+
+```bash
+$ gem install exvo_globalize
+```
+
+add it to the Gemfile
+
+```ruby
+gem 'exvo_globalize'
+```
+
+bundle
+
+```bash
+$ bundle
+```
+
+and generate the database migration
+
+```bash
+$ rails generate exvo_globalize
+```
+
+
+Is is advised to have your `/globalize/` actions behind an authorization barrier (besides `/globalize/translations.json`, which is by default publicly accessible).
+Create a `config/initializers/exvo_globalize.rb` file with similar contents:
+
+```ruby
+I18n::Backend::GlobalizeStore.authenticator = proc {
+  authenticate_user!
+  require_admin!
+}
+```
+
+`authenticate_user!` and `require_admin!` are just exemplary authorization actions.
+
+
+
 Copyright © 2011 Exvo.com Development BV, released under the MIT license

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/app/controllers/globalize_translations_controller.rb

@@ -1,8 +1,28 @@
 class GlobalizeTranslationsController < ApplicationController
-  respond_to :json
+
+  before_filter :globalize_translations_authenticator, :except => [:index]
+
+  # get :index as JSON should not require authentication
+  before_filter(:only => :index) do |controller|
+    globalize_translations_authenticator unless controller.request.format.json?
+  end
+
+  layout false
+
+  respond_to :html, :json
 
   def index
     # returns {"default_locale":"en","pl":{"hello.world":"Witaj \u015bwiecie","hello.earth":"Witaj ziemio"},"en":{"hello.world":"Hello world","hello.earth":"Hello Earth"}}
-    respond_with I18n.backend.available_translations.merge({ :default_locale => I18n.default_locale })
+    @translations = I18n.backend.available_translations.merge({ :default_locale => I18n.default_locale })
+    respond_with @translations
   end
+
+  private
+
+  def globalize_translations_authenticator
+    if I18n::Backend::GlobalizeStore.authenticator && I18n::Backend::GlobalizeStore.authenticator.respond_to?(:call)
+      I18n::Backend::GlobalizeStore.authenticator.bind(self).call
+    end
+  end
+
 end

data/config/routes.rb

@@ -1,5 +1,7 @@
 Rails.application.routes.draw do
   scope '/globalize' do
-    resources :translations, :only => [:index], :as => 'globalize_translations', :controller => 'globalize_translations'
+    resources :translations, :only => [:index], :as => 'globalize_translations', :controller => 'globalize_translations' do
+      put :update_many, :on => :collection
+    end
   end
 end

data/exvo_globalize.gemspec

@@ -21,4 +21,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails', ['>= 3.0.0']
   s.add_dependency 'i18n', ['>= 0.5.0']
+  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']
+  s.add_development_dependency 'factory_girl_rails', ['>= 1.1.0']
+  s.add_development_dependency 'shoulda-matchers', ['>= 1.0.0.beta3']
+  s.add_development_dependency 'json', ['>= 1.5.1']
 end

data/lib/exvo_globalize.rb

@@ -1,6 +1,9 @@
 require "exvo_globalize/version"
-require "exvo_globalize/globalize_store"
+require "exvo_globalize/backend/chain"
+require "exvo_globalize/backend/globalize_store"
+require "exvo_globalize/backend/simple"
 
+# Make it a Rails engine
 module ExvoGlobalize
   require 'exvo_globalize/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
 end

data/lib/exvo_globalize/backend/chain.rb

@@ -0,0 +1,30 @@
+module I18n
+  module Backend
+    class Chain
+      module Implementation
+
+        # Extend the Chain backend with a custom `available_translations` method
+        # returning a combined hash with translations from all chained backends
+        def available_translations
+          # reverse, so that the translations from the first backend (GlobalizeStore) overwrite/overshadow others
+          backends.map { |backend| backend.available_translations }.reverse.inject(&:merge)
+        end
+
+        # add the simplest possible fallback to the I18n.default_locale for missing translations
+        def translate_with_fallback(locale, key, default_options = {})
+          begin
+            # will look for a translation in all backends (using requested locale)
+            translate_without_fallback(locale, key, default_options)
+          rescue I18n::MissingTranslationData
+            # if it does not find a translation it will look again in all backends, but using I18n.default_locale as a locale
+            translate_without_fallback(I18n.default_locale, key, default_options)
+          end
+        end
+
+        alias_method_chain :translate, :fallback
+      end
+
+      include Implementation
+    end
+  end
+end

data/lib/exvo_globalize/{globalize_store.rb → backend/globalize_store.rb}

@@ -3,6 +3,9 @@ module I18n
     class GlobalizeStore
       # based on https://github.com/svenfuchs/i18n-active_record/blob/master/lib/i18n/backend/active_record.rb
 
+      # Authentication proc
+      cattr_accessor :authenticator
+
       module Implementation
         include Base, Flatten
 
@@ -24,11 +27,15 @@ module I18n
         def store_translations(locale, data, options = {})
           escape = options.fetch(:escape, true)
           flatten_translations(locale, data, escape, false).each do |key, value|
-            GlobalizeTranslation.locale(locale).lookup(expand_keys(key)).delete_all
-            GlobalizeTranslation.create(:locale => locale.to_s, :key => key.to_s, :value => value)
+            store_flatten_translation(locale, key, value)
           end
         end
 
+        def store_flatten_translation(locale, key, value)
+          GlobalizeTranslation.locale(locale).lookup(expand_keys(key)).delete_all
+          GlobalizeTranslation.create(:locale => locale.to_s, :key => key.to_s, :value => value)
+        end
+
         protected
 
         def lookup(locale, key, scope = [], options = {})

data/lib/exvo_globalize/backend/simple.rb

@@ -0,0 +1,16 @@
+module I18n
+  module Backend
+    class Simple
+      module Implementation
+
+        # Extend the Simple backend with a custom `available_translations` method
+        # returning a combined hash with all translations from this backend
+        def available_translations
+          send(:translations)
+        end
+      end
+
+      include Implementation
+    end
+  end
+end

data/lib/exvo_globalize/engine.rb

@@ -5,8 +5,8 @@ require "i18n"
 module ExvoGlobalize
   class Engine < Rails::Engine
     initializer "exvo_globalize.configure_i18n" do |app|
-      # database backed store
-      I18n.backend = I18n::Backend::GlobalizeStore.new
+      # chained backends; GlobalizeStore (database backed) first, then YAML files (fallback)
+      I18n.backend = I18n::Backend::Chain.new(I18n::Backend::GlobalizeStore.new, I18n.backend)
 
       # caching layer
       I18n::Backend::GlobalizeStore.send(:include, I18n::Backend::Cache)

data/lib/exvo_globalize/version.rb

@@ -1,3 +1,3 @@
 module ExvoGlobalize
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/exvo_globalize/exvo_globalize_generator.rb

@@ -0,0 +1,23 @@
+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

data/lib/generators/exvo_globalize/templates/migration.rb

@@ -0,0 +1,16 @@
+class CreateGlobalizeTranslations < ActiveRecord::Migration
+  def self.up
+    create_table :globalize_translations do |t|
+      t.string :locale
+      t.string :key
+      t.text :value
+      t.text :interpolations
+      t.boolean :is_proc, :default => false
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :globalize_translations
+  end
+end

data/spec/app.rb

@@ -0,0 +1,41 @@
+require 'active_record'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+# database
+ActiveRecord::Base.configurations = { 'test' => { :adapter => 'sqlite3', :database => ':memory:' } }
+ActiveRecord::Base.establish_connection 'test'
+
+# config
+app = Class.new(Rails::Application)
+app.config.secret_token = "aoijg543oi2u88923j4fnvfjt529hg92"
+app.config.session_store :cookie_store, :key => "_exvo_globalize_session"
+app.config.active_support.deprecation = :log
+app.config.i18n.default_locale = :en
+app.initialize!
+
+# application controller
+class ApplicationController < ActionController::Base
+  def require_admin
+     redirect_to '/403.html', :status => 403 unless @current_user && @current_user.admin?
+  end
+end
+
+# custom authentication
+I18n::Backend::GlobalizeStore.authenticator = proc {
+  require_admin
+}
+
+# migration
+class CreateGlobalizeTranslations < ActiveRecord::Migration
+  def self.up
+    create_table :globalize_translations do |t|
+      t.string :locale
+      t.string :key
+      t.text :value
+      t.text :interpolations
+      t.boolean :is_proc, :default => false
+      t.timestamps
+    end
+  end
+end

data/spec/controllers/globalize_translations_controller_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'json'
+
+describe GlobalizeTranslationsController do
+
+  let(:i18n_title) { Factory(:i18n_title) }
+
+  context "JSON" do
+
+    describe "GET :index" do
+
+      let(:translations) do
+        i18n_title # needed so there is some data in the database before a call to get :index
+        get :index, :format => :json
+        JSON.parse(response.body)
+      end
+
+      it "returns a non-empty JSON" do
+        translations.present?.should be_true
+      end
+
+      it "returns a JSON with default_locale" do
+        translations["default_locale"].should eq(I18n.default_locale.to_s)
+      end
+
+      it "returns a JSON with translations" do
+        i18n_title.value.should eq(translations["en"]["title"])
+      end
+
+    end
+
+  end
+
+  context "HTML" do
+
+    describe "GET :index" do
+
+      context "without being logged in" do
+        before do
+          get :index, :format => :html
+        end
+
+        it { should respond_with(:forbidden) }
+      end
+
+      context "when being logged in as admin" do
+        before do
+          controller.stub!(:require_admin).and_return(true)
+          get :index, :format => :html
+        end
+
+        it { should respond_with(:success) }
+      end
+
+    end
+
+  end
+
+end

data/spec/factories.rb

@@ -0,0 +1,23 @@
+Factory.define :i18n_example, :class => GlobalizeTranslation do |u|
+  u.locale 'en'
+  u.key    'example'
+  u.value  'This is an example'
+end
+
+Factory.define :i18n_nested_example, :class => GlobalizeTranslation do |u|
+  u.locale 'en'
+  u.key    'nested.example'
+  u.value  'This is a nested example'
+end
+
+Factory.define :i18n_title, :class => GlobalizeTranslation do |u|
+  u.locale 'en'
+  u.key    'title'
+  u.value  'This is a title'
+end
+
+Factory.define :i18n_title_pl, :class => GlobalizeTranslation do |u|
+  u.locale 'pl'
+  u.key    'title'
+  u.value  'To jest tytuł'
+end

data/spec/fixtures/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  name: YAML Name
+  title: YAML Title
+
+  yaml:
+    title: YAML Title

data/spec/integration/caching_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ExvoGlobalize do
+
+  let(:i18n_example) { Factory(:i18n_example) }
+
+  it "caches translations in memory" do
+    old = I18n.translate(:example)
+    new = 'New example'
+
+    i18n_example.update_attributes(:value => new)
+    i18n_example.reload
+    i18n_example.value.should eq(new)
+
+    I18n.translate(:example).should eq(old)
+  end
+
+end

data/spec/integration/exvo_globalize_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe ExvoGlobalize do
+
+  I18n.load_path = ['spec/fixtures/locales/en.yml']
+
+  let(:i18n_example) { Factory(:i18n_example) }
+  let(:i18n_nested_example) { Factory(:i18n_nested_example) }
+  let(:i18n_title) { Factory(:i18n_title) }
+
+  it "respects the default_locale setting" do
+    I18n.default_locale.should eq(:en)
+  end
+
+  it "provides a valid translation for a given key" do
+    i18n_example.value.should eq(I18n.t(:example))
+  end
+
+  it "provides a valid translation for a scoped key" do
+    i18n_nested_example.value.should eq(I18n.t(:example, :scope => [:nested]))
+  end
+
+  context "translation storage" do
+    let(:hello_world) { 'Hello world' }
+    let(:hello_earth) { 'Hello Earth' }
+    let(:globalize_store_backend) { I18n.backend.backends.detect { |backend| backend.is_a?(I18n::Backend::GlobalizeStore) } }
+
+    it "stores nested translations in the GlobalizeStore backend" do
+      globalize_store_backend.store_translations(I18n.locale, { :hello => { :world => hello_world} })
+      I18n.translate('hello.world').should eql(hello_world)
+    end
+
+    it "stores flatten translation in the GlobalizeStore backend" do
+      globalize_store_backend.store_flatten_translation(I18n.locale, 'hello.earth', hello_earth)
+      I18n.translate(:earth, :scope => [:hello]).should eql(hello_earth)
+    end
+  end
+
+  it "falls back to the YAML file if the translation is missing in the GlobalizeStore backend (db)" do
+    I18n.translate('yaml.title').should eq('YAML Title')
+  end
+
+  it "prioritizes the translations from GlobalizeStore backend (db) over others" do
+    i18n_title.value.should eq(I18n.translate(:title))
+  end
+
+  it "lists available_translations from the Simple backend (YAML files)" do
+    simple_backend = I18n.backend.backends.detect { |backend| backend.is_a?(I18n::Backend::Simple) }
+    simple_backend.available_translations[:en][:title].should eq('YAML Title')
+  end
+
+end

data/spec/integration/locale_fallback_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ExvoGlobalize do
+
+  I18n.load_path = ['spec/fixtures/locales/en.yml']
+
+  let(:i18n_example) { Factory(:i18n_example) }
+
+  context "locale fallbacks" do
+
+    before { I18n.locale = :pt }
+
+    it "has set a different locale than the default one" do
+      I18n.locale.should_not be_eql(I18n.default_locale)
+    end
+
+    it "uses translation from the GlobalizeStore backend" do
+      i18n_example.value.should eql(I18n.translate(:example))
+    end
+
+    it "uses translation from the Simple backend if it is not found in the GlobalizeTranslation backend" do
+      simple_backend = I18n.backend.backends.detect { |backend| backend.is_a?(I18n::Backend::Simple) }
+      simple_backend.translate(I18n.default_locale, :name).should eql(I18n.translate(:name))
+    end
+
+    after { I18n.locale = I18n.default_locale }
+
+  end
+
+end

data/spec/models/globalize_translation_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe GlobalizeTranslation do
+
+  let(:i18n_title) { Factory(:i18n_title) }
+  let(:i18n_title_pl) { Factory(:i18n_title_pl) }
+
+  it "has a :title key" do
+    i18n_title.key.should eql('title')
+  end
+
+  it "returns all translations for all locales" do
+    [i18n_title, i18n_title_pl].map(&:value).should =~ GlobalizeTranslation.lookup(:title).map(&:value)
+  end
+
+  it "returns a translation for scoped locale" do
+    i18n_title.value.should eq(GlobalizeTranslation.locale('en').lookup(:title).first.value)
+  end
+
+  it "lists available locales" do
+    [i18n_title, i18n_title_pl].map(&:locale).map(&:to_sym).should =~ GlobalizeTranslation.available_locales
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'rails'
+require 'exvo_globalize'
+
+require File.join(File.dirname(__FILE__), 'app')
+
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'shoulda-matchers'
+
+# Requires supporting ruby files with custom matchers and macros, etc.
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  # run migrations
+  config.before :all do
+    CreateGlobalizeTranslations.up unless ActiveRecord::Base.connection.table_exists? 'globalize_translations'
+  end
+
+  # run each spec within a transactions
+  config.use_transactional_fixtures = true
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exvo_globalize
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Go\xC5\x9Bcicki"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-29 00:00:00 +02:00
+date: 2011-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,133 @@ dependencies:
         version: 0.5.0
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !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: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !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: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: factory_girl_rails
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: shoulda-matchers
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196357
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta
+        - 3
+        version: 1.0.0.beta3
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  version_requirements: *id010
 description: It exposes `/globalize/translations.json` with JSON of all translations in the app
 email: 
 - pawel.goscicki@gmail.com
@@ -61,18 +188,33 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
 - app/controllers/globalize_translations_controller.rb
 - app/models/globalize_translation.rb
+- app/views/globalize_translations/index.html
 - config/routes.rb
 - exvo_globalize.gemspec
 - lib/exvo_globalize.rb
+- lib/exvo_globalize/backend/chain.rb
+- lib/exvo_globalize/backend/globalize_store.rb
+- lib/exvo_globalize/backend/simple.rb
 - lib/exvo_globalize/engine.rb
-- lib/exvo_globalize/globalize_store.rb
 - lib/exvo_globalize/version.rb
+- lib/generators/exvo_globalize/exvo_globalize_generator.rb
+- lib/generators/exvo_globalize/templates/migration.rb
+- spec/app.rb
+- spec/controllers/globalize_translations_controller_spec.rb
+- spec/factories.rb
+- spec/fixtures/locales/en.yml
+- spec/integration/caching_spec.rb
+- spec/integration/exvo_globalize_spec.rb
+- spec/integration/locale_fallback_spec.rb
+- spec/models/globalize_translation_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/Exvo/exvo_globalize
 licenses: