json_schematize 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e2681baf728aedcec1f36235ec2c80ba340228da15d8445b64d1f520c0226d
-  data.tar.gz: b0423051b51cce86508bc2e554365d7df66f88824124ad0157087e9b11577733
+  metadata.gz: 332c8451a65d8d3ef3c738e6a06d54407e62d479f6d0f015aa348c01c8c70f03
+  data.tar.gz: 534ae0f9dd57ee349c99fa75305370241470afb99ca0273afe98d9b206a9eb57
 SHA512:
-  metadata.gz: b84409952c29690b3e9f731dcd4bdf15cf5b63ca494875b319d383640ebd4197f4ec3b59b0d96721d9b6ae26d4784f40a1afbb4ade69911944530f3032a7451e
-  data.tar.gz: 786329f8de424b9a83a4eb7ac12884fa1f352f8eef62f4c65fb23b11e5561b10a2a3c204ccaf7cd4adda1988b9ca9bb2576a83df44bbbd8e88acc74a2ed6f710
+  metadata.gz: ce9ed85a4db89c977231290127487fde0d703ac527009173d28d0d10a1ced80a43d1febcb8cc3e4dff3b64bd80dc20c2817dd14fe301c478d3169342799f1187
+  data.tar.gz: 6eca9b7c49801e97d1393157c8c49a42ffafcb26bcdc103974329c2222ce3f804a496038f1cf8041836170ac251b3e9f977727f99d4bd11edad6de47931b76de

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'redis'
+gem 'activesupport'
 gem 'faker'
 gem 'pry'
 gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,11 +1,16 @@
 PATH
   remote: .
   specs:
-    json_schematize (0.6.0)
+    json_schematize (0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.2.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
@@ -16,6 +21,7 @@ GEM
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
+    minitest (5.15.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -23,7 +29,6 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (12.3.3)
-    redis (4.6.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -45,17 +50,19 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  activesupport
   faker
   json_schematize!
   pry
   pry-byebug
   rake (~> 12.0)
-  redis
   rspec (~> 3.0)
   rspec_junit_formatter
   simplecov

data/docker-compose.yml

@@ -10,13 +10,6 @@ services:
       - .:/gem
       - ..:/local
       - bundle-cache:/usr/local/bundle:delegated
-    environment:
-      REDIS_URL: redis://redis
-    links:
-      - redis
-  redis:
-    image: redis
-    expose:
-      - 6379
+
 volumes:
   bundle-cache:

data/lib/json_schematize/cache/class_methods/client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module JsonSchematize::Cache::ClassMethods
+  module Client
+
+    def __deserialize_keys__(key_hash_bytes)
+      return [{}, 0] if key_hash_bytes.nil?
+
+      min_expire = Time.now.to_i
+      key_hash =  Marshal.load(key_hash_bytes)
+      keys_removed = 0
+      key_hash.each do |key, expire|
+        next if expire.to_i > min_expire
+
+        key_hash.delete(key)
+        keys_removed += 1
+      end
+
+      [key_hash, keys_removed]
+    rescue StandardError => e
+      ::Kernel.warn("Yikes!! Failed to parse. Returning empty. #{e.message}")
+      [{}, 0]
+    end
+
+    def __update_record_keeper__!(expire:, cache_key:, delete_key: false)
+      record_of_truth = cached_keys(with_expire: true)
+      if delete_key
+        record_of_truth.delete(cache_key)
+      else
+        record_of_truth[cache_key] = expire
+      end
+      serialized_string = Marshal.dump(record_of_truth)
+
+      cache_client.write(cache_namespace, serialized_string)
+    end
+
+    def __delete_record__!(key)
+      __update_record_keeper__!(expire: nil, cache_key: key, delete_key: true)
+    end
+
+    def cached_keys(with_expire: false, count_removed: false)
+      raw_string = cache_client.read(cache_namespace)
+      key_hash, keys_removed = __deserialize_keys__(raw_string)
+      return key_hash if with_expire
+      return keys_removed if count_removed
+
+      key_hash.keys
+    end
+
+    def cached_items(key_includes: nil)
+      clear_unscored_items! if rand > cache_configuration[:stochastic_cache_bust]
+
+      cached_keys.map do |key|
+        if key_includes
+          next unless key.include?(key_includes)
+        end
+
+        serialized_string = cache_client.read(key)
+        Marshal.load(serialized_string)
+      end.compact
+    end
+
+    def clear_cache!
+      cache_client.delete_multi(([cache_namespace] + cached_keys))
+    end
+
+    def clear_unscored_items!
+      cached_keys(count_removed: true)
+    end
+  end
+end

data/lib/json_schematize/cache/class_methods/configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module JsonSchematize::Cache::ClassMethods
+  module Configuration
+    def cache_options(key: nil, cache_client: nil, cache_namespace: nil, ttl: nil, update_on_change: nil, stochastic_cache_bust: nil)
+      cache_configuration[:key] = key if key
+      cache_configuration[:ttl] = ttl if ttl
+      cache_configuration[:stochastic_cache_bust] = stochastic_cache_bust if stochastic_cache_bust
+      cache_configuration[:update_on_change] = update_on_change if update_on_change
+      cache_namespace = cache_configuration[:cache_namespace] = cache_namespace if cache_namespace
+
+      self.cache_client = cache_configuration[:cache_client] = cache_client if cache_client
+    end
+
+    def cache_namespace
+       cache_configuration[:cache_namespace] ||= "jss:#{self.name.downcase}"
+    end
+
+    def cache_namespace=(namespace)
+      cache_configuration[:cache_namespace] = namespace
+    end
+
+    def cache_configuration
+      @cache_configuration ||= begin
+        {
+          cache_client: JsonSchematize.configuration.cache_client,
+          cache_namespace: JsonSchematize.configuration.cache_namespace,
+          key: JsonSchematize.configuration.cache_key,
+          stochastic_cache_bust: JsonSchematize.configuration.cache_stochastic_bust,
+          ttl: JsonSchematize.configuration.cache_ttl,
+          update_on_change: JsonSchematize.configuration.cache_update_on_change,
+        }
+      end
+    end
+
+    def cache_client=(client)
+      cache_configuration[:cache_client] = client
+    end
+
+    def cache_client
+      cache_configuration[:cache_client].is_a?(Proc) ? cache_configuration[:cache_client].call : cache_configuration[:cache_client]
+    end
+  end
+end

data/lib/json_schematize/cache/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JsonSchematize
   module Cache
     module InstanceMethods
@@ -12,16 +14,17 @@ module JsonSchematize
 
       def __update_cache_item__(with_delete: true)
         __clear_entry__! if with_delete # needs to get done first in the event the cache_key changes
-        client = self.class.redis_client
+        client = self.class.cache_client
         ttl = self.class.cache_configuration[:ttl].to_i
         score = Time.now.to_i + ttl
-        client.zadd(__cache_namespace__, score, __cache_key__)
-        client.set(__cache_key__, Marshal.dump(self), ex: ttl)
+        self.class.__update_record_keeper__!(expire: score, cache_key: __cache_key__)
+
+        client.write(__cache_key__, Marshal.dump(self), expires_in: ttl)
       end
 
       def __clear_entry__!
-        self.class.redis_client.zrem(__cache_namespace__, __cache_key__)
-        self.class.redis_client.unlink(__cache_key__)
+        self.class.cache_client.delete(__cache_key__)
+        self.class.__delete_record__!(__cache_key__)
       end
 
       def __cache_key__

data/lib/json_schematize/cache.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 require "json_schematize/cache/instance_methods"
-require "json_schematize/cache/class_methods"
+require "json_schematize/cache/class_methods/client"
+require "json_schematize/cache/class_methods/configuration"
 
 module JsonSchematize
   module Cache
-    def self.included(base)
-      raise StandardError, "Yikes! JsonSchematize::Cache Needs Redis to work. Include it as a gem" unless defined?(Redis)
+    module ClassMethods; end
 
+    def self.included(base)
       base.include(JsonSchematize::Cache::InstanceMethods)
-      base.extend(JsonSchematize::Cache::ClassMethods)
+      base.extend(JsonSchematize::Cache::ClassMethods::Client)
+      base.extend(JsonSchematize::Cache::ClassMethods::Configuration)
     end
   end
 end

data/lib/json_schematize/configuration.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module JsonSchematize
+  class Configuration
+    DEFAULT_ONE_MIN = 60 * 60
+    DEFAULT_ONE_HOUR = DEFAULT_ONE_MIN * 60
+    DEFAULT_ONE_DAY = DEFAULT_ONE_HOUR * 24
+    DEFAULT_CACHE_OPTIONS = {
+      cache_client: nil,
+      cache_key: ->(val, _custom_key) { val.hash },
+      cache_namespace: nil,
+      cache_stochastic_bust: 0.8,
+      cache_ttl: DEFAULT_ONE_DAY,
+      cache_update_on_change: true,
+    }
+
+    attr_accessor *DEFAULT_CACHE_OPTIONS.keys
+
+    def initialize
+      @cache_client = DEFAULT_CACHE_OPTIONS[:cache_client]
+      @cache_key = DEFAULT_CACHE_OPTIONS[:cache_key]
+      @cache_namespace = DEFAULT_CACHE_OPTIONS[:cache_namespace]
+      @cache_stochastic_bust = DEFAULT_CACHE_OPTIONS[:cache_stochastic_bust]
+      @cache_ttl = DEFAULT_CACHE_OPTIONS[:cache_ttl]
+      @cache_update_on_change = DEFAULT_CACHE_OPTIONS[:cache_update_on_change]
+    end
+
+    def cache_hash
+      DEFAULT_CACHE_OPTIONS.map do |key, value|
+        val = public_send(key)
+        [key, val]
+      end.to_h
+    end
+
+    def cache_key=(value)
+      if value.is_a? Proc
+        @key = value
+        return @key
+      end
+
+      assign = _assign_msg_("cache_key", "->(val, cusom_key) { val.hash }", "Default proc to assign cache key")
+      msg = "cache_key must be a proc. \n#{assign}"
+      raise JsonSchematize::ConfigError, msg
+    end
+
+    def cache_client=(client)
+      min_required = [:read, :write, :delete_multi, :read_multi]
+      min_required.each do |meth|
+        next if client.methods.include?(meth)
+
+        assign = _assign_msg_("cache_client", "_initialized_client_", "Preferably an ActiveSupport::Cache::Store supported client")
+        msg = "Passed in client does not accept minimum values. #{min_required} are required methods \n#{assign}"
+        raise JsonSchematize::ConfigError, msg
+      end
+
+
+      @cache_client = client
+    end
+
+    def cache_client
+      return @cache_client unless @cache_client.nil?
+
+      begin
+        Kernel.require 'active_support'
+      rescue LoadError
+        assign = _assign_msg_("cache_client", "ActiveSupport::Cache::MemoryStore.new", "A ActiveSupport::Cache::Store supported client")
+        msg = "Default client missing. Attempted to use 'active_support/cache' but not loaded. \n#{assign}"
+        raise JsonSchematize::ConfigError, msg
+      end
+
+      @cache_client = ActiveSupport::Cache::MemoryStore.new
+      @cache_client
+    end
+
+    private
+
+    def _assign_msg_(key, assignment, comment)
+      config = "  config.#{key} = #{assignment} # #{comment}"
+      "\n\n# Initializer for json_schematize\n" \
+      "JsonSchematize.configure do |config|\n" \
+      "#{config}\n" \
+      "end\n\n"
+    end
+  end
+end

data/lib/json_schematize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonSchematize
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/json_schematize.rb

@@ -4,12 +4,14 @@ require "json_schematize/version"
 
 require "json_schematize/base"
 require "json_schematize/boolean"
-require "json_schematize/generator"
+require "json_schematize/configuration"
 require "json_schematize/empty_value"
+require "json_schematize/generator"
 require "json_schematize/version"
 
 module JsonSchematize
   class Error < StandardError; end
+  class ConfigError < StandardError; end
   class FieldError < Error; end
   class InvalidField < Error; end
   class InvalidFieldByValidator < InvalidField; end
@@ -18,4 +20,22 @@ module JsonSchematize
 
   ## Customized class errors
   class UndefinedBoolean < Error; end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= JsonSchematize::Configuration.new
+  end
+
+  def self.configuration=(object)
+    raise ConfigError, "Expected configuration to be a JsonSchematize::Configuration" unless object.is_a?(JsonSchematize::Configuration)
+
+    @configuration = object
+  end
+
+  def self.cache_client
+    configuration.cache_client
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-09 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -92,8 +92,10 @@ files:
 - lib/json_schematize/base.rb
 - lib/json_schematize/boolean.rb
 - lib/json_schematize/cache.rb
-- lib/json_schematize/cache/class_methods.rb
+- lib/json_schematize/cache/class_methods/client.rb
+- lib/json_schematize/cache/class_methods/configuration.rb
 - lib/json_schematize/cache/instance_methods.rb
+- lib/json_schematize/configuration.rb
 - lib/json_schematize/empty_value.rb
 - lib/json_schematize/field.rb
 - lib/json_schematize/field_transformations.rb
@@ -122,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: This gem gives you the ability to turn API results into a standardized schema's

data/lib/json_schematize/cache/class_methods.rb

@@ -1,81 +0,0 @@
-module JsonSchematize
-  module Cache
-    module ClassMethods
-      DEFAULT_ONE_MIN = 60 * 60
-      DEFAULT_ONE_HOUR = DEFAULT_ONE_MIN * 60
-      DEFAULT_ONE_DAY = DEFAULT_ONE_HOUR * 24
-      DEFAULT_URL = ENV["CACHE_LAYER_REDIS_URL"] || ENV["REDIS_URL"]
-      DEFAULTS = {
-        redis_url: DEFAULT_URL,
-        ttl: DEFAULT_ONE_DAY,
-        key: ->(val, _custom_key) { val.hash },
-        update_on_change: true,
-        redis_client: ->() { ::Redis.new(url: DEFAULT_URL) },
-        stochastic_cache_bust: 0.8,
-      }
-
-      def cache_options(key: nil, redis_url: nil, redis_client: nil, cache_namespace: nil, ttl: nil, update_on_change: nil, stochastic_cache_bust: nil)
-        cache_configuration[:key] = key if key
-        cache_configuration[:ttl] = ttl if ttl
-        cache_configuration[:stochastic_cache_bust] = stochastic_cache_bust if stochastic_cache_bust
-        cache_configuration[:update_on_change] = update_on_change if update_on_change
-        cache_namespace = cache_configuration[:cache_namespace] = cache_namespace if cache_namespace
-
-        self.redis_client = cache_configuration[:redis_client] = redis_client if redis_client
-        self.redis_url = cache_configuration[:redis_url] = redis_url if redis_url
-      end
-
-      def cache_namespace
-         cache_configuration[:cache_namespace] ||= "jss:#{self.name.downcase}"
-      end
-
-      def cache_namespace=(namespace)
-        cache_configuration[:cache_namespace] = namespace
-      end
-
-      def cache_configuration
-        @cache_configuration ||= DEFAULTS.clone
-      end
-
-      def redis_client=(client)
-        cache_configuration[:redis_client] = client
-      end
-
-      def redis_url=(url)
-        cache_configuration[:redis_url] = url
-        cache_configuration[:redis_client] = ::Redis.new(url: url)
-      end
-
-      def redis_client
-        cache_configuration[:redis_client].is_a?(Proc) ? cache_configuration[:redis_client].call : cache_configuration[:redis_client]
-      end
-
-      def cached_keys
-        max_length = Time.now.to_i + cache_configuration[:ttl].to_i + 10
-        redis_client.zrangebyscore(cache_namespace, Time.now.to_i, "+inf")
-      end
-
-      def cached_items(key_includes: nil)
-        clear_unscored_items! if rand > cache_configuration[:stochastic_cache_bust]
-
-        cached_keys.map do |key|
-          if key_includes
-            next unless key.include?(key_includes)
-          end
-
-          serialized_string = redis_client.get(key)
-          Marshal.load(serialized_string)
-        end.compact
-      end
-
-      def clear_cache!
-        redis_client.unlink(*cached_keys) if cached_keys.length > 0
-        redis_client.unlink(cache_namespace)
-      end
-
-      def clear_unscored_items!
-        redis_client.zremrangebyscore(cache_namespace, "-inf", Time.now.to_i)
-      end
-    end
-  end
-end