- PR for fixing the default {} issue #108

 now {} is serialized to db when the default value is {} instead of nil

Author: danielspaniel

.gitignore

@@ -16,4 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 gemfiles/*.lock
-
+.idea/*

lib/active_record/typed_store/extension.rb

@@ -8,7 +8,7 @@
 
 module ActiveRecord::TypedStore
   module Extension
-    def typed_store(store_attribute, options={}, &block)
+    def typed_store(store_attribute, options = {}, &block)
       unless self < Behavior
         include Behavior
         class_attribute :typed_stores, :store_accessors, instance_accessor: false
@@ -22,19 +22,20 @@ def typed_store(store_attribute, options={}, &block)
       typed_klass = TypedHash.create(dsl.fields.values)
       const_set("#{store_attribute}_hash".camelize, typed_klass)
 
+      properties = extract_attribute_properties(store_attribute)
       if ActiveRecord.version >= Gem::Version.new('7.2.0.alpha')
         decorate_attributes([store_attribute]) do |name, subtype|
           subtype = subtype.subtype if subtype.is_a?(Type)
-          Type.new(typed_klass, dsl.coder, subtype)
+          Type.new(typed_klass, dsl.coder, subtype, properties: properties)
         end
       elsif ActiveRecord.version >= Gem::Version.new('6.1.0.alpha')
         attribute(store_attribute) do |subtype|
           subtype = subtype.subtype if subtype.is_a?(Type)
-          Type.new(typed_klass, dsl.coder, subtype)
+          Type.new(typed_klass, dsl.coder, subtype, properties: properties)
         end
       else
         decorate_attribute_type(store_attribute, :typed_store) do |subtype|
-          Type.new(typed_klass, dsl.coder, subtype)
+          Type.new(typed_klass, dsl.coder, subtype, properties: properties)
         end
       end
       store_accessor(store_attribute, dsl.accessors.keys, **store_options)
@@ -54,5 +55,15 @@ def typed_store(store_attribute, options={}, &block)
         end
       end
     end
+
+    def extract_attribute_properties(store_attribute)
+      parent = self.ancestors.first
+      column_info = parent.columns_hash if parent.superclass == ActiveRecord::Base
+      attribute_def = column_info[store_attribute.to_s]
+      { null: attribute_def.null, default: attribute_def.default }
+    rescue StandardError => e
+      {}
+    end
   end
+
 end

lib/active_record/typed_store/type.rb

@@ -2,8 +2,9 @@
 
 module ActiveRecord::TypedStore
   class Type < ActiveRecord::Type::Serialized
-    def initialize(typed_hash_klass, coder, subtype)
+    def initialize(typed_hash_klass, coder, subtype, properties: {})
       @typed_hash_klass = typed_hash_klass
+      @properties = properties
       super(subtype, coder)
     end
 
@@ -36,6 +37,8 @@ def defaults
     end
 
     def default_value?(value)
+      return false if (@properties[:null] == false || @properties[:default] == '{}') && value == {} && defaults == {}
+
       value == defaults
     end
 

spec/active_record/typed_store_spec.rb

@@ -500,6 +500,73 @@
 
 end
 
+describe "saving model when typed_store property is empty" do
+
+  it "when db schema declares null: false, saves empty hash in db" do
+    ActiveRecord::Schema.define do
+      create_table :product1s, force: true do |t|
+        t.json :properties, null: false, default: {}
+      end
+    end
+
+    class Product1 < ActiveRecord::Base
+      typed_store :properties, coder: ActiveRecord::TypedStore::IdentityCoder do |s|
+        s.string :some_property
+      end
+    end
+
+    Product1.new().save
+
+    saved_properties = ActiveRecord::Base.connection.select_all("select * from product1s")
+                                         .map { |row| row['properties'] }
+
+    expect(saved_properties).to eq(['{}'])
+  end
+
+  it "when db schema declares null: true, with default {} saves {} in db" do
+    ActiveRecord::Schema.define do
+      create_table :product3s, force: true do |t|
+        t.json :properties, default: {}
+      end
+    end
+
+    class Product3 < ActiveRecord::Base
+      typed_store :properties, coder: ActiveRecord::TypedStore::IdentityCoder do |s|
+        s.string :some_property
+      end
+    end
+
+    Product3.new().save
+
+    saved_properties = ActiveRecord::Base.connection.select_all("select * from product3s")
+                                         .map { |row| row['properties'] }
+
+    expect(saved_properties).to eq(['{}'])
+  end
+
+  it "when db schema declares null: true, and no default, saves nil in db" do
+    ActiveRecord::Schema.define do
+      create_table :product2s, force: true do |t|
+        t.json :properties
+      end
+    end
+
+    class Product2 < ActiveRecord::Base
+      typed_store :properties, coder: ActiveRecord::TypedStore::IdentityCoder do |s|
+        s.string :some_property
+      end
+    end
+
+    Product2.new().save
+
+    saved_properties = ActiveRecord::Base.connection.select_all("select * from product2s")
+                                         .map { |row| row['properties'] }
+
+    expect(saved_properties).to eq([nil])
+  end
+
+end
+
 shared_examples 'a store' do |retain_type = true, settings_type = :text|
   let(:model) { described_class.new }
 
@@ -799,7 +866,8 @@
       expect(model.explicit_settings[:signup][:counter]).to be_nil
     end
 
-    it 'coerce hashes to HashWithIndifferentAccess' do # this is actually Rails behavior
+    it 'coerce hashes to HashWithIndifferentAccess' do
+      # this is actually Rails behavior
       model.signup[:metadata] = { "signed_up_at" => Time.now }
       expect(model.signup[:metadata]).to be_a ActiveSupport::HashWithIndifferentAccess
     end
@@ -832,7 +900,7 @@
 
 end
 
-shared_examples 'a model supporting arrays' do |pg_native=false|
+shared_examples 'a model supporting arrays' do |pg_native = false|
 
   let(:model) { described_class.new }
 
@@ -871,13 +939,13 @@
   if pg_native
 
     it 'raise on non rectangular multidimensianl arrays' do
-      expect{
+      expect {
         model.update(grades: [[1, 2], [3, 4, 5]])
       }.to raise_error(ActiveRecord::StatementInvalid)
     end
 
     it 'raise on non nil assignation if column is non nullable' do
-      expect{
+      expect {
         model.update(tags: nil)
       }.to raise_error(ActiveRecord::StatementInvalid)
     end