weathercock 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7554f2d86d4cd3499ea0aa89d77bc327e9667b16257b234f00391d82118f8b
-  data.tar.gz: 7687c05fe5724b8ec134bfbaf9fc4689b799415f368627a85de790b8ddcd7073
+  metadata.gz: e6f2f450b510bee3dbea48bf0b4e7e37ef24040d82141caaabe45d6dce3c3cb6
+  data.tar.gz: ab78b22090a84493d97b3f5deca74963f150d3ea21af0b47408babb64fdb7985
 SHA512:
-  metadata.gz: 9bb7bf12377be72a41e51a5de234475e2cbab1d3a8333b47865da959053d482b5bcb762d4c13fa00ed142a95bf64c531e2b04a22a608969440a7feb45dd881dc
-  data.tar.gz: 90e5eafb164fe1fdc2b11167b28a9f9a6fda24dc1be2ed98e987505b05bb4aabe7f8bb7b66b9141e658bdba0e70cc36a808be3a557a42ff19c944ef115d020ff
+  metadata.gz: e10e7fee6c2e629c994c097920af3226a3f6fdde65a18aed9a85b5556ae6d0a4b4abf78029b833d50d88581745f2517911177ebaee78bbe7de6aef2c78eacb49
+  data.tar.gz: 4a2089ecaceb03a54cb1462504f9b946145b81837db87c4a497650164180c56533246f851ab0c1e1c8f84a337f06faf767c782960e8a9ac6273149f0e69f5766

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v1.2.0 - 2026-09-16
+
+### Changed
+
+- `union` now reuses an existing destination key instead of always recomputing it, so its 900 second TTL works as a cache
+- `union_dest` now includes `decay_factor` so decayed and non-decayed results no longer share a cache entry
+
 ## v1.1.0 - 2026-04-17
 
 ### Added

data/Steepfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library "date"
+
+  configure_code_diagnostics(D::Ruby.default)
+end

data/lib/weathercock/key_builder.rb

@@ -38,8 +38,9 @@ module Weathercock
       end
     end
 
-    def union_dest(base, type, count)
-      "#{base}:top:#{type}:#{count}"
+    def union_dest(base, type, count, decay_factor: nil)
+      dest = "#{base}:top:#{type}:#{count}"
+      decay_factor ? "#{dest}:decay:#{decay_factor}" : dest
     end
   end
 end

data/lib/weathercock/scorer.rb

@@ -74,7 +74,9 @@ module Weathercock
       base = @key_builder.base(event)
       dest = window.empty? ? @key_builder.total(base) : union(event, window)
       scores = @redis.call("ZMSCORE", dest, *ids.map(&:to_s))
-      ids.zip(scores).to_h { |id, score| [id.to_s, (score || "0").to_i] }
+      ids.zip(scores).to_h do |id, score|
+        [id.to_s, Integer(score || "0")] #: [String, Integer]
+      end
     end
 
     private
@@ -82,13 +84,19 @@ module Weathercock
     def union(event, window, decay_factor: nil)
       base = @key_builder.base(event)
       type, count = window.first
-      keys = @key_builder.window_keys(base, type, count)
-      dest = @key_builder.union_dest(base, type, count)
-
-      weights = decay_factor ? count.times.map { |i| (decay_factor**i).round(10) } : nil
-      zunionstore_args = ["ZUNIONSTORE", dest, keys.size, *keys]
-      zunionstore_args += ["WEIGHTS", *weights] if weights
-      @redis.call(*zunionstore_args)
+      dest = if decay_factor
+               @key_builder.union_dest(base, type, count, decay_factor: decay_factor)
+             else
+               @key_builder.union_dest(base, type, count)
+             end
+
+      unless @redis.call("EXISTS", dest) == 1
+        keys = @key_builder.window_keys(base, type, count)
+        weights = decay_factor ? count.times.map { |i| (decay_factor**i).round(10) } : nil
+        zunionstore_args = ["ZUNIONSTORE", dest, keys.size, *keys]
+        zunionstore_args += ["WEIGHTS", *weights] if weights
+        @redis.call(*zunionstore_args)
+      end
       @redis.call("EXPIRE", dest, 900)
       dest
     end

data/lib/weathercock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Weathercock
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/sig/weathercock/key_builder.rbs

@@ -0,0 +1,13 @@
+class Weathercock::KeyBuilder
+  def initialize: (namespace: String, klass: Module) -> void
+
+  def base: (Symbol) -> String
+
+  def total: (String) -> String
+
+  def bucket: (String, :hours | :days | :months, Date | Time) -> String
+
+  def window_keys: (String, :hours | :days | :months, Integer) -> Array[String]
+
+  def union_dest: (String, :hours | :days | :months, Integer, ?decay_factor: Float) -> String
+end

data/sig/weathercock/scorable.rbs

@@ -0,0 +1,25 @@
+module Weathercock::Scorable
+  def self.included: (Module) -> void
+  # steep infers self.class in instance methods as singleton(Scorable),
+  # so declare weathercock_scorer here to satisfy the type checker.
+  def self.weathercock_scorer: () -> Weathercock::Scorer
+
+  # Expected to be provided by the including class (e.g. ActiveRecord).
+  def id: () -> Weathercock::id
+
+  def hit: (Symbol, ?increment: Integer) -> void
+
+  def hit_count: (Symbol, ?hours: Integer, ?days: Integer, ?months: Integer) -> Integer
+
+  def rank: (Symbol, ?hours: Integer, ?days: Integer, ?months: Integer) -> Integer?
+
+  def remove_hits: (Symbol) -> void
+end
+
+module Weathercock::Scorable::ClassMethods : Module
+  def weathercock_scorer: () -> Weathercock::Scorer
+
+  def top: (Symbol, limit: Integer?, ?decay_factor: Float, ?hours: Integer, ?days: Integer, ?months: Integer) -> Array[String]
+
+  def hit_counts: (Symbol, ids: Array[Weathercock::id], ?hours: Integer, ?days: Integer, ?months: Integer) -> Hash[String, Integer]
+end

data/sig/weathercock/scorer.rbs

@@ -0,0 +1,20 @@
+class Weathercock::Scorer
+  BUCKET_COUNT: Integer
+  BUCKET_TTLS: Hash[:hours | :days | :months, Integer]
+
+  def initialize: (klass: Module) -> void
+
+  def hit: (Weathercock::id, Symbol, ?increment: Integer) -> void
+
+  def hit_count: (Weathercock::id, Symbol, ?hours: Integer, ?days: Integer, ?months: Integer) -> Integer
+
+  def union: (Symbol, Hash[untyped, untyped], ?decay_factor: Float) -> String
+
+  def top: (Symbol, limit: Integer?, ?decay_factor: Float, ?hours: Integer, ?days: Integer, ?months: Integer) -> Array[String]
+
+  def hit_counts: (Symbol, ids: Array[Weathercock::id], ?hours: Integer, ?days: Integer, ?months: Integer) -> Hash[String, Integer]
+
+  def rank: (Weathercock::id, Symbol, ?hours: Integer, ?days: Integer, ?months: Integer) -> Integer?
+
+  def remove_hits: (Weathercock::id, Symbol) -> void
+end

data/sig/weathercock.rbs

@@ -1,4 +1,18 @@
 module Weathercock
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  type id = Integer | String
+
+  class Error < StandardError
+  end
+
+  class Config
+    attr_accessor namespace: String
+    attr_accessor redis: untyped
+
+    def initialize: () -> void
+  end
+
+  def self.configure: () { (Config) -> void } -> void
+  def self.config: () -> Config
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weathercock
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Takafumi ONAKA
@@ -49,6 +49,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - compose.yaml
 - lib/weathercock.rb
 - lib/weathercock/key_builder.rb
@@ -56,6 +57,9 @@ files:
 - lib/weathercock/scorer.rb
 - lib/weathercock/version.rb
 - sig/weathercock.rbs
+- sig/weathercock/key_builder.rbs
+- sig/weathercock/scorable.rbs
+- sig/weathercock/scorer.rbs
 homepage: https://github.com/onk/weathercock
 licenses:
 - MIT
@@ -77,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Hit counter and popularity tracking using Valkey/Redis Sorted Sets
 test_files: []