rails_cached_method 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adb70332fd66d09b43164dc071a109c780f10008ea6a1aa83b97b46196452c5e
+  data.tar.gz: 0d2ecc3d2b86796d1e9da3a724008e8c419d81ddf30c820f5a169d01b48d05ab
+SHA512:
+  metadata.gz: 3396b9439c314d57957aed51aa90b267ad9fdbecce51baca3c4160814e099d68d6aa73b9ab1ea6e43a42ad61f023ff5809552f5ad27e44d2d38b4be01fc75332
+  data.tar.gz: df6cb825167aad571a4168b947e1515f9fa11f1adbbc8f21aecec6b0898137146237616d2ece74c97316c1c957dffde25fe290200c3061269ada6a504ffc466f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Igor Kasyanchuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Rails Cached Method
+
+Simple way to cache results of methods. Using `Rails.cache` inside with default expiration time of 1 minute.
+
+
+## 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
+```
+
+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.
+
+For example:
+
+```ruby
+post.cached.comments.first # A
+post.cached.comments.last  # B
+```
+
+Here `post.cached.comments` will return same collection.
+
+You don't need to specify a key, because it's dynamically set based on object, arguments, etc.
+
+Options:
+
+```ruby
+cached(key: nil, expires_in: 1.minute, recache: false)
+```
+
+key - you can set your key.
+expires_in - TTL of cached object.
+recache - should be key deleted and cached again.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_cached_method'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_cached_method
+```
+
+## TODO
+
+- think if rails dependency could be replaced with something more lightweight
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rails_cached_method.rb

@@ -0,0 +1,67 @@
+require "rails_cached_method/version"
+require "rails_cached_method/railtie"
+
+module RailsCachedMethod
+  class CachedProxy
+    Object.methods.each do |e|
+      delegate e, to: :@__object__
+    end
+
+    def initialize(object, key: nil, expires_in:, parent_key: nil, recache: false)
+      @__object__     = object
+      @__key__        = key
+      @__expires_in__ = expires_in
+      @__recache__    = recache
+      @__parent_key__ = parent_key
+      @__object__
+    end
+
+    def __value__
+      @__object__
+    end
+
+    def method_missing(*args)
+      key = ___compose_key__(args)
+      if @__recache__
+        #puts "deleting: #{key}"
+        Rails.cache.delete(key)
+      end
+      #puts "key: #{key}, expires_in: #{@__expires_in__}, args: #{args}, recache: #{@__recache__}"
+      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
+  end
+
+  module CachedProxyExt
+    def cached(key: nil, expires_in: 1.minute, recache: false)
+      CachedProxy.new(
+        self,
+        key: key,
+        expires_in: expires_in,
+        recache: recache
+      )
+    end
+  end
+end
+
+Object.send :include, RailsCachedMethod::CachedProxyExt

data/lib/rails_cached_method/railtie.rb

@@ -0,0 +1,4 @@
+module RailsCachedMethod
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/rails_cached_method/version.rb

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

data/lib/tasks/rails_cached_method_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_cached_method do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rails_cached_method
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Very easy way to cache results of your methods
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails_cached_method.rb
+- lib/rails_cached_method/railtie.rb
+- lib/rails_cached_method/version.rb
+- lib/tasks/rails_cached_method_tasks.rake
+homepage: http://github.com/igorkasyanchuk/rails_cached_method
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/igorkasyanchuk/rails_cached_method
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Very easy way to cache results of your methods
+test_files: []