redis_hash 0.9.5 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9571da3226484c40dc459a9a76684fdc07a9aaf63f8df568f86432449945af81
-  data.tar.gz: cba522bee6a8988426c079987138baf393b99324eaa6cf2158782193b491b980
+  metadata.gz: 29ab1dc565944c85efab09cdee351cb3d16ab9f703c26df92a2f0adb2e120f46
+  data.tar.gz: 393055cc71ae67b3a35320338cb15c4c9072a59ab129052dd01fcdcc3cbe95d2
 SHA512:
-  metadata.gz: 13662938025f2d3bdf43e23641db06a236876f3493a7e3d33b4654588bec29da0d534a915dc321ff3d32b9582d04b2a642fc753cba8c37837724b332482e07da
-  data.tar.gz: 2ef6a6bf131abdbf33a408846bf57da7b5cb9aa7e9b7600106c41659fdb73dadf2d6cbde69b21c2b7ea81b469a18e875d7e4197c7b06eebd539d57cb49093d11
+  metadata.gz: 0fb0884e4b582715cdfc3f516f8c4d698828d3b5399c09823d5a30afa0ab5b60c0c0b5c354c88ba895501de1d03d85d2c91806a70e2ba4ebcf4ac59b9437115f
+  data.tar.gz: adc1a0ace6cd162ac08d9159b2a68e74a46503ecd8634bfc65f4c70ec7704a237982e2c28eb8f94c0fd5db1e771818507ea35692c7156b276af2e912250b2a6b

data/lib/redis_hash/base.rb

@@ -4,6 +4,7 @@ require_relative "concerns/adapter"
 require_relative "concerns/default"
 require_relative "concerns/callbacks"
 require_relative "concerns/core"
+require_relative "concerns/schema"
 require_relative "concerns/identity"
 require_relative "concerns/accessors"
 require_relative "concerns/comparisons"
@@ -22,6 +23,7 @@ module RedisHash
     include RedisHash::Default
     include RedisHash::Callbacks
     include RedisHash::Core
+    include RedisHash::Schema
     include RedisHash::Identity
     include RedisHash::Accessors
     include RedisHash::Comparisons

data/lib/redis_hash/concerns/adapter.rb

@@ -10,6 +10,8 @@ module RedisHash
 
       delegate :default_redis, :default_redis_key, :default_redis_ttl, to: :class
 
+      delegate :pipelined, :multi, :exec, to: :redis
+
       private
 
       def initialize_redis(redis, redis_key, redis_ttl)

data/lib/redis_hash/concerns/expiration.rb

@@ -33,5 +33,10 @@ module RedisHash
     def ttl
       redis.ttl(redis_key)
     end
+
+    def persist
+      @redis_ttl = nil
+      redis.persist(redis_key)
+    end
   end
 end

data/lib/redis_hash/concerns/insertions.rb

@@ -11,6 +11,7 @@ module RedisHash
     end
 
     def merge!(other_hash)
+      assert_keys_allowed(other_hash.keys)
       run_callbacks(:insertion) { hmset(*other_hash.to_a.unshift(redis_key)) }
 
       self
@@ -18,11 +19,13 @@ module RedisHash
     alias_method :update, :merge!
 
     def store(field, value)
+      assert_keys_allowed(field)
       run_callbacks(:insertion) { hset(redis_key, field, value) }
     end
     alias_method :[]=, :store
 
     def setnx!(field, value)
+      assert_keys_allowed(field)
       run_callbacks(:insertion) do
         success = hsetnx(redis_key, field, value)
 

data/lib/redis_hash/concerns/schema.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Schema allow for the enforcement of a whitelist on the keys of the Hash.
+module RedisHash
+  module Schema
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_allowed_keys, instance_writer: false, default: []
+
+      delegate :_allowed_keys, to: :class
+
+      private
+
+      def assert_keys_allowed(*keys)
+        return true if _allowed_keys.empty?
+
+        impermissible = keys.flatten.map(&:to_sym) - _allowed_keys
+        return true if impermissible.empty?
+
+        raise ArgumentError, "Impermissible #{"key".pluralize(impermissible.length)}: #{impermissible.join(", ")}"
+      end
+    end
+
+    class_methods do
+      def inherited(base)
+        base._allowed_keys = _allowed_keys.dup
+        super
+      end
+
+      private
+
+      def allow_keys(*keys)
+        _allowed_keys.push(*keys.flatten.map(&:to_sym))
+      end
+    end
+  end
+end

data/lib/redis_hash/custom_matchers/allow_key.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.allow_keys`
+#
+#     class Example < RedisHash
+#       allow_keys :foo, :bar
+#     end
+#
+#     RSpec.describe Example, type: :redis_hash do
+#       subject { described_class }
+#
+#       it { is_expected.to allow_key :foo }
+#       it { is_expected.to allow_key :bar }
+#     end
+
+RSpec::Matchers.define :allow_key do |key|
+  match { expect(test_subject._allowed_keys).to include key }
+  description { "allow key #{key}" }
+  failure_message { "expected #{test_subject} to allow key #{key}" }
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/redis_hash/custom_matchers.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers/allow_key"

data/lib/redis_hash/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers"

data/lib/redis_hash/version.rb

@@ -1,4 +1,4 @@
 module RedisHash
   # This constant is managed by spicerack
-  VERSION = "0.9.5"
+  VERSION = "0.10.0"
 end

data/lib/redis_hash.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "active_support"
+require "active_support/inflector"
 
 require "redis"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_hash
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.0
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,6 +65,10 @@ files:
 - lib/redis_hash/concerns/insertions.rb
 - lib/redis_hash/concerns/mutations.rb
 - lib/redis_hash/concerns/predicates.rb
+- lib/redis_hash/concerns/schema.rb
+- lib/redis_hash/custom_matchers.rb
+- lib/redis_hash/custom_matchers/allow_key.rb
+- lib/redis_hash/spec_helper.rb
 - lib/redis_hash/version.rb
 homepage: https://github.com/Freshly/spicerack/tree/master/redis_hash
 licenses: