heavy_keeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8de4da5b817f62a3047b5de8d8b1118d91577ef12e5389ade96f1dd69179e045
+  data.tar.gz: d42f28f5a1af3539010c269e14540fcaef6cafc9ad059529f04a10a55faf3422
+SHA512:
+  metadata.gz: 29c288a59c986a75df4224030486c9afb59af3fa00710b35c0355f617e679b75559c6143881a3bb6404754a3ebc18bcb63c99ecc584072ac6910f43ee638dbfc
+  data.tar.gz: 8ad3f0583c3e64a59516a80c28cc162c2d64fdd4ce44c82d088db02143713425c049190b3f5cd5352daa9e830896ed9c51399ebf49a3e240d91ca806cd354bc9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - Gemfile.lock
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/AbcSize:
+  Max: 25
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - heavy_keeper.gemspec
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Max: 20
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Naming/VariableNumber:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*_spec.rb
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/heavy_keeper.rb'
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+Style/WordArray:
+  EnforcedStyle: percent
+Layout/LineLength:
+  Max: 200
+Lint/AmbiguousBlockAssociation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heavy_keeper.gemspec
+gemspec
+
+gem 'rubocop', require: false
+
+gem 'rake', '~> 13.0'
+
+group :test do
+  gem 'mock_redis'
+  gem 'rspec'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    heavy_keeper (0.1.0)
+      dry-configurable (>= 0.13.0)
+      dry-schema (~> 1)
+      redis (~> 4)
+      xxhash (~> 0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-configurable (0.15.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.1.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.9.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    method_source (1.0.0)
+    mock_redis (0.31.0)
+      ruby2_keywords
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.7.0)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+    xxhash (0.4.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  heavy_keeper!
+  mock_redis
+  pry-byebug
+  rake (~> 13.0)
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,58 @@
+# HeavyKeeper
+This gem implements HeavyKeeper algorithm, based on the paper with the same
+name: https://www.usenix.org/conference/atc18/presentation/gong
+
+The interface is designed to be similar with ReBloom TopK datastructure (DS)
+(https://oss.redis.com/redisbloom/TopK_Commands/).
+
+This is a naive implementation of HeavyKeeper, probably not very optimized.
+We use multiple Redis DSs:
+
+- A hash with maximum depth * width items to act as a bucket to store main
+counter
+- A sorted set with maximum K elements to act as a MinHeap
+- A hash with maximum K elements to store more correct counter of the element in MinHeap
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heavy_keeper'
+```
+
+## Usage
+
+You will need to add an initializer to provide some configuration:
+
+```ruby
+HeavyKeeper::Config.configure do |config|
+  config.cache_prefix = 'cache_prefix'.freeze # currently used as prefix for the redis data structures.
+  config.storage = Redis.new # a Redis store, at least version 4.0
+end
+```
+
+In general, you will only interact with an instance of the `HeavyKeeper::TopK` class.
+
+These are the most relevant instance methods (see code comments for more detail):
+
+`reserve(name, top_k: size, width:, depth:, decay:)` - sets up a Top K list with specified options
+
+`increase_by(name, *items)` - add an array of items to a list
+
+`list(name)` - returns full list of items in Top K list
+
+`clear(name)` - deletes list
+
+`remove(name, item)` - reset the counter of the targeted item in the list
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+
+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/Kaligo/heavy_keeper.

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'heavy_keeper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/heavy_keeper.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/heavy_keeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'heavy_keeper'
+  spec.version = HeavyKeeper::VERSION
+  spec.authors = ['Hieu Nguyen', 'Kenneth Teh']
+
+  spec.summary = 'Gem which implements HeavyKeeper algorithm'
+  spec.homepage = 'https://github.com/Kaligo/heavy_keeper'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Kaligo/heavy_keeper'
+  spec.metadata['changelog_uri'] = 'https://github.com/Kaligo/heavy_keeper/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-configurable', '>= 0.13.0'
+  spec.add_dependency 'dry-schema', '~> 1'
+  spec.add_dependency 'redis', '~> 4'
+  spec.add_dependency 'xxhash', '~> 0.4.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/heavy_keeper/bucket.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+# Act as 2D array with to store HeavyKeeper counter.
+# It's implemented using a hash underneath.
+#
+# rubocop:disable Naming/MethodParameterName
+module HeavyKeeper
+  class Bucket
+    def initialize(storage = HeavyKeeper::Config.config.storage)
+      @storage = storage
+    end
+
+    def set(key, i, j, value)
+      storage.hset(hash_key(key), "#{i}:#{j}", JSON.generate(value))
+    end
+
+    def get(key, i, j)
+      value = storage.hget(hash_key(key), "#{i}:#{j}")
+
+      value ? JSON.parse(value) : value
+    end
+
+    def clear(key)
+      storage.del(hash_key(key))
+    end
+
+    private
+
+    attr_reader :storage
+
+    def hash_key(key)
+      "#{key_prefix}:hash:#{key}"
+    end
+
+    def key_prefix
+      "#{HeavyKeeper::Config.config.cache_prefix}_bucket"
+    end
+  end
+end
+# rubocop:enable Naming/MethodParameterName

data/lib/heavy_keeper/config.rb

@@ -0,0 +1,10 @@
+require 'dry-configurable'
+
+module HeavyKeeper
+  class Config
+    extend Dry::Configurable
+
+    setting :cache_prefix, default: 'cache_prefix'
+    setting :storage
+  end
+end

data/lib/heavy_keeper/min_heap.rb

@@ -0,0 +1,92 @@
+# A min-heap implementation in Redis.
+# This class is not supposed to use outside of the HeavyKeeper implementation
+# for TopK. It uses the following datastructure in Redis:
+# - A sorted set with size K to store the min heap
+# - A hash with size K to store counter for each item in min heap
+#
+module HeavyKeeper
+  class MinHeap
+    def initialize(storage = HeavyKeeper::Config.config.storage)
+      @storage = storage
+    end
+
+    def list(key, total)
+      items = storage.zrevrange(sorted_set_key(key), 0, total - 1)
+
+      if items.empty?
+        {}
+      else
+        storage.mapped_hmget(hash_key(key), *items)
+      end
+    end
+
+    def count(key, item)
+      storage.hget(hash_key(key), item).to_i
+    end
+
+    def min(key)
+      item = storage.zrangebyscore(sorted_set_key(key), - Float::INFINITY, Float::INFINITY, limit: [0, 1]).first
+      count(key, item)
+    end
+
+    def exist?(key, item)
+      storage.hexists(hash_key(key), item)
+    end
+
+    def add(key, item, value, top_k)
+      count = storage.zcard(sorted_set_key(key))
+
+      storage.multi do
+        storage.zadd(sorted_set_key(key), value, item)
+        storage.hset(hash_key(key), item, value)
+      end
+
+      if count >= top_k
+        dropped_item, _ = storage.zpopmin(sorted_set_key(key))
+        storage.hdel(hash_key(key), dropped_item)
+
+        if dropped_item != item
+          value
+        end
+      else
+        value
+      end
+    end
+
+    def update(key, item, value)
+      storage.multi do
+        storage.zrem(sorted_set_key(key), item)
+        storage.zincrby(sorted_set_key(key), value, item)
+        storage.hset(hash_key(key), item, value)
+      end
+
+      value
+    end
+
+    def clear(key)
+      storage.del(sorted_set_key(key))
+      storage.del(hash_key(key))
+    end
+
+    def delete(key, item)
+      storage.zrem(sorted_set_key(key), item)
+      storage.hdel(hash_key(key), item)
+    end
+
+    private
+
+    attr_reader :storage
+
+    def sorted_set_key(key)
+      "#{key_prefix}:sorted_set:#{key}"
+    end
+
+    def hash_key(key)
+      "#{key_prefix}:hash:#{key}"
+    end
+
+    def key_prefix
+      "#{HeavyKeeper::Config.config.cache_prefix}_heavy_keeper"
+    end
+  end
+end

data/lib/heavy_keeper/top_k.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+require 'securerandom'
+require 'xxhash'
+require_relative '../validations/message'
+
+module HeavyKeeper
+  class TopK # rubocop:disable Metrics/ClassLength
+    Validator = ::Dry::Schema.Params do
+      required(:top_k).filled(:integer, gt?: 0)
+      required(:width).filled(:integer, gt?: 0)
+      required(:depth).filled(:integer, gt?: 0)
+      required(:decay).filled(:decimal, gt?: 0, lteq?: 1)
+    end
+
+    # Initiate the controller to create/operate on top-k DS
+    #
+    # @param storage [Redis] A Redis client to interact with Redis
+    #
+    # @return [HeavyKeeper::TopK] new instance of the controller
+    def initialize(storage: HeavyKeeper::Config.config.storage)
+      @storage = storage
+      @min_heap = MinHeap.new(storage)
+      @bucket = Bucket.new(storage)
+    end
+
+    # Complexity O(1)
+    # Initialize a TopK in Redis with specified parameters.
+    #
+    # @param key [String] a key for identifying top-k DS in Redis
+    # @param top_k [Integer] number of top elements we want to track
+    # @param width [Integer] Size of the bucket to store counter
+    # @param depth [Integer] Number of buckets we want to store
+    # @param decay [Decimal] decay factor: smaller number means bigger
+    #        distinction between mouse-flow and elelphant flow
+    #
+    # @return OK on success, otherwise raise error
+    def reserve(key, options)
+      options = validate(options)
+
+      storage.mapped_hmset(metadata_key(key), options)
+    end
+
+    # Complexity O(k + depth)
+    # Add an array of items to a Top-K DS
+    #
+    # @param key [String] key for identifying top-k DS in Redis
+    # @param items [String, String, ...] each value represents an item we want to
+    #        store in Top-K
+    #
+    # @return [Array[Nil, Integer]]
+    #         nil if the item is not addded to the list
+    #         otherwise, return the current value of item
+    def add(key, *items)
+      items_and_increments = items.map { |item| [item, 1] }
+      increase_by(key, *items_and_increments)
+    end
+
+    # Complexity O(k + (increment * depth))
+    # Add an array of items to a Top-K DS, with custom increment for each item
+    #
+    # @param key [String] key for identifying top-k DS in Redis
+    # @param items_and_increments [[String, Integer], ...]
+    #        each value represents an item and increment that needs to be added
+    #        to Top-K
+    #
+    # @return [Array[Nil, String]]
+    #         nil if the item is not addded to the list
+    #         otherwise, return the current value of item
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/BlockLength
+    # rubocop:disable Metrics/PerceivedComplexity
+    def increase_by(key, *items_and_increments)
+      options = validate(storage.hgetall(metadata_key(key)))
+
+      items_and_increments.map do |(item, increment)|
+        max_count = 0
+        item_fingerprint = XXhash.xxh64(item)
+
+        exist = min_heap.exist?(key, item)
+        min_value = min_heap.min(key)
+
+        options[:depth].times do |i|
+          bucket_number = XXhash.xxh64_stream(StringIO.new(item), i) % options[:width]
+
+          fingerprint, count = bucket.get(key, i, bucket_number)
+
+          if count.nil? || count.zero?
+            bucket.set(key, i, bucket_number, [item_fingerprint, increment])
+            max_count = [increment, max_count].max
+          elsif fingerprint == item_fingerprint
+            if exist || count <= min_value
+              bucket.set(key, i, bucket_number, [fingerprint, count + increment])
+              max_count = [count + increment, max_count].max
+            end
+          else
+            decay = options[:decay]**count
+
+            if SecureRandom.rand < decay
+              count -= increment
+
+              if count.positive?
+                bucket.set(key, i, bucket_number, [fingerprint, count])
+              else
+                bucket.set(key, i, bucket_number, [item_fingerprint, increment])
+                max_count = [increment, max_count].max
+              end
+            end
+          end
+        end
+
+        if exist
+          min_heap.update(key, item, max_count)
+        else
+          min_heap.add(key, item, max_count, options[:top_k])
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/BlockLength
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    # Complexity O(k)
+    # Checks whether an item is one of Top-K items. Multiple items can be checked at once.
+    #
+    # @param key [String] a key for identifying top-k DS in Redis
+    # @param items [String, String, ...] an array of item that we want to check
+    #
+    # @return [Array[Boolean]] true if item is in Top-K, otherwise return false
+    def query(key, *items)
+      items.map do |item|
+        min_heap.exist?(key, item)
+      end
+    end
+
+    # Complexity O(k + depth)
+    # Please note this number will never be higher than the real count
+    # and likely to be lower. Multiple items can be queried at once.
+    #
+    # @param key [String] a key for identifying top-k DS in Redis
+    # @param items [String, String, ...] an array of item that we want to check
+    #
+    # @return [Array[Integer]] return the count of each item
+    def count(key, *items)
+      items.map do |item|
+        min_heap.count(key, item)
+      end
+    end
+
+    # Complexity O(k)
+    # Return full list of items in Top K list.
+    #
+    # @param key [String] a key for identifying top-k DS in Redis
+    #
+    # @return [Hash] return a hash contains the key and the count of the top-K
+    #         elements
+    def list(key)
+      top_k = storage.hget(metadata_key(key), :top_k).to_i
+      min_heap.list(key, top_k)
+    end
+
+    # Complexity O(1)
+    # Clean up all Redis data related to a key
+    #
+    # @param key [String] a key for identifying top-k DS in Redis
+    #
+    # @return OK if successful; otherwise, raise error
+    def clear(key)
+      storage.multi do
+        storage.del(metadata_key(key))
+        min_heap.clear(key)
+        bucket.clear(key)
+      end
+    end
+
+    # Complexity O(1)
+    # Reset counter of an item to zero in order to decay it out
+    #
+    # @param key [String] a key for identifying top-k DS in Redis
+    # @param items [String] item that we want to decay
+    #
+    # @return OK if successful, raise error otherwise
+    def remove(key, item)
+      options = validate(storage.hgetall(metadata_key(key)))
+      item_fingerprint = XXhash.xxh64(item)
+
+      options[:depth].times do |i|
+        bucket_number = XXhash.xxh64_stream(StringIO.new(item), i) % options[:width]
+        fingerprint, _ = bucket.get(key, i, bucket_number)
+
+        bucket.set(key, i, bucket_number, [fingerprint, 0]) if item_fingerprint == fingerprint
+      end
+
+      min_heap.delete(key, item)
+    end
+
+    private
+
+    attr_reader :storage, :min_heap, :bucket
+
+    def metadata_key(key)
+      "#{key_prefix}:#{key}:data"
+    end
+
+    def key_prefix
+      "#{HeavyKeeper::Config.config.cache_prefix}_heavy_keeper"
+    end
+
+    def validate(options)
+      result = Validator.call(options)
+
+      if result.failure?
+        error = ::Validations::Message.new.build(result.errors.to_h).join('. ')
+        raise HeavyKeeper::Error, error
+      end
+
+      result.output
+    end
+  end
+end

data/lib/heavy_keeper/version.rb

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

data/lib/heavy_keeper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'heavy_keeper/version'
+require_relative 'heavy_keeper/config'
+require_relative 'heavy_keeper/top_k'
+require_relative 'heavy_keeper/min_heap'
+require_relative 'heavy_keeper/bucket'
+
+module HeavyKeeper
+  class Error < StandardError; end
+end

data/lib/validations/message.rb

@@ -0,0 +1,35 @@
+module Validations
+  class Message
+    CLASSIFY_SEPARATOR = '_'.freeze
+    TITLEIZE_SEPARATOR = ' '.freeze
+
+    # @errors [Hash | Array] output of dry-validation
+    #         after validating params
+    # @parent [Nil | String] key name of a field that has `errors`
+    #         after validating params
+    # Output: array of string that can be used to feed into
+    # Errors::InvalidParamsError
+    def build(errors, parent = nil)
+      case errors
+      when Hash
+        errors.flat_map do |key, value|
+          child = [parent, key].compact.join(' ')
+          build(value, child)
+        end
+      when Array
+        errors.flat_map do |error|
+          "#{titleize(parent.to_s)} #{build(error)}"
+        end
+      else
+        errors
+      end
+    end
+
+    private
+
+    def titleize(string)
+      # NOTE: this is not a robust implementation of titleize
+      string.split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: heavy_keeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hieu Nguyen
+- Kenneth Teh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- heavy_keeper.gemspec
+- lib/heavy_keeper.rb
+- lib/heavy_keeper/bucket.rb
+- lib/heavy_keeper/config.rb
+- lib/heavy_keeper/min_heap.rb
+- lib/heavy_keeper/top_k.rb
+- lib/heavy_keeper/version.rb
+- lib/validations/message.rb
+homepage: https://github.com/Kaligo/heavy_keeper
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Kaligo/heavy_keeper
+  source_code_uri: https://github.com/Kaligo/heavy_keeper
+  changelog_uri: https://github.com/Kaligo/heavy_keeper/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: Gem which implements HeavyKeeper algorithm
+test_files: []