inky-rb 1.3.7.0 → 1.3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4008c29bb92a467214a676eb6dfa34286f7333
-  data.tar.gz: 2a5e4bf73fe574f8d952aed07ad6324c7aecfdad
+  metadata.gz: 77c176107d789eb48bb01a6d4f6d75713f67d062
+  data.tar.gz: 3caf4fac84fadda5c06c8bce1a77b01a6cd443aa
 SHA512:
-  metadata.gz: 0c67e33eb5035b4e02333642e3781eb70292bb7b1b2dcdf3fc3af6d54c8802f7085f232cbef1bb9198f3a0f048b2b926b510631aa72f8c841d95d594c14a5bef
-  data.tar.gz: 6f1d96ad26149214322c00e279f8ffbea12c531f9d30848c1d43af5b5beec3d08187580c82e9b90f34dcd8269c945d6090d7a47f66664aa9d01b311639def83b
+  metadata.gz: c9d7938d47cbe1cfe38b36a04d27839a4f8af211a3657814d5f71cfd805de0402bd51c13d3a097a4d908b691ec5482da8cf26cd8432daf972243187d3885d7d2
+  data.tar.gz: 8cadd7b1c791284697612b8a87e2cb7b88a270f3e407c1cca6273d73c826824e33d9006ae10167438f6a113da79b2c832803ed047940a51da472d1154fb4b258

data/.gitignore

@@ -1,3 +1,5 @@
 *.swp
 pkg
 spec/_cases_output
+spec/test_app/log/*.log
+spec/test_app/tmp/

data/Gemfile.lock

@@ -1,28 +1,110 @@
 PATH
   remote: .
   specs:
-    inky-rb (1.3.7.0)
+    inky-rb (1.3.7.1)
       foundation_emails (~> 2)
       nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    arel (6.0.3)
     ast (2.3.0)
+    builder (3.2.2)
+    capybara (2.7.0)
+      addressable
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    concurrent-ruby (1.0.2)
     diff-lcs (1.2.5)
+    erubis (2.7.0)
     foundation_emails (2.2.1.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
+    minitest (5.9.1)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
     parser (2.3.1.4)
       ast (~> 2.2)
     powerpack (0.1.1)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rainbow (2.1.0)
-    rake (11.2.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
+    rake (11.3.0)
     rspec-core (3.5.0)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
@@ -31,6 +113,14 @@ GEM
     rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     rubocop (0.43.0)
       parser (>= 2.3.1.1, < 3.0)
@@ -39,19 +129,40 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.7.5)
+    slim (3.0.6)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    temple (0.7.6)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     unicode-display_width (1.1.1)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.6)
+  capybara
   inky-rb!
+  rails
   rake
-  rspec
   rspec-core
   rspec-expectations
+  rspec-rails
   rubocop
+  slim
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -62,19 +62,44 @@ Run the following command to set up the required styles and mailer layout:
 rails g inky:install
 ```
 
-(You can specify the generated mailer layout filename like so: `rails g inky:install some_name`)
+(You can specify the generated mailer layout filename like so: `rails g inky:install some_name` and also your prefered
+markup language like: `rails g inky:install mailer_layout slim`)
 
-Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use ERB within the `.inky` templates:
+Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use your default
+template engine within the `.inky` templates:
 
 ```
 welcome.html      => welcome.html.inky
 pw_reset.html.erb => pw_reset.html.inky
 ```
 
+
 You're all set!
 
 ** 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.
 
+## Alternative template engine
+
+If you do not use ERB for your views and layouts but some other markup like Haml or Slim, you can configure Inky to
+use these languages. To do so, just set an initializer:
+
+```ruby
+# config/initializers/inky.rb
+Inky.configure do |config|
+  config.template_engine = :slim
+end
+```
+
+Check [lib/generators/inky/templates/mailer_layout.html.slim](lib/generators/inky/templates/mailer_layout.html.slim)
+for a Slim example.
+
+You may prefer to specify which template engine to use before inky:
+
+```
+welcome.html.haml => welcome.html.inky-haml
+pw_reset.html.erb => pw_reset.html.inky-erb
+```
+
 ## Custom Elements
 
 Inky simplifies the process of creating HTML emails by expanding out simple tags like `<row>` and `<column>` into full table syntax. The names of the tags can be changed with the `components` setting.

data/inky.gemspec

@@ -13,12 +13,16 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files -z`.split("\x0")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.test_files    = Dir['spec/**/*']
 
   s.add_dependency "foundation_emails", "~> 2"
   s.add_dependency "nokogiri"
   s.add_development_dependency "bundler", "~> 1.6"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
   s.add_development_dependency "rubocop"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "rails"
+  s.add_development_dependency "slim"
+  # s.add_development_dependency "pry-byebug"
 end

data/lib/generators/inky/install_generator.rb

@@ -6,11 +6,12 @@ module Inky
       desc 'Install Foundation for Emails'
       source_root File.join(File.dirname(__FILE__), 'templates')
       argument :layout_name, type: :string, default: 'mailer', banner: 'layout_name'
+      argument :extension,   type: :string, default: 'erb',    banner: 'extension'
 
       def preserve_original_mailer_layout
         return unless layout_name == 'mailer'
 
-        original_mailer = File.join(layouts_base_dir, 'mailer.html.erb')
+        original_mailer = File.join(layouts_base_dir, "mailer.html.#{extension}")
         rename_filename = File.join(layouts_base_dir, "old_mailer_#{Time.now.to_i}.html.erb")
         File.rename(original_mailer, rename_filename) if File.exist? original_mailer
       end
@@ -20,7 +21,7 @@ module Inky
       end
 
       def create_mailer_layout
-        template 'mailer_layout.html.erb', File.join(layouts_base_dir, "#{layout_name.underscore}.html.erb")
+        template "mailer_layout.html.#{extension}", File.join(layouts_base_dir, "#{layout_name.underscore}.html.#{extension}")
       end
 
       private

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

@@ -4,7 +4,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta name="viewport" content="width=device-width" />
 
-    <%%= stylesheet_link_tag "foundation_emails" %>
+    <%= stylesheet_link_tag "foundation_emails" %>
   </head>
 
   <body>
@@ -12,7 +12,7 @@
       <tr>
         <td class="center" align="center" valign="top">
           <center>
-            <%%= yield %>
+            <%= yield %>
           </center>
         </td>
       </tr>

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

@@ -0,0 +1,13 @@
+!!! Strict
+%html{:xmlns => "http://www.w3.org/1999/xhtml"}
+  %head
+    %meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}/
+    %meta{:content => "width=device-width", :name => "viewport"}/
+    = stylesheet_link_tag "foundation_emails"
+  %body
+    %table.body{"data-made-with-foundation" => ""}
+      %tr
+        %td.center{:align => "center", :valign => "top"}
+          %center
+            %container
+              = yield

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

@@ -0,0 +1,15 @@
+doctype strict
+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"
+
+  body
+    table.body data-made-with-foundation=""
+      tr
+        td.center align="center" valign="top"
+          center
+            container
+              = yield

data/lib/inky.rb

@@ -1,7 +1,9 @@
+require 'nokogiri'
+require_relative 'inky/configuration'
+require_relative 'inky/component_factory'
+
 module Inky
   class Core
-    require 'nokogiri'
-    require_relative 'component_factory'
     attr_accessor :components, :column_count, :component_lookup, :component_tags
 
     include ComponentFactory
@@ -28,14 +30,13 @@ module Inky
       self.component_tags = components.values
     end
 
-    def release_the_kraken(xml_string)
-      xml_string = xml_string.gsub(/doctype/i, 'DOCTYPE')
-      raws, str = Inky::Core.extract_raws(xml_string)
+    def release_the_kraken(html_string)
+      html_string.force_encoding('utf-8') # transform_doc barfs if encoding is ASCII-8bit
+      html_string = html_string.gsub(/doctype/i, 'DOCTYPE')
+      raws, str = Inky::Core.extract_raws(html_string)
       parse_cmd = str =~ /<html/i ? :parse : :fragment
       html = Nokogiri::HTML.public_send(parse_cmd, str)
-      html.elements.each do |elem|
-        transform_doc(elem)
-      end
+      transform_doc(html)
       string = html.to_html(encoding: 'US-ASCII')
       Inky::Core.re_inject_raws(string, raws)
     end

data/lib/inky/component_factory.rb

@@ -0,0 +1,139 @@
+module Inky
+  module ComponentFactory
+    def component_factory(elem)
+      transform_method = :"_transform_#{component_lookup[elem.name]}"
+      return unless respond_to?(transform_method)
+      inner = elem.children.map(&:to_s).join
+      send(transform_method, elem, inner)
+    end
+
+    tags = %w[class id href size large no-expander small target]
+    tags = tags.to_set if tags.respond_to? :to_set
+    IGNORED_ON_PASSTHROUGH = tags.freeze
+
+    def _pass_through_attributes(elem)
+      elem.attributes.reject { |e| IGNORED_ON_PASSTHROUGH.include?(e.downcase) }.map do |name, value|
+        %{#{name}="#{value}" }
+      end.join
+    end
+
+    def _has_class(elem, klass)
+      elem.attr('class') =~ /(^|\s)#{klass}($|\s)/
+    end
+
+    def _combine_classes(elem, extra_classes)
+      [elem['class'], extra_classes].join(' ')
+    end
+
+    def _combine_attributes(elem, extra_classes = nil)
+      classes = _combine_classes(elem, extra_classes)
+      [_pass_through_attributes(elem), classes && %{class="#{classes}"}].join
+    end
+
+    def _target_attribute(elem)
+      elem.attributes['target'] ? %{ target="#{elem.attributes['target']}"} : ''
+    end
+
+    def _transform_button(component, inner)
+      expand = _has_class(component, 'expand')
+      if component.attr('href')
+        target = _target_attribute(component)
+        extra = ' align="center" class="float-center"' if expand
+        inner = %{<a href="#{component.attr('href')}"#{target}#{extra}>#{inner}</a>}
+      end
+      inner = "<center>#{inner}</center>" if expand
+
+      classes = _combine_classes(component, 'button')
+      expander = '<td class="expander"></td>' if expand
+      %{<table class="#{classes}"><tr><td><table><tr><td>#{inner}</td></tr></table></td>#{expander}</tr></table>}
+    end
+
+    def _transform_menu(component, inner)
+      attributes = _combine_attributes(component, 'menu')
+      %{<table #{attributes}><tr><td><table><tr>#{inner}</tr></table></td></tr></table>}
+    end
+
+    def _transform_menu_item(component, inner)
+      target = _target_attribute(component)
+      attributes = _combine_attributes(component, 'menu-item')
+      %{<th #{attributes}><a href="#{component.attr('href')}"#{target}>#{inner}</a></th>}
+    end
+
+    def _transform_container(component, inner)
+      attributes = _combine_attributes(component, 'container')
+      %{<table #{attributes} align="center"><tbody><tr><td>#{inner}</td></tr></tbody></table>}
+    end
+
+    def _transform_row(component, inner)
+      attributes = _combine_attributes(component, 'row')
+      %{<table #{attributes}><tbody><tr>#{inner}</tr></tbody></table>}
+    end
+
+    # in inky.js this is factored out into makeClumn.  TBD if we need that here.
+    def _transform_columns(component, inner)
+      col_count = component.parent.elements.size
+
+      small_val = component.attr('small')
+      large_val = component.attr('large')
+
+      small_size = small_val || column_count
+      large_size = large_val || small_val || (column_count / col_count).to_i
+
+      classes = _combine_classes(component, "small-#{small_size} large-#{large_size} columns")
+
+      classes << ' first' unless component.previous_element
+      classes << ' last' unless component.next_element
+
+      subrows = component.elements.css(".row").to_a.concat(component.elements.css("row").to_a)
+      expander = %{<th class="expander"></th>} if large_size.to_i == column_count && subrows.empty?
+
+      %{<th class="#{classes}" #{_pass_through_attributes(component)}><table><tr><th>#{inner}</th>#{expander}</tr></table></th>}
+    end
+
+    def _transform_block_grid(component, inner)
+      classes = _combine_classes(component, "block-grid up-#{component.attr('up')}")
+      %{<table class="#{classes}"><tr>#{inner}</tr></table>}
+    end
+
+    def _transform_center(component, _inner)
+      # NOTE:  Using children instead of elements because elements.to_a
+      # sometimes appears to miss elements that show up in size
+      component.elements.each do |child|
+        child['align'] = 'center'
+        child['class'] = _combine_classes(child, 'float-center')
+        items = component.elements.css(".menu-item").to_a.concat(component.elements.css("item").to_a)
+        items.each do |item|
+          item['class'] = _combine_classes(item, 'float-center')
+        end
+      end
+      component.to_s
+    end
+
+    def _transform_callout(component, inner)
+      classes = _combine_classes(component, 'callout-inner')
+      attributes = _pass_through_attributes(component)
+      %{<table #{attributes}class="callout"><tr><th class="#{classes}">#{inner}</th><th class="expander"></th></tr></table>}
+    end
+
+    def _transform_spacer(component, _inner)
+      classes = _combine_classes(component, 'spacer')
+      build_table = ->(size, extra) { %{<table class="#{classes} #{extra}"><tbody><tr><td height="#{size}px" style="font-size:#{size}px;line-height:#{size}px;">&#xA0;</td></tr></tbody></table>} }
+      size = component.attr('size')
+      size_sm = component.attr('size-sm')
+      size_lg = component.attr('size-lg')
+      if size_sm || size_lg
+        html = ''
+        html << build_table[size_sm, 'hide-for-large'] if size_sm
+        html << build_table[size_lg, 'show-for-large'] if size_lg
+        html
+      else
+        build_table[size || 16, nil]
+      end
+    end
+
+    def _transform_wrapper(component, inner)
+      attributes = _combine_attributes(component, 'wrapper')
+      %{<table #{attributes} align="center"><tr><td class="wrapper-inner">#{inner}</td></tr></table>}
+    end
+  end
+end