tally 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd6d7b4cdc084ad0d1f638ecbf06fe82909c8e437498abcc8d5987b03628f2f
-  data.tar.gz: e30633b53c9ae6f9db7b324fb12d9da01a4416399c3c399c4a971a616e1429b6
+  metadata.gz: 2326dfbbdcb9474f788b14370829771c27cf8945d9a2c4c07208ef78a157bcfa
+  data.tar.gz: 852b21044a153ba21c0eb3f48f282a3157a55f4e535fed2006ea80652263f7b2
 SHA512:
-  metadata.gz: f3774064bceec83d7b25ade9e3a68799b0676230392241335231ce8318c33bec2b311694f186f1322ea70cef586bf53c3aacef69ffcc02156d125841d015c6d1
-  data.tar.gz: 9ee909f93c6e0c6430d6b0ffc21c865b7b94a44e7bdd40ab41c6b0ad5c39eef4109c2b52e313015b1cd78c369dc107a05543732746c0313b7e84007b90f7c269
+  metadata.gz: 16d1b206ded32742d3fc04973bb52fc066ba2618ee70a692e3b73322b0950957b34534bd9b3e6c5bfc555de5149ca9f61455265ed91d254962077ba0c689a20f
+  data.tar.gz: 5610ac5ba2038971c7aa9e3fb6694971a7cea354939c0a6c65e94515ca6757cc22f4e00a3c095671bf39321d40f6fd9471906a714077e44695be308eb9ac557c

data/README.md

@@ -12,8 +12,8 @@ _[Read more about Tally in my blog post introducing it ...](https://johntornow.c
 
 ## Requirements
 
-* Ruby 2.2+
-* Rails 5.2.x+
+* Ruby 3.0.3+
+* Rails 6.1+
 * Redis 4+
 
 ## Installation
@@ -204,10 +204,31 @@ The endpoints can be used to display JSON-formatted data from `Tally::Record`. T
 
 Tally works _really_ well with [Sidekiq](https://github.com/mperham/sidekiq/), but it isn't required. If Sidekiq is installed in your app, Tally will use its connection pooling for Redis connections. If Sidekiq isn't in use, the `Redis.current` connection is used to store stats. If you'd like to override the specific connection used for Tally's redis store, you can do so by setting `Tally.redis_connection` to another instance of `Redis`. This can be useful to use an alternate Redis store for just stats, for example.
 
+As of version 2.0.0 this connection is automatically used within a [ConnectionPool](https://github.com/mperham/connection_pool).
+
 ```ruby
 # use an alternate Redis connection (for non-sidekiq integrations)
 Tally.redis_connection = Redis.new(...)
 ```
+
+Alternatively, you can just set the config for Redis and `Redis.new` will be called for you:
+
+```ruby
+# provide Redis config
+Tally.config.redis_config = {
+  driver: :ruby,
+  url: "redis://127.0.0.1:6379/10",
+  ssl_params: {
+    verify_mode: OpenSSL::SSL::VERIFY_NONE
+  }
+}
+
+# then Tally uses the connection within a pool:
+Tally.redis do |connection|
+  connection.incr("test")
+end
+```
+
 ## Issues
 
 If you have any issues or find bugs running Tally, please [report them on Github](https://github.com/jdtornow/tally/issues).

data/lib/tally/daily.rb

@@ -10,26 +10,6 @@ module Tally
 
     private
 
-      def all_keys
-        @keys ||= build_keys_from_redis
-      end
-
-      def build_keys_from_redis
-        result = []
-        cursor = ""
-
-        scan = scan_from_redis
-
-        while cursor != "0"
-          result << scan.last
-          cursor = scan.first
-
-          scan = scan_from_redis(cursor: cursor)
-        end
-
-        result.flatten
-      end
-
       def day_key
         @day_key ||= day.strftime(Tally.config.date_format)
       end
@@ -39,8 +19,20 @@ module Tally
       end
 
       def scan_from_redis(cursor: "0")
-        Tally.redis do |conn|
-          conn.sscan(daily_key, cursor, match: scan_key, count: 25)
+        klass = Tally.redis { |conn| conn.class.to_s }
+
+        # if we're using sidekiq / RedisClient, scan needs a block, and doesn't worry about the cursor
+        if klass == "Sidekiq::RedisClientAdapter::CompatClient"
+          Tally.redis do |conn|
+            [
+              "0", # fake cursor to match redis-rb output
+              conn.sscan(daily_key, "MATCH", scan_key, "COUNT", 25).to_a
+            ]
+          end
+        else
+          Tally.redis do |conn|
+            conn.sscan(daily_key, cursor, match: scan_key, count: 25)
+          end
         end
       end
 

data/lib/tally/increment.rb

@@ -5,12 +5,12 @@ module Tally
 
     def increment(by = 1)
       Tally.redis do |conn|
-        conn.multi do
-          conn.incrby(redis_key, by)
-          conn.expire(redis_key, Tally.config.ttl) if Tally.config.ttl.present?
+        conn.multi do |pipeline|
+          pipeline.incrby(redis_key, by)
+          pipeline.expire(redis_key, Tally.config.ttl.to_i) if Tally.config.ttl.present?
 
-          conn.sadd(daily_key, simple_key)
-          conn.expire(daily_key, Tally.config.ttl) if Tally.config.ttl.present?
+          pipeline.sadd(daily_key, simple_key)
+          pipeline.expire(daily_key, Tally.config.ttl.to_i) if Tally.config.ttl.present?
         end
       end
     end

data/lib/tally/key_finder.rb

@@ -73,18 +73,16 @@ module Tally
 
       def build_keys_from_redis
         result = []
-        cursor = ""
-
-        scan = scan_from_redis
+        cursor = nil
 
         while cursor != "0"
+          scan = scan_from_redis(cursor: cursor.presence || "0")
+
           result << scan.last
           cursor = scan.first
-
-          scan = scan_from_redis(cursor: cursor)
         end
 
-        result.flatten
+        result.flatten.uniq
       end
 
       def day_key
@@ -100,7 +98,19 @@ module Tally
       end
 
       def scan_from_redis(cursor: "0")
-        Tally.redis { |conn| conn.scan(cursor, match: scan_key) }
+        klass = Tally.redis { |conn| conn.class.to_s }
+
+        # if we're using sidekiq / RedisClient, scan needs a block, and doesn't worry about the cursor
+        if klass == "Sidekiq::RedisClientAdapter::CompatClient"
+          Tally.redis do |conn|
+            [
+              "0", # fake cursor to match redis-rb output
+              conn.scan("MATCH", scan_key).to_a
+            ]
+          end
+        else
+          Tally.redis { |conn| conn.scan(cursor, match: scan_key) }
+        end
       end
 
       def scan_key

data/lib/tally/sweeper.rb

@@ -22,10 +22,10 @@ module Tally
 
     def sweep!
       Tally.redis do |conn|
-        purgeable_keys.in_groups_of(25, fill_with = nil).each do |group|
-          conn.pipelined do
+        purgeable_keys.in_groups_of(25, fill_with = false).each do |group|
+          conn.pipelined do |pipeline|
             group.each do |key|
-              conn.del(key)
+              pipeline.del(key)
             end
           end
         end

data/lib/tally/version.rb

@@ -1,5 +1,5 @@
 module Tally
 
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 
 end

data/lib/tally.rb

@@ -46,6 +46,12 @@ module Tally
     # Archivers get queued into the background with ActiveJob by default
     # Set to :now to run inline
     config.perform_calculators = :later
+
+    # override to set default redis configuration for Tally when Sidekiq is not present
+    config.redis_config = {}
+
+    # override to set connection pool details for Redis
+    config.redis_pool_config = {}
   end
 
   # If sidekiq is available, piggyback on its pooling
@@ -57,18 +63,28 @@ module Tally
     if defined?(Sidekiq)
       Sidekiq.redis(&block)
     else
-      block.call(redis_connection)
+      redis_pool.with(&block)
     end
   end
 
   def self.redis_connection
-    @redis_connection ||= Redis.current
+    @redis_connection ||= Redis.new(Tally.config.redis_config)
   end
 
   def self.redis_connection=(connection)
     @redis_connection = connection
   end
 
+  def self.redis_pool
+    @redis_pool ||= ConnectionPool.new(Tally.config.redis_pool_config) do
+      redis_connection
+    end
+  end
+
+  def self.redis_pool=(pool)
+    @redis_pool = pool
+  end
+
   def self.increment(*args)
     Increment.public_send(:increment, *args)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tally
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - John D. Tornow
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: kaminari-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -106,28 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -230,14 +230,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.7
+      version: 3.0.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Stats collection and reporting