artirix_cache_service 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c799eb1c4173b8f329ca600d6ae11d41e818106
-  data.tar.gz: 4ae4f9898571512b39967e59d15e4ff57cfbb7f0
+  metadata.gz: 5871260d413d0b379be074fd68456dbf560e65b5
+  data.tar.gz: fe55cfc25c52328783ee5544fefa543b93532b14
 SHA512:
-  metadata.gz: c1cb3f17d2241fa807bae7fe7c5f4c3f579e4ab6ad56172ea2aaa2b4c99a5844a4546ed00a35e4342368edce62a55b3edb302ef21d7873c01d2995a5295f4831
-  data.tar.gz: 812862d064c613e2b0360352cf33801e6a5654566e2afd1952d2145fd7117a0abfc1d2fa36718ec46d2b04ee4e4eab69ed4cfeb4634e928b2c5612f24b8258b9
+  metadata.gz: 00633e6912fc6549966c6f5f039140139d0416603ba29de9d62a492543e6e9073193a0bbbd87a0070258e1d0c8d86dd4e897ad14c72f23d0e0bb12db7bbcf0e3
+  data.tar.gz: a20524d2819fc873444925ce2e17da77ac9ebc9407d6f36e0e3668469bc44bd4a930dc3c0590c16c93d0edd7da82f86648eacd22e77e02f12f656482e1ccf5da

data/Gemfile

@@ -11,4 +11,8 @@ group :development, :test do
   gem 'pry-rescue'
 end
 
+group :test do
+  gem 'fakeredis', require: "fakeredis/rspec"
+end
+
 gem 'codeclimate-test-reporter', :group => :test, :require => nil

data/README.md

@@ -136,6 +136,98 @@ ArtirixCacheService.options :missing, :another_missing, return_if_missing: :empt
   # => {} 
 ```
 
+## Variables
+
+as part of the cache_key, we can specify the name of a variable that the Service 
+can retrieve to use in the digest.
+
+Using this, we can effectively change cache_keys arguments without changing code, 
+effectively invalidating cache without coupling.
+  
+If the variable does not have a value, it will get nil, which is valid for the 
+digest.
+
+Note: we retrieve the variables as strings always, and return nil if `blank?`.
+  
+```ruby
+
+# some_view.html.erb
+<%= cache ArtirixCacheService.key(:my_key, variables: :classification) %>
+...
+<% end %>
+
+# first request, variable :my_var does not have a value (nil), so 
+# the cache_key is "prfx/my_key/333a21750df06ef3c82aece819ded0f6f691638a" 
+
+# Digest::SHA1.hexdigest( { my_var: nil }.to_s )
+#  # => "333a21750df06ef3c82aece819ded0f6f691638a"
+
+# model_a.rb
+uuid = SecureRandom.uuid # => "6d6eb11e-0241-4f97-b706-91982eb8e69b"
+ArtirixCacheService.variable_set :my_var, uuid
+
+# now the next request on the view, the cache key is different:
+# cache key is "prfx/my_key/a8484d25b7c57b1f93a05ad82422d7b45c4ad83e"
+
+# Digest::SHA1.hexdigest( { my_var: uuid }.to_s )
+#  # => "a8484d25b7c57b1f93a05ad82422d7b45c4ad83e"
+
+# => 
+```
+
+This way we can invalidate based on a variable value, without directly 
+invalidating cache, for the use cases when we cannot rely on the argument's `cache_key`. 
+
+We use `variable_set` to set new values, and `variable_get` to retrieve them.
+
+We can also pass an optional block to `variable_get` to set the value if it's nil.
+
+```ruby
+
+ArtirixCacheService.variable_get :my_var # => nil
+ArtirixCacheService.variable_get(:my_var) { 990 } # => "990"
+ArtirixCacheService.variable_get :my_var # => "990" 
+```
+
+### Variable Store
+
+by default (dev mode) the values are stored in an internal hash.
+ 
+#### Redis
+
+it can connect to Redis, using the given options, and store the variables with
+a given prefix.
+
+```ruby
+redis_options = {
+                  namespace: 'xyz',
+                  host:      'localhost',
+                  port:      6379,
+                  db:        0,
+                }
+
+ArtirixCacheService.redis_options = redis_options
+ArtirixCacheService.register_variables_store :redis, force: true
+```
+
+A prefix on the variable name will be used. By default it's `artirix_cache_service`.
+It gets prepended to the given variable name, and separated by `_`.
+
+```ruby
+# default prefix
+ArtirixCacheService.redis_variable_prefix # => "artirix_cache_service"
+
+# setting a new prefix (don't forget to reload the store)
+ArtirixCacheService.redis_variable_prefix = 'my_app_prefix'
+ArtirixCacheService.register_variables_store :redis, force: true
+
+# checking variables
+ArtirixCacheService.variable_set 'myvar', 'paco'
+
+redis_client = Redis.new redis_options
+redis_client.get 'my_app_prefix_myvar' # => 'paco'
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -165,7 +257,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/artiri
 
 # Changeset
 
-## v 0.2.0
+## v0.3.0
+
+- add Redis support
+
+## v0.2.0
 
 - removed `ArtirixCacheService.config_params` support, now using `register_key_prefix` method
 - add `options` support

data/artirix_cache_service.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '~> 4'
+  spec.add_dependency 'redis'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'

data/lib/artirix_cache_service.rb

@@ -1,6 +1,12 @@
 require 'active_support/all'
+require 'redis'
 require 'artirix_cache_service/version'
 require 'artirix_cache_service/key'
+require 'artirix_cache_service/options_service'
+require 'artirix_cache_service/variables_store_service'
+require 'artirix_cache_service/variables_stores/base'
+require 'artirix_cache_service/variables_stores/internal'
+require 'artirix_cache_service/variables_stores/redis'
 require 'artirix_cache_service/service'
 
 module ArtirixCacheService
@@ -11,8 +17,11 @@ module ArtirixCacheService
              :register_key_prefix, :key_prefix,
              :default_options, :register_default_options,
              :register_options, :registered_options,
-             :registered_options?, :registered_options,
-             :options,
+             :registered_options?, :registered_options, :options,
+             :variables_store, :register_variables_store, :reload_variables_store,
+             :redis_options, :redis_options=,
+             :redis_variable_prefix, :redis_variable_prefix=,
+             :variable_set, :variable_get,
              to: :service
   end
 

data/lib/artirix_cache_service/key.rb

@@ -9,7 +9,7 @@ module ArtirixCacheService
       @args    = clean_key_args given_args
     end
 
-    delegate :key_prefix, :digest, to: :service
+    delegate :key_prefix, :digest, :variable_get, to: :service
 
     def call
       clean_parts.join KEY_SEPARATOR
@@ -39,9 +39,21 @@ module ArtirixCacheService
 
     def cache_key_from_options(hash)
       return nil unless hash.kind_of? Hash
-      return nil unless hash[:digest]
 
-      digest hash[:digest]
+      d = hash[:digest].presence
+      v = variables_hash(Array(hash[:variables])).presence
+
+      return nil unless d || v
+
+      if d && v
+        digest [d, v]
+      else
+        digest d || v
+      end
+    end
+
+    def variables_hash(variable_names)
+      Hash[variable_names.map { |var| [var, variable_get(var)] }]
     end
 
   end

data/lib/artirix_cache_service/options_service.rb

@@ -0,0 +1,59 @@
+module ArtirixCacheService
+  class OptionsService
+
+    def default_options
+      @default_options ||= {}
+    end
+
+    def register_default_options(default_options)
+      @default_options = Hash(default_options)
+      self
+    end
+
+    def register_options(name, options)
+      raise ArgumentError if name.blank?
+      options_map[name.to_sym] = Hash(options)
+      self
+    end
+
+    def registered_options(name)
+      return nil unless name.present?
+      options_map[name.to_sym]
+    end
+
+    def registered_options?(name)
+      !registered_options(name).nil?
+    end
+
+    def options(*names, return_if_missing: :empty)
+      name = names.detect { |name| registered_options? name }
+      if name.present?
+        get_options(name)
+      else
+        missing_options(return_if_missing)
+      end
+    end
+
+    private
+
+    def missing_options(return_if_missing)
+      case return_if_missing
+      when :default
+        default_options.dup
+      when :nil, nil
+        nil
+      else
+        {}
+      end
+    end
+
+    def get_options(name)
+      default_options.merge registered_options(name)
+    end
+
+    def options_map
+      @options_map ||= {}
+    end
+
+  end
+end

data/lib/artirix_cache_service/service.rb

@@ -17,59 +17,25 @@ module ArtirixCacheService
       Digest::SHA1.hexdigest arg.to_s
     end
 
-    def default_options
-      @default_options ||= {}
-    end
-
-    def register_default_options(default_options)
-      @default_options = Hash(default_options)
-      self
-    end
+    delegate :default_options, :register_default_options,
+             :register_options, :registered_options,
+             :registered_options?, :options,
+             to: :options_service
 
-    def register_options(name, options)
-      raise ArgumentError if name.blank?
-      options_map[name.to_sym] = Hash(options)
-      self
-    end
-
-    def registered_options(name)
-      return nil unless name.present?
-      options_map[name.to_sym]
-    end
-
-    def registered_options?(name)
-      !registered_options(name).nil?
-    end
-
-    def options(*names, return_if_missing: :empty)
-      name = names.detect { |name| registered_options? name }
-      if name.present?
-        get_options(name)
-      else
-        missing_options(return_if_missing)
-      end
-    end
+    delegate :register_variables_store, :variables_store, :reload_variables_store,
+             :redis_options, :redis_options=,
+             :redis_variable_prefix, :redis_variable_prefix=,
+             :variable_get, :variable_set,
+             to: :variables_store_service
 
     private
 
-    def missing_options(return_if_missing)
-      case return_if_missing
-      when :default
-        default_options.dup
-      when :nil, nil
-        nil
-      else
-        {}
-      end
+    def options_service
+      @options_service ||= OptionsService.new
     end
 
-    def get_options(name)
-      default_options.merge registered_options(name)
+    def variables_store_service
+      @variables_store_service ||= VariablesStoreService.new
     end
-
-    def options_map
-      @options_map ||= {}
-    end
-
   end
 end

data/lib/artirix_cache_service/variables_store_service.rb

@@ -0,0 +1,53 @@
+module ArtirixCacheService
+  class VariablesStoreService
+    DEFAULT_PREFIX = 'artirix_cache_service'.freeze
+
+    attr_writer :redis_options
+    attr_writer :redis_variable_prefix
+
+    def redis_options
+      @redis_options ||= {}
+    end
+
+    def redis_variable_prefix
+      @redis_variable_prefix ||= DEFAULT_PREFIX
+    end
+
+    def register_variables_store(type, force: false)
+      @variables_store = build_by_type type, force
+    end
+
+    def reload_variables_store
+      register_variables_store type, force: true
+    end
+
+    def variables_store
+      @variables_store ||= build_internal
+    end
+
+    delegate :variable_get, :variable_set, :type, to: :variables_store
+
+    private
+
+    def build_by_type(type, force = false)
+      case type
+      when :internal
+        build_internal force
+      when :redis
+        build_redis force
+      else
+        raise ArgumentError, 'type not recognized'
+      end
+    end
+
+    def build_internal(force = false)
+      return @variables_store if !force && @variables_store.kind_of?(VariablesStores::Internal)
+      VariablesStores::Internal.new
+    end
+
+    def build_redis(force = false)
+      return @variables_store if !force && @variables_store.kind_of?(VariablesStores::Redis)
+      VariablesStores::Redis.new redis_variable_prefix, redis_options
+    end
+  end
+end

data/lib/artirix_cache_service/variables_stores/base.rb

@@ -0,0 +1,22 @@
+module ArtirixCacheService
+  module VariablesStores
+    class Base
+
+      def variable_get(given_key, &block)
+        key = given_key.to_sym
+        val = retrieve(key).presence
+        return val.to_s if val
+        return nil unless block_given?
+
+        val = block.call
+        store key, val
+        val.presence && val.to_s
+      end
+
+      def variable_set(key, value)
+        store key.to_sym, value
+        self
+      end
+    end
+  end
+end

data/lib/artirix_cache_service/variables_stores/internal.rb

@@ -0,0 +1,23 @@
+module ArtirixCacheService
+  module VariablesStores
+    class Internal < Base
+      def type
+        :internal
+      end
+
+      private
+
+      def retrieve(key)
+        map[key]
+      end
+
+      def store(key, value)
+        map[key] = value
+      end
+
+      def map
+        @map ||= {}
+      end
+    end
+  end
+end

data/lib/artirix_cache_service/variables_stores/redis.rb

@@ -0,0 +1,35 @@
+module ArtirixCacheService
+  module VariablesStores
+    class Redis < Base
+
+      attr_reader :redis_variable_prefix
+
+      def type
+        :redis
+      end
+
+      def initialize(redis_variable_prefix, redis_options = {})
+        @redis_variable_prefix = redis_variable_prefix
+        @redis_options         = redis_options
+      end
+
+      private
+
+      def retrieve(key)
+        redis.get(complete_key(key))
+      end
+
+      def store(key, value)
+        redis.set(complete_key(key), value)
+      end
+
+      def complete_key(key)
+        "#{redis_variable_prefix}_#{key}"
+      end
+
+      def redis
+        @redis ||= ::Redis.new @redis_options
+      end
+    end
+  end
+end

data/lib/artirix_cache_service/version.rb

@@ -1,3 +1,3 @@
 module ArtirixCacheService
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artirix_cache_service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +112,12 @@ files:
 - bin/setup
 - lib/artirix_cache_service.rb
 - lib/artirix_cache_service/key.rb
+- lib/artirix_cache_service/options_service.rb
 - lib/artirix_cache_service/service.rb
+- lib/artirix_cache_service/variables_store_service.rb
+- lib/artirix_cache_service/variables_stores/base.rb
+- lib/artirix_cache_service/variables_stores/internal.rb
+- lib/artirix_cache_service/variables_stores/redis.rb
 - lib/artirix_cache_service/version.rb
 homepage: https://github.com/artirix/artirix_cache_service
 licenses: []