weathercock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69167dba72d21575ef52f1c799423a78ff435b8fa42a8ea60eac368a1dbe680b
+  data.tar.gz: 586f93c2471f63dc178de81ee96c3d39dd205c41ba69984535d2d14012b04f2c
+SHA512:
+  metadata.gz: 362d33770a45bbf057ee4907dd978ce032444e134972f841dc903c52f7df2511aa2c5556abfe1d31008b6e10b0841c0b98ab8ae0aabc34564af1cbd7fbce642c
+  data.tar.gz: d4d6f1434f014a87a0906732960217ba1ebbbe9d8ab3660e70544da151a856696f08fa2b07f938ced057440a6ab5d1677eec21ae4820a3ecac735bb2a5950d2f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Takafumi ONAKA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Weathercock
+
+Hit counter and popularity tracking using Valkey/Redis Sorted Sets.
+
+Records hit counts for arbitrary resources across hourly, daily, and monthly time windows. Aggregates them with `ZUNIONSTORE` to build popularity rankings.
+
+## Installation
+
+```bash
+bundle add weathercock
+```
+
+## Usage
+
+### Configuration
+
+```ruby
+Weathercock.configure do |c|
+  c.redis     = RedisClient.new(host: "localhost", port: 6379)
+  c.namespace = "myapp"  # default: "weathercock"
+end
+```
+
+### Tracking
+
+Include `Weathercock::Scorable` in any class that has an `id`:
+
+```ruby
+class Article
+  include Weathercock::Scorable
+end
+```
+
+Record a hit:
+
+```ruby
+article.hit(:views)
+article.hit(:views, increment: 5)
+```
+
+Each call writes to four Sorted Sets:
+
+```
+myapp:article:views:total           # all-time (no TTL)
+myapp:article:views:2026-04-15-09   # hourly   (TTL: 3 days)
+myapp:article:views:2026-04-15      # daily    (TTL: 90 days)
+myapp:article:views:2026-04         # monthly  (TTL: 3 years)
+```
+
+### Ranking
+
+`top` returns IDs ordered by total score. Without a window, it reads from the all-time key. With a window, it aggregates via `ZUNIONSTORE`.
+
+```ruby
+# All-time ranking
+Article.top(:views)
+# => ["42", "7", "133", ...]
+
+# Top article IDs by views over the last 7 days
+Article.top(:views, days: 7)
+
+# Using hours or months
+Article.top(:views, hours: 24)
+Article.top(:views, months: 3)
+
+# Exponential time decay (recent hits weighted higher)
+Article.top(:views, days: 7, decay_factor: 0.9)
+```
+
+### Counting
+
+Get the hit count for a single instance:
+
+```ruby
+article.hit_count(:views)         # all-time
+article.hit_count(:views, days: 7)
+# => 42
+```
+
+Get hit counts for multiple instances at once (useful for list views):
+
+```ruby
+Article.hit_counts(:views, ids: [1, 2, 3])          # all-time
+Article.hit_counts(:views, ids: [1, 2, 3], days: 7)
+# => {"1" => 42, "2" => 15, "3" => 7}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/onk/weathercock.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/compose.yaml

@@ -0,0 +1,5 @@
+services:
+  valkey:
+    image: valkey/valkey:9.0-alpine@sha256:e1095c6c76ee982cb2d1e07edbb7fb2a53606630a1d810d5a47c9f646b708bf5
+    ports:
+      - "6379:6379"

data/lib/weathercock/scorable.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "../weathercock"
+
+module Weathercock
+  module Scorable
+    WEATHERCOCK_BUCKET_TTLS = {
+      hours: 3 * 24 * 3600,
+      days: 3 * 30 * 86400,
+      months: 3 * 12 * 30 * 86400
+    }.freeze
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def top(event, decay_factor: nil, **window)
+        return Weathercock.config.redis.call("ZRANGE", "#{weathercock_base_key(event)}:total", 0, -1, "REV") if window.empty?
+
+        dest = weathercock_union(event, window, decay_factor: decay_factor)
+        Weathercock.config.redis.call("ZRANGE", dest, 0, -1, "REV")
+      end
+
+      def hit_counts(event, ids:, **window)
+        redis = Weathercock.config.redis
+        dest = window.empty? ? "#{weathercock_base_key(event)}:total" : weathercock_union(event, window)
+        ids.to_h { |id| [id.to_s, (redis.call("ZSCORE", dest, id.to_s) || "0").to_i] }
+      end
+
+      def weathercock_base_key(event)
+        "#{Weathercock.config.namespace}:#{name.gsub("::", "_").downcase}:#{event}"
+      end
+
+      private
+
+      def weathercock_union(event, window, decay_factor: nil)
+        redis = Weathercock.config.redis
+        base = weathercock_base_key(event)
+        type, count = window.first
+        keys = weathercock_window_keys(base, type, count)
+
+        dest = "#{base}:top:#{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)
+        redis.call("EXPIRE", dest, 900)
+        dest
+      end
+
+      def weathercock_window_keys(base, type, count)
+        now = Time.now
+        case type
+        when :hours
+          count.times.map { |i| weathercock_bucket_key(base, type, now - (i * 3600)) }
+        when :days
+          count.times.map { |i| weathercock_bucket_key(base, type, now - (i * 86400)) }
+        when :months
+          d = Date.new(now.year, now.month)
+          count.times.map { |i| weathercock_bucket_key(base, type, d << i) }
+        end
+      end
+
+      def weathercock_bucket_key(base, type, time)
+        case type
+        when :hours  then "#{base}:#{time.strftime("%Y-%m-%d-%H")}"
+        when :days   then "#{base}:#{time.strftime("%Y-%m-%d")}"
+        when :months then "#{base}:#{time.strftime("%Y-%m")}"
+        end
+      end
+    end
+
+    def hit(event, increment: 1)
+      now = Time.now
+      redis = Weathercock.config.redis
+      base = self.class.weathercock_base_key(event)
+
+      redis.pipelined do |p|
+        p.call("ZINCRBY", "#{base}:total", increment, id.to_s)
+        WEATHERCOCK_BUCKET_TTLS.each do |type, ttl|
+          key = self.class.send(:weathercock_bucket_key, base, type, now)
+          p.call("ZINCRBY", key, increment, id.to_s)
+          p.call("EXPIRE", key, ttl)
+        end
+      end
+    end
+
+    def hit_count(event, **window)
+      if window.empty?
+        score = Weathercock.config.redis.call("ZSCORE", "#{self.class.weathercock_base_key(event)}:total", id.to_s)
+        return score ? score.to_i : 0
+      end
+
+      dest = self.class.send(:weathercock_union, event, window)
+      score = Weathercock.config.redis.call("ZSCORE", dest, id.to_s)
+      score ? score.to_i : 0
+    end
+  end
+end

data/lib/weathercock/version.rb

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

data/lib/weathercock.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "weathercock/version"
+
+module Weathercock
+  class Error < StandardError; end
+
+  class Config
+    attr_accessor :namespace, :redis
+
+    def initialize
+      @namespace = "weathercock"
+    end
+  end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/sig/weathercock.rbs

@@ -0,0 +1,4 @@
+module Weathercock
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: weathercock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takafumi ONAKA
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Track hit counts for arbitrary resources and aggregate them with zunionstore
+  to build popularity rankings across time windows.
+email:
+- takafumi.onaka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- compose.yaml
+- lib/weathercock.rb
+- lib/weathercock/scorable.rb
+- lib/weathercock/version.rb
+- sig/weathercock.rbs
+homepage: https://github.com/onk/weathercock
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/onk/weathercock
+  source_code_uri: https://github.com/onk/weathercock
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Hit counter and popularity tracking using Valkey/Redis Sorted Sets
+test_files: []