cache_json 1.2.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1d01d761ef7ff3aff1777d3a019704095b1f50a9ba2ab57fd5a5ba72e02816
-  data.tar.gz: 64b4ac0d7350fbb3125c11c16c9d952e847efa8d230cd54d024f56cfb7ede509
+  metadata.gz: 5df5d41a7515bef89f1d04f0368a8e4704a2ecf7ee46e8c43fa4a39b76850a37
+  data.tar.gz: 11baaf8f7055c0dfb5ae0928e47f85d881e0dc83ffb368c8744d2573c42ba5d4
 SHA512:
-  metadata.gz: ad7911c949d27461f994f16bfcb19e93a5c0830e7b606ccf87e4362042d888056d9a9e029608381550a997297691b34e5570827eb2da64666b0b8d407647fb8e
-  data.tar.gz: 1cfde86c126160747298a70ef8ebc07dcfb0be8e6e66945c464262a99de4a227ef4e264a0d4e265ba5724afd1a5cee5e94dca78eea53e757b3cb0fdfa4c94bf7
+  metadata.gz: 70db145dc314055f2f5200a1e51cd05ba807ac2489765f22275f3ee747a15dac358907c2597b888a918c771d6396c200a52c9d7113424b3504fe2ce07addc8e5
+  data.tar.gz: a99dc593f2e01d575516489dd8321d7d2969b6b05b723f740fc02bd1752d62cedda91d37a5cee4763b6bafa6e29799d8d33570ff01af7f0b56f81f52ac89c7a5

data/.rubocop.yml

@@ -1,14 +1,41 @@
-Style/GlobalVars:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: true
   Max: 100
 
-Metrics/BlockLength:
+Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
-  Exclude:
-    - "spec/**/*"
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cache_json (1.2.0)
+    cache_json (1.2.5)
       redis (>= 3.3.5, < 5)
 
 GEM
@@ -15,7 +15,7 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.3)
       ast (~> 2.4.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-protection (2.0.8.1)
       rack
     rainbow (3.0.0)
@@ -66,4 +66,4 @@ DEPENDENCIES
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   2.0.2
+   2.2.3

data/README.md

@@ -54,6 +54,44 @@ CacheJSON.configure do |config|
 end
 ```
 
+## Automatic refreshing (Sidekiq)
+
+There is a simple Sidekiq job that lets you pre-compute selected classes with specified ranges of arguments. All you have to do is add a `refresh` option:
+
+```ruby
+class ExpensiveJob
+
+  include CacheJSON::Base
+
+
+  cache_json_options(
+    time_to_expire: 1.hour,
+    refresh: {
+      buffer: 5.minutes,
+      arguments: {
+        first: (5..10),
+        second: ['one option', 'another option'],
+        third: 'the only option',
+        fourth: -> { ['proc result'] }
+      }
+    }
+  )
+  ...
+end
+```
+
+The Sidekiq job will take the Cartesian product of all the argument ranges/arrays (all the combinations).
+
+We leave it to you to schedule the job. If you're using https://github.com/moove-it/sidekiq-scheduler, you can do something like this:
+
+```yml
+cache_json_worker:
+  every: "20s"
+  class: CacheJSON::Worker
+```
+
+Whenever the worker runs, it checks which results have expired, and refreshes only those. If you pass in the `buffer` option, it will actually refresh keys that are that far away from expiring. In the example above, the worker will refresh the cache 5 minutes before it expires. This is good if you want to avoid cache misses altogether.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/cache_json/adapters/redis.rb

@@ -31,6 +31,10 @@ module CacheJSON
         $redis.del(class_key)
       end
 
+      def cache_expiring_soon?
+        $redis.ttl(full_key) < options[:refresh][:buffer].to_i
+      end
+
       private
 
       def full_key

data/lib/cache_json/base.rb

@@ -8,7 +8,7 @@ module CacheJSON
       base.extend(ClassMethods)
     end
 
-    def results(args)
+    def results(args = {})
       raise ArgumentError, 'Must use keyword arguments' unless args.is_a?(Hash)
 
       options = self.class.cache_json_full_options
@@ -17,13 +17,18 @@ module CacheJSON
         JSON.parse(refresh_cache!(args: args, cache: cache).to_json) # stringify keys
     end
 
+    def cache_expiring_soon?(args:, cache: nil)
+      cache ||= Cache.new(args: args, options: self.class.cache_json_full_options)
+      cache.cache_expiring_soon?
+    end
+
     def clear_cache!
       Cache.new(options: self.class.cache_json_full_options).clear_cache!
     end
 
     def refresh_cache!(args:, cache: nil)
       cache ||= Cache.new(args: args, options: self.class.cache_json_full_options)
-      results = compute_results(args)
+      results = compute_results(**args)
       cache.cached_results = results
       results
     end
@@ -54,6 +59,10 @@ module CacheJSON
         adapter.clear_cache!
       end
 
+      def cache_expiring_soon?
+        adapter.cache_expiring_soon?
+      end
+
       def adapter
         @adapter ||= CacheJSON::Adapters::Redis.new(args: args, options: options)
       end

data/lib/cache_json/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CacheJSON
-  VERSION = '1.2.0'
+  VERSION = '1.2.5'
 end

data/lib/cache_json/worker.rb

@@ -5,7 +5,6 @@ begin
 rescue LoadError
   nil
 end
-
 module CacheJSON
   class Worker
     if defined?(Sidekiq)
@@ -18,66 +17,79 @@ module CacheJSON
       end
     end
 
-    def perform(klass: nil, args: {})
+    def perform(params="{}")
+      parsed_params = JSON.parse(params)
+      klass = parsed_params["klass"]
+      args = (parsed_params["args"] || {}).transform_keys(&:to_sym)
       if klass
-        klass.new.refresh_cache!(args: args)
+        klass = Object.const_get(klass)
+        klass.new.refresh_cache!(args: args) if should_refresh?(klass, args)
       else
-        generate_workers
+        AllPermutations.new.results.each do |perm|
+          if should_refresh?(perm[:klass], perm[:args])
+            CacheJSON::Worker.perform_async(perm.to_json)
+          end
+        end
       end
     end
 
     private
 
-    def generate_workers
-      all_cache_classes.each do |klass|
-        all_argument_permutations(klass).each do |args|
-          CacheJSON::Worker.new.perform(klass: klass, args: args) if should_refresh?(klass, args)
-        end
-      end
+    def should_refresh?(klass, args)
+      !klass.new.check_cache(args: args) || klass.new.cache_expiring_soon?(args: args)
     end
 
-    def all_cache_classes
-      # TODO: make this more efficient
-      ObjectSpace.each_object(Class).select do |klass|
-        klass.included_modules.include? CacheJSON::Base
+    class AllPermutations
+      def results
+        all_cache_classes.flat_map do |klass|
+          all_argument_permutations(klass).map do |args|
+            {
+              klass: klass,
+              args: args
+            }
+          end
+        end
       end
-    end
 
-    def all_argument_permutations(klass)
-      refresh_options = klass.cache_json_full_options[:refresh]
-      if refresh_options
-        all_combinations_with_fixed_points({}, refresh_options[:arguments])
-      else
-        []
+      def all_cache_classes
+        # TODO: make this more efficient
+        ObjectSpace.each_object(Class).select do |klass|
+          klass.included_modules.include? CacheJSON::Base
+        end
       end
-    end
 
-    def all_combinations_with_fixed_points(fixed_points, full_hash)
-      non_fixed_points = full_hash.dup.delete_if { |k, _| fixed_points.key?(k) }
-      if non_fixed_points.empty?
-        [fixed_points]
-      else
-        pivot_key = non_fixed_points.keys.first
-        values_for_key(non_fixed_points, pivot_key).flat_map do |pivot_key_value|
-          new_fixed_points = fixed_points.merge(Hash[pivot_key, pivot_key_value])
-          all_combinations_with_fixed_points(new_fixed_points, full_hash)
+      def all_argument_permutations(klass)
+        refresh_options = klass.cache_json_full_options[:refresh]
+        if refresh_options
+          all_combinations_with_fixed_points({}, refresh_options[:arguments])
+        else
+          []
         end
       end
-    end
 
-    def values_for_key(hsh, key)
-      pivot_key_values = hsh[key]
-      if pivot_key_values.is_a?(Proc)
-        pivot_key_values.call
-      elsif pivot_key_values.is_a?(Range) || pivot_key_values.is_a?(Array)
-        pivot_key_values
-      else
-        [pivot_key_values]
+      def all_combinations_with_fixed_points(fixed_points, full_hash)
+        non_fixed_points = full_hash.dup.delete_if { |k, _| fixed_points.key?(k) }
+        if non_fixed_points.empty?
+          [fixed_points]
+        else
+          pivot_key = non_fixed_points.keys.first
+          values_for_key(non_fixed_points, pivot_key).flat_map do |pivot_key_value|
+            new_fixed_points = fixed_points.merge(Hash[pivot_key, pivot_key_value])
+            all_combinations_with_fixed_points(new_fixed_points, full_hash)
+          end
+        end
       end
-    end
 
-    def should_refresh?(klass, args)
-      !klass.new.check_cache(args: args)
+      def values_for_key(hsh, key)
+        pivot_key_values = hsh[key]
+        if pivot_key_values.is_a?(Proc)
+          pivot_key_values.call
+        elsif pivot_key_values.is_a?(Range) || pivot_key_values.is_a?(Array)
+          pivot_key_values
+        else
+          [pivot_key_values]
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_json
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.5
 platform: ruby
 authors:
 - Paul Gut
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -166,7 +166,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/loopsupport/cache_json
   source_code_uri: https://github.com/loopsupport/cache_json
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,8 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Extremely simple Redis caching for any Ruby class
 test_files: []