has_localization_table 0.3.13 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2ZlMDQ3ZWRiY2EwYzhmZWU1YmVjYjcwNzk1ZDNlY2VkZDYwNDhjYg==
+    ZDVjZmEwMjUwZTk5OTMxMWJhZmQ4MmJhNTk5NTFjNDZhNjcxNDk3OQ==
   data.tar.gz: !binary |-
-    OGFhMjlkZWU0ZTdiMzA3OGEwNTMzYzAxYjkzYTgxNmFkODVmM2RlNg==
+    Y2ExNzJkNWJkMTY0MmQyMDM4MmQ5Y2YzYTVlNWE5YWUwMzhkYjg1ZA==
 SHA512:
   metadata.gz: !binary |-
-    ODQyMTUzOGY0YjRjNGY0YTY0YzVlMTZhZTQyN2EzMDhiNzZlMmZhZDZmYmE5
-    NmMwOTAyNTMzNWY4NDRkMmZhOGMwMGVlMWJjOWMzZDEyY2ZiNzllOWU1N2Y3
-    NWJhZWJiNGNhMGIzNGRjNmQ2MWE5ZDI1M2ZiZWZlNTBjYTU5NmM=
+    OTQzNGFhMThhMmZmY2NiMjliOTJlYmQ2YWVmYjM3YTYzM2E0ZDdmNTA0YzI4
+    OTdkODNmYzRhYjNiNGIyNTdkMGIwYzRjMTBjMzZkNmQ3MjczMTUyZmQ5NmVj
+    ODQyZTQ5N2JjYTcwZjYwMDgwNTY3ZTBkNDM4MWUxMmZjNzE1ZTc=
   data.tar.gz: !binary |-
-    ODQ4MGU3OWE4ZjM5Mjk3OGE5YTJlNDU3NWYyYTg1M2Y0YTIyZmQ5M2NmYjNm
-    MjE3ZmQyMGViMDRkMmFkMWExOWJiNGM2YTBkZDc5NDE1ZDJhYWM2MDg2ZTc1
-    MWU4ZDFkMDhiZmJjYjIyNzI4MGQyMWE4N2EyZDllOWM5NmVmZmQ=
+    ZDkwZGMxODU0ODNiNjNkMzVmNGRmYzYyODBhYmUzMjgyNTViMDYxYjgxY2E2
+    YzM1MDY5OGNkZTVlYWFkMTYyMjdjZGI2MWMzODFlYTE4OGU3NGY2NTRlYzYz
+    NDcwMzViNTc5Yjg4MTgxNGNkN2QzMTUwYWEzYTBiMzA1ZDc0ODQ=

data/lib/has_localization_table/active_record/callbacks.rb

@@ -1,17 +1,21 @@
 module HasLocalizationTable
   module ActiveRecord
     module Callbacks
+      def self.extended(klass)
+        klass.send(:include, InstanceMethods)
+      end
+
       def setup_localization_callbacks!
         # Initialize string records after main record initialization
-        after_initialize do
+        after_initialize(if: :add_localization_after_initialize?) do
           build_missing_localizations!
         end
-        
+
         before_validation do
           reject_empty_localizations!
           build_missing_localizations!
         end
-        
+
         # Reject any blank strings before saving the record
         # Validation will have happened by this point, so if there is a required string that is needed, it won't be rejected
         before_save do
@@ -19,6 +23,14 @@ module HasLocalizationTable
         end
       end
       private :setup_localization_callbacks!
+
+      module InstanceMethods
+        def add_localization_after_initialize?
+          localization_table_options.fetch(:initialize, true) && !localization_table_options.fetch(:include, false)
+        end
+
+        private :add_localization_after_initialize?
+      end
     end
   end
-end
+end

data/lib/has_localization_table/active_record/meta_methods.rb

@@ -4,52 +4,52 @@ module HasLocalizationTable
       def self.extended(klass)
         klass.send(:include, InstanceMethods)
       end
-      
+
       def localization_class
         localization_table_options[:class_name].constantize
       end
-      
+
       def localization_association_name
         localization_table_options[:association_name]
       end
-      
+
       def localized_attributes
         # Determine which attributes of the association model should be accessible through the base class
         # ie. everything that's not a primary key, foreign key, or timestamp attribute
         association_name = self.localization_table_options[:association_name] || :strings
         association = reflect_on_association(association_name)
-        
+
         attribute_names = association.klass.attribute_names
         timestamp_attrs = association.klass.new.send(:all_timestamp_attributes_in_model).map(&:to_s)
         foreign_keys = association.klass.reflect_on_all_associations.map{ |a| a.association_foreign_key }
         primary_keys = [association.klass.primary_key]
         # protected_attrs = association.klass.protected_attributes.to_a
-        
+
         (attribute_names - timestamp_attrs - foreign_keys - primary_keys).map(&:to_sym)
       end
-      
+
       def localized_attribute_required?(attribute)
         return false unless localization_table_options[:required] || false
         return true unless localization_table_options[:optional]
-        
-        !localization_table_options[:optional].include?(attribute) 
+
+        !localization_table_options[:optional].include?(attribute)
       end
-      
+
       module InstanceMethods
         # Helper method for getting the localization association without having to look up the name each time
         def localization_association
           association_name = localization_table_options[:association_name]
           send(association_name)
         end
-        
+
         def localized_attributes
           self.class.localized_attributes
         end
-        
+
         def localization_table_options
           self.class.localization_table_options
         end
       end
     end
   end
-end
+end

data/lib/has_localization_table/active_record/relation.rb

@@ -1,6 +1,8 @@
 module HasLocalizationTable
   module ActiveRecord
     module Relation
+      RESERVED_KEYS = [:association_name, :required, :optional, :dependent, :has_one, :initialize, :include]
+
       def self.extended(klass)
         klass.send(:include, InstanceMethods)
         klass.send(:create_localization_associations!)
@@ -8,10 +10,10 @@ module HasLocalizationTable
         # Alias the scoping method to use the actual association name
         alias_method :"with_#{klass.localization_association_name}", :with_localizations
       end
-      
+
       def with_localizations(locale = HasLocalizationTable.current_locale.id)
         lcat = localization_class.arel_table
-        
+
         scoped.joins(
           arel_table.join(lcat, Arel::Nodes::OuterJoin).
             on(lcat[:"#{self.name.underscore}_id"].eq(arel_table[self.primary_key]).and(lcat[HasLocalizationTable.locale_foreign_key].eq(locale))).
@@ -37,7 +39,7 @@ module HasLocalizationTable
         association_name = localization_association_name.to_s.singularize.to_sym
         association_name = :localization if localized_attributes.include?(association_name)
 
-        has_one_options = localization_table_options.except(:association_name, :required, :optional, :dependent, :has_one).
+        has_one_options = localization_table_options.except(*RESERVED_KEYS).
           merge({ conditions: Proc.new { "#{table_name}.#{foreign_key} = #{HasLocalizationTable.current_locale.id}"} })
 
         self.has_one association_name, has_one_options
@@ -46,18 +48,22 @@ module HasLocalizationTable
 
       # Collect all localizations for the object
       def create_has_many_association
-        self.has_many localization_association_name, localization_table_options.except(:association_name, :required, :optional, :has_one).reverse_merge(autosave: true) do
+        self.has_many localization_association_name, localization_table_options.except(*RESERVED_KEYS).reverse_merge(autosave: true) do
           def for_locale(locale)
             # where(HasLocalizationTable.locale_foreign_key => locale).first
             select{ |s| s.send(HasLocalizationTable.locale_foreign_key) == locale }.first
           end
         end
+
+        if localization_table_options.fetch(:include, false)
+          self.default_scope -> { includes(localization_association_name) }
+        end
       end
 
     public
 
       module InstanceMethods
-        # Add localization objects for any available locale that doesn't have one 
+        # Add localization objects for any available locale that doesn't have one
         def build_missing_localizations!
           return unless HasLocalizationTable.all_locales.any?
 
@@ -66,11 +72,11 @@ module HasLocalizationTable
             unless localization_association.detect{ |str| str.send(HasLocalizationTable.locale_foreign_key) == locale.id }
               localization_association.build(HasLocalizationTable.locale_foreign_key => locale.id)
             end
-            
+
             localization_association.sort_by!{ |l| locale_ids.index(l.send(HasLocalizationTable.locale_foreign_key)) || 0 }
           end
         end
-        
+
         # Remove localization objects that are not filled in
         def reject_empty_localizations!
           localization_association.reject! { |l| !l.persisted? and localized_attributes.all?{ |attr| l.send(attr).blank? } }
@@ -78,4 +84,4 @@ module HasLocalizationTable
       end
     end
   end
-end
+end

data/lib/has_localization_table/version.rb

@@ -1,3 +1,3 @@
 module HasLocalizationTable
-  VERSION = "0.3.13"
+  VERSION = "0.4.0"
 end

data/spec/active_record/callbacks_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe HasLocalizationTable do
+  before do
+    # Configure HLT
+    HasLocalizationTable.configure do |c|
+      c.primary_locale = Locale.first
+      c.current_locale = Locale.first
+      c.all_locales = Locale.all
+    end
+
+    Object.send(:remove_const, :Article) rescue nil
+    Article = Class.new(ActiveRecord::Base)
+    Article.has_localization_table
+  end
+
+  let(:article) { Article.create!(name: "Test", description: "Description") }
+
+  it 'should initialize the localizations association on initialize' do
+    a = Article.new
+    a.localizations.wont_be_empty
+  end
+
+  it 'should initialize the localizations association on initialize for an existing object' do
+    a = Article.find(article.id)
+    a.localizations.wont_be_empty
+  end
+
+  it 'should not initialize the association on initialize if initialize: false is given in config' do
+    Article.has_localization_table initialize: false
+    a = Article.new
+    a.localizations.must_be_empty
+  end
+
+  it 'should not initialize the association for an existing object if initialize: false is given in config' do
+    Article.has_localization_table initialize: false
+    a = Article.find(article.id)
+    refute(a.localizations.loaded?)
+  end
+
+  it 'should not initialize the association on initialize if include: true is given in config' do
+    Article.has_localization_table include: true
+    a = Article.new
+    a.localizations.must_be_empty
+  end
+
+  it 'should load associations if include: true is given' do
+    Article.has_localization_table include: true
+    assert Article.find(article.id).localizations.loaded?
+  end
+end

data/spec/active_record/relation_spec.rb

@@ -5,7 +5,7 @@ describe HasLocalizationTable do
   before do
     # Configure HLT
     HasLocalizationTable.configure do |c|
-      c.primary_locale = Locale.first 
+      c.primary_locale = Locale.first
       c.current_locale = Locale.first
       c.all_locales = Locale.all
     end
@@ -91,4 +91,26 @@ describe HasLocalizationTable do
       conditions.call.must_equal "article_localizations.locale_id = 3"
     end
   end
-end
+
+  it 'should add a default scope if include: true is given' do
+    Article.stub :localization_table_options, { include: true } do
+      Article.default_scopes.must_be_empty
+      Article.send(:extend, HasLocalizationTable::ActiveRecord::Relation)
+      Article.default_scopes.size.must_equal(1)
+    end
+  end
+
+  it 'should not add a default scope if include: false is given' do
+    Article.stub :localization_table_options, { include: false } do
+      Article.send(:extend, HasLocalizationTable::ActiveRecord::Relation)
+      Article.default_scopes.must_be_empty
+    end
+  end
+
+  it 'should not add a default scope if include: is not given' do
+    Article.stub :localization_table_options, { } do
+      Article.send(:extend, HasLocalizationTable::ActiveRecord::Relation)
+      Article.default_scopes.must_be_empty
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_localization_table
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -106,6 +106,7 @@ files:
 - lib/has_localization_table/config.rb
 - lib/has_localization_table/version.rb
 - spec/active_record/attributes_spec.rb
+- spec/active_record/callbacks_spec.rb
 - spec/active_record/finder_method_spec.rb
 - spec/active_record/ordered_by_spec.rb
 - spec/active_record/relation_spec.rb
@@ -140,6 +141,7 @@ summary: Sets up associations and attribute methods for AR models that have a re
   table to contain user-created data in multiple languages.
 test_files:
 - spec/active_record/attributes_spec.rb
+- spec/active_record/callbacks_spec.rb
 - spec/active_record/finder_method_spec.rb
 - spec/active_record/ordered_by_spec.rb
 - spec/active_record/relation_spec.rb