easy_mail_preview 0.1.0

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in easy_mail_preview.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+group :development do
+  gem "jeweler", "~> 1.8.3"
+end
+

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    easy_mail_preview (0.1.0)
+      easy_mail_preview
+      jquery-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.5)
+      activemodel (= 3.2.5)
+      activesupport (= 3.2.5)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.5)
+      activesupport (= 3.2.5)
+      builder (~> 3.0.0)
+    activesupport (3.2.5)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.3)
+    jquery-rails (2.0.2)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.3)
+    multi_json (1.3.6)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.2.5)
+      actionpack (= 3.2.5)
+      activesupport (= 3.2.5)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.15.2)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  easy_mail_preview!
+  jeweler (~> 1.8.3)
+  jquery-rails
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 This Life, Inc.
+
+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.md

@@ -0,0 +1,60 @@
+EasyMailPreview
+===============
+
+EasyMailPreview is a Rails tool that makes it easy to get previews of
+your HTML emails in development. It is designed to offer as much power
+as possible with a minimum of configuration.  
+
+Inspired in part by RailsEmailPreview:
+  https://github.com/glebm/rails_email_preview
+
+Security Note
+-------------
+
+EasyMailPreview is only intended to be used in development mode. The
+instructions below tell you how to do that. You really shouldn't run it
+in any other mode.
+
+If you care about the details: To save you the trouble of having to
+create factory methods for emails you'd like to preview, EasyMailPreview
+takes Ruby strings as arguments in HTTP GET requests and eval's them
+inside of the Rails server. If you were to expose this in a publically
+available site it would be trivially easy for somebody else to use it to
+destroy your data. Please don't do that.
+
+Usage
+-----
+
+Include the Gem in your Gemfile:
+
+    gem 'easy_mail_preview'
+
+Specify which mailer classes you'd like to use for previewing in
+   `config/initializers/easy_mail_preview`:
+
+    require 'easy_mail_preview'
+
+    EasyMailPreview.setup do |config|
+      config.mailers = [
+        MessageMailer, LifecycleMailer, ExpirationMailer
+      ]
+    end
+  
+Mount the app in `config/routes`. *Important*: you should only do this in
+   development mode.
+
+    if Rails.env.development?
+      mount EasyMailPreview::Engine, :at => 'email_previews'
+    end
+  
+Start up your Rails server and go to your URL:
+
+![Screenshot](https://raw.github.com/howaboutwe/easy_mail_preview/master/screenshot.jpg)
+
+That's it! You will be able to select mailer classes, mail methods, and
+then fill in arguments to pass to the mail method.
+
+Copyright
+---------
+
+Copyright (c) 2012 HowAboutWe. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EasyMailPreview'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "easy_mail_preview"
+  gem.homepage = "http://github.com/howaboutwe/easy_mail_preview"
+  gem.license = "MIT"
+  gem.summary = %Q{Easy previews of HTML emails for your Rails app.}
+  gem.description = %Q{Easy previews of HTML emails for your Rails app.}
+  gem.email = "dev@howaboutwe.com"
+  gem.authors = ["HowAboutWe"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/assets/javascripts/easy_mail_preview/application.js

@@ -0,0 +1,15 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/easy_mail_preview/emails.js

@@ -0,0 +1,53 @@
+EasyMailPreview = {
+  mailerAndMethod: function() {
+    return EasyMailPreview.selectedMailer() + '_' + EasyMailPreview.selectedMethod();
+  },
+
+  preview: function(evt) {
+    url = EasyMailPreview.rootPath + "emails/show/";
+    url += EasyMailPreview.mailerAndMethod();
+    var argCount =
+      $(EasyMailPreview.selectedMethodArgumentsSelector() + ' input').length;
+    if (argCount > 0) {
+      url += "?";
+      for (var i = 0; i < argCount; i++) {
+        evalString =
+          $('input[name=mail_methods_' + EasyMailPreview.mailerAndMethod() + '_' + i + ']').val(); 
+        if (i > 0) url += '&';
+        url += "arg_" + i + "=" + escape(evalString);
+      }
+    }
+    $('#preview_frame').attr('src', url);
+    return false;
+  },
+
+  refreshSelections: function() {
+     $('.mail_methods').hide();
+     $('.mail_methods#mail_methods_' + EasyMailPreview.selectedMailer()).show();
+     $('.arguments').hide();
+     $(EasyMailPreview.selectedMethodArgumentsSelector()).show();
+  },
+
+  selectedMailer: function() {
+    return $('form#email_preview select[name=mailer]').val();
+  },
+
+  selectedMethod: function() {
+    return $('form#email_preview select[name=mail_method_' + EasyMailPreview.selectedMailer() + ']').val();
+  },
+
+  selectedMethodArgumentsSelector: function() {
+    return '.arguments#mail_methods_' + EasyMailPreview.mailerAndMethod();
+  }
+};
+
+$(document).ready(function() {
+  EasyMailPreview.refreshSelections();
+  
+  $('form#email_preview select[name=mailer]')
+      .live('change', EasyMailPreview.refreshSelections);
+  $('form#email_preview .mail_methods select')
+      .live('change', EasyMailPreview.refreshSelections);
+  $('form#email_preview').submit(EasyMailPreview.preview);
+});
+

data/app/assets/stylesheets/easy_mail_preview/application.css

@@ -0,0 +1,26 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/
+
+body {
+  width: 1000px;
+  margin: 0px auto;
+}
+
+label {
+  font-size: x-large;
+}
+
+select {
+  font-size: x-large;
+}

data/app/assets/stylesheets/easy_mail_preview/emails.scss

@@ -0,0 +1,48 @@
+#easy_mail_preview {
+  #mailer_container {
+    float: left;
+    width: 50%;
+  }
+
+  #mail_methods_container {
+    margin-top: 10px;
+  }
+
+  .mail_methods {
+    display: none;
+  }
+
+  #arguments_container {
+    margin-top: 10px;
+  }
+
+  .arguments {
+    display: none;
+  }
+
+  .arguments table th {
+    text-align: left;
+    padding-right: 5px;
+  }
+
+  .arguments table th.optional {
+    color: #CCC;
+  }
+
+  .arguments table input.argument {
+    width: 800px;
+    font-size: x-large;
+  }
+
+  #email_preview input[type=submit] {
+    margin-top: 15px;
+    background: lightBlue;
+    font-size: x-large;
+  }
+
+  #preview_frame {
+    margin-top: 25px;
+    width: 1000px;
+    height: 800px;
+  }
+}

data/app/controllers/easy_mail_preview/application_controller.rb

@@ -0,0 +1,4 @@
+module EasyMailPreview
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/easy_mail_preview/emails_controller.rb

@@ -0,0 +1,23 @@
+class EasyMailPreview::EmailsController <
+      EasyMailPreview::ApplicationController
+  def index
+    @mailers = EasyMailPreview.config.mailers.map { |action_mailer|
+      EasyMailPreview::Mailer.new(action_mailer)
+    }
+  end
+
+  def show
+    params[:id] =~ /(.*?)_(.*)/
+    mailer = Module.const_get($1)
+    method_name = $2
+    args = []
+    i = 0
+    until params["arg_" + i.to_s].blank?
+      eval_str = params["arg_" + i.to_s]
+      args << eval(eval_str)
+      i += 1
+    end
+    mail = mailer.send(method_name, *args)
+    render text: mail.body.to_s, layout: false
+  end
+end

data/app/helpers/easy_mail_preview/application_helper.rb

@@ -0,0 +1,4 @@
+module EasyMailPreview
+  module ApplicationHelper
+  end
+end

data/app/helpers/easy_mail_preview/emails_helper.rb

@@ -0,0 +1,4 @@
+module EasyMailPreview
+  module EmailsHelper
+  end
+end

data/app/views/easy_mail_preview/emails/index.html.erb

@@ -0,0 +1,59 @@
+<div id="easy_mail_preview">
+  <form id="email_preview">
+    <div id="mailer_container">
+      <label>Mailer</label>
+      <div>
+        <%= select_tag('mailer', options_for_select(@mailers.map(&:name))) %>
+      </div>
+    </div>
+    <div id="mail_methods_container">
+      <label>Mail methods</label>
+      <% @mailers.each do |mailer| %>
+        <% mailer_id = "mail_methods_#{mailer.name}" %>
+        <div id="<%= mailer_id %>" class="mail_methods">
+          <%= select_tag(
+            "mail_method_#{mailer.name}",
+            options_for_select(mailer.mail_methods.map(&:name))
+          ) %>
+        </div>
+      <% end %>
+    </div>
+    
+    <div id="arguments_container">
+      <label>Arguments (enter Ruby to be eval'd)</label>
+      <% @mailers.each do |mailer| %>
+        <% mailer_id = "mail_methods_#{mailer.name}" %>
+        <% mailer.mail_methods.each do |mail_method| %>
+          <% mail_method_id = mailer_id + "_#{mail_method.name}" %>
+          <div id="<%= mail_method_id %>" class="arguments">
+            <% if mail_method.arguments.empty? %>
+              (No arguments)
+            <% else %>
+              <table>
+                <% mail_method.arguments.each_with_index do |argument, i| %>
+                  <% argument_id = mail_method_id + "_" + i.to_s %>
+                  <tr>
+                    <th class="<%= argument.required? ? 'required' : 'optional' %>">
+                      <%= argument.name %>
+                    </th>
+                    <td><input name="<%= argument_id %>" class="argument"></td>
+                  </tr>
+              <% end %>
+              </table>
+            <% end %>
+          </div>
+        <% end %>
+      <% end %>
+    </div>
+
+    <input type="submit" value="Preview" />
+  </form>
+
+  <iframe id="preview_frame"></iframe>
+</div>
+
+<script type="text/javascript">
+  $(document).ready(function() {
+    EasyMailPreview.rootPath = "<%= easy_mail_preview.root_path %>";
+  });
+</script>

data/app/views/layouts/easy_mail_preview/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>EasyMailPreview</title>
+  <%= stylesheet_link_tag    "easy_mail_preview/application", :media => "all" %>
+  <%= javascript_include_tag "easy_mail_preview/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+EasyMailPreview::Engine.routes.draw do
+  root :to => 'emails#index'
+  match "/emails/show/:id" => "emails#show"
+end

data/easy_mail_preview.gemspec

@@ -0,0 +1,109 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "easy_mail_preview"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["HowAboutWe"]
+  s.date = "2012-06-08"
+  s.description = "Easy previews of HTML emails for your Rails app."
+  s.email = "dev@howaboutwe.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/assets/images/easy_mail_preview/.gitkeep",
+    "app/assets/javascripts/easy_mail_preview/application.js",
+    "app/assets/javascripts/easy_mail_preview/emails.js",
+    "app/assets/stylesheets/easy_mail_preview/application.css",
+    "app/assets/stylesheets/easy_mail_preview/emails.scss",
+    "app/controllers/easy_mail_preview/application_controller.rb",
+    "app/controllers/easy_mail_preview/emails_controller.rb",
+    "app/helpers/easy_mail_preview/application_helper.rb",
+    "app/helpers/easy_mail_preview/emails_helper.rb",
+    "app/views/easy_mail_preview/emails/index.html.erb",
+    "app/views/layouts/easy_mail_preview/application.html.erb",
+    "config/routes.rb",
+    "easy_mail_preview.gemspec",
+    "lib/easy_mail_preview.rb",
+    "lib/easy_mail_preview/engine.rb",
+    "lib/easy_mail_preview/version.rb",
+    "lib/tasks/easy_mail_preview_tasks.rake",
+    "screenshot.jpg",
+    "script/rails",
+    "test/dummy/README.rdoc",
+    "test/dummy/Rakefile",
+    "test/dummy/app/assets/javascripts/application.js",
+    "test/dummy/app/assets/stylesheets/application.css",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/mailers/.gitkeep",
+    "test/dummy/app/models/.gitkeep",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/database.yml",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/initializers/wrap_parameters.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/lib/assets/.gitkeep",
+    "test/dummy/log/.gitkeep",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/script/rails",
+    "test/easy_mail_preview_test.rb",
+    "test/functional/easy_mail_preview/emails_controller_test.rb",
+    "test/integration/navigation_test.rb",
+    "test/test_helper.rb",
+    "test/unit/helpers/easy_mail_preview/emails_helper_test.rb"
+  ]
+  s.homepage = "http://github.com/howaboutwe/easy_mail_preview"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Easy previews of HTML emails for your Rails app."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<easy_mail_preview>, [">= 0"])
+      s.add_runtime_dependency(%q<jquery-rails>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<easy_mail_preview>, [">= 0"])
+      s.add_dependency(%q<jquery-rails>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<easy_mail_preview>, [">= 0"])
+    s.add_dependency(%q<jquery-rails>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/easy_mail_preview/engine.rb

@@ -0,0 +1,5 @@
+module EasyMailPreview
+  class Engine < ::Rails::Engine
+    isolate_namespace EasyMailPreview
+  end
+end

data/lib/easy_mail_preview/version.rb

@@ -0,0 +1,3 @@
+module EasyMailPreview
+  VERSION = "0.0.1"
+end