chunky_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9550d0ea98aa1a0abf484c0c825ac671b610627781360ca17759d1a4648ea908
+  data.tar.gz: e3a09ed7799bc2734400ca4f8c8a4176e656e75d51976a23254574d74a721ba8
+SHA512:
+  metadata.gz: 19412f4f00cd70002701925d36b71972cda3505607594b2d8acfa03cb529c74323ea5812bff14606ebf95e6d2e2747912b621c2b36673b2ce5de4717770521ff
+  data.tar.gz: 73d976d28947d4f3ad6ef52a38e0c295daebdeb8933ffc529ce0b3b81cdd142778ee9bf263d935597bb13a18dcd40fcf77bfb0f5be1a0e2c40acfdfc9830eea1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,22 @@
+# This file is a template, and might need editing before it works on your project.
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: "ruby:2.5"
+
+# Cache gems in between builds
+cache:
+  paths:
+    - vendor/ruby
+
+# This is a basic example for a gem or script which doesn't use
+# services such as redis or postgres
+before_script:
+  - ruby -v  # Print out ruby version for debugging
+  - gem install bundler
+  # Uncomment next line if your rails app needs a JS runtime:
+  # - apt-get update -q && apt-get install nodejs -yqq
+  - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+rspec:
+  script:
+    - bundle exec rspec

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--order rand
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chunky_cache.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,171 @@
+PATH
+  remote: .
+  specs:
+    chunky_cache (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3)
+      actionpack (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
+      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.3)
+      actionpack (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3)
+      activesupport (= 6.1.3)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activestorage (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activesupport (= 6.1.3)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3)
+      actioncable (= 6.1.3)
+      actionmailbox (= 6.1.3)
+      actionmailer (= 6.1.3)
+      actionpack (= 6.1.3)
+      actiontext (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activemodel (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (12.3.3)
+    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 (4.0.2)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chunky_cache!
+  pry
+  rails (>= 4)
+  rake (~> 12.0)
+  rspec-rails
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Robert May
+
+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,65 @@
+# chunky_cache
+
+This gem does weird things with Rails caching. Well, one weird thing. Have you ever wanted to perform multiple cache calls on a single view, but realised that this gets quite expensive in terms of network calls to your cache? Fret no more!
+
+chunky_cache adds two Rails helpers which mess with the rendering order, allowing you to make multiple cache calls _but only execute one actual cache query_. It does this by capturing the view output inside the `chunky_cache` and `cache_chunk` helpers. These are named poorly and confusingly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chunky_cache'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install chunky_cache
+
+## Usage
+
+```erb
+<%= chunky_cache(expires_in: 10.minutes) do %>
+  <h1>Something not cached</h1>
+
+  <p>
+    <%= cache_chunk(:important_message, current_user) %>
+      <strong>This is very important, <%= current_user.name %>!</strong>
+    <% end %>
+
+    <%= cache_chunk(:the_actual_message) %>
+      <oblique>No, really</oblique>
+    <% end %>
+  </p>
+
+  <%= cache_chunk(:footer) %>
+    <p>Fin.</p>
+  <% end %>
+<% end %>
+```
+
+This will execute only one call to your cache store, using `Rails.cache.fetch_multi`.
+
+## How does it work?
+
+The helpers use Rails' built-in helper `capture` to consume the contents of their blocks and turn them into strings. `chunky_cache` does this immediately, and returns the final output after mixing everything together. But `cache_chunk` instead doesn't execute its block, but stores it in an instance variable established by `chunky_cache`, and it then returns a cache key string. At this point the template is thus half-complete, with sections missing and only weird strings in their place.
+
+`chunky_cache` then performs a cache multi-fetch, passing in all the keys it knows about. For any missing keys, the block captured by `cache_chunk` is executed and returned to the cache. The mix of cached/non-cached chunks are then reinserted into the main block content, replacing the key placeholders. A final compiled string is then returned.
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Please feel free to submit bug reports or merge requests. Don't use singlequotes in Ruby or you'll make me mad.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chunky_cache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chunky_cache.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/chunky_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chunky_cache"
+  spec.version       = ChunkyCache::VERSION
+  spec.authors       = ["Robert May"]
+  spec.email         = ["rob@afternoonrobot.co.uk"]
+
+  spec.summary       = %q{Rails cache multi-fetch inside a view}
+  spec.description   = %q{Multi-fetch optimisation for multiple cached blocks in Rails views.}
+  spec.homepage      = "https://gitlab.com/robotmay/chunky_cache"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/robotmay/chunky_cache"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rails", ["~> 6"]
+  spec.add_development_dependency "rspec-rails", ["~> 4"]
+end

data/lib/chunky_cache.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "rails"
+require "chunky_cache/version"
+require "chunky_cache/railtie"
+
+module ChunkyCache
+  class Error < StandardError; end
+  class MissingChunkyCacheError < Error; end
+end

data/lib/chunky_cache/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "view_helpers"
+
+module ChunkyCache
+  class Railtie < ::Rails::Railtie
+    initializer "chunky_cache.view_helpers" do |app|
+      self.class_eval do
+        include ChunkyCache::ViewHelpers
+      end
+    end
+  end
+end

data/lib/chunky_cache/version.rb

@@ -0,0 +1,3 @@
+module ChunkyCache
+  VERSION = "0.1.0"
+end

data/lib/chunky_cache/view_helpers.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ChunkyCache
+  module ViewHelpers
+    # Begin an exciting cache block. This has to wrap
+    # calls to `cache_chunk`. This will absorb the contents of the block,
+    # allowing it to discover the `cache_chunk` calls, before multi-fetching
+    # all keys and then reinserting the cached contents or blocks into
+    # the correct places in the output.
+    #
+    # All keyword arguments are passed to the cache store,
+    # but Rails only supports `expires_in` for `fetch_multi` anyway.
+    #
+    # @param expires_in [ActiveSupport::Duration, Integer] expiry time will be passed to the underlying store
+    # @return [ActiveSupport::SafeBuffer]
+    def chunky_cache(**cache_options)
+      @chunky_key_blocks ||= {}
+      blocks = @chunky_key_blocks[template_root_key] = {}
+
+      # Capture the block, storing its output in a string
+      big_ol_strang = capture do
+        yield
+      end
+
+      # This probably shouldn't happen
+      return if big_ol_strang.nil?
+
+      # Now the cache blocks are populated and the placeholders in place,
+      # we multi-fetch all the keys from the cache, or call the `cache_chunk` blocks
+      # for missing values.
+      chunks = Rails.cache.fetch_multi(*blocks.keys, **cache_options) do |missing_key|
+        capture do
+          blocks[missing_key].call
+        end
+      end
+
+      # Then we replace the placeholders with our new compiled template data
+      chunks.each do |key, chunk|
+        big_ol_strang.gsub!(key, (chunk || ""))
+      end
+
+      big_ol_strang.html_safe
+    end
+
+    # Denote a cached chunk of markup. This captures the block
+    # and instead returns just a placeholder string for replacement
+    # at the end of the `chunky_cache` run.
+    #
+    # @param keys [*Object] one or multiple objects which respond to `#cache_key` or convert to strings
+    # @return [String] the placeholder key
+    def cache_chunk(*keys, &block)
+      raise MissingChunkyCacheError if @chunky_key_blocks.nil?
+
+      key = keys.map! { |k| k.try(:cache_key) || k.to_s }.unshift(template_root_key).join(":")
+
+      @chunky_key_blocks[template_root_key][key] = block
+
+      return key
+    end
+
+    private
+
+    # Returns the digest of the current template
+    #
+    # @return [String]
+    def template_root_key
+      digest_path_from_template(@current_template)
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: chunky_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert May
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Multi-fetch optimisation for multiple cached blocks in Rails views.
+email:
+- rob@afternoonrobot.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chunky_cache.gemspec
+- lib/chunky_cache.rb
+- lib/chunky_cache/railtie.rb
+- lib/chunky_cache/version.rb
+- lib/chunky_cache/view_helpers.rb
+homepage: https://gitlab.com/robotmay/chunky_cache
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/robotmay/chunky_cache
+  source_code_uri: https://gitlab.com/robotmay/chunky_cache
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rails cache multi-fetch inside a view
+test_files: []