RubyGems - letter_bomb - Versions diffs - 0.0.1 - Mend

letter_bomb 0.0.1

Files changed (53) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +62 -0
data/Rakefile +9 -0
data/app/controllers/letter_bomb/application_controller.rb +4 -0
data/app/controllers/letter_bomb/mailers_controller.rb +13 -0
data/app/views/layouts/letter_bomb/application.html.erb +12 -0
data/app/views/letter_bomb/mailers/index.html.erb +12 -0
data/app/views/letter_bomb/mailers/show.html.erb +88 -0
data/config/routes.rb +4 -0
data/lib/letter_bomb.rb +2 -0
data/lib/letter_bomb/engine.rb +17 -0
data/lib/letter_bomb/preview.rb +33 -0
data/lib/letter_bomb/version.rb +3 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/mailers/user_mailer.rb +21 -0
data/spec/dummy/app/models/user.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/user_mailer/welcome.html.erb +3 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +65 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +3 -0
data/spec/dummy/db/migrate/20130430115218_create_users.rb +9 -0
data/spec/dummy/db/schema.rb +22 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/dummy/tmp/pids/server.pid +1 -0
data/spec/lib/letter_bomb/preview_spec.rb +52 -0
data/spec/requests/mailer_preview_listing_spec.rb +9 -0
data/spec/requests/mailer_preview_showing_spec.rb +23 -0
data/spec/spec_helper.rb +16 -0
metadata +189 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c67ffe4932cf6ab7ad4afb2b846bbaac8750fa8
+  data.tar.gz: 0d2ba7da06ca5b5fec46b5dbec6224fb864890bd
+SHA512:
+  metadata.gz: 2a178785f941f88ab127a964e421f6dac918484aaaa4b0e870ead025748ed1baa54ba62eccce731e81026bcd76d2699216dd5d532fca261be0b63b4d022848c9
+  data.tar.gz: 62665b33af2ecbe0b38dd0f3002c0b0efe8e2b5d633f744fd859fa1801e5d77c0117e58209e7ba4c8909c95b477f448d5d0dc29d632112f4783fb750ad268eb9

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+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 ADDED Viewed

@@ -0,0 +1,62 @@
+LetterBomb
+==========
+Emails are pretty dangerous - inspect your mailer templates from the safety of your browser.
+Install
+-------
+Add to your `Gemfile`:
+```ruby
+gem 'letter_bomb', group: :development
+```
+and `bundle` away.
+Usage
+-----
+Mount the engine in your `routes.rb`:
+```ruby
+mount LetterBomb::Engine, at: '/letter_bomb'
+```
+and hit `/letter_bomb` for a list of previews.
+Previews can be defined anywhere within `app/mailers`.
+```ruby
+class UserMailer::Preview < LetterBomb::Preview
+  def welcome
+    UserMailer.welcome(User.last)
+  end
+end
+```
+Preview methods are wrapped in a transaction that will be rolled back, so it's safe to create test data.
+One approach is to load your factory_girl factories and use those:
+```ruby
+class UserMailer::Preview < LetterBomb::Preview
+  has_factory_girl
+  def welcome
+    user = FactoryGirl.create(:user)
+    UserMailer.welcome(user)
+  end
+end
+```
+Preview class names and methods are arbitrary so long as they return a `Mail` object.
+Alternatives
+------------
+Also check out 37signals [mail_view](https://github.com/37signals/mail_view), which much inspiration was taken from.
+Differences: no automatic reloading of preview classes, no transactional previews, need to mount individual mailers.

data/Rakefile ADDED Viewed

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/controllers/letter_bomb/application_controller.rb ADDED Viewed

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

data/app/controllers/letter_bomb/mailers_controller.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module LetterBomb
+  class MailersController < ApplicationController
+    def index
+      @mailers = LetterBomb::Preview.previews
+    end
+    def show
+      mailer_class = params[:mailer_class]
+      mailer_action = params[:mailer_action]
+      @mail = mailer_class.constantize.preview_action(mailer_action)
+    end
+  end
+end

data/app/views/layouts/letter_bomb/application.html.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>LetterBomb</title>
+  <%= yield :head %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/app/views/letter_bomb/mailers/index.html.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<h1>Mailers</h1>
+<% @mailers.each do |mailer| %>
+  <p><%= mailer.to_s %></p>
+  <ul>
+  <% mailer.mailer_actions.each do |action| %>
+    <li><%= link_to action, mailer_path(mailer.to_s, action) %></li>
+  <% end %>
+  </ul>
+<% end %>

data/app/views/letter_bomb/mailers/show.html.erb ADDED Viewed

@@ -0,0 +1,88 @@
+<% content_for :head do %>
+  <meta http-equiv="Content-Type" content="text/html; charset=<%= @mail.charset %>" />
+  <style type="text/css">
+    #message_headers {
+      width: 100%;
+      margin: 0;
+      background: #fff;
+      font-size: 12px;
+      font-family: "Lucida Grande";
+      border-bottom: 1px solid #dedede;
+      overflow: hidden;
+    }
+    #message_headers dl {
+      float: left;
+      margin: 0 0 10px 0;
+      padding: 0;
+    }
+    #message_headers dt {
+      width: 100px;
+      padding: 1px;
+      float: left;
+      text-align: right;
+      font-weight: bold;
+      color: #7f7f7f;
+    }
+    #message_headers dd {
+      margin-left: 110px;
+      padding: 1px;
+    }
+    #message_headers p.alternate {
+      float: right;
+      margin: 0;
+    }
+    #message_headers p.alternate a {
+      color: #09c;
+    }
+    pre#message_body {
+      padding: 10px;
+      white-space: pre-wrap;
+    }
+  </style>
+<% end %>
+<div id="message_headers">
+  <dl>
+    <% if @mail.respond_to?(:smtp_envelope_from) && @mail.from != @mail.smtp_envelope_from %>
+      <dt>SMTP-From:</dt>
+      <dd><%= @mail.smtp_envelope_from %></dd>
+    <% end %>
+    <dt>From:</dt>
+    <dd><%= @mail.from %></dd>
+    <% if @mail.reply_to %>
+      <dt>Reply-To:</dt>
+      <dd><%= @mail.reply_to %></dd>
+    <% end %>
+    <dt>Subject:</dt>
+    <dd><strong><%= @mail.subject %></strong></dd>
+    <dt>Date:</dt>
+    <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
+    <% if @mail.respond_to?(:smtp_envelope_to) && @mail.to != @mail.smtp_envelope_to %>
+      <dt>SMTP-To:</dt>
+      <dd><%= @mail.smtp_envelope_to %></dd>
+    <% end %>
+    <dt>To:</dt>
+    <dd><%= @mail.to %></dd>
+    <dt>Content-Type:</dt>
+    <dd><%= @mail.content_type %></dd>
+  </dl>
+</div>
+<% if @mail.content_type && @mail.content_type.match(/text\/html/) %>
+  <%= @mail.body.to_s.html_safe %>
+<% else %>
+  <pre id="message_body"><%= @mail.body %></pre>
+<% end %>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,4 @@
+LetterBomb::Engine.routes.draw do
+  get '/', to: 'mailers#index', as: :mailers
+  get '/:mailer_class/:mailer_action', to: 'mailers#show', as: :mailer
+end

data/lib/letter_bomb.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require 'letter_bomb/engine'
2	+ require 'letter_bomb/preview'

data/lib/letter_bomb/engine.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module LetterBomb
+  class Engine < ::Rails::Engine
+    isolate_namespace LetterBomb
+    initializer 'letterbomb.mailers.autoload' do |app|
+      # TODO this is sloppy. the reason behind it is:
+      # 1) to generate the list of previews, we need all subclasses.
+      #    rails doesn't load them up front, so we need to do that manually.
+      #
+      # 2) because we load the mailers and previews up-front, we have to manually tell
+      #    rails to reload each per request.
+      ActionDispatch::Callbacks.before do
+        Dir[File.join(app.config.root, "/app/mailers/**/*.rb")].each { |file| load(file) }
+      end
+    end
+  end
+end

data/lib/letter_bomb/preview.rb ADDED Viewed

@@ -0,0 +1,33 @@
+module LetterBomb
+  class Preview
+    def self.previews
+      subclasses
+    end
+    def self.mailer_actions
+      new.public_methods(false).map(&:to_s).sort
+    end
+    def self.preview_action(mailer_action)
+      mail = nil
+      ActiveRecord::Base.transaction do
+        mail = new.send(mailer_action)
+        raise ActiveRecord::Rollback
+      end
+      mail
+    end
+    def self.has_factory_girl
+      @@factory_girl = true
+    end
+    def initialize
+      if defined?(@@factory_girl) && !defined?(FactoryGirl)
+        require 'factory_girl'
+        FactoryGirl.find_definitions
+      end
+    end
+  end
+end

data/lib/letter_bomb/version.rb ADDED Viewed

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

data/spec/dummy/README.rdoc ADDED Viewed

@@ -0,0 +1,261 @@
+== Welcome to Rails
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+== Getting Started
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+== Debugging Rails
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+The result will be a message in your log file along the lines of:
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+== Debugger
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+...and even better, you can examine how your runtime objects actually work:
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+Finally, when you're ready to resume execution, you can enter "cont".
+== Console
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+To start the console, run <tt>rails console</tt> from the application
+directory.
+Options:
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+== dbconsole
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+== Description of Contents
+The default directory structure of a generated Ruby on Rails application:
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+app
+  Holds all the code that's specific to this particular application.
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+script
+  Helper scripts for automation and generation.
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.