tablesalt 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ba239c7512c2a7cb481687f4441004fc6dda64e3a4108b5fd571b06f5df35a
-  data.tar.gz: 533ed0e4c8f18a620f8f30cf2e76dc41bf58999db6a58a3b736d38441971a19a
+  metadata.gz: d4f0e11454d95394d0070ffa386056836628db24f0070be4524ea5cf70a17912
+  data.tar.gz: 1b27619517487c59c84324b3c8313755ad2274a15eecba5b8ff1e17355cae3e7
 SHA512:
-  metadata.gz: 599e8a40a39446cd314f63481776a4b5fbc38ab804013839ca082ddc182a1dcdd463e68f7b9c5bbae2673c98770e43ba4b5ba84a987db4720fc15711c9cdb315
-  data.tar.gz: 64b3b201336719da82a739d327d64e7e4b77f09bfd8594f6a6bf021a914d4ff034d545331a46f0e1a7d373bb95550d5220f8661d28c2cbe6f3b13a2fb618d016
+  metadata.gz: 92d11b14fe9b71135e9b75e23bc885070854fac486982be65802aec6b2462b9a724fc75d5e5345985b0cd7e973cd213ecfa285c5089827632759501b3b3773c2
+  data.tar.gz: 11a193ee36b492d3c3167cb9ad6668de036b99dd8341924c05b47ec7e63d847b53855d83e416c8ee9cb146cd8350b015ef9a612afef780621ef9e240d05a442e

data/lib/tablesalt/redis_hash/accessors.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Accessors allow for the retrieval of data from the Hash.
+module Tablesalt
+  module RedisHash
+    module Accessors
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :assoc, :compact, :dig, :fetch_values, :flatten, :key, :rassoc, :rehash, to: :to_h
+      end
+
+      def [](field)
+        hget(redis_key, field) || default(field)
+      end
+
+      def fetch(field, default = nil)
+        value = self[field]
+        return value if value.present?
+        return yield(field) if block_given?
+        return default unless default.nil?
+
+        raise KeyError, "key not found: \"#{field}\""
+      end
+
+      def keys
+        hkeys(redis_key)
+      end
+
+      def length
+        hlen(redis_key)
+      end
+      alias_method :size, :length
+
+      def values
+        hvals(redis_key)
+      end
+
+      def values_at(*fields)
+        hmget(*fields.flatten.unshift(redis_key))
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/callbacks.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Callbacks provide an extensible mechanism for hooking into a RedisHash.
+module Tablesalt
+  module RedisHash
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      included do
+        include ActiveSupport::Callbacks
+        define_callbacks :initialize, :reload
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/comparisons.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Comparisons encompasses equality and set inclusion.
+module Tablesalt
+  module RedisHash
+    module Comparisons
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :<, :<=, :>, :>=, :compare_by_identity, :compare_by_identity?, to: :to_h
+      end
+
+      def eql?(other)
+        other.hash == hash
+      end
+      alias_method :==, :eql?
+    end
+  end
+end

data/lib/tablesalt/redis_hash/converters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Converters allow for other objects to be coerced into a RedisHash.
+module Tablesalt
+  module RedisHash
+    module Converters
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def [](*arguments)
+          options = block_given? ? yield({}) : {}
+          new(**options).merge!(Hash[*arguments])
+        end
+
+        def try_convert(object, &block)
+          return object if object.is_a?(RedisHash)
+
+          self[object, &block] if object.respond_to?(:to_hash)
+        end
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/core.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# A RedisHash is a wrapper around a h<key> stored in Redis.
+module Tablesalt
+  module RedisHash
+    module Core
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :redis_key, :redis
+        delegate :del, :hdel, :hexists, :hget, :hgetall, :hkeys, :hlen, :hmget, :hmset, :hset, :hvals, to: :redis
+
+        private
+
+        def set_default(default, &block)
+          self.default = default if default.present?
+          self.default_proc = block if block_given?
+        end
+      end
+
+      def initialize(default = nil, redis_key: SecureRandom.hex, redis: Redis.new, &block)
+        raise ArgumentError, "cannot specify both block and static default" if block_given? && default.present?
+
+        run_callbacks(:initialize) do
+          set_default(default, &block)
+          @redis_key = redis_key
+          @redis = redis
+        end
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/default.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# A Default allows a static or procedurally generated value to be returned on failed lookups.
+module Tablesalt
+  module RedisHash
+    module Default
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :default_proc
+
+        private
+
+        def to_default(field = nil, allow_nil_field: true)
+          @default.presence || (default_proc&.call(self, field) if !field.nil? || allow_nil_field)
+        end
+
+        def validate_proc(proc)
+          raise TypeError, "wrong default_proc type #{proc.class.name} (expected Proc)" unless proc.is_a? Proc
+
+          validate_lambda_arity(proc.arity) if proc.lambda?
+        end
+
+        def validate_lambda_arity(arity)
+          raise TypeError, "default_proc takes two arguments (2 for #{arity})" if arity >= 0 && arity != 2
+        end
+      end
+
+      def default=(value)
+        @default = value
+        @default_proc = nil
+      end
+
+      def default_proc=(value)
+        validate_proc(value) unless value.nil?
+
+        @default = nil
+        @default_proc = value
+      end
+
+      def default(field = nil)
+        to_default(field, allow_nil_field: false)
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/deletions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Deletions allow for the removal of data from the Hash.
+module Tablesalt
+  module RedisHash
+    module Deletions
+      extend ActiveSupport::Concern
+
+      def clear
+        del(redis_key) and {}
+      end
+
+      def delete(field)
+        value = self[field]
+        result = hdel(redis_key, field)
+        (result == 0 && block_given?) ? yield(field) : value
+      end
+
+      def shift
+        return to_default if empty?
+
+        field = keys.first
+        [ field, delete(field) ]
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/enumerators.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Enumerators allow for the traversal and manipulation of data in the Hash.
+module Tablesalt
+  module RedisHash
+    module Enumerators
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :each, :each_pair, :each_key, :each_value, :reject, :select, :transform_values, to: :to_h
+      end
+
+      def delete_if
+        return enum_for(__method__) unless block_given?
+
+        each { |field, value| delete(field) if yield(field, value) }
+
+        to_h
+      end
+
+      def keep_if
+        return enum_for(__method__) unless block_given?
+
+        delete_if { |field, value| !yield(field, value) }
+      end
+
+      def reject!(&block)
+        return enum_for(__method__) unless block_given?
+
+        original = to_h
+        delete_if(&block)
+        current = to_h
+
+        (original == current) ? nil : current
+      end
+
+      def select!
+        return enum_for(__method__) unless block_given?
+
+        reject! { |*arguments| !yield(*arguments) }
+      end
+
+      def transform_values!
+        return enum_for(__method__) unless block_given?
+
+        each { |field, value| store(field, yield(value)) }
+
+        to_h
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/identity.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Identity relates to the specific object instance.
+module Tablesalt
+  module RedisHash
+    module Identity
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :inspect, :to_proc, :to_s, to: :to_h
+      end
+
+      def hash
+        { redis_id: redis.id, redis_key: redis_key }.hash
+      end
+
+      def to_hash
+        to_h
+      end
+
+      def to_h
+        hgetall(redis_key)
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/insertions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Insertions allow for the addition of data into the RedisHash.
+module Tablesalt
+  module RedisHash
+    module Insertions
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :merge, to: :to_h
+      end
+
+      def merge!(other_hash)
+        hmset(*other_hash.to_a.unshift(redis_key))
+        self
+      end
+      alias_method :update, :merge!
+
+      def store(field, value)
+        hset(redis_key, field, value)
+      end
+      alias_method :[]=, :store
+    end
+  end
+end

data/lib/tablesalt/redis_hash/mutations.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Mutations allow for the manipulation of data in the Hash.
+module Tablesalt
+  module RedisHash
+    module Mutations
+      extend ActiveSupport::Concern
+
+      def compact!
+        delete_if { |_, value| value.blank? }
+      end
+
+      def invert
+        inversion = to_h.invert
+        clear
+        inversion.each { |key, value| self[key] = value }
+      end
+
+      def replace(other_hash)
+        clear and merge!(other_hash)
+      end
+    end
+  end
+end

data/lib/tablesalt/redis_hash/predicates.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Predicates enable querying the Hash for data.
+module Tablesalt
+  module RedisHash
+    module Predicates
+      extend ActiveSupport::Concern
+
+      def any?(&block)
+        return length > 0 unless block_given?
+
+        to_h.any?(&block)
+      end
+
+      def empty?
+        length == 0
+      end
+
+      def include?(field)
+        hexists(redis_key, field)
+      end
+      alias_method :has_key?, :include?
+      alias_method :key?, :include?
+      alias_method :member?, :include?
+
+      def value?(value)
+        values.include? value
+      end
+      alias_method :has_value?, :value?
+    end
+  end
+end

data/lib/tablesalt/redis_hash_base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "redis_hash/default"
+require_relative "redis_hash/callbacks"
+require_relative "redis_hash/core"
+require_relative "redis_hash/identity"
+require_relative "redis_hash/accessors"
+require_relative "redis_hash/comparisons"
+require_relative "redis_hash/predicates"
+require_relative "redis_hash/insertions"
+require_relative "redis_hash/deletions"
+require_relative "redis_hash/enumerators"
+require_relative "redis_hash/mutations"
+require_relative "redis_hash/converters"
+
+module Tablesalt
+  class RedisHashBase
+    include Technologic
+    include Tablesalt::RedisHash::Default
+    include Tablesalt::RedisHash::Callbacks
+    include Tablesalt::RedisHash::Core
+    include Tablesalt::RedisHash::Identity
+    include Tablesalt::RedisHash::Accessors
+    include Tablesalt::RedisHash::Comparisons
+    include Tablesalt::RedisHash::Predicates
+    include Tablesalt::RedisHash::Insertions
+    include Tablesalt::RedisHash::Deletions
+    include Tablesalt::RedisHash::Enumerators
+    include Tablesalt::RedisHash::Mutations
+    include Tablesalt::RedisHash::Converters
+  end
+end

data/lib/tablesalt/version.rb

@@ -2,5 +2,5 @@
 
 module Tablesalt
   # This constant is managed by spicerack
-  VERSION = "0.8.3"
+  VERSION = "0.8.4"
 end

data/lib/tablesalt.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
+require "active_support"
+
+require "redis"
+
+require "technologic"
+
 require "tablesalt/version"
 
-module Tablesalt
-end
+require "tablesalt/redis_hash_base"
+
+module Tablesalt; end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: tablesalt
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Jordan Minneti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
-dependencies: []
+date: 2019-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: technologic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: A package of helpers that introduce some conventions and convenience
   for common behaviors
 email:
@@ -21,6 +63,19 @@ files:
 - LICENSE.txt
 - README.md
 - lib/tablesalt.rb
+- lib/tablesalt/redis_hash/accessors.rb
+- lib/tablesalt/redis_hash/callbacks.rb
+- lib/tablesalt/redis_hash/comparisons.rb
+- lib/tablesalt/redis_hash/converters.rb
+- lib/tablesalt/redis_hash/core.rb
+- lib/tablesalt/redis_hash/default.rb
+- lib/tablesalt/redis_hash/deletions.rb
+- lib/tablesalt/redis_hash/enumerators.rb
+- lib/tablesalt/redis_hash/identity.rb
+- lib/tablesalt/redis_hash/insertions.rb
+- lib/tablesalt/redis_hash/mutations.rb
+- lib/tablesalt/redis_hash/predicates.rb
+- lib/tablesalt/redis_hash_base.rb
 - lib/tablesalt/version.rb
 homepage: https://www.freshly.com
 licenses: