email_preview 0.4.2 → 1.0.0

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+

data/Gemfile

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

data/Rakefile

@@ -1,23 +1,5 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "email_preview"
-    gem.summary = %Q{preview emails within your webbrowser}
-    gem.description = %Q{render and send sample html and plain text emails to see what they will *really* look like}
-    gem.email = "ryan@socialcast.com"
-    gem.homepage = "http://github.com/wireframe/email_preview"
-    gem.authors = ["Ryan Sonnek"]
-    gem.add_runtime_dependency "mail", ">= 2.2.3"
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -25,30 +7,4 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
 task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "email_preview #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/app/controllers/email_preview_controller.rb

@@ -1,7 +1,7 @@
 class EmailPreviewController < ApplicationController
   unloadable
   before_filter :enforce_allowed_environments
-  before_filter :build_email, :only => [:show, :deliver]
+  before_filter :build_email, :only => [:show, :deliver, :details, :preview]
   layout nil
 
   def deliver
@@ -9,11 +9,21 @@ class EmailPreviewController < ApplicationController
     @mail.deliver
     redirect_to email_preview_path(params[:id])
   end
+  def preview
+    @part = if request.format == 'html'
+              @parts.detect {|p| p.content_type.include?('text/html') }
+            else
+              @parts.detect {|p| p.content_type.include?('text/plain') }
+            end
+    @part ||= @parts.first
+    render :text => @part.body.to_s
+  end
   private
   def enforce_allowed_environments
     raise "'#{Rails.env}' is not in the supported list of environments from EmailPreview.allowed_environments: #{EmailPreview.allowed_environments.inspect}" unless EmailPreview.allowed_environments.include?(Rails.env)
   end
   def build_email
     @mail = EmailPreview.preview params[:id]
+    @parts = @mail.multipart? ? @mail.parts : [@mail]
   end
 end

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

@@ -0,0 +1,49 @@
+<style>
+  .headers {
+    color: #333;
+  }
+  .headers dl {
+    margin: 0;
+    padding: 0;
+    clear: both;
+  }
+  .headers dt {
+    width: 100px;
+    padding: 1px;
+    float: left;
+    text-align: right;
+    font-weight: bold;
+    color: #7f7f7f;
+  }
+  .headers dd {
+    margin-left: 110px;
+    padding: 1px;
+  }
+
+  .deliver_form {
+    margin-bottom: 0;
+    float: right;
+  }
+  .deliver_form input {
+    width: 250px;
+    }
+</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' %>
+  <button type="submit">Send</button>
+<% end %>
+<h2>Headers</h2>
+<div class="headers">
+<% @mail.header_fields.each do |header| %>
+ <dl>
+   <dt><%= header.name %></dt>
+   <dd><%= header.decoded %></dd>
+ </dl>
+<% end %>
+</div>
+
+<h2>Content</h2>
+<% @parts.each do |part| %>
+  <% render_format = part.content_type.include?('text/html') ? 'html' : 'txt' %>
+  <%= link_to "View #{render_format} output", preview_email_preview_path(params[:id], :format => render_format), :target => 'preview' %>
+<% end %>

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

@@ -4,7 +4,7 @@
   <title>Email Preview</title>
 </head>
 <frameset cols="20%,*">
-  <frame src="<%= navigation_email_preview_index_path %>" name="listing" />
-  <frame name="render" />
+  <frame src="<%= navigation_email_preview_index_path %>" name="index" />
+  <frame name="show" />
 </frameset>
 </html>

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

@@ -1,5 +1,5 @@
 <ul>
 <% EmailPreview.emails.each_index do |index| %>
-  <li><%= link_to EmailPreview.emails[index][:description], email_preview_path(index), :target => 'render' %>
+  <li><%= link_to EmailPreview.emails[index][:description], email_preview_path(index), :target => 'show' %>
 <% end%>
-</ul>
+</ul>

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

@@ -1,41 +1,10 @@
-<style>
-  .headers {
-    color: #333;
-  }
-  .deliver_form {
-    margin-bottom: 0;
-    float: right;
-  }
-  .deliver_form input {
-    width: 250px;
-  }
-  .content_type {
-    margin: .5em 0;
-  }
-</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' %>
-  <button type="submit">Send</button>
-<% end %>
-<h2>Message Headers</h2>
-<pre class='headers'>
-<%= @mail.header_fields.collect { |header| "#{header.name}:   #{header.decoded}\n"}%>
-</pre>
-<!--
-<h3>Debug output</h3>
-<pre>
-  <%= @mail.to_s %>
-</pre>
--->
-
-<h2>Message Content</h2>
-<% parts = @mail.multipart? ? @mail.parts : [@mail] %>
-<% parts.each do |part| %>
-  <h3 class="content_type"><%= part.content_type %></h3>
-  <hr />
-  <% if part.content_type.include?('text/plain') %>
-    <pre><%= part.body %></pre>
-  <% elsif part.content_type.include?('text/html')%>
-    <%= part.body.to_s.html_safe %>
-  <% end %>
-<% end %>
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Email Preview</title>
+</head>
+<frameset rows="300px,*">
+  <frame src="<%= details_email_preview_path(params[:id]) %>" name="details" />
+  <frame name="preview" />
+</frameset>
+</html>

data/config/routes.rb

@@ -5,6 +5,8 @@ Rails.application.routes.draw do
     end
     member do
       post :deliver
+      get :details
+      get :preview
     end
   end
 end

data/email_preview.gemspec

@@ -1,60 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "email_preview/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{email_preview}
-  s.version = "0.4.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Ryan Sonnek}]
-  s.date = %q{2011-05-20}
+  s.name        = "email_preview"
+  s.version     = EmailPreview::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Sonnek"]
+  s.email       = ["ryan@codecrate.com"]
+  s.homepage    = ""
+  s.summary     = %q{simple tool to preview emails in development environment}
   s.description = %q{render and send sample html and plain text emails to see what they will *really* look like}
-  s.email = %q{ryan@socialcast.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "app/controllers/email_preview_controller.rb",
-    "app/views/email_preview/index.html.erb",
-    "app/views/email_preview/navigation.html.erb",
-    "app/views/email_preview/show.html.erb",
-    "config/routes.rb",
-    "email_preview.gemspec",
-    "lib/email_preview.rb",
-    "lib/engine.rb",
-    "test/helper.rb",
-    "test/test_email_preview.rb"
-  ]
-  s.homepage = %q{http://github.com/wireframe/email_preview}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.1}
-  s.summary = %q{preview emails within your webbrowser}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_email_preview.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.rubyforge_project = "email_preview"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mail>, [">= 2.2.3"])
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    else
-      s.add_dependency(%q<mail>, [">= 2.2.3"])
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<mail>, [">= 2.2.3"])
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-  end
-end
+  s.add_runtime_dependency(%q<mail>, [">= 2.2.3"])
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
 
+  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"]
+end

data/lib/email_preview/version.rb

@@ -0,0 +1,3 @@
+module EmailPreview
+  VERSION = "1.0.0"
+end

data/lib/email_preview.rb

@@ -1,22 +1,34 @@
 require 'mail'
-require 'engine' if defined?(Rails)
+require 'email_preview/engine' if defined?(Rails)
 
 module EmailPreview
-
   class << self
     attr_accessor :emails
     attr_accessor :allowed_environments
+    attr_accessor :transactional
 
-    def allowed_environments
-      @allowed_environments ||= ['development', 'test']
-      @allowed_environments
-    end
     def register(description, &block)
-      self.emails ||= []
       self.emails << {:description => description, :block => block }
     end
     def preview(index)
-      self.emails[index.to_i][:block].call
+      mail = nil
+      ActiveRecord::Base.transaction do
+        mail = self.emails[index.to_i][:block].call
+        raise ActiveRecord::Rollback, "EmailPreview rollback" if EmailPreview.transactional?
+      end
+      mail
+    end
+    def transactional?
+      !!self.transactional
     end
   end
 end
+
+# initialize to empty array
+EmailPreview.emails = []
+
+# default to only run in development and test environment
+EmailPreview.allowed_environments = %w{ development test }
+
+# default to rollback transactions after previewing email
+EmailPreview.transactional = true

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.keys.length
+      assert_equal 1, EmailPreview.emails.length
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: email_preview
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 Z
+date: 2011-06-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mail
@@ -34,7 +34,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -48,31 +48,34 @@ dependencies:
   type: :development
   version_requirements: *id002
 description: render and send sample html and plain text emails to see what they will *really* look like
-email: ryan@socialcast.com
+email: 
+- ryan@codecrate.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .document
+- .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - app/controllers/email_preview_controller.rb
+- app/views/email_preview/details.html.erb
 - app/views/email_preview/index.html.erb
 - app/views/email_preview/navigation.html.erb
 - app/views/email_preview/show.html.erb
 - config/routes.rb
 - email_preview.gemspec
 - lib/email_preview.rb
-- lib/engine.rb
+- lib/email_preview/engine.rb
+- lib/email_preview/version.rb
 - test/helper.rb
 - test/test_email_preview.rb
-homepage: http://github.com/wireframe/email_preview
+homepage: ""
 licenses: []
 
 post_install_message: 
@@ -100,11 +103,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: email_preview
 rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
-summary: preview emails within your webbrowser
+summary: simple tool to preview emails in development environment
 test_files: 
 - test/helper.rb
 - test/test_email_preview.rb

data/VERSION

@@ -1 +0,0 @@
-0.4.2