json_schematize 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d0fba5a93c9300806e91b5d13da3d16974a72d7598d3b180bd4f9ab13b711c1
-  data.tar.gz: 7361e6e1b2994abd945ab62f90f6d3d7a17fd5e8a51ba11f78525316e2062436
+  metadata.gz: 7db5a295c8de919a0eb55d2894094d8c5c97f932b0955495c31ed762e84133f8
+  data.tar.gz: a8dc99a3affdf8027d9ec4bde5e689e84b18d1571ba126e54cb806d484ad8fb2
 SHA512:
-  metadata.gz: a0c5362513008667000c309259dfb21e61835eb150f095f18bfdd84cba21e391d3d44de2bd2d72ed7fffc34963122c029d4032e8ecc5d3459d1f5818dd935f5c
-  data.tar.gz: 25a59ae832bd2eb65bf92dabe3dac3989f34ad0b46d49e554ec19769b83549b71a2387237b45ee6a7c9e3472662db74c197029ecae2bda1b1ce6b292fdaf79b1
+  metadata.gz: 4de0766c2fb072d96908c1cb66e7611c79db5635cfc046b51d90ad40a8d732d0fe086e62e1b243b0813d90b48e9607198c854624544e2e05b7bbd8a59dd7fb2b
+  data.tar.gz: ce9fa6fdda05e251c7ec45cbff00a22f7aba3ce28f31820f682da05676584defdf491540d5cddd17e26697d572665081781430be7dcaa87723d7466f975f2560

data/.circleci/config.yml

@@ -8,6 +8,7 @@ orbs:
 common_envs: &common_envs
   environment:
     APP_BUNDLER_VERSION: "2.3.8"
+    REDIS_URL: "redis://127.0.0.1"
 
 executors:
   gem:
@@ -17,6 +18,8 @@ executors:
         type: string
     docker:
       - image: cimg/ruby:<< parameters.ruby-version >>
+      - image: circleci/redis:6.0
+
     <<: *common_envs
 
 commands:
@@ -146,6 +149,16 @@ jobs:
           command: |
             curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
             chmod +x ./cc-test-reporter
+      - run:
+          name: Waiting for Redis to be ready
+          command: |
+            for i in `seq 1 10`;
+            do
+              nc -z localhost 6379 && echo Success && exit 0
+              echo -n .
+              sleep 1
+            done
+            echo Failed waiting for Redis to be available && exit 1
       - run:
           name: Run and Report tests
           command: |

data/CHANGELOG.md

@@ -7,10 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.1.0] - YYYY-MM-DD
+## [0.6.0] - 2021-04-01
 
 ### Added
-- New feature 1
+- Caching Layer
 - New feature 2
 
 ### Changed
@@ -24,3 +24,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Bug fix 1
 - Bug fix 2
+
+[//]: # (Added, Changed, Removed, Fixed are the possible headers for each changlog version)

data/Gemfile

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

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    json_schematize (0.5.0)
+    json_schematize (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     docile (1.4.0)
     faker (2.20.0)
@@ -23,6 +23,7 @@ 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)
@@ -32,7 +33,7 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (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)
@@ -54,6 +55,7 @@ DEPENDENCIES
   pry
   pry-byebug
   rake (~> 12.0)
+  redis
   rspec (~> 3.0)
   rspec_junit_formatter
   simplecov

data/README.md

@@ -110,6 +110,87 @@ class CustomClasses < JsonSchematize::Generator
 end
 ```
 
+### Caching Adapter
+
+JsonSchematize is built to be schema for API results. But what happens when you dont expect the result to change? Introducing the caching layer. This layer lets you cache a `JsonSchematize` object that can be queried from later
+
+**Note: This requires redis**
+
+```ruby
+class CachedClass < JsonSchematize::Generator
+  include JsonSchematize::Cache
+  cache_options key: ->(instance_of_cached_class, cache_key_from_initialization) { "#{instance_of_cached_class.id}:#{cache_key_from_initialization}" }
+  cache_options ttl: 7.days.to_i
+
+  schema_default option: :dig_type, value: :string
+
+  add_field name: :id, type: Integer
+end
+
+params = { id: 1 }
+CachedClass.new(cache_key: User.first.id, **params)
+###
+params = { "id" => 1 }
+CachedClass.new(params, cache_key: User.first.id)
+```
+
+#### Instance methods for Cache
+```ruby
+# optional cache_key added on initialization: Can be used to customize the cache entry for the instance
+item = CachedClass.new(cache_key: User.first.id, **params)
+
+# Update the cached item -- Note: This will overwrite the previous cached item IFF the `__cache_key__` remains the same. This is not gaurenteed
+# Optional Param: with_delete, Default true -- Will attempt to delete the original object
+item.__update_cache_item__
+
+# Manually delete the cached entry
+item.__clear_entry__!
+
+# Cache key for the item
+item.__cache_key__
+```
+
+#### Class methods for Cache
+```ruby
+# Retrieve all cached items for the class. Returns an array of CachedClass objects. Only objects that have not expired via TTL
+# Optional: key_includes: "string_expected_in_cache", default is nil and return everthing
+CachedClass.cached_items
+
+# Retrieves all valid object keys from the cache
+CachedClass.cached_keys
+
+# Clears all cached items for the given class
+CachedClass.clear_cache!
+
+# manually clear objects that have expired
+CachedClass.clear_unscored_items!
+```
+### Cache options
+```ruby
+# [Required] false; [Expect] Proc; [Return] String to be used as instance key; [Default] key will be the hash of the object
+cache_options key: ->(instance_of_class, custom_key) { }
+
+# [Required] false; [Expect] String; [Default] ENV["CACHE_LAYER_REDIS_URL"] || ENV["REDIS_URL"]
+cache_options redis_url: _redis_url_value
+
+# [Required] false; [Expect] Redis Object or Proc that returns value of Redis Client; [Default] Redis.new(url: redis_url)
+cache_options redis_client: redis_client
+
+# [Required] false; [Expect] Object that plays with to_s and has no spaces; [Default] Full class name downcased
+cache_options cache_namespace: cache_namespace
+
+# [Required] false; [Expect] Integer in seconds; [Default] 1 day
+cache_options ttl: (60 * 60)
+
+# [Required] false; [Expect] Boolean; [Default] true
+# Update the cache when a value has been changed manually
+cache_options update_on_change: true
+
+# [Required] false; [Expect] Float; [Default] 0.8
+# Expected value to be between 0 and 1. The sample rate that the class will clear oldcache values on retreival
+cache_options stochastic_cache_bust: 0.8
+```
+
 ## Development
 
 This gem can be developed against local machine or while using docker. Simpleified Docker commands can be found in the `Makefile` or execute `make help`

data/docker-compose.yml

@@ -10,6 +10,13 @@ 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.rb

@@ -0,0 +1,81 @@
+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
+      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

data/lib/json_schematize/cache/instance_methods.rb

@@ -0,0 +1,36 @@
+module JsonSchematize
+  module Cache
+    module InstanceMethods
+      def initialize(stringified_params = nil, cache_key: nil, skip_cache_update: false, raise_on_error: true, **params)
+        super(stringified_params, raise_on_error: raise_on_error, **params)
+
+        @__incoming_cache_key__ = cache_key
+        if @values_assigned
+          __update_cache_item__(with_delete: false) unless skip_cache_update
+        end
+      end
+
+      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
+        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)
+      end
+
+      def __clear_entry__!
+        self.class.redis_client.zrem(__cache_namespace__, __cache_key__)
+        self.class.redis_client.unlink(__cache_key__)
+      end
+
+      def __cache_key__
+        "#{__cache_namespace__}:#{self.class.cache_configuration[:key].call(self, @__incoming_cache_key__)}"
+      end
+
+      def __cache_namespace__
+        self.class.cache_namespace
+      end
+    end
+  end
+end

data/lib/json_schematize/cache.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json_schematize/cache/instance_methods"
+require "json_schematize/cache/class_methods"
+
+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)
+
+      base.include(JsonSchematize::Cache::InstanceMethods)
+      base.extend(JsonSchematize::Cache::ClassMethods)
+    end
+  end
+end

data/lib/json_schematize/empty_value.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-class JsonSchematize::EmptyValue
+require "json_schematize/generator"
+
+class JsonSchematize::EmptyValue < ::JsonSchematize::Generator
   def initialize(*)
+    super
   end
 end

data/lib/json_schematize/generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "json_schematize/empty_value"
+require "json_schematize/cache"
 require "json_schematize/field"
 require "json_schematize/introspect"
 
@@ -59,6 +59,12 @@ class JsonSchematize::Generator
     @optional_fields ||= []
   end
 
+  # def self.update_block(&block)
+  #   @skip_individual_updates = true
+  #   yield(cloned)
+  #   @skip_individual_updates = false
+  # end
+
   def self.convenience_methods(field:)
     unless self.instance_methods.include?(:"#{field.name}=")
       define_method(:"#{field.name}=") do |value|
@@ -71,6 +77,7 @@ class JsonSchematize::Generator
         return false unless validate_value(**validate_params)
 
         instance_variable_set(:"@#{field.name}", value)
+        __update_cache__!
         return true
       end
     end
@@ -100,6 +107,13 @@ class JsonSchematize::Generator
 
   private
 
+  def __update_cache__!
+    return unless self.class.include?(JsonSchematize::Cache)
+    return unless self.class.cache_configuration[:update_on_change]
+
+    __update_cache_item__
+  end
+
   def assign_values!
     self.class.fields.each do |field|
       value = field.value_from_field(@__params)[:transformed_value]

data/lib/json_schematize/introspect.rb

@@ -22,6 +22,7 @@ module JsonSchematize::Introspect
   end
 
   def inspect
-    "#<#{self.class} - required fields: #{self.class.required_fields.map(&:name)}; optional fields: #{self.class.optional_fields.map(&:name)}>"
+    stringify = to_h.map { |k, v| "#{k}:#{v}" }.join(", ")
+    "#<#{self.class} - required fields: #{self.class.required_fields.map(&:name)}; #{stringify}>"
   end
 end

data/lib/json_schematize/version.rb

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

data/lib/json_schematize.rb

@@ -3,6 +3,7 @@
 require "json_schematize/base"
 require "json_schematize/boolean"
 require "json_schematize/generator"
+require "json_schematize/empty_value"
 require "json_schematize/version"
 
 module JsonSchematize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -90,6 +90,9 @@ files:
 - lib/json_schematize.rb
 - 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/instance_methods.rb
 - lib/json_schematize/empty_value.rb
 - lib/json_schematize/field.rb
 - lib/json_schematize/field_transformations.rb