RubyGems - roadie-rails - Versions diffs - 1.0.0.pre1 - Mend

roadie-rails 1.0.0.pre1

Files changed (166) hide show

data/Upgrading.md ADDED

@@ -0,0 +1,70 @@
+# Upgrading from Roadie 2
+## Project
+Start by adding `roadie-rails` to your `Gemfile`. Remember to specify version requirements!
+You'll need to change your configuration too. The main change is that Roadie now uses its own configuration for URL options:
+```ruby
+config.roadie.url_options = {host: "myapp.com"}
+```
+Most other options should be easy to convert:
+```ruby
+config.roadie.enabled => Removed
+# Override `#roadie_options` in the mailers to control enabling (if using Automatic) or do it manually (if using Mailer).
+config.roadie.before_inlining => config.roadie.before_transformation
+config.roadie.provider => config.roadie.asset_providers
+```
+## Mailers
+Next, find all mailers that you want to inline and include the `Roadie::Rails::Automatic` module:
+```ruby
+class MyMailer < ActionMailer::Base
+  include Roadie::Rails::Automatic
+  def cool_mail
+    mail(options)
+  end
+end
+```
+You'll also need to remove any uses of the `:css` option to `mail` and `default_options`. Include CSS files by using `stylesheet_link_tag` instead.
+**Before:**
+```ruby
+class MyMailer < ActionMailer::Base
+  defaults css: :email
+  def cool
+    mail(css: [:email, :cool])
+  end
+end
+```
+** After:**
+```erb
+<head>
+  <%= stylesheet_link_tag :email, :cool %>
+</head>
+```
+## Views
+Search through your templates after uses of `data-immutable` and change them to `data-roadie-ignore`.
+## Tests
+If your tests relied on the styles being applied, they will fail unless you deliver the email. `Roadie::Rails::Automatic` does not inline stylesheets when you don't deliver the email. Either change how your tests work, or call `deliver` on the generated emails where you need it. If the problem is major, switch from `Roadie::Rails::Automatic` to `Roadie::Rails::Mailer` and follow the instructions in the documentation.
+## Custom asset providers
+The API has changed a bit. Read the new examples in the README and you should be able to convert without any great effort.

data/lib/roadie-rails.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'roadie/rails'

data/lib/roadie/rails.rb ADDED

@@ -0,0 +1,21 @@
+module Roadie
+  module Rails
+  end
+end
+require "roadie"
+require "roadie/rails/version"
+require "roadie/rails/options"
+require "roadie/rails/document_builder"
+require "roadie/rails/mail_inliner"
+require "roadie/rails/asset_pipeline_provider"
+require "roadie/rails/mailer"
+require "roadie/rails/automatic"
+require "roadie/rails/inline_on_delivery"
+require "roadie/rails/railtie"

data/lib/roadie/rails/asset_pipeline_provider.rb ADDED

@@ -0,0 +1,24 @@
+module Roadie
+  module Rails
+    class AssetPipelineProvider
+      include Roadie::AssetProvider
+      attr_reader :pipeline
+      def initialize(pipeline)
+        super()
+        @pipeline = pipeline
+      end
+      def find_stylesheet(name)
+        if (asset = @pipeline[normalize_asset_name name])
+          Stylesheet.new("#{asset.pathname} (live compiled)", asset.to_s)
+        end
+      end
+      private
+      def normalize_asset_name(href)
+        File.basename href.split('?').first
+      end
+    end
+  end
+end

data/lib/roadie/rails/automatic.rb ADDED

@@ -0,0 +1,16 @@
+module Roadie
+  module Rails
+    module Automatic
+      def mail(*args, &block)
+        super.tap do |email|
+          email.extend InlineOnDelivery
+          email.roadie_options = roadie_options.dup
+        end
+      end
+      def roadie_options
+        ::Rails.application.config.roadie
+      end
+    end
+  end
+end

data/lib/roadie/rails/document_builder.rb ADDED

@@ -0,0 +1,18 @@
+module Roadie
+  module Rails
+    class DocumentBuilder
+      class << self
+        def build(html, options)
+          new.build(html, options)
+        end
+        private :new
+      end
+      def build(html, options)
+        document = Document.new(html)
+        options.apply_to document
+        document
+      end
+    end
+  end
+end

data/lib/roadie/rails/inline_on_delivery.rb ADDED

@@ -0,0 +1,17 @@
+module Roadie
+  module Rails
+    # Extend instances of Mail with this to have it inlined automatically when
+    # delivered. You'll need to assign some #roadie_options for it to actually
+    # do anything.
+    module InlineOnDelivery
+      attr_accessor :roadie_options
+      def deliver
+        if (options = roadie_options)
+          MailInliner.new(self, options).execute
+        end
+        super
+      end
+    end
+  end
+end

data/lib/roadie/rails/mail_inliner.rb ADDED

@@ -0,0 +1,26 @@
+module Roadie
+  module Rails
+    class MailInliner
+      attr_reader :email, :options
+      def initialize(email, options)
+        @email = email
+        @options = options
+      end
+      def execute
+        improve_html_part(email.html_part) if email.html_part
+        email
+      end
+      private
+      def improve_html_part(html_part)
+        html_part.body = make_new_html(html_part.body.decoded)
+      end
+      def make_new_html(old_html)
+        DocumentBuilder.build(old_html, options).transform
+      end
+    end
+  end
+end

data/lib/roadie/rails/mailer.rb ADDED

@@ -0,0 +1,14 @@
+module Roadie
+  module Rails
+    module Mailer
+      def roadie_mail(options = {}, &block)
+        email = mail(options, &block)
+        MailInliner.new(email, roadie_options).execute
+      end
+      def roadie_options
+        ::Rails.application.config.roadie
+      end
+    end
+  end
+end

data/lib/roadie/rails/options.rb ADDED

@@ -0,0 +1,101 @@
+module Roadie
+  module Rails
+    class Options
+      private
+      ATTRIBUTE_NAMES = [:url_options, :before_transformation, :after_transformation, :asset_providers]
+      public
+      attr_reader *ATTRIBUTE_NAMES
+      def initialize(options = {})
+        complain_about_unknown_keys options.keys
+        self.url_options           = options[:url_options]
+        self.before_transformation = options[:before_transformation]
+        self.after_transformation  = options[:after_transformation]
+        self.asset_providers       = options[:asset_providers]
+      end
+      def url_options=(options)
+        @url_options = options
+      end
+      def before_transformation=(callback)
+        @before_transformation = callback
+      end
+      def after_transformation=(callback)
+        @after_transformation = callback
+      end
+      def asset_providers=(providers)
+        if providers
+          @asset_providers = ProviderList.wrap providers
+        end
+      end
+      def apply_to(document)
+        document.url_options = url_options
+        document.before_transformation = before_transformation
+        document.after_transformation = after_transformation
+        document.asset_providers = asset_providers
+      end
+      def merge(options)
+        dup.merge! options
+      end
+      def merge!(options)
+        [:url_options, :before_transformation, :after_transformation, :asset_providers].each do |attribute|
+          send "#{attribute}=", options.fetch(attribute, send(attribute))
+        end
+        self
+      end
+      def combine(options)
+        dup.combine! options
+      end
+      def combine!(options)
+        self.url_options = combine_hash url_options, options[:url_options]
+        self.before_transformation = combine_callable before_transformation, options[:before_transformation]
+        self.after_transformation = combine_callable after_transformation, options[:after_transformation]
+        self.asset_providers = combine_providers asset_providers, options[:asset_providers]
+        self
+      end
+      private
+      def combine_hash(first, second)
+        combine_nilable(first, second) do |a, b|
+          a.merge(b)
+        end
+      end
+      def combine_callable(first, second)
+        combine_nilable(first, second) do |a, b|
+          proc { |*args| a.call(*args); b.call(*args) }
+        end
+      end
+      def combine_providers(first, second)
+        combine_nilable(first, second) do |a, b|
+          ProviderList.new a.to_a + Array.wrap(b)
+        end
+      end
+      def combine_nilable(first, second)
+        if first && second
+          yield first, second
+        else
+          first ? first : second
+        end
+      end
+      def complain_about_unknown_keys(keys)
+        invalid_keys = keys - ATTRIBUTE_NAMES
+        if invalid_keys.size > 0
+          raise ArgumentError, "Unknown configuration parameters: #{invalid_keys}", caller(1)
+        end
+      end
+    end
+  end
+end

data/lib/roadie/rails/railtie.rb ADDED

@@ -0,0 +1,22 @@
+require 'rails'
+module Roadie
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.roadie = Roadie::Rails::Options.new
+      initializer "roadie-rails.setup" do |app|
+        config.roadie.asset_providers = [
+          Roadie::FilesystemProvider.new(::Rails.root.join("public").to_s),
+        ]
+        # Saying config.assets.enabled here does not work in Rails 3.1-3.2, but
+        # APP.config.assets work. There is a difference between "config" and
+        # "app.config" on those versions.
+        if app.config.respond_to?(:assets) && app.config.assets.enabled != false
+          config.roadie.asset_providers << AssetPipelineProvider.new(app.assets)
+        end
+      end
+    end
+  end
+end

data/lib/roadie/rails/version.rb ADDED

@@ -0,0 +1,5 @@
+module Roadie
+  module Rails
+    VERSION = "1.0.0.pre1"
+  end
+end

data/roadie-rails.gemspec ADDED

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roadie/rails/version'
+Gem::Specification.new do |spec|
+  spec.name          = "roadie-rails"
+  spec.version       = Roadie::Rails::VERSION
+  spec.authors       = ["Magnus Bergmark"]
+  spec.email         = ["magnus.bergmark@gmail.com"]
+  spec.homepage      = 'http://github.com/Mange/roadie-rails'
+  spec.summary       = %q{Making HTML emails comfortable for the Rails rockstars}
+  spec.description   = %q{Hooks Roadie into your Rails application to help with email generation.}
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.extra_rdoc_files = %w[README.md Changelog.md LICENSE.txt]
+  spec.require_paths = ["lib"]
+  spec.add_dependency "roadie", "~> 3.0.0.pre1"
+  spec.add_dependency "rails", ">= 3.0", "< 4.2"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-collection_matchers"
+end

data/setup.sh ADDED

@@ -0,0 +1,62 @@
+#!/bin/bash
+# This cannot be executed from within a Ruby-based environment (like Rake)
+# since Bundler will affect the subshell environments.
+set -e
+function header() {
+  echo -e "\n$(tput setaf 5)$(tput smul)$1:$(tput sgr0)"
+}
+function green() {
+  echo $(tput setaf 2)$@$(tput sgr0)
+}
+function update() {
+  bundle update | grep -ve "^Using "
+}
+function install() {
+  bundle install --quiet && green "  OK"
+}
+root=$(dirname $0)
+# Set by Travis CI; interferes with the nested repos
+unset BUNDLE_GEMFILE
+if [[ $1 == "install" ]]; then
+  header "Installing gem dependencies"
+  install
+  for app_path in $root/spec/railsapps/rails_*; do
+    (
+      cd $app_path
+      header "Installing gems for $(basename $app_path)"
+      install
+    )
+  done
+  echo ""
+elif [[ $1 == "update" ]]; then
+  header "Updating gem dependencies"
+  update
+  for app_path in $root/spec/railsapps/rails_*; do
+    (
+      cd $app_path
+      header "Updating $(basename $app_path)"
+      update
+    )
+  done
+  echo ""
+else
+  echo "Usage: $0 [install|update]"
+  echo ""
+  echo "  Install: Install all bundled updates."
+  echo "  Update: Run bundle update on all bundles."
+  echo ""
+  exit 127
+fi