statisfy 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6383d7143334e6448a05a5afb28b751f35afc830e04a2ad93dfe58a31a63a55f
-  data.tar.gz: eaf65b189c72a4fa77a439d4aff01bd6eeacf653036194e70085823433476e4f
+  metadata.gz: b1fc7262fee03a85f7aec7875b837371114d2205e2e88ed1d4adb372c83025a7
+  data.tar.gz: 14e250747429e2dc67861b13bc6c249cb07fb1a616b9248f37e69d46578c2f9b
 SHA512:
-  metadata.gz: ff8563a77a395cee961fbed96a2b58df75d9d284f737b30341f448cd0cd6f5e7c46b9dd64f3fc077f1c1dafc3ee8de7228f6c48d8bc195fcd5af15f22bd374ac
-  data.tar.gz: dfb1216d2ffb054c81f9055da931bb8d0e766ff148a95cb090afbccdffd36d27c8fd72fd55d8f5b73f5f0b54e8d381e23ab8392681cf9ea4cf337aac39f5e153
+  metadata.gz: 84612c386cf3ec0e0c941404cf0f74c3acba3c37f41cfc2f3ae34ab689f8ffcd603a1a16d27e7c15efc5b3ee9ab76d05a15f882a2a739b0b7ea08ff324d5dba6
+  data.tar.gz: 4980ac9dd156ea28aeae6f1ab1c48f6ec5804b572eca27427f05abebf82a1db747f0e9d27c97a1d5a0e100ef580083d3018e0bcf19d7a086f239145375707459

data/lib/statisfy/counter.rb

@@ -39,16 +39,12 @@ module Statisfy
       # but the `count` DSL defines them automatically based on the options provided
       #
       def apply_default_counter_options(args)
-        define_method(:identifier, args[:uniq_by] || -> { nil })
+        define_method(:identifier, args[:value] || args[:uniq_by] || -> { nil })
         define_method(:scopes, args[:scopes] || Statisfy.configuration.default_scopes || -> { [] })
         define_method(:if_async, args[:if_async] || -> { true })
         define_method(:decrement?, args[:decrement_if] || -> { false })
-        define_method(:value, args[:value] || -> {})
         define_method(:should_run?, args[:if] || -> { true })
-        define_method(:on_destroy, args[:on_destroy]) if args[:on_destroy].present?
-        define_method(:decrement_on_destroy?, args[:decrement_on_destroy].is_a?(Proc) ? args[:decrement_on_destroy] : lambda {
-                                                                                                                        args[:decrement_on_destroy] || true
-                                                                                                                      })
+        define_method(:decrement_on_destroy?, -> { args[:decrement_on_destroy] != false })
       end
 
       #
@@ -70,6 +66,10 @@ module Statisfy
         end
       end
 
+      def aggregate_counter?
+        const_get(:COUNTER_TYPE) == :aggregate
+      end
+
       def size(scope: nil, month: nil)
         redis_client.scard(key_for(scope:, month:))
       end
@@ -128,7 +128,7 @@ module Statisfy
       # This allows to run a counter increment manually
       # It is useful when you want to backfill counters
       #
-      def initialize_with(resource, options = {})
+      def trigger_with(resource, options = {})
         counter = new
         counter.params = resource
 
@@ -177,36 +177,22 @@ module Statisfy
     end
 
     def process_event
-      return if destroy_event_handled?
+      return decrement if can_decrement_on_destroy?
       return unless if_async
 
-      if value.present?
-        append(value:)
+      if self.class.aggregate_counter?
+        append
       else
         decrement? ? decrement : increment
       end
     end
 
-    def destroy_event_handled?
-      return false unless params[:statisfy_trigger] == :destroy && value.blank?
-
-      if decrement_on_destroy?
-        decrement
-        return true
-      elsif respond_to?(:on_destroy)
-        on_destroy
-        return true
-      end
-
-      false
-    end
-
-    def key_value
-      value || identifier || params["id"]
+    def can_decrement_on_destroy?
+      params[:statisfy_trigger] == :destroy && !self.class.aggregate_counter? && decrement_on_destroy?
     end
 
-    def custom_key_value?
-      identifier.present? || value.present?
+    def value
+      identifier || params["id"]
     end
 
     #
@@ -223,15 +209,19 @@ module Statisfy
 
     def increment
       all_counters do |key|
-        self.class.redis_client.sadd?(key, key_value)
-        self.class.redis_client.sadd?(uniq_by_ids(key), params["id"]) if custom_key_value?
+        self.class.redis_client.sadd?(key, value)
+
+        # When setting a uniq_by option, we use this set to keep track of the number of unique instances
+        # with the same identifier.
+        # When there are no more instances with this identifier, we can decrement the counter
+        self.class.redis_client.sadd?(key_for_instance_ids(key), params["id"]) if identifier.present?
       end
     end
 
     #
     # To be used to store a list of values instead of a basic counter
     #
-    def append(value:)
+    def append
       all_counters do |key|
         self.class.redis_client.rpush(key, value)
       end
@@ -240,18 +230,29 @@ module Statisfy
     # rubocop:disable Metrics/AbcSize
     def decrement
       all_counters do |key|
-        if custom_key_value?
-          self.class.redis_client.srem?(uniq_by_ids(key), params["id"])
-          self.class.redis_client.srem?(key, key_value) if self.class.redis_client.scard(uniq_by_ids(key)).zero?
+        if identifier.present?
+          self.class.redis_client.srem?(key_for_instance_ids(key), params["id"])
+          self.class.redis_client.srem?(key, value) if no_more_instances_with_this_identifier?(key)
         else
-          self.class.redis_client.srem?(key, key_value)
+          self.class.redis_client.srem?(key, value)
         end
       end
     end
     # rubocop:enable Metrics/AbcSize
 
-    def uniq_by_ids(key)
-      "#{key};#{key_value}"
+    def no_more_instances_with_this_identifier?(key)
+      self.class.redis_client.scard(key_for_instance_ids(key)).zero?
+    end
+
+    #
+    # This redis key is used when setting a uniq_by. It stores the list of ids of the main resource (e.g. User)
+    # in order to count the number of unique instances with the same identifier
+    #
+    # When the associated array becomes empty, it means that we can
+    # decrement the counter because there are no more instances associated with this identifier
+    #
+    def key_for_instance_ids(key)
+      JSON.parse(key).merge("subject_id" => identifier).to_json
     end
   end
 end

data/lib/statisfy/model.rb

@@ -10,14 +10,14 @@ module Statisfy
     end
 
     module ClassMethods
-      def count(params)
+      def statisfy_count(params)
         raise ArgumentError, "Missing :as parameter" unless params[:as]
 
         class_name = params[:as].to_s.camelize
 
         eval <<-RUBY, binding, __FILE__, __LINE__ + 1
           class ::Statisfy::#{class_name}
-            include Statisfy::Counter
+            include Statisfy::#{params[:type] == :aggregate ? "Aggregate" : "Counter"}
           end
         RUBY
 
@@ -27,9 +27,12 @@ module Statisfy
           end
         RUBY
 
-        "::Statisfy::#{class_name}".constantize.send(__method__, **params)
+        "::Statisfy::#{class_name}".constantize.send(:count, **params)
+      end
+
+      def statisfy_aggregate(params)
+        statisfy_count(params.merge(type: :aggregate))
       end
-      alias aggregate count
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statisfy
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Michaël Villeneuve
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord