store_attribute 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26bfe00fc2e06215356a2e050700f0d257e56401249c97487e26f58133f4ea0e
-  data.tar.gz: 5e9ba6def76cf0f0aa77130db602929da9725f1483508e244557e90e8bd22892
+  metadata.gz: 44ef41ba6670ce7ce109d0a856948ba3ae113328037e9b52025b7a7229b6580d
+  data.tar.gz: e25ade087cdad2fe69394462b227a0c1b580b4a0d977a8f505c6e28af916e143
 SHA512:
-  metadata.gz: 3de11ae80f51e606826b3dbbdd92afa4a7443ec24ef595c616908adb23f2588908052f5db52d963164843aa0868c30747b54921e9fdac2b7deaede4b770413b3
-  data.tar.gz: 6032541f1dd51712f9755b9ca8ccfa25b145c670d319a3dde909917fb0b7447069600a3fdd7c8fce40e131733fa6495e7be420f7a77aa5f60a88c36c28301f3a
+  metadata.gz: 29f7c336831838593456099308e7549e41a6d879585c1fb6f92dc2e48ba5150c4bba6856b2b9cb6e680c0b02882d8015f76d16bfcabab2ab73476d7e7dc4bc47
+  data.tar.gz: 0ca99dc3856dfef871cf57729bef285118e2a775b9dbb4b64038d39c2f6480aa9d6c162e97d54ffa7ea5d0d100cd3fccc016658268e76dcba6bed3d2ef7e0fa5

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change log
+
+## master
+
+## 0.6.0 (2019-07-24)
+
+- Added default values support. ([@dreikanter][], [@SumLare][])
+
+  See [PR #7](https://github.com/palkan/store_attribute/pull/7).
+
+- Start keeping changelog. ([@palkan][])
+
+[@palkan]: https://github.com/palkan
+[@dreikanter]: https://github.com/dreikanter
+[@SumLare]: https://github.com/SumLare

data/README.md

@@ -6,8 +6,7 @@ ActiveRecord extension which adds typecasting to store accessors.
 
 Compatible with Rails 4.2 and Rails 5+.
 
-<a href="https://evilmartians.com/">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+Extracted from not merged PR to Rails: [rails/rails#18942](https://github.com/rails/rails/pull/18942).
 
 ### Install
 
@@ -33,7 +32,7 @@ Where:
 - `store_name` The name of the store.
 - `name` The name of the accessor to the store.
 - `type` A symbol such as `:string` or `:integer`, or a type object to be used for the accessor.
-- `options` (optional) A hash of cast type options such as `precision`, `limit`, `scale`.
+- `options` (optional) A hash of cast type options such as `precision`, `limit`, `scale`, `default`.
 
 Type casting occurs every time you write data through accessor or update store itself
 and when object is loaded from database.
@@ -47,6 +46,8 @@ class MegaUser < User
   store_attribute :settings, :ratio, :integer, limit: 1
   store_attribute :settings, :login_at, :datetime
   store_attribute :settings, :active, :boolean
+  store_attribute :settings, :color, :string, default: "red"
+  store_attribute :settings, :data, :datetime, default: -> { Time.now }
 end
 
 u = MegaUser.new(active: false, login_at: "2015-01-01 00:01", ratio: "63.4608")
@@ -55,6 +56,10 @@ u.login_at.is_a?(DateTime) # => true
 u.login_at = DateTime.new(2015, 1, 1, 11, 0, 0)
 u.ratio # => 63
 u.active # => false
+# Default value is set
+u.color # => red
+# A dynamic default can also be provided
+u.data # => Current time
 # And we also have a predicate method
 u.active? # => false
 u.reload

data/lib/store_attribute/active_record/type/typed_store.rb

@@ -15,43 +15,57 @@ module ActiveRecord
 
       def initialize(subtype)
         @accessor_types = {}
+        @defaults = {}
         @store_accessor = subtype.accessor
         super(subtype)
       end
 
-      def add_typed_key(key, type, **options)
+      UNDEFINED = Object.new
+      private_constant :UNDEFINED
+
+      def add_typed_key(key, type, default: UNDEFINED, **options)
         type = ActiveRecord::Type.lookup(type, options) if type.is_a?(Symbol)
-        @accessor_types[key.to_s] = type
+        safe_key = key.to_s
+        @accessor_types[safe_key] = type
+        @defaults[safe_key] = default unless default == UNDEFINED
       end
 
       def deserialize(value)
         hash = super
-        if hash
-          accessor_types.each do |key, type|
-            hash[key] = type.deserialize(hash[key]) if hash.key?(key)
+        return hash unless hash
+        accessor_types.each do |key, type|
+          if hash.key?(key)
+            hash[key] = type.deserialize(hash[key])
+          elsif defaults.key?(key)
+            hash[key] = get_default(key)
           end
         end
         hash
       end
 
       def serialize(value)
-        if value.is_a?(Hash)
-          typed_casted = {}
-          accessor_types.each do |key, type|
-            k = key_to_cast(value, key)
-            typed_casted[k] = type.serialize(value[k]) unless k.nil?
+        return super(value) unless value.is_a?(Hash)
+        typed_casted = {}
+        accessor_types.each do |str_key, type|
+          key = key_to_cast(value, str_key)
+          next unless key
+          if value.key?(key)
+            typed_casted[key] = type.serialize(value[key])
+          elsif defaults.key?(str_key)
+            typed_casted[key] = type.serialize(get_default(str_key))
           end
-          super(value.merge(typed_casted))
-        else
-          super(value)
         end
+        super(value.merge(typed_casted))
       end
 
       def cast(value)
         hash = super
-        if hash
-          accessor_types.each do |key, type|
-            hash[key] = type.cast(hash[key]) if hash.key?(key)
+        return hash unless hash
+        accessor_types.each do |key, type|
+          if hash.key?(key)
+            hash[key] = type.cast(hash[key])
+          elsif defaults.key?(key)
+            hash[key] = get_default(key)
           end
         end
         hash
@@ -74,6 +88,7 @@ module ActiveRecord
       def key_to_cast(val, key)
         return key if val.key?(key)
         return key.to_sym if val.key?(key.to_sym)
+        return key if defaults.key?(key)
       end
 
       def typed?(key)
@@ -84,7 +99,12 @@ module ActiveRecord
         accessor_types.fetch(key.to_s)
       end
 
-      attr_reader :accessor_types, :store_accessor
+      def get_default(key)
+        value = defaults.fetch(key)
+        value.is_a?(Proc) ? value.call : value
+      end
+
+      attr_reader :accessor_types, :defaults, :store_accessor
     end
   end
 end

data/lib/store_attribute/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoreAttribute # :nodoc:
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

data/spec/cases/store_attribute_spec.rb

@@ -21,6 +21,9 @@ describe StoreAttribute do
     @connection.drop_table "users", if_exists: true
   end
 
+  let(:date) { Date.new(2019, 7, 17) }
+  let(:default_date) { User::DEFAULT_DATE }
+  let(:dynamic_date) { User::TODAY_DATE }
   let(:time) { DateTime.new(2015, 2, 14, 17, 0, 0) }
   let(:time_str) { "2015-02-14 17:00" }
   let(:time_str_utc) { "2015-02-14 17:00:00 UTC" }
@@ -120,7 +123,12 @@ describe StoreAttribute do
 
     it "re-typecast old data" do
       jamie = User.create!
-      User.update_all('jparams = \'{"active":"1", "salary":"12.02"}\'::jsonb')
+      User.update_all(
+        "jparams = '{"\
+          '"active":"1",'\
+          '"salary":"12.02"'\
+        "}'::jsonb"
+      )
 
       jamie = User.find(jamie.id)
       expect(jamie).to be_active
@@ -170,4 +178,39 @@ describe StoreAttribute do
       expect(jamie.inner_json).to eq("x" => 1)
     end
   end
+
+  context "default option" do
+    it "should init the field after an object is created" do
+      jamie = User.new
+      expect(jamie.static_date).to eq(default_date)
+    end
+
+    it "should not affect explicit initialization" do
+      jamie = User.new(static_date: date)
+      expect(jamie.static_date).to eq(date)
+    end
+
+    it "should not affect explicit nil initialization" do
+      jamie = User.new(static_date: nil)
+      expect(jamie.static_date).to be_nil
+    end
+
+    it "should handle a static value" do
+      jamie = User.create!
+      jamie = User.find(jamie.id)
+      expect(jamie.static_date).to eq(default_date)
+    end
+
+    it "should handle a lambda" do
+      jamie = User.create!
+      jamie = User.find(jamie.id)
+      expect(jamie.dynamic_date).to eq(dynamic_date)
+    end
+
+    it "should handle nil" do
+      jamie = User.create!
+      jamie = User.find(jamie.id)
+      expect(jamie.empty_date).to be_nil
+    end
+  end
 end

data/spec/store_attribute/typed_store_spec.rb

@@ -20,6 +20,37 @@ describe ActiveRecord::Type::TypedStore do
         date = ::Date.new(2016, 6, 22)
         expect(subject.cast(date: "2016-06-22")).to eq("date" => date)
       end
+
+      it "with default" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: date)
+
+        expect(subject.cast({})).to eq("date" => date)
+      end
+
+      it "with dynamic default" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: -> { date })
+
+        expect(subject.cast({})).to eq("date" => date)
+      end
+
+      it "with default and explicit nil" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: date)
+        nil_date = {"date" => nil}
+
+        expect(subject.cast(nil_date)).to eq(nil_date)
+      end
+
+      it "with default and existing value" do
+        default = ::Date.new(2016, 6, 22)
+        expected = ::Date.new(2019, 7, 17)
+        subject.add_typed_key("date", :date, default: default)
+        date = {"date" => expected}
+
+        expect(subject.cast("date" => expected.to_s)).to eq(date)
+      end
     end
 
     describe "#deserialize" do
@@ -34,6 +65,37 @@ describe ActiveRecord::Type::TypedStore do
         date = ::Date.new(2016, 6, 22)
         expect(subject.deserialize('{"date":"2016-06-22"}')).to eq("date" => date)
       end
+
+      it "with default" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: date)
+
+        expect(subject.deserialize("{}")).to eq("date" => date)
+      end
+
+      it "with dynamic default" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: -> { date })
+
+        expect(subject.deserialize("{}")).to eq("date" => date)
+      end
+
+      it "with default and explicit nil" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: date)
+        s11n = {"date" => nil}.to_json
+
+        expect(subject.deserialize(s11n)).to eq("date" => nil)
+      end
+
+      it "with default and existing value" do
+        default = ::Date.new(2016, 6, 22)
+        expected = ::Date.new(2019, 7, 17)
+        subject.add_typed_key("date", :date, default: default)
+        s11n = {"date" => expected}.to_json
+
+        expect(subject.deserialize(s11n)).to eq("date" => expected)
+      end
     end
 
     describe "#serialize" do
@@ -54,6 +116,25 @@ describe ActiveRecord::Type::TypedStore do
 
         expect { subject.serialize(val: 1024) }.to raise_error(RangeError)
       end
+
+      it "with type key and a default" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key("date", :date, default: date)
+        expect(subject.serialize({})).to eq({date: date}.to_json)
+      end
+
+      it "with type key and a dynamic default" do
+        date = ::Date.today
+        default = -> { date }
+        subject.add_typed_key("date", :date, default: default)
+        expect(subject.serialize({})).to eq({date: date}.to_json)
+      end
+
+      it "with a symbolic type key" do
+        date = ::Date.new(2016, 6, 22)
+        subject.add_typed_key(:date, :date, default: date)
+        expect(subject.serialize({})).to eq({date: date}.to_json)
+      end
     end
 
     describe ".create_from_type" do
@@ -66,6 +147,20 @@ describe ActiveRecord::Type::TypedStore do
         expect(type.cast(date: "2016-06-22", val: "1.2")).to eq("date" => date, "val" => "1.2")
         expect(new_type.cast(date: "2016-06-22", val: "1.2")).to eq("date" => date, "val" => 1)
       end
+
+      it "accepts default", :aggregate_failures do
+        default = 1
+        type = described_class.create_from_type(json_type, "val", :date, default: default)
+
+        expect(type.cast({})).to eq("val" => default)
+      end
+
+      it "accepts dynamic default", :aggregate_failures do
+        default = 1
+        type = described_class.create_from_type(json_type, "val", :date, default: -> { default })
+
+        expect(type.cast({})).to eq("val" => default)
+      end
     end
   end
 
@@ -105,5 +200,41 @@ describe ActiveRecord::Type::TypedStore do
       expect(subject.serialize(date: date)).to eq "--- !ruby/hash:ActiveSupport::HashWithIndifferentAccess\ndate: 2016-06-22\n"
       expect(subject.serialize("date" => date)).to eq "--- !ruby/hash:ActiveSupport::HashWithIndifferentAccess\ndate: 2016-06-22\n"
     end
+
+    it "uses default" do
+      default = ::Date.new(2019, 7, 17)
+      subject.add_typed_key("date", :date, default: default)
+
+      expect(subject.deserialize("---\n")).to eq("date" => default)
+    end
+
+    it "uses dynamic default" do
+      default = -> { ::Date.new(2019, 7, 17) }
+      subject.add_typed_key("date", :date, default: default)
+
+      expect(subject.deserialize("---\n")).to eq("date" => default.call)
+    end
+
+    it "keeps explicit nil" do
+      default = ::Date.new(2019, 7, 17)
+      subject.add_typed_key("date", :date, default: default)
+
+      expect(subject.deserialize("---\ndate: null\n")).to eq("date" => nil)
+    end
+
+    it "keeps existing value" do
+      default = ::Date.new(2019, 7, 17)
+      date = ::Date.new(2016, 6, 22)
+      subject.add_typed_key("date", :date, default: default)
+
+      expect(subject.deserialize("---\ndate: #{date}\n")).to eq("date" => date)
+    end
+
+    it "with a default" do
+      default = ::Date.new(2019, 7, 17)
+      subject.add_typed_key("date", :date, default: default)
+      expected = "--- !ruby/hash:ActiveSupport::HashWithIndifferentAccess\ndate: 2019-07-17\n"
+      expect(subject.serialize({})).to eq(expected)
+    end
   end
 end

data/spec/support/user.rb

@@ -5,9 +5,14 @@ class RawUser < ActiveRecord::Base
 end
 
 class User < ActiveRecord::Base
+  DEFAULT_DATE = ::Date.new(2019, 7, 17)
+  TODAY_DATE = ::Date.today
+
   store_accessor :jparams, :version, active: :boolean, salary: :integer
   store_attribute :jparams, :birthday, :date
-
+  store_attribute :jparams, :static_date, :date, default: DEFAULT_DATE
+  store_attribute :jparams, :dynamic_date, :date, default: -> { TODAY_DATE }
+  store_attribute :jparams, :empty_date, :date, default: nil
   store_attribute :jparams, :inner_json, :json
 
   store :custom, accessors: [price: :money_type]

data/store_attribute.gemspec

@@ -21,6 +21,14 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.4.0"
 
+  s.metadata = {
+    "bug_tracker_uri" => "http://github.com/palkan/store_attribute/issues",
+    "changelog_uri" => "https://github.com/palkan/store_attribute/blob/master/CHANGELOG.md",
+    "documentation_uri" => "http://github.com/palkan/store_attribute",
+    "homepage_uri" => "http://github.com/palkan/store_attribute",
+    "source_code_uri" => "http://github.com/palkan/store_attribute"
+  }
+
   s.add_runtime_dependency "activerecord", ">= 5.0"
 
   s.add_development_dependency "pg", ">= 0.18"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_attribute
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,6 +147,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -172,7 +173,12 @@ files:
 homepage: http://github.com/palkan/store_attribute
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://github.com/palkan/store_attribute/issues
+  changelog_uri: https://github.com/palkan/store_attribute/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/store_attribute
+  homepage_uri: http://github.com/palkan/store_attribute
+  source_code_uri: http://github.com/palkan/store_attribute
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -188,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ActiveRecord extension which adds typecasting to store accessors