lost_in_translations 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcda78e45d1191420fb5863127b77c5315fa7b46
-  data.tar.gz: 6cdf234915545512aac5e751a692986454fcfe27
+  metadata.gz: 29ebb7845e6d024febce53bff8436ac9797c75b9
+  data.tar.gz: aaffaef479abb13f14eb6c84de725c28f4af50c4
 SHA512:
-  metadata.gz: 55dd44bafc0005398321643ca0b44cef0ede2dd18365735809aceeeb06acec6e0a0b8201eba40380d2fe0b552738d317633ae9a3d8f6699fd667ba1e817f0bc2
-  data.tar.gz: c73c4f621cf6dc45e67fe3ba2901319604dbdb12ff481c01a8600edced13100a8c0d55d4e8e9a97aa1f7df8a3fd1d83851e1271d04a953251f1c0a3e56c050f8
+  metadata.gz: 657717a980be03b4eafadf654520d5aa464f2c39690f6fa055a15538978c29dbc341d340daf5b002a42977c42affdeae7b65b431752cd1d2e9655d2b4a32c171
+  data.tar.gz: a437cb00356bc9b232f17cc4c1fc81ddd326c7b6674fe41a07ad7111482864d858c9d47d7e040c1d89a7b4d523d365adc3bba8e91231ea5a6c194a94e2d4ac88

data/.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
     - 'spec/**/*'
     - 'Gemfile*'
     - '*.gemspec'
+    - 'vendor/**/*'
 
 Documentation:
   Enabled: false

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
 - 1.9.3
-- 2.1.0
 - 2.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lost_in_translations (1.2.0)
+    lost_in_translations (1.3.0)
       i18n (~> 0.7)
 
 GEM
@@ -23,7 +23,6 @@ GEM
     arel (6.0.3)
     ast (2.2.0)
     builder (3.2.2)
-    byebug (8.2.5)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
@@ -40,10 +39,8 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.3.0)
-      byebug (~> 8.0)
-      pry (~> 0.10)
     rainbow (2.1.0)
+    rake (11.2.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -81,17 +78,14 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (= 4.2.6)
-  byebug (= 8.2.5)
   codeclimate-test-reporter (= 0.4.8)
   lost_in_translations!
-  pry-byebug (= 3.3.0)
+  pry (= 0.10.3)
+  rake (= 11.2.2)
   rspec (= 3.4.0)
   rubocop (= 0.37.2)
   simplecov (= 0.11.2)
   sqlite3 (= 1.3.11)
 
-RUBY VERSION
-   ruby 2.3.0p0
-
 BUNDLED WITH
    1.12.5

data/README.md

@@ -5,7 +5,7 @@ Super light Translation Ruby Gem agnostic to your framework and source data
 [![Test Coverage](https://codeclimate.com/github/Streetbees/lost_in_translations/badges/coverage.svg)](https://codeclimate.com/github/Streetbees/lost_in_translations/coverage)
 [![Build Status](https://travis-ci.org/Streetbees/lost_in_translations.svg?branch=master)](https://travis-ci.org/Streetbees/lost_in_translations)
 
-## 1. Basic Usage
+## 1) Basic Usage
 ```ruby
 class User < Struct.new(:title, :first_name, :last_name)
   include LostInTranslations
@@ -20,7 +20,7 @@ class User < Struct.new(:title, :first_name, :last_name)
   end
 end
 ```
-Class method **.translate** will redefine **#title** and **#first_name** instance methods in order to return the values that match the **I18n.locale** and the **attribute name** from the Hash returned by **#translation_data**, otherwise calls the original redefined method.
+Class method ```.translate``` will redefine ```#title``` and ```#first_name``` instance methods in order to return the values that match the ```I18n.locale``` and the ```attribute name``` from the Hash returned by ```#translation_data```, otherwise calls the original redefined method.
 
 ```ruby
 @user = User.new('Cavaleiro', 'Joao', 'Neve')
@@ -44,15 +44,23 @@ I18n.with_locale(:de) do
 end
 ```
 
-Instance method **#translate** is also available:
+Instance method ```#translate``` is also available:
 ```ruby
 @user.translate(:first_name, :fr) # returns 'Jean'
 @user.translate(:first_name, :en) # returns 'Jon'
 @user.translate(:first_name, :de) # returns 'Joao'
 ```
 
-## 2. Ideal usage
-If your ActiveRecord Model has a json attribute called **translation_data**.
+And ```#<I18n.available_locales>_<translated_field>``` is also available:
+```ruby
+@user.fr_first_name # returns 'Jean'
+@user.en_first_name # returns 'Jon'
+@user.pt_first_name # returns 'Joao'
+@user.de_first_name # returns 'Joao'
+```
+
+## 2) Ideal usage
+If your ActiveRecord Model has a json attribute called ```translation_data```.
 ```ruby
 class CreateUsers < ActiveRecord::Migration
   def up
@@ -60,7 +68,7 @@ class CreateUsers < ActiveRecord::Migration
       t.string :title
       t.string :first_name
       t.string :last_name
-      t.json :translation_data
+      t.jsonb :translation_data
       t.timestamps
     end
 
@@ -93,9 +101,9 @@ I18n.locale = :fr
 @user.title # returns 'Cavaleiro'
 ```
 
-## 3. Configuration
+## 3) Configuration
 
-### 3.1 Your "translation_data" method (in all of your objects) is not called "translation_data"
+### 3.1) Your "translation_data" method (in all of your objects) is not called "translation_data"
 ```ruby
 LostInTranslations.configure do |config|
   config.translation_data_field = 'my_translation_data_field'
@@ -121,7 +129,7 @@ I18n.locale = :fr
 User.find(1).first_name # returns 'Jean'
 ```
 
-### 3.2 Your "translation_data" method (in a particular object) is not called "translation_data"
+### 3.2) Your "translation_data" method (in a particular object) is not called "translation_data"
 ```ruby
 class User < ActiveRecord::Base
   include LostInTranslations
@@ -143,7 +151,7 @@ I18n.locale = :fr
 User.find(1).first_name # returns 'Jean'
 ```
 
-### 3.3 Custom translation mechanism
+### 3.3) Custom translation mechanism
 ```ruby
 class MyTranslator
   def self.translate(object, field, locale)
@@ -189,7 +197,7 @@ I18n.locale = :fr
 User.find(1).first_name # returns 'Jean' from redis or yaml file
 ```
 
-## 4 Instalation
+## 4) Instalation
 
 Add your application's Gemfile:
 ```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task(:default).clear
+task default: [:rubocop, :spec]

data/lib/lost_in_translations/active_record.rb

@@ -10,7 +10,7 @@ module LostInTranslations
     end
 
     def self.included(base_class)
-      base_class.include Base
+      base_class.send(:include, Base)
       base_class.extend ClassMethods
     end
 

data/lib/lost_in_translations/ruby.rb

@@ -14,10 +14,12 @@ module LostInTranslations
     end
 
     def self.included(base_class)
-      base_class.include Base
+      base_class.send(:include, Base)
       base_class.extend ClassMethods
     end
 
+    include Base
+
     def translate(field, locale = I18n.locale)
       LostInTranslations.translate(self, field, locale) ||
         Ruby.call_original_field(self, field)

data/lib/lost_in_translations/version.rb

@@ -1,5 +1,5 @@
 module LostInTranslations
 
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 
 end

data/lib/lost_in_translations.rb

@@ -10,9 +10,9 @@ module LostInTranslations
   def self.included(base_class)
     if defined?(::ActiveRecord::Base) &&
        base_class.ancestors.include?(::ActiveRecord::Base)
-      base_class.include LostInTranslations::ActiveRecord
+      base_class.send(:include, LostInTranslations::ActiveRecord)
     else
-      base_class.include Ruby
+      base_class.send(:include, Ruby)
     end
   end
 
@@ -26,9 +26,24 @@ module LostInTranslations
 
   def self.define_translation_methods(object, *fields)
     fields.each do |field|
+      define_dynamic_translation_method(object, field)
+      define_particular_translation_method(object, field)
+    end
+  end
+
+  def self.define_dynamic_translation_method(object, method_name)
+    object.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{method_name}
+        translate(:#{method_name}, I18n.locale)
+      end
+    RUBY
+  end
+
+  def self.define_particular_translation_method(object, method_name)
+    I18n.available_locales.each do |locale|
       object.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{field}
-          translate(:#{field}, I18n.locale)
+        def #{locale}_#{method_name}
+          translate(:#{method_name}, :#{locale})
         end
       RUBY
     end

data/lost_in_translations.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
+  gem.add_development_dependency 'pry', '0.10.3'
+  gem.add_development_dependency 'rake', '11.2.2'
   gem.add_development_dependency 'rspec', '3.4.0'
-  gem.add_development_dependency 'byebug', '8.2.5'
   gem.add_development_dependency 'sqlite3', '1.3.11'
   gem.add_development_dependency 'rubocop', '0.37.2'
   gem.add_development_dependency 'simplecov', '0.11.2'
-  gem.add_development_dependency 'pry-byebug', '3.3.0'
   gem.add_development_dependency 'activerecord', '4.2.6'
   gem.add_development_dependency 'codeclimate-test-reporter', '0.4.8'
 

data/spec/lost_in_translations/lost_in_translations_spec.rb

@@ -2,6 +2,52 @@ require 'spec_helper'
 
 describe LostInTranslations do
 
+  describe "#define_translation_methods" do
+    context "when the passed methods do not exist" do
+      before do
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations
+        end
+
+        LostInTranslations.define_translation_methods(@user_class, :unknown)
+
+        @user = @user_class.new('Joao', 'Neve')
+      end
+
+      it "#unknown should be defined" do
+        expect(@user.respond_to?(:unknown)).to be true
+      end
+
+      it "#<I18n.available_locales>_unknown should be defined" do
+        I18n.available_locales.each do |locale|
+          expect(@user.respond_to?("#{locale}_unknown")).to be true
+        end
+      end
+    end
+
+    context "when the passed methods do exist" do
+      before do
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations
+        end
+
+        LostInTranslations.define_translation_methods(@user_class, :first_name)
+
+        @user = @user_class.new('Joao', 'Neve')
+      end
+
+      it "#first_name should be defined" do
+        expect(@user.respond_to?(:first_name)).to be true
+      end
+
+      it "#<I18n.available_locales>_first_name should be defined" do
+        I18n.available_locales.each do |locale|
+          expect(@user.respond_to?("#{locale}_first_name")).to be true
+        end
+      end
+    end
+  end
+
   describe "#included" do
     context "when the object inherits from ActiveRecord" do
       before do

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ end
 
 $: << File.expand_path('../', File.dirname(__FILE__))
 
-require 'pry-byebug'
+require 'pry'
 require 'active_record'
 require 'lost_in_translations'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lost_in_translations
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - StreetBees Dev Team
@@ -11,89 +11,89 @@ cert_chain: []
 date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 0.10.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.2.5
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.2.5
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.11
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.11
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 1.3.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 1.3.11
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.37.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.37.2
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 0.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 0.11.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
+- Rakefile
 - lib/lost_in_translations.rb
 - lib/lost_in_translations/active_record.rb
 - lib/lost_in_translations/base.rb