artirix_cache_service 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e1719e6511906dbf2b6a809ce5908a1611619a4
-  data.tar.gz: 24a67f4e940d307c3ef8b9bd53b65aa4762e58bd
+  metadata.gz: 65a29d56ab01795d2127f62bccd84a00f4667dca
+  data.tar.gz: 5d64879751a1b97e376521f6a7c47bf4edaf6058
 SHA512:
-  metadata.gz: 96b78b39ece2dfecaa199bc8a55c84e2aa2bf0ab6e1397c17e4d0494bb2c1045c3884e1eccc6ef712967291e46d0382360db75c6153834ffd294d9b0a24ea9ed
-  data.tar.gz: 87954784f67d284af6133f11e12b0f57407e3c4bc83b09ec9adf2b387a29ac38e5a4f68c33a88244512d0ef335cc758627a4118eabb5c6ac0bfa85cfbd737351
+  metadata.gz: cbf5d72828d7eb04a0b90d2a6a6930433b55001885a8a8550f3e6e2e47abf9b9b366cb9b7b9c83a64cda748482ccc01ffb00024fcc02440ac84a0c428c67d535
+  data.tar.gz: bd80228958022cf34da234a228b464d1345cd4b3fa4a2e1894bfd45dfdc759ff028811a8beab95131c5923aaf3472c8f032c37b57786af06a59a817093d00317

data/README.md

@@ -172,7 +172,7 @@ 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) %>
+<%= cache ArtirixCacheService.key(:my_key, variables: :my_var) %>
 ...
 <% end %>
 
@@ -209,6 +209,12 @@ ArtirixCacheService.variable_get(:my_var) { 990 } # => "990"
 ArtirixCacheService.variable_get :my_var # => "990" 
 ```
 
+We can list the variables that the service has currently access to with `.variables`
+ 
+```ruby
+ArtirixCacheService.variables # => [ "my_var" ]
+```
+
 ### Variable Store
 
 by default (dev mode) the values are stored in an internal hash.
@@ -259,9 +265,10 @@ and will load up the options to pass to `cache` method looking for the second
 argument on the registered options (using `.options` Service method).
 
 ```ruby
+# in ApplicationHelper
 include ArtirixCacheService.view_helper
 
-
+# in the view
 <%= artirix_cache :my_key, :registered_options_name, :arg1, request: request do %>
 ...
 <% end %>
@@ -285,12 +292,29 @@ possible option names to lookup (see `.options` method).
 <%= artirix_cache :my_key, [:opts1, :otps2], :arg1, request: request do %>
 ...
 <% end %>
+```
 
-# same as 
-<%= cache ArtirixCacheService.key(:my_key, :arg1, request: request), 
-          ArtirixCacheService.options(:opts1, :opts2) do %>
+### with `disable_cache: true` in the options
+
+There is one important difference from using the `artirix_cache` view helper and
+calling `cache` directly. If the options hash to be used has a truthy value on
+`disable_cache` key, then it will `yield` directly and it will not call the 
+`cache` method
+
+example:
+
+```ruby
+# having:
+ArtirixCacheService.options :options_with_disabled
+  # => { expires_in: 300, disable_cache: true }
+
+
+# in the view
+<%= artirix_cache :my_key, :options_with_disabled, :arg1, request: request do %>
 ...
 <% end %>
+
+# will never call `cache` method, it will yield directly
 ```
 
 ## Installation
@@ -320,7 +344,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/artirix/artirix_cache_service.
 
 
-# Changeset
+# CHANGELOG
+
+## v0.5.0
+
+- added `.variables`
 
 ## v0.4.0
 
@@ -337,4 +365,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/artiri
 ## v0.2.0
 
 - removed `ArtirixCacheService.config_params` support, now using `register_key_prefix` method
-- add `options` support
+- add `options` support

data/lib/artirix_cache_service.rb

@@ -22,7 +22,7 @@ module ArtirixCacheService
              :variables_store, :register_variables_store, :reload_variables_store,
              :redis_options, :redis_options=,
              :redis_variable_prefix, :redis_variable_prefix=,
-             :variable_set, :variable_get,
+             :variable_set, :variable_get, :variables,
              to: :service
   end
 

data/lib/artirix_cache_service/service.rb

@@ -25,7 +25,7 @@ module ArtirixCacheService
     delegate :register_variables_store, :variables_store, :reload_variables_store,
              :redis_options, :redis_options=,
              :redis_variable_prefix, :redis_variable_prefix=,
-             :variable_get, :variable_set,
+             :variable_get, :variable_set, :variables,
              to: :variables_store_service
 
     private

data/lib/artirix_cache_service/variables_store_service.rb

@@ -25,7 +25,7 @@ module ArtirixCacheService
       @variables_store ||= build_internal
     end
 
-    delegate :variable_get, :variable_set, :type, to: :variables_store
+    delegate :variable_get, :variable_set, :variables, :type, to: :variables_store
 
     private
 

data/lib/artirix_cache_service/variables_stores/base.rb

@@ -2,6 +2,10 @@ module ArtirixCacheService
   module VariablesStores
     class Base
 
+      def variables
+        raise 'abstract method not overridden'
+      end
+
       def variable_get(given_key, &block)
         key = given_key.to_sym
         val = retrieve(key).presence

data/lib/artirix_cache_service/variables_stores/internal.rb

@@ -5,6 +5,10 @@ module ArtirixCacheService
         :internal
       end
 
+      def variables
+        map.keys.map &:to_s
+      end
+
       private
 
       def retrieve(key)

data/lib/artirix_cache_service/variables_stores/redis.rb

@@ -2,6 +2,9 @@ module ArtirixCacheService
   module VariablesStores
     class Redis < Base
 
+      EMPTY_STRING = ''.freeze
+      WILDCARD     = '*'.freeze
+
       attr_reader :redis_variable_prefix
 
       def type
@@ -13,8 +16,16 @@ module ArtirixCacheService
         @redis_options         = redis_options
       end
 
+      def variables
+        list.map { |key| clean_listed_variable key }
+      end
+
       private
 
+      def list
+        redis.keys(complete_key(WILDCARD))
+      end
+
       def retrieve(key)
         redis.get(complete_key(key))
       end
@@ -27,6 +38,14 @@ module ArtirixCacheService
         "#{redis_variable_prefix}_#{key}"
       end
 
+      def clean_listed_variable(key)
+        key.sub clean_listed_regex, EMPTY_STRING
+      end
+
+      def clean_listed_regex
+        @clean_listed_regex ||= /^#{redis_variable_prefix}_/
+      end
+
       def redis
         @redis ||= ::Redis.new @redis_options
       end

data/lib/artirix_cache_service/version.rb

@@ -1,3 +1,3 @@
 module ArtirixCacheService
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_cache_service
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport