cache_json 1.1.1 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbcbf754cd566cb8a11b52307d9ad70e68cc9690d2f880755f9ab55623541d55
-  data.tar.gz: f7e7a36a74934e904f577d363464e85c8d2279f5d265d58173e8ed62d343176f
+  metadata.gz: 5a2871967748d37f7dcca4cc282329618481c1a94e927a91d0edef8dd261e787
+  data.tar.gz: 7bf987cd4de3a9a6067ba22e138fec40dd445fa84fbc3770cb78ccb14f409a5b
 SHA512:
-  metadata.gz: 2d554661775ccfbdb4cda88e23c62dbde1f1e59ea76aa1658c667e79319bc0065fa1371e995bbb90c0ad1b97633bbe40ee1ba7fcc07582a3522fb049a0ba5658
-  data.tar.gz: efbce041a5a4128c576d254f4219074087428d3dd0a46cd241b710fe5c81d7420cd269164698fd247ad7090cec094dc8cfe3aea9c0cf6b19b12ec7a534c71187
+  metadata.gz: 55429caa296c0ff0e0ec826a1de86be8cbad241f4957a1bb7d90498c36dfa3e8cb8a215725271a3c540bcf3e8a87b26198d3460697d1c24015ddc7f89989948d
+  data.tar.gz: 7fa105bcbffc4400dbd949b8c64b0b885b868d0e031a2d4047dc33ec8060ec7b40459a55879c6475581836d35ec5d198adc4f8e6e676077d8b97507cc6680e6f

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.1.1)
+    cache_json (1.2.4)
       redis (>= 3.3.5, < 5)
 
 GEM
@@ -10,45 +10,47 @@ GEM
     ast (2.4.0)
     connection_pool (2.2.2)
     diff-lcs (1.3)
-    jaro_winkler (1.5.3)
+    jaro_winkler (1.5.4)
     mock_redis (0.21.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.19.1)
+    parser (2.7.0.3)
       ast (~> 2.4.0)
-    rack (2.0.7)
-    rack-protection (2.0.5)
+    rack (2.2.3)
+    rack-protection (2.0.8.1)
       rack
     rainbow (3.0.0)
-    rake (10.5.0)
-    redis (4.1.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    redis (4.1.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.72.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    sidekiq (5.2.7)
-      connection_pool (~> 2.2, >= 2.2.2)
-      rack (>= 1.5.0)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.5, < 5)
+    sidekiq (6.0.5)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
     timecop (0.9.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
@@ -57,11 +59,11 @@ DEPENDENCIES
   bundler (~> 2.0)
   cache_json!
   mock_redis (~> 0.21.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.72)
   sidekiq (>= 3.0, < 7)
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

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/cache_json.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'redis', '>= 3.3.5', '< 5'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'mock_redis', '~> 0.21.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.72'
   spec.add_development_dependency 'sidekiq', '>= 3.0', '< 7'

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.1.1'
+  VERSION = '1.2.4'
 end

data/lib/cache_json/worker.rb

@@ -22,62 +22,71 @@ module CacheJSON
       if klass
         klass.new.refresh_cache!(args: args)
       else
-        generate_workers
+        AllPermutations.new.results.each do |perm|
+          if should_refresh?(perm[:klass], perm[:args])
+            CacheJSON::Worker.new.perform(klass: perm[:klass], args: perm[:args])
+          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.1.1
+  version: 1.2.4
 platform: ruby
 authors:
 - Paul Gut
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extremely simple Redis caching for any Ruby class