caching_mailer 1.0

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in crm_repo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    caching_mailer (1.0)
+      rails (~> 3.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    multi_json (1.7.1)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.17.0)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  caching_mailer!
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Demers <mike_(at)_9astronauts.com>
+
+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.rdoc

@@ -0,0 +1,51 @@
+= CachingMailer
+
+Enables the use of fragment caching in ActionMailer views.
+
+Shares the cache configuration of ActionController::Base.
+
+== Usage
+
+Configure fragment caching in "config/environment.rb" (or in the
+configuration file for a specific environment such as
+"config/environments/production.rb"):
+
+  config.action_controller.perform_caching = true
+  config.cache_store = :file_store, File.join(Rails.root, 'tmp', 'cache')
+
+
+For the mailer "app/models/hello_mailer.rb":
+
+  class HelloMailer < ActionMailer::Base
+    def hello
+      subject     "Hello, World"
+      recipients  "you@foo.com"
+      from        "me@bar.com"
+      sent_on     Time.now
+    end
+  end
+
+And the template "app/views/hello_mailer/hello.text.plain.erb":
+
+  Hello, World!
+  
+  This is an computationally expensive list:
+  
+  <% cache("mail/expensive-list") do %>
+     <% ExpensiveOperation.results.each do |result| %>
+     * Item #<%= result.id %>: "<%= result.title %>"
+     <% end %>
+  <% end %>
+
+The computationally expensive method `ExpensiveOperation.results` will only
+be invoked once.  Subsequent emails will use the cached result.
+
+For automatic expiration, try including a time value in the cache key.  This
+example will generate a new cache entry every 2 hours (removal of stale
+entries is left as an exercise to the reader):
+
+  <% cache("mail/expensive-list-#{Time.now.to_i / 2.hours.to_i}") do %>
+     <% ExpensiveOperation.results.each do |result| %>
+     * Item #<%= result.id %>: "<%= result.title %>"
+     <% end %>
+  <% end %>

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/caching_mailer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "caching_mailer"
+  s.version     = "1.0"
+  s.authors     = ["Mike Demers", "Tim Dorr"]
+  s.email       = ["timdorr@timdorr.com"]
+  s.homepage    = "https://github.com/timdorr/caching_mailer"
+  s.summary     = %q{Adds fragment caching to ActionMailer}
+  s.description = %q{Uses ActionController to provide fragment caching to ActionMailer}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency("rspec")
+  s.add_runtime_dependency("rails", ["~> 3.2.0"])
+end

data/lib/caching_mailer.rb

@@ -0,0 +1,28 @@
+module CachingMailer
+  extend ActiveSupport::Concern
+
+  included do
+    delegate :cache, :cache_store, :perform_caching, :cache_configured?, :benchmark, :silence, :to => ActionController::Base
+    include ActionController::Caching::Fragments
+  end
+
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load(:action_mailer) do
+      include CachingMailer
+    end
+  end
+
+  protected
+  
+  def fragment_cache_key(key)
+    ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, 'views/mailers')
+  end
+
+  def cache(key, options = {}, &block)
+    if cache_configured?
+      cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :mailer), options, &block)
+    else
+      yield
+    end
+  end
+end

data/test/caching_mailer_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CachingMailerTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: caching_mailer
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Mike Demers
+- Tim Dorr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Uses ActionController to provide fragment caching to ActionMailer
+email:
+- timdorr@timdorr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- caching_mailer.gemspec
+- lib/caching_mailer.rb
+- test/caching_mailer_test.rb
+- test/test_helper.rb
+homepage: https://github.com/timdorr/caching_mailer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -673683854124937832
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -673683854124937832
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds fragment caching to ActionMailer
+test_files:
+- test/caching_mailer_test.rb
+- test/test_helper.rb