cachengue 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: abdbe3f73ef48939bcd5a527588d3dabdcb9f743
-  data.tar.gz: 184300301128c201b944546a928fc9192c2ac052
+SHA256:
+  metadata.gz: 1d61f4fc468d164194855289a59933c239687ba325f33470816ab45dbf383a50
+  data.tar.gz: 68fc8ff64e399aca19acc01fbf20272537a67a86c08722967cf7de2e7f19ba0a
 SHA512:
-  metadata.gz: 2a312074235e514cfc7cf6275c2fe87adabd6cb1e545e5920d0337a2ebeb36b3211c6b4deb17b489841e7238750d43ab5aaded5424ba0e68f96c47edc1471991
-  data.tar.gz: 5d104102cddeca4a0075c0d9ecf8e568ac975f39aee63d879706f39dff34338b53c8038edaab32a2a3ffe1fb64bb268e2e0869e8ce18d9be5fef71afaaf3a150
+  metadata.gz: edda0834cac796434c6f0e9df1137323f7cd6c1a5ab7713a5ef8fdb251caa8d04682f132ea22ff06a18058d5ec52a8370b6b5b00afb0cb533f4b112a810af2db
+  data.tar.gz: ea1e368ed2bc7897c66ec6cbf9a20e82489750d41aea1ee4b1d3bf4fef1779009ffe080d69589e40ec3fe7b85616d48ec410cd1c0039258c01ad112fa1e25f06

data/.rubocop.yml

@@ -1,17 +1,12 @@
 AllCops:
   Exclude:
     - bin/*
-    - config/**/*
-    - db/*
-    - db/migrate/*
-    - lib/tasks/*
     - test/*
+    - cachengue.gemspec
     - Gemfile
     - Rakefile
-    - config.ru
-    - lib/onfleet/onfleet-ruby/**/*
 
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 Layout/IndentHash:
   EnforcedStyle: consistent
@@ -63,5 +58,3 @@ Style/Documentation:
 
 Style/Lambda:
   Enabled: false
-
-

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    cachengue (0.1.0)
+    cachengue (0.2.0)
+      activesupport (>= 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     concurrent-ruby (1.0.5)
-    i18n (1.0.1)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     minitest (5.3.5)
     rake (10.5.0)
@@ -24,11 +25,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 5.1.5)
   bundler (~> 1.16)
   cachengue!
-  minitest (~> 5.3.4)
+  minitest (~> 5.3)
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 ## Usage
 
 
-###Examples:
+### Examples:
 
 In ```models/user.rb```
 ```ruby

data/cachengue.gemspec

@@ -36,5 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.3"
-  spec.add_development_dependency "activesupport", "~> 5.1"
+
+  spec.add_runtime_dependency "activesupport", ">= 5.1"
 end

data/lib/cachengue.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'cachengue/version'
-require 'cachengue/proxy'
 require 'cachengue/caching'
+require 'cachengue/namespace'
+require 'cachengue/proxy'
+require 'cachengue/version'
 
 module Cachengue
   module ActiveRecord
     extend ActiveSupport::Concern
 
     included do
-      extend Cachengue::Caching
-      before_save do
-        self.class.cachengue.cache_clear
-      end
+      extend Cachengue::Namespace
+
+      before_save { self.class.cachengue_clear }
     end
   end
 end

data/lib/cachengue/caching.rb

@@ -2,48 +2,80 @@
 
 module Cachengue
   module Caching
-    def cachengue(method_name = nil, &block)
-      return Cachengue::Proxy.new(self) if method_name.blank?
+    # Reduce memory use and its faster.
+    ALL_KEYS = %w[*].freeze
+    NONE_KEYS = [].freeze
 
-      fetch(self, method_name, [], &block)
+    module_function
+
+    def format_key(namespace, method_name, args)
+      args = args.is_a?(Array) ? args.map(&:as_json) : [args.as_json]
+      namespace = key_prefix(namespace)
+
+      "#{namespace}:#{method_name}:#{args}"
     end
 
-    def module_cachengue(method_name, &block)
-      singleton_class.instance_eval do
-        define_method(method_name) do |*args|
-          Cachengue::Caching.fetch(self, method_name, args, &block)
-        end
+    def key_prefix(namespace = nil)
+      if namespace.present?
+        "cachengue:#{namespace.to_s.underscore}"
+      else
+        'cachengue'
       end
     end
 
-    module_function
+    def key_suffix(strategy)
+      strategy == :all ? ALL_KEYS : NONE_KEYS
+    end
 
-    def key_by(classx, method_name, args)
-      args = args.map(&:as_json)
+    def keys(namespace = nil, strategy = :all)
+      return [] if Rails.env.test?
 
-      "#{key_prefix(classx)}:#{method_name}:#{args}"
+      prefix = key_prefix(namespace)
+
+      key_suffix(strategy).flat_map do |suffix|
+        Rails.cache.data.keys("#{prefix}:#{suffix}")
+      end
     end
 
-    def key_prefix(classx)
-      "cache:#{classx.to_s.underscore}"
+    def clear(namespace = nil, strategy = :all)
+      keys_to_clear = keys(namespace, strategy)
+
+      clear_keys(keys_to_clear)
     end
 
-    def keys(classx)
-      prefix = Cachengue::Caching.key_prefix(classx)
+    def clear_by(options)
+      key = format_key(
+        options.fetch(:namespace),
+        options[:key] || options.fetch(:method),
+        options.fetch(:args)
+      )
 
-      Rails.cache.data.keys("#{prefix}:*")
+      clear_keys([key])
     end
 
-    def clear(classx)
+    def clear_keys(keys_to_clear)
       return if Rails.env.test?
 
-      keys(classx).map { |k| Rails.cache.delete(k) }.size
+      keys_to_clear.sum do |k|
+        Rails.cache.delete(k)
+      end
     end
 
-    def fetch(classx, method_name, args)
-      key = Cachengue::Caching.key_by(classx, method_name, args)
+    def fetch(namespace, method_name, args, options = {})
+      key = format_key(
+        options[:namespace] || namespace,
+        options[:key] || options[:method] || method_name,
+        options[:args] || args
+      )
+
+      options = options.without(
+        :args,
+        :key,
+        :method,
+        :namespace
+      )
 
-      new_block = proc do
+      Rails.cache.fetch(key, options) do
         value = yield(*args)
 
         if defined?(::ActiveRecord) && value.is_a?(::ActiveRecord::Relation)
@@ -52,8 +84,6 @@ module Cachengue
           value
         end
       end
-
-      Rails.cache.fetch(key, &new_block)
     end
   end
 end

data/lib/cachengue/namespace.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Cachengue
+  module Namespace
+    def cachengue(options = {})
+      if block_given?
+        # Proc.new is the block passed as argument.
+        Caching.fetch(self, nil, [], options, &Proc.new)
+      else
+        Proxy.new(self, options)
+      end
+    end
+
+    def module_cachengue(method_name, options = {})
+      singleton_class.instance_eval do
+        define_method(method_name) do |*args|
+          Caching.fetch(self, method_name, args, options, &Proc.new)
+        end
+      end
+    end
+
+    def cachengue_namespace(namespace, strategy: :all)
+      __cachengue_namespaces__[namespace.to_sym] = strategy
+    end
+
+    def cachengue_clear_by(options)
+      Caching.clear_by(
+        options.reverse_merge(namespace: self)
+      )
+    end
+
+    def cachengue_clear
+      __cachengue_namespaces__.inject({}) do |results, (namespace, strategy)|
+        results.merge!(
+          namespace => Caching.clear(namespace, strategy)
+        )
+      end
+    end
+
+    private
+
+    def __cachengue_namespaces__
+      if class_variable_defined?(:@@cachengue_namespaces)
+        class_variable_set(
+          :@@cachengue_namespaces,
+          class_variable_get(:@@cachengue_namespaces)
+        )
+      else
+        class_variable_set(
+          :@@cachengue_namespaces,
+          to_s.to_sym => :all
+        )
+      end
+    end
+  end
+end

data/lib/cachengue/proxy.rb

@@ -4,8 +4,9 @@
 
 module Cachengue
   class Proxy
-    def initialize(classx)
+    def initialize(classx, options = {})
       @classx = classx
+      @options = options
     end
 
     def cache_keys
@@ -23,7 +24,7 @@ module Cachengue
     end
 
     def method_missing(method_name, *args)
-      Cachengue::Caching.fetch(@classx, method_name, args) do
+      Cachengue::Caching.fetch(@classx, method_name, args, @options) do
         @classx.public_send(method_name, *args)
       end
     end

data/lib/cachengue/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cachengue
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cachengue
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - shipnow developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
 description: A gem for caching
@@ -84,6 +84,7 @@ files:
 - cachengue.gemspec
 - lib/cachengue.rb
 - lib/cachengue/caching.rb
+- lib/cachengue/namespace.rb
 - lib/cachengue/proxy.rb
 - lib/cachengue/version.rb
 homepage: https://gitlab.com/shipnow/cachengue
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: cache gem for ruby on rails