activerecord-typedstore 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c3d4b1b4f103d05dc3371d1e8ebeb7f666ac227
-  data.tar.gz: 33f47581329169894a7c7c9f3b79cec592b62eb4
+  metadata.gz: e093bbab4aa7f56fe8b248cbc6b3ffee4c896523
+  data.tar.gz: 101fbbb8b13b3687010ce3543e371be6b4561ff1
 SHA512:
-  metadata.gz: 6e35186b4dfbc9b54984d4e5a350035ecc8c64136f827ab3762586aeb14477699d2035fcce317d113402c393c068103acdddd23415ec6d69f879040d1831c111
-  data.tar.gz: b32badf3a634ba1aa2b572129622e9a4a2650bfefef3fbf470ee37f891c0080225d1fdb054aa0089b299dd6d0e051c26b62cb02e061e415e5b9fb3877b6ac228
+  metadata.gz: 81ccdf476b884892c67460b9945784d593e50380a7e452452d0a3b54a60f82c3e39cf8a70f64bd154f01337ecac60675866f525aaf6d39a1536ed551c971d10b
+  data.tar.gz: da7fc4fc81c1cd22156b78dad835ee14ec788b9cdc69f7d2ccc839dc0e9f77fb5a024cf13dc159db43e297d6251f6e579759a061f2287fd85443bf23fc9b6a6b

data/.travis.yml

@@ -8,4 +8,7 @@ gemfile:
 
 before_script:
   - mysql -e 'create database typed_store_test;'
-  - psql -c 'create database typed_store_test;' -U postgres
+
+env:
+  - TIMEZONE_AWARE=1 POSTGRES=1 MYSQL=1 POSTGRES_URL=$(curl http://api.postgression.com)
+  - TIMEZONE_AWARE=0 POSTGRES=1 MYSQL=1 POSTGRES_URL=$(curl http://api.postgression.com)

data/README.md

@@ -36,7 +36,7 @@ class Shop < ActiveRecord::Base
     s.string :email
     s.datetime :publish_at
     s.integer :age, null: false
-    
+
     # You can define array attributes like in rails 4 and postgres
     s.string :tags, array: true, default: [], null: false
 
@@ -92,3 +92,8 @@ If not, please fill an issue.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## TODO
+
+- HStore support with ActiveRecord 4.1.0.beta (master)
+- Handle casting and default at the store layer, so accessors are not mandatory anymore. See #4

data/Rakefile

@@ -4,3 +4,21 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+namespace :spec do
+  task :all do
+    %w(3.2 4.0 edge).each do |ar_version|
+      [1, 0].each do |timezone_aware|
+        command = %W{
+          BUNDLE_GEMFILE=gemfiles/Gemfile.ar-#{ar_version}
+          TIMEZONE_AWARE=#{timezone_aware}
+          MYSQL=1
+          POSTGRES=1
+          rspec
+        }.join(' ')
+        puts command
+        puts `#{command}`
+      end
+    end
+  end
+end

data/lib/active_record/typed_store/extension.rb

@@ -10,8 +10,10 @@ module ActiveRecord::TypedStore
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :stored_typed_attributes, instance_accessor: false
-      self.stored_typed_attributes = {}
+      class_attribute :typed_stores, instance_accessor: false
+      class_attribute :typed_store_attributes, instance_accessor: false
+      self.typed_stores = {}
+      self.typed_store_attributes = {}
     end
 
     module ClassMethods
@@ -19,10 +21,15 @@ module ActiveRecord::TypedStore
       def typed_store(store_attribute, options={}, &block)
         dsl = DSL.new(&block)
 
-        store(store_attribute, options.merge(accessors: dsl.column_names))
+        if hstore?(store_attribute)
+          store_accessor(store_attribute, dsl.column_names)
+        else
+          store(store_attribute, options.merge(accessors: dsl.column_names))
+        end
 
-        stored_typed_attributes[store_attribute] ||= {}
-        stored_typed_attributes[store_attribute].merge!(dsl.columns.index_by(&:name))
+        typed_stores[store_attribute] ||= {}
+        typed_stores[store_attribute].merge!(dsl.columns.index_by(&:name))
+        typed_store_attributes.merge!(dsl.columns.index_by { |c| c.name.to_s })
 
         dsl.column_names.each { |c| define_virtual_attribute_method(c.to_s) }
         dsl.column_names.each { |c| define_store_attribute_queries(store_attribute, c) }
@@ -34,6 +41,15 @@ module ActiveRecord::TypedStore
 
       private
 
+      def hstore?(store_attribute)
+        columns_hash[store_attribute.to_s].try(:type) == :hstore
+      end
+
+      def create_time_zone_conversion_attribute?(name, column)
+        column ||= typed_store_attributes[name]
+        super(name, column)
+      end
+
       def define_store_attribute_queries(store_attribute, column_name)
         define_method("#{column_name}?") do
           query_store_attribute(store_attribute, column_name)
@@ -50,6 +66,11 @@ module ActiveRecord::TypedStore
     protected
 
     def write_store_attribute(store_attribute, key, value)
+      column = store_column_definition(store_attribute, key)
+      if column.try(:type) == :datetime && self.class.time_zone_aware_attributes && value.respond_to?(:in_time_zone)
+        value = value.in_time_zone
+      end
+
       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
@@ -64,7 +85,7 @@ module ActiveRecord::TypedStore
     end
 
     def store_column_definition(store_attribute, key)
-      store_definition = self.class.stored_typed_attributes[store_attribute]
+      store_definition = self.class.typed_stores[store_attribute]
       store_definition && store_definition[key]
     end
 
@@ -77,7 +98,7 @@ module ActiveRecord::TypedStore
     end
 
     def reload_stores!
-      self.class.stored_typed_attributes.keys.each do |store_attribute|
+      self.class.typed_stores.keys.each do |store_attribute|
         instance_variable_set("@_#{store_attribute}_initialized", false)
       end
     end
@@ -86,7 +107,7 @@ module ActiveRecord::TypedStore
       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]
+          if columns = self.class.typed_stores[store_attribute]
             initialize_store(store, columns.values)
           end
         end
@@ -113,14 +134,8 @@ module ActiveRecord::TypedStore
       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?
+
+        if column.number?
           !value.zero?
         else
           !value.blank?

data/lib/active_record/typed_store/version.rb

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

data/spec/active_record/typed_store_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-ar_version = Gem::Version.new(ActiveRecord::VERSION::STRING)
-ar_4_0 = Gem::Version.new('4.0')
-ar_4_1 = Gem::Version.new('4.1.0.beta')
-
 shared_examples 'any model' do
 
   let(:model) { described_class.new }
@@ -26,19 +22,6 @@ 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
@@ -113,6 +96,19 @@ shared_examples 'any model' do
       expect(model.reload.name).to be == '42'
     end
 
+    it 'any string is considered present' do
+      model.name = 'Peter Gibbons'
+      expect(model.name?).to be_true
+    end
+
+    it 'empty string is not considered present' do
+      expect(model.name?).to be_false
+    end
+
+    it 'nil is not considered present' do
+      expect(model.cell_phone?).to be_false
+    end
+
   end
 
   describe 'boolean attribute' do
@@ -162,6 +158,19 @@ shared_examples 'any model' do
       expect(model.reload.enabled).to be_true
     end
 
+    it 'true is considered present' do
+      expect(model.enabled?).to be_true
+    end
+
+    it 'false is not considered present' do
+      expect(model.public?).to be_false
+    end
+
+    it 'nil is not considered present' do
+      model.update_attributes(enabled: nil)
+      expect(model.enabled?).to be_false
+    end
+
   end
 
   describe 'integer attributes' do
@@ -185,6 +194,25 @@ shared_examples 'any model' do
       expect(model.reload.max_length).to be_nil
     end
 
+    it 'positive values are considered present' do
+      expect(model.age?).to be_true
+    end
+
+    it 'negative values are considered present' do
+      model.age = -42
+      expect(model.age?).to be_true
+    end
+
+    it '0 is not considered present' do
+      model.age = 0
+      expect(model.age?).to be_false
+    end
+
+    it 'nil is not considered present' do
+      model.max_length = nil
+      expect(model.max_length?).to be_false
+    end
+
   end
 
   describe 'float attributes' do
@@ -208,6 +236,24 @@ shared_examples 'any model' do
       expect(model.reload.price).to be_nil
     end
 
+    it 'positive values are considered present' do
+      model.rate = 4.2
+      expect(model.rate?).to be_true
+    end
+
+    it 'negative values are considered present' do
+      model.rate = -4.2
+      expect(model.rate?).to be_true
+    end
+
+    it '0 is not considered present' do
+      expect(model.rate?).to be_false
+    end
+
+    it 'nil is not considered present' do
+      expect(model.price?).to be_false
+    end
+
   end
 
   describe 'decimal attributes' do
@@ -240,6 +286,25 @@ shared_examples 'any model' do
       expect(model.reload.shipping_cost).to be_nil
     end
 
+    it 'positive values are considered present' do
+      model.shipping_cost = BigDecimal.new('4.2')
+      expect(model.shipping_cost?).to be_true
+    end
+
+    it 'negative values are considered present' do
+      model.shipping_cost = BigDecimal.new('-4.2')
+      expect(model.shipping_cost?).to be_true
+    end
+
+    it '0 is not considered present' do
+      model.shipping_cost = BigDecimal.new('0')
+      expect(model.shipping_cost?).to be_false
+    end
+
+    it 'nil is not considered present' do
+      expect(model.shipping_cost?).to be_false
+    end
+
   end
 
   describe 'date attributes' do
@@ -270,17 +335,26 @@ shared_examples 'any model' do
       expect(model.reload.remind_on).to be_nil
     end
 
+    it 'any non-nil value is considered present' do
+      model.remind_on = Date.new
+      expect(model.remind_on?).to be_true
+    end
+
+    it 'nil is not considered present' do
+      expect(model.remind_on?).to be_false
+    end
+
   end
 
   describe 'datetime attributes' do
 
     let(:datetime) { DateTime.new(1984, 6, 8, 13, 57, 12) }
     let(:datetime_string) { '1984-06-08 13:57:12' }
-    let(:time) { Time.parse(datetime_string) }
+    let(:time) { datetime_string.respond_to?(:in_time_zone) ? datetime_string.in_time_zone : Time.parse(datetime_string) }
 
     context "with ActiveRecord #{ActiveRecord::VERSION::STRING}" do
 
-      if ar_version < ar_4_0
+      if AR_VERSION < AR_4_0
 
         it 'has the defined default as initial value' do
           model.save
@@ -316,10 +390,22 @@ shared_examples 'any model' do
           expect(model.reload.published_at).to be == datetime
         end
 
-        it 'properly cast assigned value to datetime' do
-          model.remind_at = datetime_string
-          expect(model.remind_at).to be == datetime
+        if ActiveRecord::Base.time_zone_aware_attributes
+
+          it 'properly cast assigned value to time' do
+            model.remind_at = datetime_string
+            expect(model.remind_at).to be == time
+          end
+
+        else
+
+          it 'properly cast assigned value to datetime' do
+            model.remind_at = datetime_string
+            expect(model.remind_at).to be == datetime
+          end
+
         end
+
       end
 
     end
@@ -334,11 +420,20 @@ shared_examples 'any model' do
       expect(model.reload.remind_at).to be_nil
     end
 
+    it 'any non-nil value is considered present' do
+      model.remind_at = DateTime.new
+      expect(model.remind_at?).to be_true
+    end
+
+    it 'nil is not considered present' do
+      expect(model.remind_at?).to be_false
+    end
+
   end
 
 end
 
-shared_examples 'a store' do
+shared_examples 'a store' do |retain_type=true|
 
   let(:model) { described_class.new }
 
@@ -396,7 +491,7 @@ shared_examples 'a store' do
       expect(model.reload.author).to be == 'George'
 
       model.update_attributes(author: 42)
-      expect(model.reload.author).to be == 42
+      expect(model.reload.author).to be == (retain_type ? 42 : '42')
     end
 
     it 'still handle default' do
@@ -420,7 +515,7 @@ shared_examples 'a db backed model' do
 
 end
 
-shared_examples 'a model supporting arrays' do |regular=false|
+shared_examples 'a model supporting arrays' do |pg_native=false|
 
   let(:model) { described_class.new }
 
@@ -430,7 +525,7 @@ shared_examples 'a model supporting arrays' do |regular=false|
   end
 
   it 'cast values inside the array (integer)' do
-    pending('ActiveRecord bug: https://github.com/rails/rails/pull/11245') if regular
+    pending('ActiveRecord bug: https://github.com/rails/rails/pull/11245') if pg_native
     model.update_attributes(grades: ['1', 2, 3.4])
     expect(model.reload.grades).to be == [1, 2, 3]
   end
@@ -450,14 +545,14 @@ shared_examples 'a model supporting arrays' do |regular=false|
     expect(model.reload.grades).to be == []
   end
 
-  if !regular || ar_version == ar_4_1
+  if !pg_native || AR_VERSION == AR_4_1
     it 'accept multidimensianl arrays' do
       model.update_attributes(grades: [[1, 2], [3, 4]])
       expect(model.reload.grades).to be == [[1, 2], [3, 4]]
     end
   end
 
-  if regular
+  if pg_native
 
     it 'raise on non rectangular multidimensianl arrays' do
       expect{
@@ -487,6 +582,7 @@ shared_examples 'a model supporting arrays' do |regular=false|
 
 end
 
+
 describe Sqlite3RegularARModel do
   it_should_behave_like 'any model'
   it_should_behave_like 'a db backed model'
@@ -495,13 +591,28 @@ end
 describe MysqlRegularARModel do
   it_should_behave_like 'any model'
   it_should_behave_like 'a db backed model'
-end
+end if defined?(MysqlRegularARModel)
 
 describe PostgresqlRegularARModel do
   it_should_behave_like 'any model'
   it_should_behave_like 'a db backed model'
-  it_should_behave_like 'a model supporting arrays', true if ar_version >= ar_4_0
-end
+  it_should_behave_like 'a model supporting arrays', true if AR_VERSION >= AR_4_0
+end if defined?(PostgresqlRegularARModel)
+
+describe PostgresHstoreTypedStoreModel do
+  if AR_VERSION >= AR_4_0
+    pending('TODO: Rails edge HStore compatibiliy')
+  else
+    it_should_behave_like 'any model'
+    it_should_behave_like 'a store', false
+  end
+end if defined?(PostgresHstoreTypedStoreModel)
+
+describe PostgresJsonTypedStoreModel do
+  it_should_behave_like 'any model'
+  it_should_behave_like 'a store'
+  it_should_behave_like 'a model supporting arrays'
+end if defined?(PostgresJsonTypedStoreModel)
 
 describe YamlTypedStoreModel do
   it_should_behave_like 'any model'

data/spec/support/models.rb

@@ -2,6 +2,11 @@ require 'active_record'
 require 'json'
 require 'yaml'
 
+AR_VERSION = Gem::Version.new(ActiveRecord::VERSION::STRING)
+AR_4_0 = Gem::Version.new('4.0')
+AR_4_1 = Gem::Version.new('4.1.0.beta')
+
+ActiveRecord::Base.time_zone_aware_attributes = ENV['TIMEZONE_AWARE'] != '0'
 ActiveRecord::Base.configurations = {
   'test_sqlite3' => {adapter: 'sqlite3', database: "/tmp/typed_store.db"},
   'test_postgresql' => {adapter: 'postgresql', database: 'typed_store_test', username: 'postgres'},
@@ -53,11 +58,23 @@ class CreateAllTables < ActiveRecord::Migration
   end
 
   def self.up
-    ActiveRecord::Base.establish_connection('test_mysql')
-    recreate_table(:mysql_regular_ar_models) { |t| define_columns(t); t.text :untyped_settings }
+    if ENV['MYSQL']
+      ActiveRecord::Base.establish_connection('test_mysql')
+      recreate_table(:mysql_regular_ar_models) { |t| define_columns(t); t.text :untyped_settings }
+    end
+
+    if ENV['POSTGRES']
+      ActiveRecord::Base.establish_connection(ENV['POSTGRES_URL'] || 'test_postgresql')
+      recreate_table(:postgresql_regular_ar_models) { |t| define_columns(t); t.text :untyped_settings }
 
-    ActiveRecord::Base.establish_connection('test_postgresql')
-    recreate_table(:postgresql_regular_ar_models) { |t| define_columns(t); t.text :untyped_settings }
+      if AR_VERSION >= AR_4_0
+        execute "create extension if not exists hstore"
+        recreate_table(:postgres_hstore_typed_store_models) { |t| t.hstore :settings; t.text :untyped_settings }
+
+        #execute "create extension if not exists json"
+        recreate_table(:postgres_json_typed_store_models) { |t| t.json :settings; t.text :untyped_settings }
+      end
+    end
 
     ActiveRecord::Base.establish_connection('test_sqlite3')
     recreate_table(:sqlite3_regular_ar_models) { |t| define_columns(t); t.text :untyped_settings }
@@ -69,14 +86,68 @@ end
 ActiveRecord::Migration.verbose = false
 CreateAllTables.up
 
-class MysqlRegularARModel < ActiveRecord::Base
-  establish_connection 'test_mysql'
-  store :untyped_settings, accessors: [:title]
+class ColumnCoder
+
+  def initialize(coder)
+    @coder = coder
+  end
+
+  def load(data)
+    return {} unless data
+    @coder.load(data)
+  end
+
+  def dump(data)
+    @coder.dump(data || {})
+  end
+
 end
 
-class PostgresqlRegularARModel < ActiveRecord::Base
-  establish_connection 'test_postgresql'
-  store :untyped_settings, accessors: [:title]
+module AsJson
+  extend self
+
+  def load(value)
+    value
+  end
+
+  def dump(value)
+    value.as_json
+  end
+
+end
+
+if ENV['MYSQL']
+  class MysqlRegularARModel < ActiveRecord::Base
+    establish_connection 'test_mysql'
+    store :untyped_settings, accessors: [:title]
+  end
+end
+
+if ENV['POSTGRES']
+  class PostgresqlRegularARModel < ActiveRecord::Base
+    establish_connection ENV['POSTGRES_URL'] || 'test_postgresql'
+    store :untyped_settings, accessors: [:title]
+  end
+
+  if AR_VERSION >= AR_4_0
+
+    class PostgresHstoreTypedStoreModel < ActiveRecord::Base
+      establish_connection ENV['POSTGRES_URL'] || 'test_postgresql'
+      store :untyped_settings, accessors: [:title]
+      typed_store :settings do |s|
+        define_store_columns(s)
+      end
+    end
+
+    class PostgresJsonTypedStoreModel < ActiveRecord::Base
+      establish_connection ENV['POSTGRES_URL'] || 'test_postgresql'
+      store :untyped_settings, accessors: [:title]
+      typed_store :settings, coder: ColumnCoder.new(AsJson) do |s|
+        define_store_columns(s)
+      end
+    end
+
+  end
 end
 
 class Sqlite3RegularARModel < ActiveRecord::Base
@@ -92,23 +163,6 @@ class YamlTypedStoreModel < ActiveRecord::Base
   end
 end
 
-class ColumnCoder
-  
-  def initialize(coder)
-    @coder = coder
-  end
-  
-  def load(data)
-    return {} unless data
-    @coder.load(data)
-  end
-
-  def dump(data)
-    @coder.dump(data || {})
-  end
-
-end
-
 class JsonTypedStoreModel < ActiveRecord::Base
   establish_connection 'test_sqlite3'
   store :untyped_settings, accessors: [:title]
@@ -124,3 +178,15 @@ class MarshalTypedStoreModel < ActiveRecord::Base
     define_store_columns(s)
   end
 end
+
+
+Models = [
+  Sqlite3RegularARModel,
+  YamlTypedStoreModel,
+  JsonTypedStoreModel,
+  MarshalTypedStoreModel
+]
+Models << MysqlRegularARModel if defined?(MysqlRegularARModel)
+Models << PostgresqlRegularARModel if defined?(PostgresqlRegularARModel)
+Models << PostgresHstoreTypedStoreModel if defined?(PostgresHstoreTypedStoreModel)
+Models << PostgresJsonTypedStoreModel if defined?(PostgresJsonTypedStoreModel)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-typedstore
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord