tally 1.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dcdb5d7466c778e0cff8dde7fd611b583964f98e873785a96c50d7a673fadd9
-  data.tar.gz: 2694b8855c48dfe6186c738ccb0a6634d085b5e6c87e92c77ea3087027c58e0c
+  metadata.gz: a1c7ca6dc7f3a11bd24936a64edb11c8b18a21ef0788b09598a45a5eb746237d
+  data.tar.gz: 112af234512f74e6e284ed8f210084c586bc7eb3b36a7f1c1c12a9d21f373403
 SHA512:
-  metadata.gz: 013706a817cd8a8baab90080ee92d509db1276d10fa29ca9ae06463646f87d58ccb723f99586e55506388c40f038b3818473daf5cda5be46e8b03eeb1725320e
-  data.tar.gz: 0f1dff1e52bb51039ea6202a46717c67f81628fde77d98c135dbb1c450ee99d5211c410d0155c09456e403946204a690363abe21a3a164e374905b3de2a3992b
+  metadata.gz: 61eb9b0fc574bfcbc23585cdef758bde1b9f9e57afcff608b7b99131ce6b847dedd051d7d358fcc22287547a473da4f75ad3b1e4ece5951ad23dcbc58e253e7e
+  data.tar.gz: 455f9248a7f3427ef635209b806e7b69a17dace683821621b47bcd0608f3efa9d4257575c86fcb9bfad2517d768a7cd47b80c0f6312b25fe1c156f54088130f5

data/README.md

@@ -1,6 +1,6 @@
 # Tally
 
-[![CircleCI](https://circleci.com/gh/jdtornow/tally.svg?style=svg)](https://circleci.com/gh/jdtornow/tally)
+[![Tests](https://github.com/jdtornow/tally/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/jdtornow/tally/actions/workflows/tests.yml)
 
 Tally is a simple Rails engine for capturing counts of various activities around an app. These counts are quickly captured in Redis then are archived periodically within the app's default relational database.
 
@@ -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.2+
+* Rails 7+
 * 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/app/jobs/tally/archiver_job.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tally
+  class ArchiverJob < ApplicationJob
+
+    def perform(day = "today")
+      case day.to_s
+      when /^\d{4}-\d{2}-\d{2}$/
+        Tally::Archiver.archive! day: Date.parse(day)
+      when "yesterday"
+        Tally::Archiver.archive! day: 1.day.ago.to_date
+      else
+        Tally::Archiver.archive!
+      end
+    end
+
+  end
+end

data/app/jobs/tally/sweeper_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Tally
+  class SweeperJob < ApplicationJob
+
+    def perform
+      Tally::Sweeper.sweep!
+    end
+
+  end
+end

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

@@ -7,10 +7,10 @@ module Tally
       Tally.redis do |conn|
         conn.multi do |pipeline|
           pipeline.incrby(redis_key, by)
-          pipeline.expire(redis_key, Tally.config.ttl) if Tally.config.ttl.present?
+          pipeline.expire(redis_key, Tally.config.ttl.to_i) if Tally.config.ttl.present?
 
           pipeline.sadd(daily_key, simple_key)
-          pipeline.expire(daily_key, Tally.config.ttl) if Tally.config.ttl.present?
+          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,7 +22,7 @@ module Tally
 
     def sweep!
       Tally.redis do |conn|
-        purgeable_keys.in_groups_of(25, fill_with = nil).each do |group|
+        purgeable_keys.in_groups_of(25, fill_with = false).each do |group|
           conn.pipelined do |pipeline|
             group.each do |key|
               pipeline.del(key)

data/lib/tally/version.rb

@@ -1,5 +1,5 @@
 module Tally
 
-  VERSION = "1.0.2"
+  VERSION = "2.1.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

data/lib/tasks/tally_tasks.rake

@@ -1,21 +1,21 @@
 namespace :tally do
   desc "Sweep all outdated keys from the data store"
-  task :sweep => :environment do
-    Tally::Sweeper.sweep!
+  task sweep: :environment do
+    Tally::SweeperJob.perform_now
 
     Rake::Task["tally:wait_for_async_queue"].execute
   end
 
   desc "Archive today's temporary keys into record entries in the database"
-  task :archive => :environment do
-    Tally::Archiver.archive!
+  task archive: :environment do
+    Tally::ArchiverJob.perform_now
 
     Rake::Task["tally:wait_for_async_queue"].execute
   end
 
   desc "Archive yesterday's temporary keys into record entries in the database"
-  task "archive:yesterday" => :environment do
-    Tally::Archiver.archive! day: 1.day.ago
+  task "archive:yesterday": :environment do
+    Tally::ArchiverJob.perform_now("yesterday")
 
     Rake::Task["tally:wait_for_async_queue"].execute
   end
@@ -24,7 +24,7 @@ namespace :tally do
   #
   # This is not needed for other adapters besides async, but since it is the
   # Rails default, we're accounting for it here.
-  task :wait_for_async_queue => :environment do
+  task wait_for_async_queue: :environment do
     if Rails.application.config.active_job.queue_adapter == :async
       ActiveJob::Base.queue_adapter.shutdown(wait: true)
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tally
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - John D. Tornow
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +18,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +43,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 +91,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -114,20 +127,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +190,9 @@ files:
 - app/helpers/tally/application_helper.rb
 - app/helpers/tally/increment_helper.rb
 - app/jobs/tally/application_job.rb
+- app/jobs/tally/archiver_job.rb
 - app/jobs/tally/calculator_runner_job.rb
+- app/jobs/tally/sweeper_job.rb
 - app/models/tally/application_record.rb
 - app/models/tally/record.rb
 - app/presenters/tally/record_presenter.rb
@@ -222,7 +223,6 @@ metadata:
   homepage_uri: https://github.com/jdtornow/tally
   source_code_uri: https://github.com/jdtornow/tally
   wiki_uri: https://github.com/jdtornow/tally/wiki
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,15 +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
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Stats collection and reporting
 test_files: []