inky-rb 1.3.6.0 → 1.3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3282f169829c4857894a4cb75b7ef6a5a96f3edc
-  data.tar.gz: 3bceb0ddb23bad1075e79ef58bad6040dbf7e17f
+  metadata.gz: 74de32d25371bce184fdc11c8bd97d240e91d6e8
+  data.tar.gz: 35d2d7fb902610d3cbe0ff3c1a7e259b65811483
 SHA512:
-  metadata.gz: a1ae7a6c393a72b2aa6c4a3f7d4ca463253a95f2b826f6a4e5032c2454efc4e1044d4e9bc25ca126eb618e4eb34c5024e92e2f3a0844f87af1c7846cc714ef83
-  data.tar.gz: 28240f7c706c4a3fa1dcc294f45a3c6f4f0e2d929780f7419fa5715c3e69a31f589e396c026a77947e21254f193e9a217cf144cf2a2262cfe37c0725c4e07fce
+  metadata.gz: a32921470b7797e53caa988ccef060bd6e4970980484d91af51e62dc447235893ba78933167c8788413fe9aacb7cd155532093e58a82787da3fa4938b66e9be8
+  data.tar.gz: 3e9f7ff46e9d6c722633a54e6f008eb6b4ad8ad58ba9c3be3aa96afdda52a4503caa9f604670fd6be53443e41c5a4d69fdec10a313202628d7ab4735f4dfafdc

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    inky-rb (0.0.3)
+    inky-rb (1.3.6.1)
       foundation_emails (~> 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
-    foundation_emails (2.1.0.1)
+    foundation_emails (2.2.0.0)
     rake (11.2.2)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec-core (3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
 
 PLATFORMS
   ruby
@@ -28,4 +28,4 @@ DEPENDENCIES
   rspec-expectations
 
 BUNDLED WITH
-   1.12.4
+   1.11.2

data/README.md

@@ -1,7 +1,11 @@
 # Inky
 
+[![Gem Version](https://badge.fury.io/rb/inky-rb.svg)](https://badge.fury.io/rb/inky-rb)
+
 Inky is an HTML-based templating language that converts simple HTML into complex, responsive email-ready HTML. Designed for [Foundation for Emails](http://foundation.zurb.com/emails), a responsive email framework from [ZURB](http://zurb.com).
 
+To include only the Foundation for Emails styles in your Asset Pipeline, without Inky, use the [**foundation_emails**](https://github.com/zurb/foundation-emails/#using-the-ruby-gem) gem.
+
 Give Inky simple HTML like this:
 
 ```html
@@ -52,13 +56,14 @@ Then execute:
 bundle install
 ```
 
-Make sure that the stylesheet included in your email layout imports the Foundation for Emails styles:
+Run the following command to set up the required styles and mailer layout:
 
-```scss
-// my_awesome_emails_stylesheet.scss
-@import "foundation-emails";
+```bash
+rails g inky:install
 ```
 
+(You can specify the generated mailer layout filename like so: `rails g inky:install some_name`)
+
 Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use ERB within the `.inky` templates:
 
 ```
@@ -68,7 +73,7 @@ pw_reset.html.erb => pw_reset.html.inky
 
 You're all set!
 
-** The majority of email clients ignore linked stylesheets. By inlining your referenced styles, `premailer-rails` lets you keep your markup and stylesheets in separate files.
+** The majority of email clients ignore linked stylesheets. By using a CSS inliner like `premailer-rails` or `roadie`, you're able to leave your stylesheets in a separate file, keeping your markup lean.
 
 ## Custom Elements
 

data/lib/generators/inky/install_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators'
+
+module Inky
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Install Foundation for Emails'
+      source_root File.join(File.dirname(__FILE__), 'templates')
+      argument :layout_name, :type => :string, :default => 'mailer', :banner => 'layout_name'
+
+      def preserve_original_mailer_layout
+        return nil unless layout_name == 'mailer'
+
+        original_mailer = File.join(layouts_base_dir, 'mailer.html.erb')
+        rename_filename = File.join(layouts_base_dir, "old_mailer_#{Time.now.to_i}.html.erb")
+        File.rename(original_mailer, rename_filename) if File.exists? original_mailer
+      end
+
+      def create_mailer_stylesheet
+        template 'foundation_emails.scss', File.join(stylesheets_base_dir, 'foundation_emails.scss')
+      end
+
+      def create_mailer_layout
+        template 'mailer_layout.html.erb', File.join(layouts_base_dir, "#{layout_name.underscore}.html.erb")
+      end
+
+      private
+
+      def stylesheets_base_dir
+        File.join('app', 'assets', 'stylesheets')
+      end
+
+      def layouts_base_dir
+        File.join('app', 'views', 'layouts')
+      end
+    end
+  end
+end

data/lib/generators/inky/templates/foundation_emails.scss

@@ -0,0 +1 @@
+@import "foundation-emails";

data/lib/generators/inky/templates/mailer_layout.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width" />
+
+    <%%= stylesheet_link_tag "foundation_emails" %>
+  </head>
+
+  <body>
+    <table class="body" data-made-with-foundation>
+      <tr>
+        <td class="center" align="center" valign="top">
+          <center>
+            <%%= yield %>
+          </center>
+        </td>
+      </tr>
+    </table>
+  </body>
+</html>

data/lib/inky/rails/version.rb

@@ -1,5 +1,5 @@
 module Inky
   module Rails
-    VERSION = "1.3.6.0"
+    VERSION = "1.3.6.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inky-rb
 version: !ruby/object:Gem::Version
-  version: 1.3.6.0
+  version: 1.3.6.1
 platform: ruby
 authors:
 - ZURB
@@ -68,6 +68,9 @@ files:
 - Rakefile
 - inky.gemspec
 - lib/component_factory.rb
+- lib/generators/inky/install_generator.rb
+- lib/generators/inky/templates/foundation_emails.scss
+- lib/generators/inky/templates/mailer_layout.html.erb
 - lib/inky.rb
 - lib/inky/rails/engine.rb
 - lib/inky/rails/template_handler.rb
@@ -94,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Inky is an HTML-based templating language that converts simple HTML into
@@ -104,4 +107,3 @@ test_files:
 - spec/components_spec.rb
 - spec/grid_spec.rb
 - spec/spec_helper.rb
-has_rdoc: