has_web_fallback 0.1.3 → 0.2.0

data/README

@@ -37,7 +37,7 @@ end
 
 ... and in the template
 
-<%= link_to("View this email online", @web_fallback_url, :path_only=>false) %>
+<%= link_to("View this email online", APPLICATION_URL+@web_fallback_url) %>
 
 
 Copyright (c) 2009 Gavin Montague, released under the MIT license

data/lib/leftbrained/has_web_fallback.rb

@@ -3,26 +3,34 @@ require 'ftools'
 require 'uuidtools'
 
 module Leftbrained
-    
+
   module HasWebFallback #:nodoc:
+    
+    @has_web_fallback_cache_path = nil
+
+    def self.has_web_fallback_cache_path=(path)
+      @has_web_fallback_cache_path = path
+    end
+
+    def self.has_web_fallback_cache_path
+      @has_web_fallback_cache_path || raise(NoCachePathSetException)
+    end
 
-    WEB_FALLBACK_PATH = File.join(File.expand_path(RAILS_ROOT), "public")
 
     def self.included(base)
       base.extend(ClassMethods)
     end    
     # mattr_accessor :write_web_fallbacks
-    
+
     module ClassMethods
-      
       def has_web_fallback?(method_name=nil)
         false
       end
-            
+
       def has_web_fallback(name, options={})   
         extend Leftbrained::HasWebFallback::IncludedClassMethods
         write_inheritable_attribute(:methods_with_web_fallback, {}) if methods_with_web_fallback.nil?
-        methods_with_web_fallback[name] = { :keep_for=>7.days }.merge(options)
+        methods_with_web_fallback[name] = { :keep_for=>7.days, :cache_path=>nil }.merge(options)
         
         class_eval <<-EOV
         include Leftbrained::HasWebFallback::InstanceMethods
@@ -75,15 +83,23 @@ module Leftbrained
       end
       
       def cache_period_for_method_with_web_fallback(method_name)
-        methods_with_web_fallback[method_name.to_sym][:keep_for]      
+        methods_with_web_fallback[method_name.to_sym][:keep_for]
       end
       
       def url_for_web_fallback(method_name)
+        if methods_with_web_fallback[method_name.to_sym]
+          methods_with_web_fallback[method_name.to_sym][:cache_path] || default_url_for_web_fallback(method_name)
+        else
+          default_url_for_web_fallback(method_name)
+        end
+      end
+
+      def default_url_for_web_fallback(method_name)
         "/system/web_fallback/#{self.to_s.underscore.gsub("_mailer", '')}/#{method_name}"
       end
-      
+
       def path_for_web_fallback(method_name)
-        File.join(WEB_FALLBACK_PATH, url_for_web_fallback(method_name))
+        File.join(Leftbrained::HasWebFallback.has_web_fallback_cache_path, url_for_web_fallback(method_name))
       end
                             
     end # ClassMethods
@@ -138,9 +154,15 @@ module Leftbrained
       end
       
     end # InstanceMethods
-      
+     
+    class NoCachePathSetException < RuntimeError
+      def message
+        "No path was set on Leftbrained::HasWebFallback.has_web_fallback_cache_path - you must set this before creating fallbacks"
+      end
+    end
+
   end
   
 end
 
-ActionMailer::Base.class_eval { include Leftbrained::HasWebFallback }
+ActionMailer::Base.class_eval { include Leftbrained::HasWebFallback }

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_web_fallback
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gavin Montague
@@ -9,39 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 +00:00
+date: 2011-06-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: actionmailer
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: uuidtools
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: Adds the commonly required behaviour of caching web accessible versions of HTML emails to ActionMailer
 email: gavin@leftbrained.co.uk
 executables: []
@@ -60,29 +78,34 @@ homepage: http://github.com/Govan/has_web_fallback
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Adds the commonly required behaviour of caching web accessible versions of HTML emails to ActionMailer
-test_files: 
-- test/has_web_fallback_test.rb
-- test/test_helper.rb
+test_files: []
+

data/test/has_web_fallback_test.rb

@@ -1,132 +0,0 @@
-require 'test_helper'
-
-
-require "#{File.dirname(__FILE__)}/test_helper"
-
-class HasWebFallbackTest < ActionMailer::TestCase
-  
-  class ExampleMailer < ActionMailer::Base
-    has_web_fallback :welcome
-    has_web_fallback :goodbye
-    
-    def welcome
-      recipients "no-one@example.com"
-      body[:name] = "Joe"
-      subject "welcome"
-    end
-    
-    def goodbye
-      body[:name] = "Joe"
-      subject "goodbye"
-    end
-    
-    def recover_password
-    end
-  end
-  # 
-
-  context "When included, ExampleMailer" do
-    
-    should "have a class attribute for tracking methods with fallbacks" do 
-      assert ExampleMailer.inheritable_attributes.include? :methods_with_web_fallback
-    end
-    
-    should "be able to identify if a method has a web fallback" do
-      assert ExampleMailer.has_web_fallback?(:welcome)
-      assert ExampleMailer.has_web_fallback?(:goodbye)
-    end
-    
-    should "be able to identify a method without a web fallback" do
-      assert !ExampleMailer.has_web_fallback?(:recover_password)
-    end
-    
-    should "be able to generate UUIDs" do # I know this is a lousy test, but how the hell would one test a UUID?
-      uuid_1 = ExampleMailer.web_fallback_uuid_for(:welcome)
-      uuid_2 = ExampleMailer.web_fallback_uuid_for(:welcome)
-      assert uuid_1 != uuid_2, "UUID clash - #{uuid_1} vs #{uuid_2}"
-    end
-    
-    should "not report that ActionMailer::Base uses has_web_fallback" do
-      assert !ActionMailer::Base.has_web_fallback?
-    end
-    
-    should "respond to has_web_fallback" do
-      assert ExampleMailer.has_web_fallback?
-    end
-  
-    should_eventually "be able to list cached files for a given function that should be deleted" do
-      # I have quite literally no idea how to test this without 
-      # mocking the living shit out File, or writing out to the file system.
-    end
-    
-  end
-  
-  context "A method with no fallback" do
-    setup do 
-      @recover_password_mail = ExampleMailer.send(:new, 'recover_password')  
-    end
-
-    should "know it doesn't have a fallback" do  
-      assert !@recover_password_mail.has_web_fallback?
-    end
-    
-    should "not write out an html version" do
-      @recover_password_mail.deliver!
-      assert !File.exists?(@recover_password_mail.web_fallback_path)
-    end
-  end
-
-  context "A method with fallback" do
-    setup do 
-      @welcome_mail = ExampleMailer.send(:new, 'welcome')
-    end
-
-    should "know if it has a web fallback " do 
-      assert @welcome_mail.has_web_fallback?
-    end
-    
-    context "and an html part" do
-      should "have a url to the email " do
-        assert_match /^\/system\/web_fallback\/has_web_fallback_test\/example\/welcome\/[a-z0-9\-]+\.html$/, @welcome_mail.web_fallback_url
-      end
-    
-      should "have an absolute_path to the file's location" do
-        assert @welcome_mail.web_fallback_path
-      end
-      
-      should "know it has an html part" do
-         assert @welcome_mail.has_html_part?
-       end
-    
-      should "be able to include a link in any of the body parts." do
-         @welcome_mail.parts.each do |part|
-          assert_match @welcome_mail.web_fallback_url, part.body
-         end
-      end
-      
-      should "write out an html version" do
-        @welcome_mail.deliver!
-        assert File.exists?(@welcome_mail.web_fallback_path)
-      end
-    end
-    
-    context "but no html part" do
-      setup do 
-        @goodbye_mail = ExampleMailer.send(:new, 'goodbye')
-      end
-      
-      should "know it doesn't have an html part" do
-        assert !@goodbye_mail.has_html_part?
-      end
-      
-      should "not write out an html version" do
-        @goodbye_mail.deliver!
-        assert !File.exists?(@goodbye_mail.web_fallback_path)
-      end
-            
-    end
-    
-  end
-  
-end
-

data/test/test_helper.rb

@@ -1,6 +0,0 @@
-require 'stringio'
-require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/has_web_fallback'
-
-# Reset out template path for AM to work with tests, apologies to any one else running tests....
-ActionMailer::Base.template_root = File.join(File.dirname(__FILE__), 'app', 'views')