artirix_cache_service 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a01c290d04ff11dacda29d2c61f5ef7b8dece7d
-  data.tar.gz: a39368fac963a4ecd34d344c54fdfcb1deee31c0
+  metadata.gz: 3e1719e6511906dbf2b6a809ce5908a1611619a4
+  data.tar.gz: 24a67f4e940d307c3ef8b9bd53b65aa4762e58bd
 SHA512:
-  metadata.gz: cc6809a9de4d95d41c6e8a8799b60e93a3dd736551e4b4b9bb5cb52645889eff0afcafe3e6577795b1bed4efcb85c03a38f4ea4a543b92b07f5b3dfd268ff3eb
-  data.tar.gz: 47803491fe5289afc35b01c82ac713fa568dda16ab5db3c850c5ac08fa3f81a9c9ad32ff8adceb77f399a2fed0a6821c87cd0185e5ac3cedaf22f1d9d8f38ec4
+  metadata.gz: 96b78b39ece2dfecaa199bc8a55c84e2aa2bf0ab6e1397c17e4d0494bb2c1045c3884e1eccc6ef712967291e46d0382360db75c6153834ffd294d9b0a24ea9ed
+  data.tar.gz: 87954784f67d284af6133f11e12b0f57407e3c4bc83b09ec9adf2b387a29ac38e5a4f68c33a88244512d0ef335cc758627a4118eabb5c6ac0bfa85cfbd737351

data/README.md

@@ -248,6 +248,51 @@ redis_client = Redis.new redis_options
 redis_client.get 'my_app_prefix_myvar' # => 'paco'
 ```
 
+## View Helper
+
+Calling `ArtirixCacheService.view_helper` we can access a module with a 
+`artirix_cache` helper method that acts as a proxy to normal Rails cache 
+view helper method.
+
+It will use the Service to get the final key using the `.key` Service method, 
+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
+include ArtirixCacheService.view_helper
+
+
+<%= artirix_cache :my_key, :registered_options_name, :arg1, request: request do %>
+...
+<% end %>
+
+# same as 
+<%= cache ArtirixCacheService.key(:my_key, :arg1, request: request), 
+          ArtirixCacheService.options(:registered_options_name) do %>
+...
+<% end %>
+```
+
+First argument is required and it's the first argument to 
+`ArtirixCacheService.key` call. The 3rd and subsequent arguments are the extra 
+arguments in that call
+
+The second argument will be used to call `.options`. We can supply an array of 
+possible option names to lookup (see `.options` method).
+
+
+```ruby
+<%= 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 %>
+...
+<% end %>
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -277,6 +322,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/artiri
 
 # Changeset
 
+## v0.4.0
+
+- View Helper with `artirix_cache` helper method
+
 ## v0.3.1
 
 - add request support

data/lib/artirix_cache_service/version.rb

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

data/lib/artirix_cache_service/view_helper.rb

@@ -0,0 +1,19 @@
+module ArtirixCacheService
+  module ViewHelper
+
+    def artirix_cache(key_prefix, options_name = [], *key_params, &block)
+      raise ArgumentError, 'key_prefix is required' unless key_prefix.present?
+
+      options = ArtirixCacheService.options *Array(options_name),
+                                            return_if_missing: :default
+
+      # if `disable_cache` in the options -> yield without caching
+      if options[:disable_cache]
+        yield
+      else
+        key = ArtirixCacheService.key key_prefix, *key_params
+        cache(key, options, &block)
+      end
+    end
+  end
+end

data/lib/artirix_cache_service.rb

@@ -1,6 +1,7 @@
 require 'active_support/all'
 require 'redis'
 require 'artirix_cache_service/version'
+require 'artirix_cache_service/view_helper'
 require 'artirix_cache_service/key'
 require 'artirix_cache_service/options_service'
 require 'artirix_cache_service/variables_store_service'
@@ -25,6 +26,10 @@ module ArtirixCacheService
              to: :service
   end
 
+  def self.view_helper
+    ViewHelper
+  end
+
   def self.service
     @service ||= reload_service
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artirix_cache_service
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -119,6 +119,7 @@ files:
 - lib/artirix_cache_service/variables_stores/internal.rb
 - lib/artirix_cache_service/variables_stores/redis.rb
 - lib/artirix_cache_service/version.rb
+- lib/artirix_cache_service/view_helper.rb
 homepage: https://github.com/artirix/artirix_cache_service
 licenses: []
 metadata: {}