email_preview 1.0.1 → 1.1.0

data/README.md

@@ -3,8 +3,9 @@
 preview emails within your web browser
 
 ## Features
-* preview HTML emails from within your web browser
+* preview HTML or plain text emails from within your web browser
 * emails are reloaded with each view so you can tweak/save/refresh for instant verification
+* integrates perfectly with existing test fixtures
 * convenient form to send any email preview directly to your *real* inbox
 * only exposes routes in development mode to prevent leaking into production mode
 
@@ -14,9 +15,9 @@ gem 'email_preview'
 
 ## Usage
 
-
 ```ruby
 # config/initializers/email_preview.rb
+# basic example for previewing an email built manually
 EmailPreview.register 'simple example email' do
   Mail.new do
     to 'tom@example.com'
@@ -27,8 +28,8 @@ end
 
 EmailPreview.register 'multipart email (html + text)' do
   Mail.new do
-    from 'mikel@test.lindsaar.net'
-    to 'you@test.lindsaar.net'
+    from 'bob@example.com'
+    to 'jim@foobar.net'
     subject 'This is a test email'
 
     text_part do
@@ -41,8 +42,11 @@ EmailPreview.register 'multipart email (html + text)' do
   end
 end
 
+# Rails ActionMailer Example
+# each execution is wrapped with a transaction and 
+# rolled back after completed so there are no side-effects
 EmailPreview.register 'Rails ActionMailer User activation email' do
-  u = User.new :email => 'foo@example.com'
+  u = User.create :email => 'foo@example.com'
   UserMailer.activation(u)
 end
 ```
@@ -50,13 +54,36 @@ end
 browse the list of registered emails and preview them in your browser at:
 http://localhost:3000/email_preview
 
-by default the email_preview feature is only available in development mode.  to turn on globally use:
+![screenshot](https://img.skitch.com/20110608-p2mck7sahpu3h8uit7akq487w2.jpg)
+
+### (optional) Group related emails using the :category option:
+
+When you have lots of emails in your app, it's useful to group them into
+related topics.
+
+```ruby
+# config/initializers/email_preview.rb
+EmailPreview.register 'User activation', :category => :user do
+  u = User.new :email => 'foo@example.com'
+  UserMailer.activation(u)
+end
+EmailPreview.register 'Blog posted', :category => :blog do
+  b = Blog.new :title => 'foo'
+  BlogMailer.posted(b)
+end
+```
+
+### (optional) expose to production environment
+
+By default the email_preview feature is only available in development mode.  
+To make it available to other environments use:
 
 ```ruby
 # config/initializers/email_preview.rb
 EmailPreview.allowed_environments << 'production'
 ```
 
+
 ## Contributing 
 
 * Fork the project

data/app/controllers/email_preview_controller.rb

@@ -11,10 +11,10 @@ class EmailPreviewController < ApplicationController
   end
   def preview
     @part = if request.format == 'html'
-              @parts.detect {|p| p.content_type && p.content_type.include?('text/html') }
-            else
-              @parts.detect {|p| p.content_type && p.content_type.include?('text/plain') }
-            end
+      @parts.detect {|p| p.content_type && p.content_type.include?('text/html') }
+    else
+      @parts.detect {|p| p.content_type && p.content_type.include?('text/plain') }
+    end
     @part ||= @parts.first
     render :text => @part.body.to_s
   end

data/app/views/email_preview/details.html.erb

@@ -1,4 +1,9 @@
 <style>
+  h2, ul, li { margin:0; padding:0;  }
+
+  h2 {
+    margin: 5px;
+  }
   .headers {
     color: #333;
   }
@@ -27,6 +32,13 @@
   .deliver_form input {
     width: 250px;
   }
+
+  ul {
+    list-style-type: none;
+  }
+  li {
+    margin-left: 10px
+  }
 </style>
 <%= form_tag deliver_email_preview_path(params[:id]), :class => 'deliver_form' do %>
   <%= text_field_tag :to, '', :placeholder => 'Send this email to me@yourcompany.com' %>

data/app/views/email_preview/navigation.html.erb

@@ -1,5 +1,22 @@
-<ul>
-<% EmailPreview.emails.each_index do |index| %>
-  <li><%= link_to EmailPreview.emails[index][:description], email_preview_path(index), :target => 'show' %>
-<% end%>
-</ul>
+<style type='text/css'>
+  ul, li, h3 { margin: 0; padding: 0; }
+
+  ul {
+    list-style-type: none;
+  }
+  li {
+    margin-left: 10px;
+  }
+  h3 {
+    margin: 5px;
+  }
+</style>
+<% EmailPreview.categories.each do |category| %>
+  <h3><%= category %></h3>
+  <ul>
+  <% EmailPreview.registry.values.sort_by {|o| o[:description]}.each do |options| %>
+    <% next unless options[:category] == category %>
+    <li><%= link_to options[:description], email_preview_path(options[:key]), :target => 'show' %>
+  <% end%>
+  </ul>
+<% end %>

data/app/views/email_preview/show.html.erb

@@ -3,7 +3,7 @@
 <head>
   <title>Email Preview</title>
 </head>
-<frameset rows="300px,*">
+<frameset rows="250px,*">
   <frame src="<%= details_email_preview_path(params[:id]) %>" name="details" />
   <frame name="preview" />
 </frameset>

data/lib/email_preview/version.rb

@@ -1,3 +1,3 @@
 module EmailPreview
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/email_preview.rb

@@ -3,17 +3,25 @@ require 'email_preview/engine' if defined?(Rails)
 
 module EmailPreview
   class << self
-    attr_accessor :emails
+    attr_accessor :registry
     attr_accessor :allowed_environments
     attr_accessor :transactional
 
-    def register(description, &block)
-      self.emails << {:description => description, :block => block }
+    def register(description, options={}, &block)
+      key = description.hash.abs
+      options[:key] = key
+      options[:category] ||= 'General'
+      options[:description] ||= description
+      options[:block] ||= block
+      self.registry[key] = options
     end
-    def preview(index)
+    def categories
+      self.registry.values.collect {|f| f[:category] }.uniq
+    end
+    def preview(key)
       mail = nil
       ActiveRecord::Base.transaction do
-        mail = self.emails[index.to_i][:block].call
+        mail = self.registry[key.to_i][:block].call
         raise ActiveRecord::Rollback, "EmailPreview rollback" if EmailPreview.transactional?
       end
       mail
@@ -24,8 +32,8 @@ module EmailPreview
   end
 end
 
-# initialize to empty array
-EmailPreview.emails = []
+# initialize registry
+EmailPreview.registry = {}
 
 # default to only run in development and test environment
 EmailPreview.allowed_environments = %w{ development test }

data/test/test_email_preview.rb

@@ -13,7 +13,7 @@ class TestEmailPreview < Test::Unit::TestCase
       end
     end
     should "have one entry in the configuration" do
-      assert_equal 1, EmailPreview.emails.length
+      assert_equal 1, EmailPreview.registry.keys.length
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: email_preview
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 Z
+date: 2011-06-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mail