activerecord-typedstore 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 542197f677322bd49dc623661de6f72adae6e259
-  data.tar.gz: 8612b393a7cbc50203a8848c9928dfade4776ef2
+  metadata.gz: 4c3d4b1b4f103d05dc3371d1e8ebeb7f666ac227
+  data.tar.gz: 33f47581329169894a7c7c9f3b79cec592b62eb4
 SHA512:
-  metadata.gz: a06189e792adec4ac11a2bc6020439135051a1d7194f21d43008d9077fcef511ddcf9f8d252f5f25478aa9220425b38bc03655462a6138b04e9e941bcfdcc566
-  data.tar.gz: dfc9469b4dd7c9e1dbb611db6db1e150ac643d6f52f890f58665308f384457cf5a0b2f6a7e885af51ff7db48f16d996971a3b12229bf8e226bd53a9c188c0bcb
+  metadata.gz: 6e35186b4dfbc9b54984d4e5a350035ecc8c64136f827ab3762586aeb14477699d2035fcce317d113402c393c068103acdddd23415ec6d69f879040d1831c111
+  data.tar.gz: b32badf3a634ba1aa2b572129622e9a4a2650bfefef3fbf470ee37f891c0080225d1fdb054aa0089b299dd6d0e051c26b62cb02e061e415e5b9fb3877b6ac228

data/Rakefile

@@ -1,7 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/active_record/typed_store/ar_32_fallbacks.rb

@@ -10,9 +10,8 @@ module ActiveRecord::TypedStore
 
     module ClassMethods
 
-      def typed_store(store_attribute, options={}, &block)
-        dsl = super
-        _ar_32_fallback_accessors(store_attribute, dsl.columns)
+      def typed_store(store_attribute, dsl)
+        _ar_32_fallback_accessors(store_attribute, dsl.column_names)
       end
 
       protected
@@ -35,65 +34,41 @@ module ActiveRecord::TypedStore
         attribute_method_matchers_cache.clear
       end
 
-      def _ar_32_fallback_accessors(store_attribute, columns)
-        _ar_32_fallback_initializer(store_attribute, columns)
-        columns.each do |column|
-          _ar_32_fallback_accessor(store_attribute, column)
+      def _ar_32_fallback_accessors(store_attribute, column_names)
+        column_names.each do |name|
+          _ar_32_fallback_accessor(store_attribute, name)
         end
       end
 
-      def _ar_32_fallback_initializer(store_attribute, columns)
-        define_method(store_attribute) do
-          initialized = "@_#{store_attribute}_initialized"
-          unless instance_variable_get(initialized)
-            store = read_attribute(store_attribute)
-            store = initialize_store(store, columns)
-            write_attribute(store_attribute, store)
-            instance_variable_set(initialized, true)
-          end
-          read_attribute(store_attribute)
+      def _ar_32_fallback_accessor(store_attribute, key)
+        define_method("#{key}=") do |value|
+          write_store_attribute(store_attribute, key, value)
         end
-      end
-
-      def _ar_32_fallback_accessor(store_attribute, column)
-        _ar_32_fallback_writer(store_attribute, column)
-        _ar_32_fallback_reader(store_attribute, column)
-      end
-
-      def _ar_32_fallback_writer(store_attribute, column)
-        define_method("#{column.name}_with_type_casting=") do |value|
-          casted_value = column.cast(value)
-          attribute_will_change!(column.name.to_s) if casted_value != send(column.name)
-          send("#{column.name}_without_type_casting=", casted_value)
+        define_method(key) do
+          read_store_attribute(store_attribute, key)
         end
-        alias_method_chain "#{column.name}=", :type_casting
       end
 
-      def _ar_32_fallback_reader(store_attribute, column)
-        define_method(column.name) do
-          send("#{store_attribute}=", {}) unless send(store_attribute).is_a?(Hash)
-          store = send(store_attribute)
+    end
 
-          store.has_key?(column.name) ? store[column.name] : column.default
-        end
-      end
+    private
 
+    def initialize_store_attribute(store_attribute)
+      send("#{store_attribute}=", {}) unless send(store_attribute).is_a?(Hash)
+      send(store_attribute)
     end
 
-    def reload(*)
-      _ar_32_reload_stores!
-      super
+    def read_store_attribute(store_attribute, key)
+      store = initialize_store_attribute(store_attribute)
+      store[key]
     end
 
-    private
-
-    def _ar_32_reload_stores!
-      self.class.stored_typed_attributes.keys.each do |store_attribute|
-        instance_variable_set("@_#{store_attribute}_initialized", false)
-      end
+    def write_store_attribute(store_attribute, key, value)
+      attribute_will_change!(store_attribute.to_s)
+      send(store_attribute)[key] = value
     end
 
   end
 
-  ActiveRecord::Base.send(:include, AR32Fallbacks)
+  Extension.send(:include, AR32Fallbacks)
 end

data/lib/active_record/typed_store/ar_41_fallbacks.rb

@@ -2,19 +2,8 @@ module ActiveRecord::TypedStore
 
   module AR41Fallbacks
 
-    def reload(*)
-      _ar_41_reload_stores!
-      super
-    end
-
     private
 
-    def _ar_41_reload_stores!
-      self.class.stored_typed_attributes.keys.each do |store_attribute|
-        instance_variable_set("@_#{store_attribute}_initialized", false)
-      end
-    end
-
     module HashAccessorPatch
 
       def self.extended(hash_accessor)
@@ -23,16 +12,9 @@ module ActiveRecord::TypedStore
 
       protected
 
-      def prepare_with_initialization(object, attribute)
-        prepare_without_initialization(object, attribute)
-
-        initialized = "@_#{attribute}_initialized"
-        unless object.instance_variable_get(initialized)
-          store = object.send(:initialize_store_attribute, attribute)
-          object.send("#{attribute}=", store)
-          object.instance_variable_set(initialized, true)
-        end
-
+      def prepare_with_initialization(object, store_attribute)
+        prepare_without_initialization(object, store_attribute)
+        object.send(:initialize_store_attribute, store_attribute)
       end
 
     end
@@ -41,5 +23,4 @@ module ActiveRecord::TypedStore
     ActiveRecord::Store::IndifferentHashAccessor.extend(HashAccessorPatch)
   end
 
-  ActiveRecord::Base.send(:include, AR41Fallbacks)
 end

data/lib/active_record/typed_store/column.rb

@@ -22,6 +22,11 @@ module ActiveRecord::TypedStore
       casted_value
     end
 
+    def extract_default(value)
+      return value if (type == :string || type == :text) && value.nil?
+      super
+    end
+
     def type_cast(value, map=true)
       if array && (map || value.is_a?(Array))
         return [] if map && !value.is_a?(Array)

data/lib/active_record/typed_store/extension.rb

@@ -4,21 +4,14 @@ require 'active_record/typed_store/dsl'
 module ActiveRecord::TypedStore
   AR_VERSION = Gem::Version.new(ActiveRecord::VERSION::STRING)
   IS_AR_3_2 = AR_VERSION < Gem::Version.new('4.0')
-  IS_AR_4_0 = AR_VERSION >= Gem::Version.new('4.0') && AR_VERSION < Gem::Version.new('4.1.0.beta')
   IS_AR_4_1 = AR_VERSION >= Gem::Version.new('4.1.0.beta')
 
-  unless IS_AR_3_2
-    ActiveModel::AttributeMethods::ClassMethods.send(:alias_method, :define_virtual_attribute_method, :define_attribute_method)
-  end
-
   module Extension
     extend ActiveSupport::Concern
 
     included do
       class_attribute :stored_typed_attributes, instance_accessor: false
       self.stored_typed_attributes = {}
-      require 'active_record/typed_store/ar_32_fallbacks' if IS_AR_3_2
-      require 'active_record/typed_store/ar_41_fallbacks' if IS_AR_4_1
     end
 
     module ClassMethods
@@ -32,34 +25,72 @@ module ActiveRecord::TypedStore
         stored_typed_attributes[store_attribute].merge!(dsl.columns.index_by(&:name))
 
         dsl.column_names.each { |c| define_virtual_attribute_method(c.to_s) }
+        dsl.column_names.each { |c| define_store_attribute_queries(store_attribute, c) }
+
+        super(store_attribute, dsl) if defined?(super)
 
         dsl
       end
 
+      private
+
+      def define_store_attribute_queries(store_attribute, column_name)
+        define_method("#{column_name}?") do
+          query_store_attribute(store_attribute, column_name)
+        end
+      end
+
+    end
+
+    def reload(*)
+      reload_stores!
+      super
     end
 
     protected
 
     def write_store_attribute(store_attribute, key, value)
-      casted_value = value
-      if store_definition = self.class.stored_typed_attributes[store_attribute]
-        if column_definition = store_definition[key]
-          casted_value = column_definition.cast(value)
-        end
-      end
-
-      attribute_will_change!(key.to_s) if casted_value != read_store_attribute(store_attribute, key)
+      previous_value = read_store_attribute(store_attribute, key)
+      casted_value = cast_store_attribute(store_attribute, key, value)
+      attribute_will_change!(key.to_s) if casted_value != previous_value
       super(store_attribute, key, casted_value)
     end
 
     private
 
+    def cast_store_attribute(store_attribute, key, value)
+      column = store_column_definition(store_attribute, key)
+      column ? column.cast(value) : value
+    end
+
+    def store_column_definition(store_attribute, key)
+      store_definition = self.class.stored_typed_attributes[store_attribute]
+      store_definition && store_definition[key]
+    end
+
+    def if_store_uninitialized(store_attribute)
+      initialized = "@_#{store_attribute}_initialized"
+      unless instance_variable_get(initialized)
+        yield
+        instance_variable_set(initialized, true)
+      end
+    end
+
+    def reload_stores!
+      self.class.stored_typed_attributes.keys.each do |store_attribute|
+        instance_variable_set("@_#{store_attribute}_initialized", false)
+      end
+    end
+
     def initialize_store_attribute(store_attribute)
-      store = IS_AR_4_0 ? super : send(store_attribute)
-      if columns = self.class.stored_typed_attributes[store_attribute]
-        store = initialize_store(store, columns.values)
+      store = defined?(super) ? super : send(store_attribute)
+      store.tap do |store|
+        if_store_uninitialized(store_attribute) do
+          if columns = self.class.stored_typed_attributes[store_attribute]
+            initialize_store(store, columns.values)
+          end
+        end
       end
-      store
     end
 
     def initialize_store(store, columns)
@@ -73,5 +104,36 @@ module ActiveRecord::TypedStore
       store
     end
 
+    # heavilly inspired from ActiveRecord::Base#query_attribute
+    def query_store_attribute(store_attribute, key)
+      value = read_store_attribute(store_attribute, key)
+
+      case value
+      when true        then true
+      when false, nil  then false
+      else
+        column = store_column_definition(store_attribute, key)
+        if column.nil?
+          if Numeric === value || value !~ /[^0-9]/
+            !value.to_i.zero?
+          else
+            return false if ActiveRecord::ConnectionAdapters::Column::FALSE_VALUES.include?(value)
+            !value.blank?
+          end
+        elsif column.number?
+          !value.zero?
+        else
+          !value.blank?
+        end
+      end
+    end
+
   end
+
+  require 'active_record/typed_store/ar_32_fallbacks' if IS_AR_3_2
+  require 'active_record/typed_store/ar_41_fallbacks' if IS_AR_4_1
+  unless IS_AR_3_2
+    ActiveModel::AttributeMethods::ClassMethods.send(:alias_method, :define_virtual_attribute_method, :define_attribute_method)
+  end
+
 end

data/lib/active_record/typed_store/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module TypedStore
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/activerecord-typedstore.rb

@@ -0,0 +1 @@
+require 'active_record/typed_store'

data/spec/active_record/typed_store_spec.rb

@@ -26,6 +26,19 @@ shared_examples 'any model' do
 
   end
 
+  describe 'attribute presence' do
+
+    it 'return true if present' do
+      expect(model.age?).to be_true
+    end
+
+    it 'return false if blank' do
+      model.age = 0
+      expect(model.age?).to be_false
+    end
+
+  end
+
   describe 'dirty tracking' do
 
     it 'track changed attributes' do
@@ -91,6 +104,10 @@ shared_examples 'any model' do
       expect(model.name).to be == ''
     end
 
+    it 'default to nil if specified explicitly' do
+      expect(model.cell_phone).to be_nil
+    end
+
     it 'properly cast the value as string' do
       model.update_attributes(name: 42)
       expect(model.reload.name).to be == '42'
@@ -325,6 +342,39 @@ shared_examples 'a store' do
 
   let(:model) { described_class.new }
 
+  describe 'initialization' do
+
+    it 'is done only once' do
+      model.should_receive(:initialize_store).once
+      3.times do
+        model.age = (rand * 100).to_i
+        model.age
+      end
+    end
+
+    it 'is done again after a reload' do
+      model.save
+
+      model.should_receive(:initialize_store).twice
+      3.times do
+        model.age = (rand * 100).to_i
+        model.age
+      end
+      model.reload
+      3.times do
+        model.age = (rand * 100).to_i
+        model.age
+      end
+    end
+
+    it 'is not performe if no store attributes are accessed' do
+      model.should_not_receive(:initialize_store)
+      model.update_attributes(untyped_settings: {foo: :bar})
+      model.update_attributes(untyped_settings: {})
+    end
+
+  end
+
   describe 'attributes' do
 
     it 'retrieve default if assigned nil and null not allowed' do
@@ -438,7 +488,6 @@ shared_examples 'a model supporting arrays' do |regular=false|
 end
 
 describe Sqlite3RegularARModel do
-  ActiveRecord::Base.establish_connection('test_sqlite3')
   it_should_behave_like 'any model'
   it_should_behave_like 'a db backed model'
 end

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 SimpleCov.start
 
-require 'active_record/typed_store'
+require 'activerecord-typedstore'
 
 Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each { |f| require f }
 

data/spec/support/models.rb

@@ -13,6 +13,7 @@ def define_columns(t)
 
   t.string :name, default: '', null: false
   t.string :email
+  t.string :cell_phone, default: nil
 
   t.boolean :public, default: false, null: false
   t.boolean :enabled, default: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-typedstore
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -161,6 +161,7 @@ files:
 - lib/active_record/typed_store/dsl.rb
 - lib/active_record/typed_store/extension.rb
 - lib/active_record/typed_store/version.rb
+- lib/activerecord-typedstore.rb
 - spec/active_record/typed_store_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb