roadie-rails 1.0.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 964013dea5eca0f622fc24a88b3dc4efdbfc5519
+  data.tar.gz: 58b489303032269e9750ebaa39dd39d96b5a72cb
+SHA512:
+  metadata.gz: 8da2753c4dfcdec5d7b1b1f6d1e6ce9326b84526af24b51c7f0143fb277d698b430a17a019fbf0788608488412e56280a5c97fed753065ddf744fa95d5ce1d73
+  data.tar.gz: 94a4856d0196a0b0bd7c48bc3a3372e2edbc650e8abef706f1a71f78d682497576a902334c04e14d45233b01c4c399ae9fe340d1a6b96f7cde60f0502f90bf53

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+**/*.log

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby
+  - rbx
+
+bundler_args: --without guard
+script: "rake"
+
+matrix:
+  allow_failures:
+    - rvm: rbx
+    - rvm: jruby

data/Changelog.md

@@ -0,0 +1,9 @@
+### development version
+
+[full changelog](https://github.com/Mange/roadie/compare/v1.0.0.pre1...master)
+
+### 1.0.0.pre1
+
+[full changelog](https://github.com/Mange/roadie/compare/0000000...v1.0.0.pre1)
+
+* First implementation

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roadie-rails.gemspec
+gemspec
+
+# Use git version of `roadie` until a full release have been made
+gem 'roadie', git: 'git://github.com/Mange/roadie.git', branch: 'master'
+
+# Additional development dependencies I use but don't want to declare in the
+# gemfile since they aren't required to develop this codebase.
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+end
+
+# Added here so it does not show up on the Gemspec; I only want it for CI builds
+gem 'coveralls', group: :test, require: nil

data/Guardfile

@@ -0,0 +1,16 @@
+rspec_options = {
+  cmd: 'rspec -f documentation',
+  fail_mode: :keep,
+  all_after_pass: true,
+  all_on_start: true,
+  run_all: {cmd: 'rspec -f progress'}
+}
+
+guard :rspec, rspec_options do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/support/.+\.rb$}) { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Magnus Bergmark
+
+MIT License
+
+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,317 @@
+# roadie-rails
+
+[![Build history and status](https://secure.travis-ci.org/Mange/roadie-rails.png)](http://travis-ci.org/#!/Mange/roadie-rails)
+[![Code Climate](https://codeclimate.com/github/Mange/roadie-rails.png)](https://codeclimate.com/github/Mange/roadie-rails)
+[![Coverage Status](https://coveralls.io/repos/Mange/roadie-rails/badge.png?branch=master)](https://coveralls.io/r/Mange/roadie-rails?branch=master)
+[![Gem Version](https://badge.fury.io/rb/roadie-rails.png)](http://badge.fury.io/rb/roadie-rails)
+[![Dependency Status](https://gemnasium.com/Mange/roadie-rails.png)](https://gemnasium.com/Mange/roadie-rails)
+
+> Making HTML emails comfortable for the Rails rockstars.
+
+**Note:** You probably want to use [Roadie 2.4][roadie2] for your Rails application right now. Roadie 3 and roadie-rails have no stable releases yet.
+
+---
+
+This gem hooks up your Rails application with Roadie to help you generate HTML emails.
+
+## Installation ##
+
+[Add this gem to your Gemfile as recommended by Rubygems][gem] and run `bundle install`.
+
+```ruby
+gem 'roadie-rails', '~> x.y.0'
+```
+
+## Usage ##
+
+`roadie-rails` have two primary means of usage. The first on is the "Automatic usage", which does almost everything automatically. It's the easiest way to hit the ground running in order to see if `roadie` would be a good fit for your application.
+
+As soon as you require some more "advanced" features (congratulations!), you should migrate to the "Manual usage" which entails that you do some things by yourself.
+
+### Automatic usage ###
+
+Include the `Roadie::Rails::Automatic` module inside your mailer. Roadie will do its magic when you try to deliver the message:
+
+```ruby
+class NewsletterMailer < ActionMailer::Base
+  include Roadie::Rails::Automatic
+
+  def user_newsletter(user)
+    mail to: user.email, subject: subject_for_user(user)
+  end
+
+  private
+  def subject_for_user(user)
+    I18n.translate 'emails.user_newsletter.subject', name: user.name
+  end
+end
+
+# email has the original body; Roadie has not been invoked yet
+email = NewsletterMailer.user_newsletter(User.first)
+
+# This triggers Roadie inlining and will deliver the email with inlined styles
+email.deliver
+```
+
+By overriding the `#roadie_options` method in the mailer you can disable inlining in certain cases:
+
+```ruby
+class NewsletterMailer < ActionMailer::Base
+  include Roadie::Rails::Automatic
+
+  private
+  def roadie_options
+    super unless Rails.env.test?
+  end
+end
+```
+
+Another way:
+
+```ruby
+describe YourMailer do
+  describe "email contents" do
+    before do
+      # Disable inlining
+      YourMailer.any_instance.stub(:roadie_options).and_return(nil)
+    end
+    # ...
+  end
+
+  describe "inlined email contents" do
+    # ...
+  end
+end
+```
+
+If you need the extra flexibility, look at the "Manual usage" below.
+
+### Manual usage ###
+
+Include the `Roadie::Rails::Mailer` module inside your `ActionMailer` and call `roadie_mail` with the same options that you would pass to `mail`.
+
+```ruby
+class NewsletterMailer < ActionMailer::Base
+  include Roadie::Rails::Mailer
+
+  def user_newsletter(user)
+    roadie_mail to: user.email, subject: subject_for_user(user)
+  end
+
+  private
+  def subject_for_user(user)
+    I18n.translate 'emails.user_newsletter.subject', name: user.name
+  end
+end
+```
+
+This will inline the stylesheets right away, which sadly decreases performance for your tests where you might only want to inline in one of them. The upside is that you can selectively inline yourself.
+
+```ruby
+class NewsletterMailer < ActionMailer::Base
+  include Roadie::Rails::Mailer
+
+  def subscriber_newsletter(subscriber, options = {})
+    use_roadie = options.fetch :use_roadie, true
+    mail_factory(use_roadie, normal_mail_options)
+  end
+
+  private
+  def mail_factory(use_roadie, options)
+    if use_roadie
+      roadie_mail options
+    else
+      mail options
+    end
+  end
+end
+
+# tests
+describe NewsletterMailer do
+  it "is emailed to the subscriber's email" do
+    email = NewsletterMailer.subscriber_newsletter(subscriber, use_roadie: false)
+    email.to.should == subscriber.email
+  end
+
+  it "inlines the emails by default" do
+    email = NewsletterMailer.subscriber_newsletter(subscriber)
+    email.should be_good_and_cool_and_all_that_jazz
+  end
+end
+```
+
+Or, perhaps by doing this:
+
+```ruby
+describe YourMailer do
+  describe "email contents" do
+    before do
+      # Redirect all roadie mail calls to the normal mail method
+      YourMailer.any_instance.stub(:roadie_mail) { |*args, &block| YourMailer.mail(*args, &block) }
+    end
+    # ...
+  end
+
+  describe "inlined email contents" do
+    # ...
+  end
+end
+```
+
+### Configuration ###
+
+Roadie can be configured in three places, depending on how specific you want to be:
+
+1. `Rails.application.config.roadie` (global, static).
+2. `YourMailer#roadie_options` (mailer, dynamic).
+3. Second argument to the `roadie_mail` (mail, specific and custom).
+
+You can override at any level in the chain, depending on how specific you need to be.
+
+Only the first two methods are available to you if you use the `Automatic` module.
+
+```ruby
+# config/environments/production.rb
+config.roadie.url_options = {host: "my-app.com", scheme: "https"}
+
+# app/mailer/my_mailer.rb
+class MyMailer
+  include Roadie::Rails::Mailer
+
+  protected
+  def roadie_options
+    super.merge(url_options: {host: Product.current.host})
+  end
+end
+
+# app/mailer/my_other_mailer.rb
+class MyOtherMailer
+  include Roadie::Rails::Mailer
+
+  def some_mail(user)
+    roadie_email {to: "foo@example.com"}, roadie_options_for(user)
+  end
+
+  private
+  def roadie_options_for(user)
+    roadie_options.combine({
+      asset_providers: [MyCustomProvider.new(user)],
+      url_options: {host: user.subdomain_with_host},
+    })
+  end
+end
+```
+
+If you `#merge` you will replace the older value outright:
+
+```ruby
+def roadie_options
+  original = super
+  original.url_options # => {protocol: "https", host: "foo.com"}
+  new = original.merge(url_options: {host: "bar.com"})
+  new.url_options # => {host: "bar.com"}
+  new
+end
+```
+
+If you want to combine two values, use `#combine`. `#combine` is closer to `Hash#deep_merge`:
+
+```ruby
+def roadie_options
+  original = super
+  original.url_options # => {protocol: "https", host: "foo.com"}
+  new = original.combine(url_options: {host: "bar.com"})
+  new.url_options # => {protocol: "https", host: "bar.com"}
+  new
+end
+```
+
+`#combine` is smarter than `Hash#deep_merge`, though. It can combine callback `proc`s (so both get called) and `Roadie::ProviderList`s as well.
+
+If you want to see the available configuration options, see the [Roadie gem][roadie].
+
+### Templates ###
+
+Use normal `stylesheet_link_tag` and `foo_path` methods when generating your email and Roadie will look for the precompiled files on your filesystem, or by asking the asset pipeline to compile the files for you if it cannot be found.
+
+### Previewing ###
+
+You can create a controller that gets the email and then renders the body from it.
+
+```ruby
+class Admin::EmailsController < AdminController
+  def user_newsletter
+    render_email NewsletterMailer.user_newsletter(current_user)
+  end
+
+  def subscriber_newsletter
+    render_email NewsletterMailer.subscriber_newsletter(Subscriber.first || Subscriber.new)
+  end
+
+  private
+  def render_email(email)
+    respond_to do |format|
+      format.html { render html: email.html_body.decoded }
+      format.text { render text: email.text_body.decoded }
+    end
+  end
+end
+```
+
+## Build status ##
+
+Tested with [Travis CI](http://travis-ci.org) using [almost all combinations of](http://travis-ci.org/#!/Mange/roadie-rails):
+
+* Ruby:
+  * MRI 1.9.3
+  * MRI 2.0.0
+  * MRI 2.1.0
+* Rails
+  * 3.0
+  * 3.1
+  * 3.2
+  * 4.0
+  * 4.1
+
+Let me know if you want any other combination supported officially.
+
+### Versioning ###
+
+This project follows [Semantic Versioning][semver]. The 0.x branch is considered unstable.
+
+## Documentation ##
+
+* [Online documentation for gem](http://rubydoc.info/gems/roadie-rails/frames)
+* [Online documentation for master](http://rubydoc.info/github/Mange/roadie-rails/master/frames)
+* [Changelog](https://github.com/Mange/roadie-rails/blob/master/Changelog.md)
+
+## Running specs ##
+
+Start by setting up your machine, then you can run the specs like normal:
+
+```bash
+./setup.sh install
+rake spec
+```
+
+## License ##
+
+(The MIT License)
+
+Copyright © 2013
+
+* [Magnus Bergmark](https://github.com/Mange) <magnus.bergmark@gmail.com>
+
+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.
+
+
+[roadie]: http://rubygems.org/gems/roadie
+[semver]: http://semver.org/
+[rdd]: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
+[gem]: http://rubygems.org/gems/roadie-rails
+
+[roadie2]: https://github.com/Mange/roadie/tree/2-4-stable

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+desc "Install gems for embedded Rails apps"
+task :install_gems do
+  sh "./setup.sh install"
+end
+
+desc "Run specs"
+task :spec do
+  sh "bundle exec rspec -f progress"
+end
+
+desc "Default: Install gems and run specs"
+task :default => [:install_gems, :spec]