lost_in_translations 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d1a0959d1fda7cbd026bfb47d428d44072c4faf
-  data.tar.gz: d37b0255c177943d54b9dd3857f148a8425559e1
+  metadata.gz: 06590098e42d3c39e2c1f2c0af0ece92d977e2bf
+  data.tar.gz: dd7b741fdae089d107d8b06b844fef1d77b69ff3
 SHA512:
-  metadata.gz: 8b4b4e39527f47afc0035ea6a56ef8ce0a2c2ef455ce2f0c1c7ad773f2d62f0946ad0b20d997798f7afe679b976a94b8e9913507ae532ebee74d5815c862efe1
-  data.tar.gz: a4b34612c1a1dacf97943c5f1d2f4dee79e220cb706b3f934875cc8aa21989d61ba045a3274f0cda56e207cb4562796246fe05d52d12fd958f65e05a68bd17ce
+  metadata.gz: da5bad9a9d8b5ddf9a4e9e3c8224b57a30a8de73143d872236e7ff4643551a1ce56c71f1b9860348738aee4569b3887f152ccdd04c792d11ea8025b519a1bb94
+  data.tar.gz: 7ce6782a647d366264d79bb4f2ce7999ca357699be4c6da628e8671bf2c3264b989bd02ba019f098e423c030690afaf86e7376fe435b6d42b7d69efc900e50e7

data/.rubocop.yml

@@ -4,6 +4,9 @@ Style/EmptyLinesAroundClassBody:
 Style/EmptyLinesAroundModuleBody:
   Enabled: false
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 AllCops:
   DisplayCopNames: true
   Exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lost_in_translations (1.3.2)
+    lost_in_translations (1.4.0)
       i18n (~> 0.7)
 
 GEM

data/README.md

@@ -127,9 +127,34 @@ I18n.locale = :fr
 @user.title # returns nil
 ```
 
-## 3) Configuration
+## 3) I18n.available_locales as changed, how do I recreate the new translation methods?
+```ruby
+LostInTranslations.reload # will run .define_translation_methods in every class that has "include LostInTranslations"
+```
+
+```ruby
+I18n.available_locales == [:pt]
+
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :first_name
+end
+
+User.new.respond_to?(:pt_first_name) == true
+User.new.respond_to?(:en_first_name) == false
+
+I18n.available_locales.push(:en)
+
+LostInTranslations.reload
+
+User.new.respond_to?(:pt_first_name) == true
+User.new.respond_to?(:en_first_name) == true
+```
+
+## 4) Configuration
 
-### 3.1) Your "translation_data" method (in all of your objects) is not called "translation_data"
+### 4.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'
@@ -155,7 +180,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"
+### 4.2) Your "translation_data" method (in a particular object) is not called "translation_data"
 ```ruby
 class User < ActiveRecord::Base
   include LostInTranslations
@@ -177,7 +202,7 @@ I18n.locale = :fr
 User.find(1).first_name # returns 'Jean'
 ```
 
-### 3.3) Custom translation mechanism
+### 4.3) Custom translation mechanism
 ```ruby
 class MyTranslator < Translator::Base
   def self.translation_data(object)
@@ -221,7 +246,7 @@ I18n.locale = :fr
 User.find(1).first_name # returns 'Jean' from redis or yaml file
 ```
 
-## 4) Instalation
+## 5) Instalation
 
 Add your application's Gemfile:
 ```

data/lib/lost_in_translations.rb

@@ -65,4 +65,12 @@ module LostInTranslations
     yield(config)
   end
 
+  def self.infected_classes
+    @infected_classes ||= []
+  end
+
+  def self.reload
+    infected_classes.each(&:define_translation_methods)
+  end
+
 end

data/lib/lost_in_translations/active_record.rb

@@ -3,17 +3,15 @@ module LostInTranslations
 
     module ClassMethods
 
-      def translate(*fields)
-        LostInTranslations.define_translation_methods(self, *fields)
+      def define_translation_methods
+        LostInTranslations.define_translation_methods self, *translation_fields
       end
 
     end
 
     def self.included(base_class)
-      base_class.class_eval do
-        include Base
-        extend ClassMethods
-      end
+      base_class.send(:include, Base)
+      base_class.extend ClassMethods
     end
 
     def call_original_field(object, field)

data/lib/lost_in_translations/base.rb

@@ -2,6 +2,8 @@ module LostInTranslations
   module Base
 
     def self.included(base_class)
+      LostInTranslations.infected_classes.push(base_class)
+
       base_class.extend ClassMethods
     end
 
@@ -28,6 +30,16 @@ module LostInTranslations
           LostInTranslations.config.translation_data_field
       end
 
+      def translation_fields
+        @translation_fields ||= []
+      end
+
+      def translate(*fields)
+        translation_fields.concat(fields)
+
+        define_translation_methods
+      end
+
     end
 
   end

data/lib/lost_in_translations/ruby.rb

@@ -3,21 +3,23 @@ module LostInTranslations
 
     module ClassMethods
 
-      def translate(*fields)
-        fields.each do |field|
-          alias_method Ruby.original_field_name(field), field.to_sym
+      def define_translation_methods
+        translation_fields.each do |field|
+          next if instance_methods.include?(Ruby.original_field_name(field))
+
+          class_eval do
+            alias_method Ruby.original_field_name(field), field.to_sym
+          end
         end
 
-        LostInTranslations.define_translation_methods(self, *fields)
+        LostInTranslations.define_translation_methods self, *translation_fields
       end
 
     end
 
     def self.included(base_class)
-      base_class.class_eval do
-        include Base
-        extend ClassMethods
-      end
+      base_class.send(:include, Base)
+      base_class.extend ClassMethods
     end
 
     def call_original_field(object, field)

data/lib/lost_in_translations/version.rb

@@ -1,5 +1,5 @@
 module LostInTranslations
 
-  VERSION = '1.3.2'.freeze
+  VERSION = '1.4.0'.freeze
 
 end

data/spec/lost_in_translations/active_record_spec.rb

@@ -2,85 +2,50 @@ require 'spec_helper'
 
 describe LostInTranslations::ActiveRecord do
 
-  describe 'readme example' do
-    context "basic usage" do
-      before do
-        @user_class = Class.new(ActiveRecord::Base) do
-          self.table_name = 'users'
+  context "when building a resource" do
+    before do
+      @user_class = Class.new(ActiveRecord::Base) do
+        self.table_name = 'users'
 
-          include LostInTranslations::ActiveRecord
+        include LostInTranslations::ActiveRecord
 
-          translate :title, :first_name
+        translate :title, :first_name
 
-          def translation_data
-            @translation_data ||= {
-              en: { first_name: 'Jon', last_name: 'Snow' },
-              fr: { first_name: 'Jean', last_name: 'Neige' }
-            }
-          end
+        def translation_data
+          @translation_data ||= {
+            en: { first_name: 'Jon', last_name: 'Snow' },
+            fr: { first_name: 'Jean', last_name: 'Neige' }
+          }
         end
-
-        @user = @user_class.new(title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve')
       end
 
-      it_behaves_like "a basic usage"
+      @user = @user_class.new(title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve')
     end
+
+    it_behaves_like "the readme example"
   end
 
-  # describe '.translate' do
-  #
-  #   context "when translating a field" do
-  #     before do
-  #       @user_class = Class.new(ActiveRecord::Base) do
-  #         self.table_name = 'users'
-  #
-  #         include LostInTranslations::ActiveRecord
-  #
-  #         translate :title, :first_name
-  #
-  #         def translation_data
-  #           @translation_data ||= {
-  #             en: { first_name: 'Jon', last_name: 'Snow' },
-  #             fr: { first_name: 'Jean', last_name: 'Neige' }
-  #           }
-  #         end
-  #       end
-  #
-  #       # @user_class.create title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve'
-  #       @user = @user_class.first
-  #     end
-  #     # after { @user.destroy }
-  #
-  #     it_behaves_like "a proper translator"
-  #   end
-  #
-  #   context "when a particular field is not translated" do
-  #     before do
-  #       @user_class = Class.new(ActiveRecord::Base) do
-  #         self.table_name = 'users'
-  #
-  #         include LostInTranslations::ActiveRecord
-  #
-  #         translate :title, :first_name
-  #
-  #         def translation_data
-  #           @translation_data ||= {
-  #             en: { first_name: 'Jon', last_name: 'Snow' },
-  #             fr: { first_name: 'Jean', last_name: 'Neige' }
-  #           }
-  #         end
-  #       end
-  #
-  #       @user = @user_class.new title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve'
-  #     end
-  #
-  #     it "#field must return the original data" do
-  #       I18n.with_locale(:en) do
-  #         expect(@user.last_name).to eq 'Neve'
-  #       end
-  #     end
-  #   end
-  #
-  # end
+  context "When finding a resource" do
+    before do
+      @user_class = Class.new(ActiveRecord::Base) do
+        self.table_name = 'users'
+
+        include LostInTranslations::ActiveRecord
+
+        translate :title, :first_name
+
+        def translation_data
+          @translation_data ||= {
+            en: { first_name: 'Jon', last_name: 'Snow' },
+            fr: { first_name: 'Jean', last_name: 'Neige' }
+          }
+        end
+      end
+
+      @user = @user_class.first
+    end
+
+    it_behaves_like "the readme example"
+  end
 
 end

data/spec/lost_in_translations/lost_in_translations_spec.rb

@@ -2,6 +2,67 @@ require 'spec_helper'
 
 describe LostInTranslations do
 
+  describe "#reload" do
+    context "when the available_locales do not include :es" do
+      before do
+        LostInTranslations.infected_classes.clear
+
+        @user_class1 = Struct.new(:first_name, :last_name) do
+          include LostInTranslations::Ruby
+
+          translate :first_name
+        end
+
+        @user_class2 = Class.new(ActiveRecord::Base) do
+          self.table_name = 'users'
+
+          include LostInTranslations::ActiveRecord
+
+          translate :last_name
+        end
+
+        @user1 = @user_class1.new('Joao', 'Neve')
+        @user2 = @user_class2.new(title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve')
+      end
+
+      it "#pt_first_name SHOULD be defined" do
+        expect(@user1.respond_to?(:pt_first_name)).to be true
+        expect(@user2.respond_to?(:pt_last_name)).to be true
+      end
+
+      it "#es_first_name should NOT be defined" do
+        expect(@user1.respond_to?(:es_first_name)).to be false
+        expect(@user1.respond_to?(:es_last_name)).to be false
+      end
+
+      context "when :es gets introduced" do
+        before { I18n.available_locales.push(:es) }
+        after { I18n.available_locales.pop }
+
+        context "and .reload as NOT ran" do
+          it "#es_first_name should NOT be defined" do
+            expect(@user1.respond_to?(:es_first_name)).to be false
+            expect(@user2.respond_to?(:es_last_name)).to be false
+          end
+        end
+
+        context "and .define_translation_methods AS ran" do
+          before { LostInTranslations.reload }
+
+          it "#pt_first_name SHOULD be defined" do
+            expect(@user1.respond_to?(:pt_first_name)).to be true
+            expect(@user2.respond_to?(:pt_last_name)).to be true
+          end
+
+          it "#es_first_name SHOULD be defined" do
+            expect(@user1.respond_to?(:es_first_name)).to be true
+            expect(@user2.respond_to?(:es_last_name)).to be true
+          end
+        end
+      end
+    end
+  end
+
   describe "#define_translation_methods" do
     context "when the passed methods do not exist" do
       before do

data/spec/lost_in_translations/ruby_spec.rb

@@ -2,77 +2,25 @@ require 'spec_helper'
 
 describe LostInTranslations::Ruby do
 
-  describe 'readme example' do
-    context "basic usage" do
-      before do
-        @user_class = Struct.new(:title, :first_name, :last_name) do
-          include LostInTranslations::Ruby
-
-          translate :title, :first_name
-
-          def translation_data
-            @translation_data ||= {
-              en: { first_name: 'Jon', last_name: 'Snow' },
-              fr: { first_name: 'Jean', last_name: 'Neige' }
-            }
-          end
+  context "when building a resource" do
+    before do
+      @user_class = Struct.new(:title, :first_name, :last_name) do
+        include LostInTranslations::Ruby
+
+        translate :title, :first_name
+
+        def translation_data
+          @translation_data ||= {
+            en: { first_name: 'Jon', last_name: 'Snow' },
+            fr: { first_name: 'Jean', last_name: 'Neige' }
+          }
         end
-
-        @user = @user_class.new('Cavaleiro', 'Joao', 'Neve')
       end
 
-      it_behaves_like "a basic usage"
+      @user = @user_class.new('Cavaleiro', 'Joao', 'Neve')
     end
-  end
 
-  # describe '.translate' do
-  #
-  #   context "when translating a field" do
-  #     before do
-  #       @user_class = Struct.new(:title, :first_name, :last_name) do
-  #         include LostInTranslations::Ruby
-  #
-  #         translate :title, :first_name
-  #
-  #         def translation_data
-  #           @translation_data ||= {
-  #             en: { first_name: 'Jon', last_name: 'Snow' },
-  #             fr: { first_name: 'Jean', last_name: 'Neige' }
-  #           }
-  #         end
-  #       end
-  #
-  #       @user = @user_class.new('Cavaleiro', 'Joao', 'Neve')
-  #     end
-  #
-  #     it_behaves_like "a proper translator"
-  #   end
-  #
-  #   context "when a particular field is not translated" do
-  #     before do
-  #       @user_class = Struct.new(:title, :first_name, :last_name) do
-  #         include LostInTranslations::Ruby
-  #
-  #         translate :title, :first_name
-  #
-  #         def translation_data
-  #           @translation_data ||= {
-  #             en: { first_name: 'Jon', last_name: 'Snow' },
-  #             fr: { first_name: 'Jean', last_name: 'Neige' }
-  #           }
-  #         end
-  #       end
-  #
-  #       @user = @user_class.new('Cavaleiro', 'Joao', 'Neve')
-  #     end
-  #
-  #     it "#field must return the original data" do
-  #       I18n.with_locale(:en) do
-  #         expect(@user.last_name).to eq 'Neve'
-  #       end
-  #     end
-  #   end
-  #
-  # end
+    it_behaves_like "the readme example"
+  end
 
 end

data/spec/support/shared_examples/basic_usage.rb

@@ -1,63 +1,98 @@
 # encoding: UTF-8
 
-shared_examples_for "a basic usage" do
-  it "should behave like the readme says it does" do
-    I18n.default_locale = :pt
-    I18n.locale = :fr
+shared_examples_for "the readme example" do
+  context "when I18n.locale == :fr" do
+    before { I18n.locale = :fr }
+    after { I18n.locale = :pt }
 
-    expect(@user.first_name).to eq 'Jean'
-    expect(@user.last_name).to eq 'Neve'
-    expect(@user.title).to be_nil
-
-    I18n.with_locale(:en) do
-      expect(@user.first_name).to eq 'Jon'
+    it "should return what the readme says it does" do
+      expect(@user.first_name).to eq 'Jean'
       expect(@user.last_name).to eq 'Neve'
       expect(@user.title).to be_nil
-    end
 
-    I18n.with_locale(:pt) do
-      expect(@user.first_name).to eq 'Joao'
-      expect(@user.last_name).to eq 'Neve'
-      expect(@user.title).to eq 'Cavaleiro'
-    end
+      I18n.with_locale(:en) do
+        expect(@user.first_name).to eq 'Jon'
+        expect(@user.last_name).to eq 'Neve'
+        expect(@user.title).to be_nil
+      end
 
-    I18n.with_locale(:de) do
-      expect(@user.first_name).to be_nil
-      expect(@user.last_name).to eq 'Neve'
-      expect(@user.title).to be_nil
-    end
+      I18n.with_locale(:pt) do
+        expect(@user.first_name).to eq 'Joao'
+        expect(@user.last_name).to eq 'Neve'
+        expect(@user.title).to eq 'Cavaleiro'
+      end
 
-    expect(@user.translate(:first_name, :fr)).to eq 'Jean'
-    expect(@user.translate(:first_name, :en)).to eq 'Jon'
-    expect(@user.translate(:first_name, :pt)).to eq 'Joao'
-    expect(@user.translate(:first_name, :de)).to be_nil
+      I18n.with_locale(:de) do
+        expect(@user.first_name).to be_nil
+        expect(@user.last_name).to eq 'Neve'
+        expect(@user.title).to be_nil
+      end
 
-    expect(@user.fr_first_name).to eq 'Jean'
-    expect(@user.en_first_name).to eq 'Jon'
-    expect(@user.pt_first_name).to eq 'Joao'
-    expect(@user.de_first_name).to be_nil
-  end
+      expect(@user.translate(:first_name, :fr)).to eq 'Jean'
+      expect(@user.translate(:first_name, :en)).to eq 'Jon'
+      expect(@user.translate(:first_name, :pt)).to eq 'Joao'
+      expect(@user.translate(:first_name, :de)).to be_nil
 
-  context "when making use of setter translation methods" do
-    before do
-      @user.pt_first_name = 'João'
-      @user.de_first_name = 'Hans'
+      expect(@user.fr_first_name).to eq 'Jean'
+      expect(@user.en_first_name).to eq 'Jon'
+      expect(@user.pt_first_name).to eq 'Joao'
+      expect(@user.de_first_name).to be_nil
     end
 
-    it "#translation_data should be updated" do
-      expect(@user.translation_data).to eq ({
-        en: { first_name: 'Jon', last_name: 'Snow' },
-        pt: { first_name: 'João' },
-        de: { first_name: 'Hans' },
-        fr: { first_name: 'Jean', last_name: 'Neige' }
-      })
+    context "when making use of setter translation methods" do
+      before do
+        @user.pt_first_name = 'João'
+        @user.de_first_name = 'Hans'
+      end
+
+      it "#translation_data should be updated" do
+        expect(@user.translation_data).to eq ({
+          en: { first_name: 'Jon', last_name: 'Snow' },
+          pt: { first_name: 'João' },
+          de: { first_name: 'Hans' },
+          fr: { first_name: 'Jean', last_name: 'Neige' }
+        })
+      end
+
+      it "translation method should return the updated results" do
+        expect(@user.translate(:first_name, :fr)).to eq 'Jean'
+        expect(@user.translate(:first_name, :en)).to eq 'Jon'
+        expect(@user.translate(:first_name, :pt)).to eq 'João'
+        expect(@user.translate(:first_name, :de)).to eq 'Hans'
+      end
     end
 
-    it "translation method should return the updated results" do
-      expect(@user.translate(:first_name, :fr)).to eq 'Jean'
-      expect(@user.translate(:first_name, :en)).to eq 'Jon'
-      expect(@user.translate(:first_name, :pt)).to eq 'João'
-      expect(@user.translate(:first_name, :de)).to eq 'Hans'
+    context "when the available_locales do not include :es" do
+      it "#es_first_name should NOT be defined" do
+        expect(@user.respond_to?(:es_first_name)).to be false
+      end
+
+      context "when :es gets introduced" do
+        before { I18n.available_locales.push(:es) }
+        after { I18n.available_locales.pop }
+
+        context "and .define_translation_methods as NOT ran" do
+          it "#es_first_name should NOT be defined" do
+            expect(@user.respond_to?(:es_first_name)).to be false
+          end
+        end
+
+        context "and .define_translation_methods AS ran" do
+          before { @user_class.define_translation_methods }
+
+          it "already defined method should work" do
+            expect(@user.fr_first_name).to eq 'Jean'
+            expect(@user.en_first_name).to eq 'Jon'
+            expect(@user.de_first_name).to be_nil
+            expect(@user.pt_first_name).to eq 'Joao'
+          end
+
+          it "#es_first_name SHOULD be defined" do
+            expect(@user.respond_to?(:es_first_name)).to be true
+            expect(@user.es_first_name).to be_nil
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lost_in_translations
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - StreetBees Dev Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry