attribute_cache 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa6e9e1044472ae54ebeac9e70d18a52d20b93461f79526b0ad73857ab2d82c
-  data.tar.gz: d5bd1fc2e76d72e64f00eccc7272b77aaecb61b9ab39675499bced0dd7a89eca
+  metadata.gz: 66a21b6648b4cfdfd46b0a30e6f98e574638b0b7fefe09e13b9cf1d566a6c358
+  data.tar.gz: e31fae03845ef5bb5d0b8144b502539a299258d7fecf863420ab246d9444e2a3
 SHA512:
-  metadata.gz: dbce65bc84784353b25dd06439f4af95307c633d36751f409a58f75f9b0f3d8fa8f5a0c67689ce2fc8c81c9c83dfb65c358fc646d1085663b023179b78c0c996
-  data.tar.gz: 1cf6172850c165c3145fa4599c663f1a60ff11514e6534d390725433afd746188493d3703299be10a5b1422b2de315f4289eeb2d193d702c356e5c70c228b66e
+  metadata.gz: 8b7b7e01e7e9d516b76be4c1b55cc28ecd7a224912174a13ce0b8c7ea814398a51978e5142560f721850883debc2c9dee814677e6aa554dc34e3ac8bc90248fa
+  data.tar.gz: 49133b0d6ebb635ca0676b6526b560f4c94cd806bbc4c6abfe47b469d414394c3f78bb8cb2605cc11e273cfa3b4cec8eaf8936bcaeb49301d8ff80980b30c51c

data/lib/attribute_cache.rb

@@ -1,47 +1,69 @@
+require 'first_existing'
 require 'attribute_cache/version'
 require 'attribute_cache/railtie'
+require 'attribute_cache/attribute_cache'
 
 module AttributeCache
   extend ActiveSupport::Concern
 
   included do
-    def self.attribute_cache(name, attribute: nil, callback: nil, callback_prefix: 'calculate',
-                             attribute_prefix: 'cached', &block)
-      attribute ||= :"#{attribute_prefix}_#{name}"
-      callback ||= :"#{callback_prefix}_#{name}"
+    def self.attribute_cache(name, options = {}, &block)
+      options.default! :attribute_prefix, 'cached'
+      options.default! :callback_prefix,  'calculate'
 
-      set_method = "set_#{name}"
-      set_save_method = "set_#{name}!"
+      options.default! :attribute, :"#{options[:attribute_prefix]}_#{name}"
+      options.default! :callback,  :"#{options[:callback_prefix]}_#{name}"
 
-      define_method set_method do
-        write_attribute(attribute, call_callback(callback, self, &block))
+      options[:callback] = block if block_given?
+
+      options.default! :cache_on_create, false
+      options.default! :dependent_on, []
+
+      options[:dependent_on] = [options[:dependent_on]] unless options[:dependent_on].is_a? Array
+
+      attr_cache = AttributeCache.new(
+        name: name,
+        attribute: options[:attribute],
+        callback: options[:callback]
+      )
+
+      if options[:cache_on_create]
+        before_create(if: -> { read_attribute(options[:attribute]).nil? }) do
+          attr_cache.set_attribute(self)
+        end
       end
-      define_method("invalidate_#{name}") { send(set_method) }
 
-      define_method set_save_method do
-        send(set_method)
-        save
+      if options[:dependent_on].count.positive?
+        before_update(if: -> { dependent_attribute_will_change(self, options[:dependent_on]) }) do
+          attr_cache.invalidate_attribute(self)
+        end
       end
-      define_method("invalidate_#{name}!") { send(set_save_method) }
 
-      define_method name do |save: true, keep_blanks: true|
-        setter = save ? set_save_method : set_method
-        send(setter) if read_attribute(attribute).nil? || !keep_blanks && read_attribute(attribute).blank?
-        read_attribute(attribute)
+      define_method("set_#{name}") do |save: false|
+        attr_cache.set_attribute(self, save: save)
+      end
+
+      define_method("invalidate_#{name}") do |save: false|
+        attr_cache.invalidate_attribute(self, save: save)
+      end
+
+      define_method("set_#{name}!") do
+        attr_cache.set_attribute!(self)
+      end
+
+      define_method("invalidate_#{name}!") do
+        attr_cache.invalidate_attribute!(self)
+      end
+
+      define_method(name) do |save: true, keep_blanks: true|
+        attr_cache.value(self, save: save, keep_blanks: keep_blanks)
       end
     end
   end
 
-  def call_callback(callback, record)
-    return yield if block_given?
+  private
 
-    case callback
-    when Symbol, String
-      record.send(callback)
-    when Proc
-      callback[]
-    else
-      raise 'An invalid callback was provided!'
-    end
+  def dependent_attribute_will_change(record, dependent_on)
+    dependent_on.any? { |d| record.will_save_change_to_attribute?(d) }
   end
 end

data/lib/attribute_cache/attribute_cache.rb

@@ -0,0 +1,42 @@
+module AttributeCache
+  class AttributeCache
+    def initialize(name:, attribute:, callback:)
+      @name = name
+      @attribute = attribute
+      @callback = callback
+    end
+
+    def set_attribute(record, save: false)
+      record.write_attribute(@attribute, execute_callback(record))
+      record.save if save
+    end
+    alias invalidate_attribute set_attribute
+
+    def set_attribute!(record)
+      set_attribute(record, save: true)
+    end
+    alias invalidate_attribute! set_attribute!
+
+    def value(record, save:, keep_blanks:)
+      set_attribute(record, save: save) if cached_value(record).nil? || !keep_blanks && cached_value(record).blank?
+      cached_value(record)
+    end
+
+    private
+
+    def cached_value(record)
+      record.read_attribute(@attribute)
+    end
+
+    def execute_callback(record)
+      case @callback
+      when Symbol, String
+        record.send(@callback)
+      when Proc
+        @callback[]
+      else
+        raise 'An invalid callback was provided!'
+      end
+    end
+  end
+end

data/lib/attribute_cache/version.rb

@@ -1,3 +1,3 @@
 module AttributeCache
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: attribute_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jacob Lockard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: first_existing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +99,7 @@ files:
 - README.md
 - Rakefile
 - lib/attribute_cache.rb
+- lib/attribute_cache/attribute_cache.rb
 - lib/attribute_cache/railtie.rb
 - lib/attribute_cache/version.rb
 - lib/tasks/attribute_cache_tasks.rake