cache_json 1.1.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c98d70e39deec46936d9103a02a7e79abd094b829f53f7a1e9b203862b398ff
-  data.tar.gz: a6e727b179329cc1dd68b8a15b2246c2028cef24f8148bba111b82bf84411d83
+  metadata.gz: d97faf1cadc565cb04a69dee9bd89df23574d72e9b8b412c2e55dffe201d88db
+  data.tar.gz: 69e444bf0badc19dc320d644ca4929712d23552537d6493845aab0cb682dff59
 SHA512:
-  metadata.gz: 5aae4fbabd515f77747561abe2a427f2265cacb14376d085801bab836897fb79bc016be8ec1d4c4613c20af7705b8ef8cc1ed2d891db161008bb5feaca910f2d
-  data.tar.gz: eac08115326cdbe40c10936a6d83e79df496ab4693d2fa414535b27217214fa3b1d79c2c0e7b9fb9e56abaf61329cb0a77b6226bf8d35f12ead8bcc6da6d8829
+  metadata.gz: 2eaae958e037c974bcc9b7042d35b75165c331976989dad8837aee846e60d176a81c4595971f174e5ba25d78f8af9c5fd2035743e0f2ebbbe49118cfbd741e8d
+  data.tar.gz: b6cd26c9c6e4318844be79eb4193af22318feabed40054e5d0b4b28c2cf705d3abd6c32927f5e6b4853eda4838c16ff07a6377b90ffbfd005eef94f378e0858f

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.0)
+    cache_json (1.2.3)
       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,43 @@ 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: {
+      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.
+
 ## 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/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
@@ -23,7 +23,7 @@ module CacheJSON
 
     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

data/lib/cache_json/version.rb

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

data/lib/cache_json/worker.rb

@@ -22,60 +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)
     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?(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.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Paul Gut
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2020-10-29 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