rails_cached_method 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb70332fd66d09b43164dc071a109c780f10008ea6a1aa83b97b46196452c5e
-  data.tar.gz: 0d2ecc3d2b86796d1e9da3a724008e8c419d81ddf30c820f5a169d01b48d05ab
+  metadata.gz: 8309a61a67d126ce96170e4ca5e0aa048b4234150afdd5e69e7510f9503822d7
+  data.tar.gz: 0dac1785aeb5560f12fef7dbe1364c4a595c1f1fd09fb6917dffe0fd651e78cf
 SHA512:
-  metadata.gz: 3396b9439c314d57957aed51aa90b267ad9fdbecce51baca3c4160814e099d68d6aa73b9ab1ea6e43a42ad61f023ff5809552f5ad27e44d2d38b4be01fc75332
-  data.tar.gz: df6cb825167aad571a4168b947e1515f9fa11f1adbbc8f21aecec6b0898137146237616d2ece74c97316c1c957dffde25fe290200c3061269ada6a504ffc466f
+  metadata.gz: 60e9b34da18925376a03d791cc935f1393fdc889e3fe34da4a52f4fc270d1476e728064db19e5ed00ef7b38fe74ee92e6931be6b05c02ec6079ccf8bae3db4f6
+  data.tar.gz: 2318fa0d270d2ef9611040a22055c90b4e492e78a4c65add5ec0dceb0e81b1218bf5200bda2280dc5614ce63ae794001e0d494494ed73b7be5e3b909d41c5e81

data/README.md

@@ -2,16 +2,17 @@
 
 Simple way to cache results of methods. Using `Rails.cache` inside with default expiration time of 1 minute.
 
+![Demo](docs/rails_cached_method.png)
 
 ## Usage
 
 To get a value and cache it just write a code like:
 
 ```ruby
-User.cached.admins
-post.cached.comments.last
-User.cached.where(role: :moderator).count
-Project.cached.first.some_heavey_method
+User.cached.admins # get list of admins and automatically put them in cache with 1 minute TTL
+post.cached.comments.last # get last comment from the post and cache it
+User.cached.where(role: :moderator).count # cache moderators count
+Project.cached.first.some_heavey_method # cache result of some_heavey_method for first Project (if first is Project.first)
 ```
 
 So basically just call method `cached` on any object. It will wrap and cache **every** result from the next method call. So every result from method chain is cached.
@@ -37,6 +38,58 @@ key - you can set your key.
 expires_in - TTL of cached object.
 recache - should be key deleted and cached again.
 
+## How it works
+
+After you call `.cached` it will generate a cache key and store value in Rails.cache. Value is class which is wrapps original value and allow you to call methods on the value using `method_missing`. Every result is cached again and again. So on every method call in methods chain every result will be stored in Rails.cache.
+
+To get original value you can call `.__value__`.
+
+Some pieces of code to show you how it works:
+
+```ruby
+    def cached(key: nil, expires_in: 1.minute, recache: false)
+      CachedProxy.new(
+        self,
+        key: key,
+        expires_in: expires_in,
+        recache: recache
+      )
+    end
+# ---------------------------------------------------------------
+    class CachedProxy
+
+    Object.methods.each do |e|
+      delegate e, to: :@__object__
+    end
+    
+    def method_missing(*args)
+      key = ___compose_key__(args)
+      if @__recache__
+        Rails.cache.delete(key)
+      end
+      Rails.cache.fetch(key, expires_in: @__expires_in__) do
+        CachedProxy.new(
+          @__object__.send(*args),
+          expires_in: @__expires_in__,
+          recache: @__recache__,
+          parent_key: key,
+        )
+      end
+    end    
+    private
+    def ___compose_key__(args)
+      result = [@__parent_key__, @__key__]
+      result += if @__object__.respond_to?(:to_global_id)
+        [@__object__.to_global_id]
+      elsif @__object__.is_a?(ActiveRecord::Relation)
+        [@__object__.class]
+      else
+        [@__object__]
+      end
+      result += args[0..1]
+      result.compact.map(&:to_s).join('.').dasherize
+    end
+```    
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/rails_cached_method.rb

@@ -3,9 +3,13 @@ require "rails_cached_method/railtie"
 
 module RailsCachedMethod
   class CachedProxy
+    # disable warning of redefining __send__ and __object_id__
+    old = $VERBOSE.dup
+    $VERBOSE = nil
     Object.methods.each do |e|
       delegate e, to: :@__object__
     end
+    $VERBOSE = old
 
     def initialize(object, key: nil, expires_in:, parent_key: nil, recache: false)
       @__object__     = object

data/lib/rails_cached_method/version.rb

@@ -1,3 +1,3 @@
 module RailsCachedMethod
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_cached_method
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Kasyanchuk