inline_styles_mailer 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm --create ruby-1.9.2-p290@inline_styles_mailer
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bill Horsman
+
+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,53 @@
+## Inline Styles Mailer
+
+Using Jack Danger's excellent [Inline Styles](https://github.com/jackdanger/inline_styles) gem is even easier if you're using Rails 3.1 too.
+
+The Inline Styles gem helps you embed CSS styles into your markup so that you can send pretty HTML emails that won't get butchered by email clients that strip out CSS. Or, more precisely, will help reduce the amount of butchering (even with inline CSS some styles, like background images, are often cut out).
+
+## Installation
+
+If you're using bundler:
+
+```ruby
+gem 'inline_styles_mailer'
+```
+
+## Usage
+
+If you follow some conventions, then it's just one line:
+
+```ruby
+class FooMailer < ActionMailer::Base
+  include InlineStylesMailer
+
+  def foo(email)
+    mail(:to => email, :subject => "Foo foo!")
+  end
+
+end
+```
+
+If you have a CSS file <code>app/assets/stylesheets/_foo.css.scss</code> then it will get automatically applied to the mail using the inline_styles gem. That name (<code>_foo.css.scss</code>) is based on the mailer class name.
+
+Want to use a different file?
+
+```ruby
+class FooMailer < ActionMailer::Base
+  include InlineStylesMailer
+  use_stylesheet '_bar'
+
+
+  def foo(email)
+    mail(:to => email, :subject => "Foo foo!")
+  end
+
+end
+```
+
+The location of that file, and the fact that it uses [SASS](http://sass-lang.com/) is fixed at this time.
+
+## Development
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/billhorsman/inline_styles_mailer/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`.
+
+This gem was created by Bill Horsman and is under the MIT License.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/inline_styles_mailer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inline_styles_mailer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "inline_styles_mailer"
+  s.version     = InlineStylesMailer::VERSION
+  s.authors     = ["Bill Horsman"]
+  s.email       = ["bill@logicalcobwebs.com"]
+  s.homepage    = ""
+  s.summary     = %q{Convenient use of inline_styles gem with Rails 3.1}
+  s.description = %q{Convenient use of inline_styles gem with Rails 3.1}
+
+  s.rubyforge_project = "inline_styles_mailer"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "inline_styles"
+  s.add_runtime_dependency "rails", "~> 3.1"
+  s.add_runtime_dependency "sass-rails"
+end

data/lib/inline_styles_mailer/version.rb

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

data/lib/inline_styles_mailer.rb

@@ -0,0 +1,70 @@
+require "inline_styles"
+require "inline_styles_mailer/version"
+require "sass"
+
+module InlineStylesMailer
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def use_stylesheet(*stylesheets)
+      @stylesheets = Array(stylesheets)
+    end
+
+    def locate_css_file(stylesheet)
+      Rails.root.join("app", "assets", "stylesheets", "#{stylesheet}.css.scss")
+    end
+
+    def locate_template(name)
+      "#{self.name.underscore}/#{name}.html"
+    end
+
+    def css_content
+      puts "#{`pwd`}"
+      @stylesheets ||= ["_#{self.name.underscore}"]
+      @css_content ||= @stylesheets.map {|stylesheet|
+        file = locate_css_file(stylesheet)
+        if File.exist?(file)
+          puts "Processing #{file}"
+          Sass::Engine.new(File.read(file), syntax: :scss).render
+        else
+          puts "Skipping #{file}"
+          nil
+        end
+      }.compact.join
+    end
+
+    def locate_layout
+      "mailer"
+    end
+
+    def page
+      @page ||= InlineStyles::Page.new.with_css(css_content)
+    end
+
+  end
+
+  def mail(options, &block)
+    if block
+      super(mail, &block) # We'll just let this pass through
+    else
+      super(options) do |format|
+        # Only format for text if an appropriate template exists
+        # TODO we should be finding this file using Rails
+        unless Dir[Rails.root.join('app', 'views', self.class.name.underscore, "#{action_name}.text.*")].empty?
+          format.text do
+            render
+          end
+        end
+        format.html do
+          html = render_to_string :file => self.class.locate_template(action_name), :layout => self.class.locate_layout
+          render :text => self.class.page.with_html(html).apply
+        end
+      end
+    end
+  end
+
+end

data/spec/fixtures/assets/stylesheets/_foo_mailer.css.scss

@@ -0,0 +1,6 @@
+body {
+  background: yellow;
+  p {
+    color: red;
+  }
+}

data/spec/fixtures/layout.html.erb

@@ -0,0 +1,4 @@
+!!!
+%html
+  %body
+    = yield

data/spec/fixtures/views/foo_mailer/foo.html

@@ -0,0 +1 @@
+<p>Testing foo.</p>

data/spec/fixtures/views/layouts/mailer.html.erb

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/foo_mailer.rb

@@ -0,0 +1,10 @@
+require 'rails/all'
+
+class FooMailer < ActionMailer::Base
+  include InlineStylesMailer
+
+  def foo
+    mail(:to => "test@localhost", :subject => "Test")
+  end
+
+end

data/spec/inline_styles_mailer/inline_styles_mailer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'foo_mailer'
+require 'rails/all'
+
+describe InlineStylesMailer do
+
+  it "should instantiate FooMailer" do
+    FooMailer.should_receive(:locate_css_file).and_return(File.join("spec", "fixtures", "assets", "stylesheets", "_foo_mailer.css.scss"))
+    Rails.should_receive(:root).any_number_of_times.and_return(Pathname.new(File.join("spec", "fixtures")))
+    mail = FooMailer.foo
+    mail.body.should =~ /<p style="color: red;">Testing foo\.<\/p>/
+    mail.body.should =~ /<body style="background: yellow;">/
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'inline_styles_mailer'
+require 'rails/all'
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.prepend_view_path File.join(File.dirname(__FILE__), "fixtures", "views")
+
+Dir["#{File.dirname(__FILE__)}/fixtures/mailers/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: inline_styles_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bill Horsman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70169775483020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70169775483020
+- !ruby/object:Gem::Dependency
+  name: inline_styles
+  requirement: &70169775481920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70169775481920
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70169775480420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70169775480420
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: &70169775479080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70169775479080
+description: Convenient use of inline_styles gem with Rails 3.1
+email:
+- bill@logicalcobwebs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- inline_styles_mailer.gemspec
+- lib/inline_styles_mailer.rb
+- lib/inline_styles_mailer/version.rb
+- spec/fixtures/assets/stylesheets/_foo_mailer.css.scss
+- spec/fixtures/layout.html.erb
+- spec/fixtures/views/foo_mailer/foo.html
+- spec/fixtures/views/layouts/mailer.html.erb
+- spec/foo_mailer.rb
+- spec/inline_styles_mailer/inline_styles_mailer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1152225782059017698
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1152225782059017698
+requirements: []
+rubyforge_project: inline_styles_mailer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Convenient use of inline_styles gem with Rails 3.1
+test_files:
+- spec/fixtures/assets/stylesheets/_foo_mailer.css.scss
+- spec/fixtures/layout.html.erb
+- spec/fixtures/views/foo_mailer/foo.html
+- spec/fixtures/views/layouts/mailer.html.erb
+- spec/foo_mailer.rb
+- spec/inline_styles_mailer/inline_styles_mailer_spec.rb
+- spec/spec_helper.rb