cache_json 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5447969541ae8237cf12f05f7cd4f4d9765ecf698d18987557dc3c38d4226e98
-  data.tar.gz: 6623c07f0e8b5adcb2db3c1689ef8f3cbde3cf3836a6e520a08c460877f825c6
+  metadata.gz: 4c98d70e39deec46936d9103a02a7e79abd094b829f53f7a1e9b203862b398ff
+  data.tar.gz: a6e727b179329cc1dd68b8a15b2246c2028cef24f8148bba111b82bf84411d83
 SHA512:
-  metadata.gz: 46e08e0520e82b99a050e57d8478a8d87350240cbf2725e8679aac7d51e3142fcdf08109597d6f69dc0ed9f41c4513373e0be28ca1d905bd69e8ba5971281a6f
-  data.tar.gz: 0445a7014e507e7af83e3023460e1670adb53e965492810bfe0e438b33b6b46069808f16f23a59e16d3da4e69a3a470397c88ba80bc58bcacfc98ebaeb2c29f8
+  metadata.gz: 5aae4fbabd515f77747561abe2a427f2265cacb14376d085801bab836897fb79bc016be8ec1d4c4613c20af7705b8ef8cc1ed2d891db161008bb5feaca910f2d
+  data.tar.gz: eac08115326cdbe40c10936a6d83e79df496ab4693d2fa414535b27217214fa3b1d79c2c0e7b9fb9e56abaf61329cb0a77b6226bf8d35f12ead8bcc6da6d8829

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/GlobalVars:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 100
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cache_json.gemspec
 gemspec

data/Gemfile.lock

@@ -1,14 +1,24 @@
 PATH
   remote: .
   specs:
-    cache_json (1.0.0)
+    cache_json (1.1.0)
       redis (>= 3.3.5, < 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
+    connection_pool (2.2.2)
     diff-lcs (1.3)
+    jaro_winkler (1.5.3)
     mock_redis (0.21.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rack (2.0.7)
+    rack-protection (2.0.5)
+      rack
+    rainbow (3.0.0)
     rake (10.5.0)
     redis (4.1.2)
     rspec (3.8.0)
@@ -24,7 +34,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      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)
     timecop (0.9.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -35,6 +59,8 @@ DEPENDENCIES
   mock_redis (~> 0.21.0)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.72)
+  sidekiq (>= 3.0, < 7)
   timecop (~> 0.9.1)
 
 BUNDLED WITH

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "cache_json"
+require 'bundler/setup'
+require 'cache_json'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "cache_json"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/cache_json.gemspec

@@ -1,34 +1,38 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cache_json/version"
+require 'cache_json/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cache_json"
+  spec.name          = 'cache_json'
   spec.version       = CacheJSON::VERSION
-  spec.authors       = ["Paul Gut"]
-  spec.email         = ["paul@loopsupport.com"]
+  spec.authors       = ['Paul Gut']
+  spec.email         = ['paul@loopsupport.com']
 
-  spec.summary       = "Extremely simple Redis caching for any Ruby class"
-  spec.description   = "Extremely simple Redis caching for any Ruby class"
-  spec.homepage      = "https://github.com/loopsupport/cache_json"
-  spec.license       = "MIT"
+  spec.summary       = 'Extremely simple Redis caching for any Ruby class'
+  spec.description   = 'Extremely simple Redis caching for any Ruby class'
+  spec.homepage      = 'https://github.com/loopsupport/cache_json'
+  spec.license       = 'MIT'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/loopsupport/cache_json"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/loopsupport/cache_json'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'redis', '>= 3.3.5', '< 5'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'mock_redis', '~> 0.21.0'
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.72'
+  spec.add_development_dependency 'sidekiq', '>= 3.0', '< 7'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
 end

data/lib/cache_json.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "json"
-require "cache_json/version"
-require "cache_json/base"
-require "cache_json/configure"
+require 'json'
+require 'cache_json/version'
+require 'cache_json/base'
+require 'cache_json/configure'
+require 'cache_json/worker'

data/lib/cache_json/adapters/redis.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CacheJSON
+  module Adapters
+    class Redis
+      attr_accessor :args
+      attr_accessor :options
+
+      def initialize(args:, options:)
+        @args = args
+        @options = options
+      end
+
+      def cached_results
+        return @cached_results if @cached_results
+
+        results_json = $redis.get(full_key)
+        @cached_results = JSON.parse(results_json) if results_json
+      end
+
+      def cached_results=(results)
+        $redis.sadd(class_key, full_key)
+        $redis.set(full_key, results.to_json)
+        $redis.expire(full_key, options[:time_to_expire].to_i)
+      end
+
+      def clear_cache!
+        $redis.smembers(class_key).each do |key|
+          $redis.del(key)
+        end
+        $redis.del(class_key)
+      end
+
+      private
+
+      def full_key
+        @full_key ||= "#{class_key}-#{arguments_signature}"
+      end
+
+      def class_key
+        @class_key ||= "CacheJSON-#{options[:class_name]}"
+      end
+
+      def arguments_signature
+        args.to_a.map do |row|
+          "#{row[0]}:#{row[1]}"
+        end.sort.join('-')
+      end
+    end
+  end
+end

data/lib/cache_json/base.rb

@@ -1,89 +1,79 @@
-module CacheJSON::Base
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
+# frozen_string_literal: true
 
-  def results(args)
-    options = self.class.cache_json_full_options
-    cache = Cache.new(args: args, options: options)
-    if cache.get_cached_results
-      # Rails.logger.info "Got #{self.class} results from cache" if options[:logging_enabled]
-      cache.get_cached_results
-    else
-      # Rails.logger.info "Generating #{self.class} cached results" if options[:logging_enabled]
-      results = compute_results(args)
-      cache.set_cached_results(results)
-      JSON.parse(results.to_json) # stringify keys
-    end
-  end
+require 'cache_json/adapters/redis'
 
-  def clear_cache!
-    Cache.new(options: self.class.cache_json_full_options).clear_cache!
-  end
+module CacheJSON
+  module Base
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
 
-  class Cache
-    attr_accessor :args
-    attr_accessor :options
+    def results(args)
+      raise ArgumentError, 'Must use keyword arguments' unless args.is_a?(Hash)
 
-    def initialize(args: {}, options:)
-      @args = args
-      @options = options
+      options = self.class.cache_json_full_options
+      cache = Cache.new(args: args, options: options)
+      check_cache(args: args, cache: cache) ||
+        JSON.parse(refresh_cache!(args: args, cache: cache).to_json) # stringify keys
     end
 
-    def get_cached_results
-      return @get_cached_results if @get_cached_results
+    def clear_cache!
+      Cache.new(options: self.class.cache_json_full_options).clear_cache!
+    end
 
-      results_json = $redis.get(full_key)
-      if results_json
-        @get_cached_results = JSON.parse(results_json)
-      end
+    def refresh_cache!(args:, cache: nil)
+      cache ||= Cache.new(args: args, options: self.class.cache_json_full_options)
+      results = compute_results(args)
+      cache.cached_results = results
+      results
     end
 
-    def set_cached_results(results)
-      $redis.set(full_key, results.to_json)
-      $redis.expire(full_key, options[:time_to_expire].to_i)
+    def check_cache(args:, cache: nil)
+      cache ||= Cache.new(args: args, options: self.class.cache_json_full_options)
+      cache.cached_results
     end
 
-    def clear_cache!
-      $redis.keys.select do |key|
-        key.include?(base_key)
-      end.each do |key|
-        # Rails.logger.info "Deleting #{self.class} cached results" if options[:logging_enabled]
-        $redis.del(key)
+    class Cache
+      attr_accessor :args
+      attr_accessor :options
+
+      def initialize(args: {}, options:)
+        @args = args
+        @options = options
       end
-    end
 
-    def full_key
-      @full_key ||= "#{base_key}-#{arguments_signature}"
-    end
+      def cached_results
+        adapter.cached_results
+      end
 
-    def base_key
-      @base_key ||= "CacheJSON-#{options[:class_name]}"
-    end
+      def cached_results=(results)
+        adapter.cached_results = results
+      end
 
-    def arguments_signature
-      args.to_a.sort_by do |row|
-        row[0]
-      end.map do |row|
-        "#{row[0]}:#{row[1]}"
-      end.join("-")
-    end
-  end
+      def clear_cache!
+        adapter.clear_cache!
+      end
 
-  module ClassMethods
-    # Setter
-    def cache_json_options(options_hash)
-      cache_json_class_specific_overrides.merge!(options_hash)
+      def adapter
+        @adapter ||= CacheJSON::Adapters::Redis.new(args: args, options: options)
+      end
     end
 
-    # Just the class-specific overrides
-    def cache_json_class_specific_overrides
-      @cache_json_class_specific_overrides ||= {}
-    end
+    module ClassMethods
+      # Setter
+      def cache_json_options(options_hash)
+        cache_json_class_specific_overrides.merge!(options_hash)
+      end
 
-    # Getter (inherits from global defaults)
-    def cache_json_full_options
-      CacheJSON::Config.options.merge(cache_json_class_specific_overrides).merge(class_name: self.to_s)
+      # Just the class-specific overrides
+      def cache_json_class_specific_overrides
+        @cache_json_class_specific_overrides ||= {}
+      end
+
+      # Getter (inherits from global defaults)
+      def cache_json_full_options
+        CacheJSON::Config.options.merge(cache_json_class_specific_overrides).merge(class_name: to_s)
+      end
     end
   end
-end
+end

data/lib/cache_json/configure.rb

@@ -1,5 +1,6 @@
-module CacheJSON
+# frozen_string_literal: true
 
+module CacheJSON
   class Config
     @time_to_expire = 3600 # 1 hour
 
@@ -17,4 +18,4 @@ module CacheJSON
   def self.configure
     yield(CacheJSON::Config) if block_given?
   end
-end
+end

data/lib/cache_json/version.rb

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

data/lib/cache_json/worker.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+begin
+  require 'sidekiq'
+rescue LoadError
+  nil
+end
+
+module CacheJSON
+  class Worker
+    if defined?(Sidekiq)
+      include Sidekiq::Worker
+      sidekiq_options queue: 'cache_json'
+    else
+      def perform_async(*)
+        raise 'Sidekiq gem not found. ' \
+              'You can still call this worker manually via CacheJSON::Worker.new.perform'
+      end
+    end
+
+    def perform(klass: nil, args: {})
+      if klass
+        klass.new.refresh_cache!(args: args)
+      else
+        generate_workers
+      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
+    end
+
+    def all_cache_classes
+      # TODO: make this more efficient
+      ObjectSpace.each_object(Class).select do |klass|
+        klass.included_modules.include? CacheJSON::Base
+      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
+        []
+      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)
+        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]
+      end
+    end
+
+    def should_refresh?(klass, args)
+      !klass.new.check_cache(args: args)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_json
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Gut
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
@@ -59,47 +59,81 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.21.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: Extremely simple Redis caching for any Ruby class
 email:
 - paul@loopsupport.com
@@ -109,6 +143,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -120,9 +155,11 @@ files:
 - bin/setup
 - cache_json.gemspec
 - lib/cache_json.rb
+- lib/cache_json/adapters/redis.rb
 - lib/cache_json/base.rb
 - lib/cache_json/configure.rb
 - lib/cache_json/version.rb
+- lib/cache_json/worker.rb
 homepage: https://github.com/loopsupport/cache_json
 licenses:
 - MIT