redis_hash_store 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd8dae43115ff26b94577eac604e79186603f8183c1aebb8ca4a5407561845aa
+  data.tar.gz: 90d4ea6b6c613070156d3a7a8517dab0627e49d59ec1f207cc9627a6208d54e3
+SHA512:
+  metadata.gz: 283dd098e93664eb5d990e77932fc550cd4414b174399cce115a182c60a1706eff9e53256ac7e83eb62a6b0b6e27c569b98a2c58635b2e6c6ac46e0d726d09cb
+  data.tar.gz: 230b1a0e564b57f1316a00b495eb2545ea3ef859200ec1faf9e7b7e0eab17ae81a41181a8418aee02b9070a46c8b9afa6fc073468e4b5ab5b7d635950b34917d

data/lib/active_support/cache/redis_hash_store.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module Cache
+    class RedisHashStore < RedisCacheStore
+      MISSING_BLOCK_MSG = "Missing block: Calling `Cache#fetch` with `force: true` requires a block."
+
+      def initialize(options)
+        super(**options)
+      end
+
+      def write_hash_value(prefix, key, value, **options)
+        instrument(:write_hash_value, [prefix, key], options) do
+          entry = Entry.new(value, **options)
+          write_hash_entry(prefix, key, entry)
+        end
+      end
+
+      def read_hash_value(prefix, key)
+        instrument(:read_hash_value, [prefix, key]) do |payload|
+          entry = read_hash_entry(prefix, key)
+
+          if entry
+            if entry.expired?
+              delete_hash_entry(key)
+              payload[:hit] = false if payload
+              nil
+            else
+              payload[:hit] = true if payload
+              entry.value
+            end
+          else
+            payload[:hit] = false if payload
+            nil
+          end
+        end
+      end
+
+      def fetch_hash_value(prefix, key, **options)
+        force = options[:force]
+
+        raise(ArgumentError, MISSING_BLOCK_MSG) if !block_given? && force
+
+        if block_given?
+          entry = read_hash_value(prefix, key)
+
+          return entry if entry.present? && !force
+
+          write_hash_value(prefix, key, yield, options)
+        end
+
+        read_hash_value(prefix, key)
+      end
+
+      def delete_hash_value(prefix, key)
+        instrument(:delete_hash_value, [prefix, key]) do
+          delete_hash_entry(prefix, key)
+        end
+      end
+
+      def read_hash(prefix)
+        instrument(:read_hash, prefix) do
+          read_hash_entries(prefix).map do |key, entry|
+            if entry.expired?
+              delete_hash_entry(prefix, key)
+              nil
+            else
+              [key, entry.value]
+            end
+          end.compact.to_h
+        end
+      end
+
+      def delete_hash(prefix)
+        instrument(:delete_hash, prefix) do
+          delete_hash_entries(prefix)
+        end
+      end
+
+      private
+
+      def delete_hash_entry(prefix, key)
+        failsafe(:delete_hash_entry, returning: false) do
+          redis.with { |c| c.hdel(prefix, key) }
+        end
+      end
+
+      def read_hash_entry(prefix, key)
+        failsafe(:read_hash_entry) do
+          deserialize_entry(redis.with { |c| c.hget(prefix, key) }, raw: false)
+        end
+      end
+
+      def write_hash_entry(prefix, key, entry)
+        serialized_entry = serialize_entry(entry)
+
+        failsafe(:write_hash_entry, returning: false) do
+          redis.with do |connection|
+            connection.hset(prefix, key, serialized_entry)
+          end
+        end
+      end
+
+      def read_hash_entries(prefix)
+        failsafe(:write_hash_entry, returning: false) do
+          redis.with do |connection|
+            connection.hgetall(prefix).transform_values do |value|
+              deserialize_entry(value, raw: false)
+            end
+          end
+        end
+      end
+
+      def delete_hash_entries(prefix)
+        redis.with { |c| c.del(prefix) }
+      end
+    end
+  end
+end

data/lib/redis_hash_store.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "redis"
+require "redis-activesupport"
+
+require "active_support/cache/redis_hash_store"
+
+module RedisHashStore
+  mattr_accessor :logger, :cache
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: redis_hash_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Golubenko
+- Omar Bahareth
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: rubocop-rails
+  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: rubocop-rspec
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An addition to Rails's redis_cache_store to allow youto easily use Redis
+  hashes for caching
+email: sub@mrsool.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_support/cache/redis_hash_store.rb
+- lib/redis_hash_store.rb
+homepage: https://github.com/mrsool/redis_hash_store
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Redis Hash Store
+test_files: []