artirix_cache_service 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8925a97c03f8fda41870180966bfef9e8b224a3
-  data.tar.gz: 453fb7acd85987d1ee0ed7728718a91dc00d68c8
+  metadata.gz: 8c799eb1c4173b8f329ca600d6ae11d41e818106
+  data.tar.gz: 4ae4f9898571512b39967e59d15e4ff57cfbb7f0
 SHA512:
-  metadata.gz: 1dd2bae6ef68232ae2971aa016f3a04173ff4a03fc9d41598ffc07d10a91eeefde48be2fafe1357f03e564bdeee62c28d45e92bf2ee4f551a06f359d3a443721
-  data.tar.gz: 443f473eccdbf0908a9efdf11e05e046abc052ac8ebe6faf6811cc75717bed1c23c3f13280a6b22929da0c89c20766cf9411e48bb666328b0fd090d35da24064
+  metadata.gz: c1cb3f17d2241fa807bae7fe7c5f4c3f579e4ab6ad56172ea2aaa2b4c99a5844a4546ed00a35e4342368edce62a55b3edb302ef21d7873c01d2995a5295f4831
+  data.tar.gz: 812862d064c613e2b0360352cf33801e6a5654566e2afd1952d2145fd7117a0abfc1d2fa36718ec46d2b04ee4e4eab69ed4cfeb4634e928b2c5612f24b8258b9

data/README.md

@@ -10,7 +10,7 @@ and some extra variables or options, with some helper methods.
 
 TODO: also help with the cache options.
 
-## Usage
+## Usage: `.key`
 
 The basic way of using it is with the `key` method, which will return the key based on the given arguments. 
 
@@ -23,7 +23,7 @@ ArtirixCacheService.key :some_key # => will return a string with the cache key t
 The service can use a prefix to be applied to all keys
 
 ```ruby
-ArtirixCacheService.config_params[:key_prefix] = :configured_prefix
+ArtirixCacheService.register_key_prefix = :configured_prefix
 ArtirixCacheService.key :some_key # => "configured_prefix/some_key"
 ArtirixCacheService.key :another # => "configured_prefix/another"
 ```
@@ -35,7 +35,7 @@ We can pass other arguments, that will be treated and appended to the cache key.
 note: `blank?` arguments will be skipped.
 
 ```ruby
-ArtirixCacheService.config_params[:key_prefix] = :configured_prefix
+ArtirixCacheService.register_key_prefix :configured_prefix
 
 ArtirixCacheService.key :some_key, :arg1, nil, 'arg2' 
   # => "configured_prefix/some_key/arg1/arg2"
@@ -47,7 +47,7 @@ if an argument (including the first argument) responds to `cache_key`,
 it will be called.
 
 ```ruby
-ArtirixCacheService.config_params[:key_prefix] = :configured_prefix
+ArtirixCacheService.register_key_prefix :configured_prefix
 
 article = Article.find 17
 article.cache_key # => "cache_key_article_17"
@@ -64,7 +64,7 @@ for example in case that we're giving it a long list.
 It will use SHA1.
 
 ```ruby
-ArtirixCacheService.config_params[:key_prefix] = :prfx
+ArtirixCacheService.register_key_prefix :prfx
 
 arg3 = { a: 1, b: 2 }
 ArtirixCacheService.digest arg3 
@@ -82,6 +82,59 @@ ArtirixCacheService.key :some_key, :arg1, 'arg2', digest: [arg3, arg4]
   # => "prfx/some_key/arg1/arg2/7448a071aeee91fc9ee1c705f15445fdd8411224"
 ```
 
+## Usage: `.options`
+
+used for getting the cache options based on the registered defaults and the registered options.
+ 
+```ruby
+
+# unless registered otherwise, the default options is an empty array
+ArtirixCacheService.default_options # => {}
+
+
+# sets the options to be used as default when needed
+ArtirixCacheService.register_default_options expires_in: 300
+
+# we can register some options based on a name (Symbol)
+ArtirixCacheService.registered_options? :my_options # => false
+ArtirixCacheService.registered_options :my_options # => nil
+
+ArtirixCacheService.register_options :my_options, race_condition_ttl: 1
+
+ArtirixCacheService.registered_options? :my_options # => true
+ArtirixCacheService.registered_options :my_options # => { race_condition_ttl: 1 }
+
+```
+
+once we have our different options registered, we can use the Service to get the 
+desired final options.
+
+Given a list of names, it will use the first one that is registered. It will 
+return the options on that name, merged over the default options 
+
+```ruby
+ArtirixCacheService.options :missing, :my_options 
+  # => { expires_in: 300, race_condition_ttl: 1 } 
+```
+
+If no registered option is found from the given list, then it will return 
+- `nil` (if passing keyword `return_if_missing: :nil`)
+- default options (if passing keyword `return_if_missing: :default`)
+- an empty hash (default behaviour, or passing keyword `return_if_missing` with any other value)
+
+```ruby
+ArtirixCacheService.options :missing, :another_missing
+  # => {}
+  
+ArtirixCacheService.options :missing, :another_missing, return_if_missing: :default
+  # => { expires_in: 300 }
+  
+ArtirixCacheService.options :missing, :another_missing, return_if_missing: :nil
+  # => nil
+
+ArtirixCacheService.options :missing, :another_missing, return_if_missing: :empty
+  # => {} 
+```
 
 ## Installation
 
@@ -109,3 +162,10 @@ 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
+
+## v 0.2.0
+
+- removed `ArtirixCacheService.config_params` support, now using `register_key_prefix` method
+- add `options` support

data/lib/artirix_cache_service/service.rb

@@ -1,12 +1,12 @@
 module ArtirixCacheService
   class Service
-    # Instance
-    def config_params
-      @config_params ||= { key_prefix: nil }
+    def register_key_prefix(key_prefix)
+      @key_prefix = key_prefix
+      self
     end
 
     def key_prefix
-      config_params[:key_prefix]
+      @key_prefix
     end
 
     def key(*given_args)
@@ -16,5 +16,60 @@ module ArtirixCacheService
     def digest(arg)
       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
+
+    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/version.rb

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

data/lib/artirix_cache_service.rb

@@ -7,7 +7,13 @@ module ArtirixCacheService
 
   # Delegation of static methods to the Service instance
   class << self
-    delegate :key, :config_params, :key_prefix, :digest, to: :service
+    delegate :key, :digest,
+             :register_key_prefix, :key_prefix,
+             :default_options, :register_default_options,
+             :register_options, :registered_options,
+             :registered_options?, :registered_options,
+             :options,
+             to: :service
   end
 
   def self.service

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artirix_cache_service
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Eduardo Turiño