fortitude-caching 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 948eeacecc444d50258a7f59e3bece61ab5853b2
+  data.tar.gz: 0021abb8ae5cd5fec827b2ffbdfeadaa8ab09629
+SHA512:
+  metadata.gz: 7595200b374c985b10782398e70cb60223958a82c85066a9e0246e2f28f9bbb6af3de89aa340e0d926dad7b543dcdcd965ac35851996c6a693898b2255bb13e9
+  data.tar.gz: 8da0ae73c696b058a77ee67b1b1694bb4f8a923c93b595fcdb00b120d68876ff96e80289663a8510751f8b4b08b2bebb09540d2eafe70fcedbd08b6ca9d9b411

data/.gitignore

@@ -0,0 +1,17 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/config/database.yml
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/public/uploads/*
+tmp/*
+coverage/*
+*.gem
+Gemfile.lock
+spec/dummy/db/test.sqlite3
+gemfiles/*.lock
+.ruby-gemset
+spec/internal
+.ruby-version

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+fortitude-caching
+====
+
+Integrates [Rails fragment caching](http://guides.rubyonrails.org/caching_with_rails.html#fragment-caching) with [Fortitude](https://github.com/ageweke/fortitude).
+
+## Usage
+
+1. `include Fortitude::Caching` in your base widget class.
+2. Call `cacheable` for widgets that you want cached.
+
+By using `fortitude-caching`, this:
+
+```rb
+class Views::Pages::Show < Views::Base
+  needs :page
+
+  cacheable
+
+  def content
+    ...
+  end
+end
+```
+
+Is the equivalent of this:
+
+```rb
+class Views::Pages::Show < Views::Base
+  needs :page
+
+  def content
+    cache(page) do
+      ...
+    end
+  end
+end
+```
+
+## License
+
+MIT

data/fortitude-caching.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'fortitude-caching'
+  s.version = '0.0.1'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.0.0')
+  s.authors = ['Adam Becker']
+  s.summary = 'Integrates Rails fragment caching with Fortitude.'
+  s.email = 'adam@dobt.co'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {features,spec}/*`.split("\n")
+
+  s.homepage = 'https://github.com/dobtco/fortitude-caching'
+
+  s.add_dependency 'rails', '>= 4.0.0', '< 6.0'
+  s.add_dependency 'fortitude', '~> 0.9.5'
+
+  s.add_development_dependency 'rspec-rails', '~> 3.5', '>= 3.5.2'
+  s.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.12'
+end

data/lib/fortitude/caching.rb

@@ -0,0 +1,53 @@
+module Fortitude
+  module Caching
+    extend ActiveSupport::Concern
+
+    class NotCacheableError < RuntimeError
+    end
+
+    module ClassMethods
+      def cacheable(opts = {})
+        if extra_assigns == :use
+          extra_assigns :ignore
+        end
+
+        static_keys = Array(opts.fetch(:key, []))
+        options = opts.fetch(:options, {})
+
+        define_method(:cache_contents) do |&block|
+          if !cacheable_by_fortitude?
+            raise(
+              NotCacheableError,
+              "Can't digest the widget #{self}, since it's being rendered " \
+              "outside of an ActionView context."
+            )
+          end
+
+          cache calculate_cache_dependencies(assigns, static_keys), options do
+            block.call
+          end
+        end
+
+        define_method(:cacheable_by_fortitude?) do
+          respond_to?(:cache) &&
+          (
+            invoke_helper(:instance_variable_get, :@virtual_path) ||
+            options[:skip_digest]
+          )
+        end
+
+        around_content :cache_contents
+      end
+    end
+
+    private
+
+    def calculate_cache_dependencies(assigns, static_keys)
+      (
+        assigns.to_a.sort_by(&:first).flatten +
+        static_keys +
+        [widget_locale]
+      )
+    end
+  end
+end

data/spec/caching_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Fortitude::Caching, type: :request do
+  def get_and_return_response(path)
+    get path
+    response.body
+  end
+
+  it 'caches without needs' do
+    expect(get_and_return_response('/projects/1/show_cached')).
+      to eq(get_and_return_response('/projects/1/show_cached'))
+  end
+
+  it 'has different caches for different locales' do
+    res1 = get_and_return_response('/projects/1/show_cached')
+    res2 = get_and_return_response('/projects/1/show_cached?locale=fr')
+    res3 = get_and_return_response('/projects/1/show_cached?locale=fr')
+
+    expect(res1).to_not eq res2
+    expect(res2).to eq res3
+  end
+
+  it 'caches with needs' do
+    res1 = get_and_return_response('/projects/1/show_cached_with_needs')
+    res2 = get_and_return_response('/projects/2/show_cached_with_needs')
+    res3 = get_and_return_response('/projects/2/show_cached_with_needs')
+
+    expect(res1).to_not eq res2
+    expect(res2).to eq res3
+  end
+
+  it 'does not cache if cacheable is not called' do
+    expect(get_and_return_response('/projects/1/show_uncached')).
+      to_not eq(get_and_return_response('/projects/1/show_uncached'))
+  end
+
+  it 'throws an error if a view cannot be cached' do
+    expect { get '/projects/1/cannot_cache' }.
+      to raise_error(Fortitude::Caching::NotCacheableError)
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  layout false
+end

data/spec/dummy/app/controllers/projects_controller.rb

@@ -0,0 +1,31 @@
+class ProjectsController < ApplicationController
+  around_action :set_locale
+  before_action :set_project
+
+  def show_cached
+  end
+
+  def show_cached_with_needs
+  end
+
+  def show_uncached
+  end
+
+  def cannot_cache
+    render widget: Views::Projects::ShowCached.new
+  end
+
+  private
+
+  def set_project
+    @project = params[:id]
+  end
+
+  def set_locale
+    if params[:locale]
+      I18n.with_locale(params[:locale]) { yield }
+    else
+      yield
+    end
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/base.rb

@@ -0,0 +1,3 @@
+class Views::Base < Fortitude::Widgets::Html5
+  include Fortitude::Caching
+end

data/spec/dummy/app/views/projects/show_cached.rb

@@ -0,0 +1,12 @@
+class Views::Projects::ShowCached < Views::Base
+  cacheable
+
+  def content
+    @@count ||= 0
+    text "#{@@count += 1}"
+
+    if params[:locale]
+      text params[:locale]
+    end
+  end
+end

data/spec/dummy/app/views/projects/show_cached_with_needs.rb

@@ -0,0 +1,10 @@
+class Views::Projects::ShowCachedWithNeeds < Views::Base
+  needs :project
+
+  cacheable
+
+  def content
+    @@count ||= 0
+    text "#{@@count += 1}"
+  end
+end

data/spec/dummy/app/views/projects/show_uncached.rb

@@ -0,0 +1,6 @@
+class Views::Projects::ShowUncached < Views::Base
+  def content
+    @@count ||= 0
+    text "#{@@count += 1}"
+  end
+end

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end