rails_simple_caching 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03a870f37e5d45c8fe45c58720d121b6daf88c68f4e653c85bfb625a97b57e3c
+  data.tar.gz: 1868335440ee6a526daefea845c2922f8361f81a38c17edd1b8bbfd99575eb23
+SHA512:
+  metadata.gz: 282c5968348b213714ca0ef293a571affca13ba8de9252aa3a4654cd0aafee3e8524656ded8257aeecb5b6542b1d80e572e772ec1fe3ddfe73d647f324fd02b9
+  data.tar.gz: ba4c6d56d5f1ad5245a9b189af731b2e87d478fafb8cb54951ece53d6eedccf589283e789384cccb4f6bb86af9cb127f3c2c238849bd631d07edd93e761f0718

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/dummy/storage/*
+/spec/dummy/log/*
+/spec/dummy/tmp/*
+/spec/dummy/test/*
+spec/dummy/db/development.sqlite3
+!/spec/dummy/tmp/caching-dev.txt
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_simple_caching.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rails", "~> 6.1"
+gem 'sqlite3', '~> 1.4', group: :development
+
+gem "rspec", "~> 3.10"
+
+gem "rubocop", "~> 1.22"

data/Gemfile.lock

@@ -0,0 +1,190 @@
+PATH
+  remote: .
+  specs:
+    rails_simple_caching (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rails (~> 6.1)
+  rails_simple_caching!
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rspec-rails
+  rubocop (~> 1.22)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 bulgakke
+
+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,104 @@
+# RailsSimpleCaching
+
+A simple wrapper around Rails built-in caching. Provides Rails-like macros to generate `cached_` versions of your methods. The original goal was to reduce DB queries, but it works with any methods you define (as long as they don't take any arguments, though it's doable to make it work for methods with arguments, too).
+How Rails caching works: https://guides.rubyonrails.org/caching_with_rails.html#low-level-caching
+https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html
+
+
+https://github.com/igorkasyanchuk/rails_cached_method is the only gem of a similar caliber that does kind of the same thing. That one's functionality is wider, but it does a little bit too much for my taste.
+
+## Example of usage:
+
+```ruby
+class Author < ApplicationRecord
+  has_many :books
+
+  cache_expires_in 96.hours
+  caches :books
+  caches :expensive_method, expires_in: 2.hours
+
+  def expensive_method
+    SomeExternalAPIService.call(self)
+    do_something_else
+  end
+end
+```
+
+The above is equivalent to:
+```ruby
+class Author < ApplicationRecord
+  has_many :books
+
+  def expensive_method
+    SomeExternalAPIService.call(self)
+    do_something_else
+  end
+
+  def cached_books
+    Rails.cache.fetch("#{cache_key_with_version}/books", expires_in: 96.hours) do
+      books
+    end
+  end
+
+  def cached_expensive_method
+    Rails.cache.fetch("#{cache_key_with_version}/expensive_method", expires_in: 2.hours) do
+      expensive_method
+    end
+  end
+end
+```
+
+Rails caching won't work in development by default; run `rails dev:cache` in terminal.
+
+## Cache expiration time
+Use these methods for setting up expiration time (how long until the data is deleted from the cache store). All of them expect a `ActiveSupport::Duration` argument (`24.hours`, `10.minutes` etc.)
+The precedence goes:
+
+1. `:expires_in` keyword argument.
+2. `cache_expires_in` class method. Sets default expiration time for all `caches` macros in the model class. Will only work on macros that are declared below it, for example:
+
+```ruby
+caches :something # Cache will still expire after default time
+cache_expires_in 2.minutes
+caches :something_else # Will expire in 2 minutes
+cache_expires_in 3.hours
+caches :another_something # Will expire in 3 hours
+```
+3. `Rails.configuration.default_expire_time`: global default for all models. Set to `24.hours` by default. Set it to your liking in `config/application.rb` or in `config/environments/`
+
+## Cache invalidation
+The cache is invalidated whenever an object with a `cached_` method has its `updated_at` value changed (because [this method](https://api.rubyonrails.org/classes/ActiveRecord/Integration.html#method-i-cache_key_with_version) is used to form the key by which the data is fetched). The data is not deleted from the store, it just won't be fetched the next time you call the method.
+
+`# TODO: write some more about cache invalidation`
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_simple_caching'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_simple_caching
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_simple_caching.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rails_simple_caching/caching/class_methods.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RailsSimpleCaching
+  module Caching
+    module ClassMethods
+      def cache_expires_in(time)
+        @expire_time = time
+      end
+
+      def caches(attribute, expires_in: expire_time)
+        @cached_attributes ||= []
+        @cached_attributes << attribute
+
+        # `cache_key_with_version` generates a string based on the
+        # model's class name, `id`, and `updated_at` attributes.
+        # This is a common convention and has the benefit of invalidating
+        # the cache whenever the product is updated.
+        define_method("cached_#{attribute}") do
+          key = "#{cache_key_with_version}/#{attribute}"
+          Rails.cache.fetch(key, expires_in: expires_in) do
+            update_cached(attribute)
+          end
+        end
+      end
+
+      def cached_attributes
+        @cached_attributes
+      end
+
+      private
+
+      def expire_time
+        @expire_time || Rails.configuration.default_expire_time
+      end
+    end
+  end
+end

data/lib/rails_simple_caching/caching.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsSimpleCaching
+  module Caching
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    def update_cached(attribute)
+      contents = public_send(attribute)
+      key = "#{cache_key_with_version}/#{attribute}"
+      success = Rails.cache.write(key, contents)
+      success ? contents : false
+    end
+
+    # Updates all the cached attributes.
+    # Returns true if every update is successful.
+    def update_cache
+      self.class.cached_attributes.map { |attr| update_cached(attr) }.none?(false)
+    end
+  end
+end

data/lib/rails_simple_caching/railtie.rb

@@ -0,0 +1,11 @@
+module RailsSimpleCaching
+  class Railtie < ::Rails::Railtie
+    config.default_expire_time = 24.hours
+
+    initializer 'rails_simple_caching.include_caching_concern' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.include Caching
+      end
+    end
+  end
+end

data/lib/rails_simple_caching/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsSimpleCaching
+  VERSION = "0.1.0"
+end

data/lib/rails_simple_caching.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "rails_simple_caching/version"
+require_relative "rails_simple_caching/railtie" if defined?(Rails::Railtie)
+require_relative "rails_simple_caching/caching"
+require_relative "rails_simple_caching/caching/class_methods"
+
+module RailsSimpleCaching
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/rails_simple_caching.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails_simple_caching/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_simple_caching"
+  spec.version       = RailsSimpleCaching::VERSION
+  spec.authors       = ["bulgakke"]
+  spec.email         = ["vvp835@yandex.ru"]
+
+  spec.summary       = "A simple macro-like interface for Rails caching"
+  # spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/bulgakke/rails_simple_caching"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bulgakke/rails_simple_caching"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec-rails'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rails_simple_caching
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bulgakke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: 
+email:
+- vvp835@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_simple_caching.rb
+- lib/rails_simple_caching/caching.rb
+- lib/rails_simple_caching/caching/class_methods.rb
+- lib/rails_simple_caching/railtie.rb
+- lib/rails_simple_caching/version.rb
+- rails_simple_caching.gemspec
+homepage: https://github.com/bulgakke/rails_simple_caching
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bulgakke/rails_simple_caching
+  source_code_uri: https://github.com/bulgakke/rails_simple_caching
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A simple macro-like interface for Rails caching
+test_files: []