active_remote-cached 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81e9acd882928c8bbbef788810301b195c2400eb
-  data.tar.gz: ac45bdd85f22bfa2185451e4bf0bfb2c03410510
+  metadata.gz: da0c6caa85c4c4bc50f0df7e6b3315783b546628
+  data.tar.gz: 408733b9f1a0708bbd7fb8289df0d55c454efe1c
 SHA512:
-  metadata.gz: e24999c6d62259b1f88f625cc8ae7bdb96d2ae0c5bd3d0beca2418729823d3d8b2fbdd4581b17a27ecf82ca7ed5831975b67167639b158d24986f36d1a2f3497
-  data.tar.gz: b699749dbd2d7d77cf9b4851d460c9d76b7bb2ac96374b9874001c950a7d45550ce4b3efd49a0e0e956592ef8780bcd507bf7e7e13cfebe5f8a7e3c59428476e
+  metadata.gz: 535e2f65f6933679c321832536c61d3048399ea18899403d090f8dfe5f74c885b45e13bac36933e4b7732a05d106e6e277bf391539f2ff40dbb145c4476b0622
+  data.tar.gz: 240613cf4187528adf150f8ff7b6e3ab111b12653b4fdf45ca62e635a66566635a6d9a285a1246758b3c00ebc84677e49b1a510059da52e3e0281c5e151250ca

data/lib/active_remote/cached.rb

@@ -3,6 +3,7 @@ require "active_support/cache"
 require "active_support/concern"
 require "active_support/core_ext/array/extract_options"
 
+require "active_remote/cached/argument_keys"
 require "active_remote/cached/cache"
 require "active_remote/cached/version"
 require "active_remote/errors"
@@ -142,8 +143,19 @@ module ActiveRemote
           def self.#{method_name}(#{expanded_method_args}, __active_remote_cached_options = {})
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
-            find_cache_key = [namespace, name, "#find", #{sorted_method_args}].compact
-            search_cache_key = [namespace, name, "#search", #{sorted_method_args}].compact
+            find_cache_key = [
+              namespace,
+              name,
+              "#find",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
+
+            search_cache_key = [
+              namespace,
+              name,
+              "#search",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
 
             ::ActiveRemote::Cached.cache.delete(find_cache_key)
             ::ActiveRemote::Cached.cache.delete(search_cache_key)
@@ -163,7 +175,12 @@ module ActiveRemote
           def self.#{method_name}(#{expanded_method_args}, __active_remote_cached_options = {})
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
-            cache_key = [namespace, name, "#find", #{sorted_method_args}].compact
+            cache_key = [
+              namespace,
+              name,
+              "#find",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
 
             ::ActiveRemote::Cached.cache.exist?(cache_key)
           end
@@ -184,7 +201,12 @@ module ActiveRemote
           def self.#{method_name}(#{expanded_method_args}, __active_remote_cached_options = {})
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
-            cache_key = [namespace, name, "#search", #{sorted_method_args}].compact
+            cache_key = [
+              namespace,
+              name,
+              "#search",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
 
             ::ActiveRemote::Cached.cache.exist?(cache_key)
           end
@@ -218,7 +240,12 @@ module ActiveRemote
           def self.#{method_name}(#{expanded_method_args}, __active_remote_cached_options = {})
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
-            cache_key = [namespace, name, "#find", #{sorted_method_args}].compact
+            cache_key = [
+              namespace,
+              name,
+              "#find",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
 
             ::ActiveRemote::Cached.cache.fetch(cache_key, __active_remote_cached_options) do
               if block_given?
@@ -260,7 +287,12 @@ module ActiveRemote
           def self.#{method_name}(#{expanded_method_args}, __active_remote_cached_options = {})
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
-            cache_key = [namespace, name, "#search", #{sorted_method_args}].compact
+            cache_key = [
+              namespace,
+              name,
+              "#search",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
 
             ::ActiveRemote::Cached.cache.fetch(cache_key, __active_remote_cached_options) do
               if block_given?
@@ -307,7 +339,12 @@ module ActiveRemote
           def self.#{method_name}(#{expanded_method_args}, __active_remote_cached_options = {})
             __active_remote_cached_options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(__active_remote_cached_options)
             namespace = __active_remote_cached_options.delete(:namespace)
-            cache_key = [namespace, name, "#search", #{sorted_method_args}].compact
+            cache_key = [
+              namespace,
+              name,
+              "#search",
+              ::ActiveRemote::Cached::ArgumentKeys.new(#{sorted_method_args}, __active_remote_cached_options).cache_key
+            ].compact
 
             ::ActiveRemote::Cached.cache.fetch(cache_key, __active_remote_cached_options) do
               results = []

data/lib/active_remote/cached/argument_keys.rb

@@ -0,0 +1,57 @@
+module ActiveRemote::Cached
+  class ArgumentKeys
+    attr_reader :arguments, :argument_string, :options
+
+    REMOVE_CHARACTERS = /[[:space:]+=><{}\[\];:\-,]/
+    REPLACE_MAP = [
+      [" ", "SP"],
+      ["+", "PL"],
+      ["=", "EQ"],
+      [">", "GT"],
+      ["<", "LT"],
+      ["{", "LB"],
+      ["}", "RB"],
+      ["[", "LB2"],
+      ["]", "RB2"],
+      [";", "SC"],
+      [":", "CO"],
+      ["-", "DA"],
+      [",", "COM"],
+    ].freeze
+
+    def initialize(*arguments, options)
+      @options = options
+      @arguments = arguments.flatten.compact
+      @argument_string = ""
+
+      @arguments.each do |argument|
+        @argument_string << "#{argument}"
+      end
+    end
+
+    def cache_key
+      return @argument_string.gsub(REMOVE_CHARACTERS, "") if remove_characters?
+      if replace_characters?
+        REPLACE_MAP.each do |character, replacement|
+          @argument_string.gsub!(character, replacement)
+        end
+      end
+
+      @argument_string
+    end
+
+    def to_s
+      cache_key
+    end
+
+    private
+
+    def remove_characters?
+      options.fetch(:active_remote_cached_remove_characters, false)
+    end
+
+    def replace_characters?
+      options.fetch(:active_remote_cached_replace_characters, false)
+    end
+  end
+end

data/lib/active_remote/cached/cache.rb

@@ -56,7 +56,7 @@ module ActiveRemote::Cached
     end
 
     def valid_fetched_value?(value, options = {})
-      return false if value.nil?
+      return false if value.nil? && !options.fetch(:allow_nil, false)
       return false if !options.fetch(:allow_empty, false) && value.respond_to?(:empty?) && value.empty?
       return true
     end

data/lib/active_remote/cached/version.rb

@@ -1,5 +1,5 @@
 module ActiveRemote
   module Cached
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/spec/active_remote/cached/argument_keys_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ::ActiveRemote::Cached::ArgumentKeys do
+  it "does not mutate a string by default" do
+    ::ActiveRemote::Cached::ArgumentKeys.new("hello", {}).cache_key.must_equal("hello")
+  end
+
+  it "returns a string of a symbol by default" do
+    ::ActiveRemote::Cached::ArgumentKeys.new(:hello, {}).cache_key.must_equal("hello")
+  end
+
+  it "does not mutate a string with special characters by default" do
+    ::ActiveRemote::Cached::ArgumentKeys.new("hello {}", {}).cache_key.must_equal("hello {}")
+  end
+
+  it "removes special characters from string with special characters when :active_remote_cached_remove_characters" do
+    options = { :active_remote_cached_remove_characters => true }
+    ::ActiveRemote::Cached::ArgumentKeys.new("hello {}", options).cache_key.must_equal("hello")
+  end
+
+  it "replaces special characters from string with special characters when :active_remote_cached_replace_characters" do
+    options = { :active_remote_cached_replace_characters => true }
+    ::ActiveRemote::Cached::ArgumentKeys.new("hello {}", options).cache_key.must_equal("helloSPLBRB")
+  end
+end

data/spec/active_remote/cached_find_methods_spec.rb

@@ -71,7 +71,7 @@ describe FindMethodClass do
     end
 
     it "merges the default options in for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", :guid], :expires_in => 100).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", "guid"], :expires_in => 100).returns(:hello)
 
       FindMethodClass.stub(:find, :hello) do
         FindMethodClass.cached_find_by_guid(:guid).must_equal(:hello)
@@ -79,7 +79,7 @@ describe FindMethodClass do
     end
 
     it "overrides the default options with local options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", :guid], :expires_in => 200).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", "guid"], :expires_in => 200).returns(:hello)
 
       FindMethodClass.stub(:find, :hello) do
         FindMethodClass.cached_find_by_guid(:guid, :expires_in => 200).must_equal(:hello)
@@ -92,7 +92,7 @@ describe FindMethodClass do
       end
 
       it "uses the namespace as a prefix to the cache key" do
-        ::ActiveRemote::Cached.cache.expects(:fetch).with(["MyApp", FindMethodClass.name, "#find", :guid], :expires_in => 100).returns(:hello)
+        ::ActiveRemote::Cached.cache.expects(:fetch).with(["MyApp", FindMethodClass.name, "#find", "guid"], :expires_in => 100).returns(:hello)
 
         FindMethodClass.stub(:find, :hello) do
           FindMethodClass.cached_find_by_guid(:guid)
@@ -112,7 +112,7 @@ describe FindMethodClass do
     end
 
     it "overrides the default options with cached_finder options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", :foo], :expires_in => 500).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", "foo"], :expires_in => 500).returns(:hello)
 
       FindMethodClass.stub(:find, :hello) do
         FindMethodClass.cached_find_by_foo(:foo).must_equal(:hello)
@@ -120,7 +120,7 @@ describe FindMethodClass do
     end
 
     it "overrides the cached_finder options with local options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", :foo], :expires_in => 200).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([FindMethodClass.name, "#find", "foo"], :expires_in => 200).returns(:hello)
 
       FindMethodClass.stub(:find, :hello) do
         FindMethodClass.cached_find_by_foo(:foo, :expires_in => 200).must_equal(:hello)

data/spec/active_remote/cached_search_methods_spec.rb

@@ -95,7 +95,7 @@ describe SearchMethodClass do
       end
     end
 
-    it "does not persist nil values" do
+    it "does not persist nil values by default" do
       SearchMethodClass.stub(:derp, nil) do
         SearchMethodClass.cached_search(:guid => :guid) do
           SearchMethodClass.derp
@@ -105,6 +105,16 @@ describe SearchMethodClass do
       end
     end
 
+    it "persists nil values when allow_nil sent" do
+      SearchMethodClass.stub(:derp, nil) do
+        SearchMethodClass.cached_search({:guid => :guid}, :allow_nil => true) do
+          SearchMethodClass.derp
+        end
+
+        SearchMethodClass.cached_exist_search_by_guid?(:guid).must_equal(true)
+      end
+    end
+
     it "does persist non nil values" do
       SearchMethodClass.stub(:derp, :derp) do
         SearchMethodClass.cached_search(:guid => :guid) do
@@ -128,7 +138,7 @@ describe SearchMethodClass do
     end
 
     it "merges the default options in for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", :guid], :expires_in => 100).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", "guid"], :expires_in => 100).returns(:hello)
 
       SearchMethodClass.stub(:search, :hello) do
         SearchMethodClass.cached_search_by_guid(:guid).must_equal(:hello)
@@ -136,7 +146,7 @@ describe SearchMethodClass do
     end
 
     it "overrides the default options with local options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", :guid], :expires_in => 200).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", "guid"], :expires_in => 200).returns(:hello)
 
       SearchMethodClass.stub(:search, :hello) do
         SearchMethodClass.cached_search_by_guid(:guid, :expires_in => 200).must_equal(:hello)
@@ -149,7 +159,7 @@ describe SearchMethodClass do
       end
 
       it "uses the namespace as a prefix to the cache key" do
-        ::ActiveRemote::Cached.cache.expects(:fetch).with(["MyApp", SearchMethodClass.name, "#search", :guid], :expires_in => 100).returns(:hello)
+        ::ActiveRemote::Cached.cache.expects(:fetch).with(["MyApp", SearchMethodClass.name, "#search", "guid"], :expires_in => 100).returns(:hello)
 
         SearchMethodClass.stub(:search, :hello) do
           SearchMethodClass.cached_search_by_guid(:guid)
@@ -169,7 +179,7 @@ describe SearchMethodClass do
     end
 
     it "overrides the default options with cached_finder options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", :foo], :expires_in => 500).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", "foo"], :expires_in => 500).returns(:hello)
 
       SearchMethodClass.stub(:find, :hello) do
         SearchMethodClass.cached_search_by_foo(:foo).must_equal(:hello)
@@ -177,7 +187,7 @@ describe SearchMethodClass do
     end
 
     it "overrides the cached_finder options with local options for the fetch call" do
-      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", :foo], :expires_in => 200).returns(:hello)
+      ::ActiveRemote::Cached.cache.expects(:fetch).with([SearchMethodClass.name, "#search", "foo"], :expires_in => 200).returns(:hello)
 
       SearchMethodClass.stub(:find, :hello) do
         SearchMethodClass.cached_search_by_foo(:foo, :expires_in => 200).must_equal(:hello)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote-cached
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Brandon Dewitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_remote
@@ -110,9 +110,11 @@ files:
 - active_remote-cached.gemspec
 - lib/active_remote-cached.rb
 - lib/active_remote/cached.rb
+- lib/active_remote/cached/argument_keys.rb
 - lib/active_remote/cached/cache.rb
 - lib/active_remote/cached/railtie.rb
 - lib/active_remote/cached/version.rb
+- spec/active_remote/cached/argument_keys_spec.rb
 - spec/active_remote/cached/cache_spec.rb
 - spec/active_remote/cached_delete_methods_spec.rb
 - spec/active_remote/cached_exist_methods_spec.rb
@@ -138,12 +140,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides a configuration for caching mechanisms and finders on ActiveRemote
   models that are cached/cacheable
 test_files:
+- spec/active_remote/cached/argument_keys_spec.rb
 - spec/active_remote/cached/cache_spec.rb
 - spec/active_remote/cached_delete_methods_spec.rb
 - spec/active_remote/cached_exist_methods_spec.rb