bootstrap-email 1.0.0.alpha1 → 1.0.0.alpha3

data/lib/bootstrap-email/config.rb

@@ -0,0 +1,50 @@
+module BootstrapEmail
+  class Config
+    attr_writer :sass_email_location # path to main sass file
+    attr_writer :sass_head_location  # path to head sass file
+    attr_writer :sass_load_paths     # array of directories for loading sass imports
+    attr_writer :sass_cache_location # path to tmp folder for sass cache
+    attr_writer :sass_log_enabled    # turn on or off sass log when caching new sass
+
+    def load_options(options)
+      file = File.expand_path('bootstrap-email.config.rb', Dir.pwd)
+      if options[:config_path]
+        require_relative options[:config_path]
+      elsif File.exist?(file)
+        require_relative file
+      end
+      options.each { |name, value| instance_variable_set("@#{name}", value) }
+    end
+
+    def sass_location_for(type:)
+      ivar = instance_variable_get("@sass_#{type.sub('bootstrap-', '')}_location")
+      return ivar if ivar
+
+      lookup_locations = ["#{type}.scss", "app/assets/stylesheets/#{type}.scss"]
+      locations = lookup_locations.map { |location| File.expand_path(location, Dir.pwd) }.select { |location| File.exist?(location) }
+      locations.first if locations.any?
+    end
+
+    def sass_load_paths
+      paths_array = [SassCache::SASS_DIR]
+      @sass_load_paths ||= []
+      paths_array.concat(@sass_load_paths)
+    end
+
+    def sass_cache_location
+      @sass_cache_location ||= begin
+        if defined?(::Rails) && ::Rails.root
+          ::Rails.root.join('tmp', 'cache', 'bootstrap-email', '.sass-cache')
+        elsif File.writable?(Dir.pwd)
+          File.join(Dir.pwd, '.sass-cache', 'bootstrap-email')
+        else
+          File.join(Dir.tmpdir, '.sass-cache', 'bootstrap-email')
+        end
+      end
+    end
+
+    def sass_log_enabled?
+      defined?(@sass_log_enabled) ? @sass_log_enabled : true
+    end
+  end
+end

data/lib/bootstrap-email/{components → converters}/alert.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Alert < Base
       def build
         each_node('.alert') do |node|

data/lib/bootstrap-email/converters/align.rb

@@ -0,0 +1,22 @@
+module BootstrapEmail
+  module Converter
+    class Align < Base
+      def build
+       ['left', 'center', 'right'].each do |type|
+        full_type = "align-#{type}"
+         each_node(".#{full_type}") do |node|
+           align_helper(node, full_type, type)
+         end
+       end
+      end
+
+      def align_helper(node, full_type, type)
+        unless table?(node) || td?(node)
+          node['class'] = node['class'].sub(full_type, '')
+          node = node.replace(template('table', classes: full_type, contents: node.to_html))[0]
+        end
+        node['align'] = type
+      end
+    end
+  end
+end

data/lib/bootstrap-email/{components → converters}/badge.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Badge < Base
       def build
         each_node('.badge') do |node|

data/lib/bootstrap-email/converters/base.rb

@@ -0,0 +1,62 @@
+module BootstrapEmail
+  module Converter
+    class Base
+      attr_reader :doc
+      def initialize(doc)
+        @doc = doc
+        @cached_templates = {}
+      end
+
+      def self.build(doc)
+        new(doc).build
+      end
+
+      private
+
+      def template(file, locals_hash = {})
+        locals_hash[:classes] = locals_hash[:classes].split.join(' ') if locals_hash[:classes]
+        if @cached_templates[file]
+          string = @cached_templates[file]
+        else
+          path = File.expand_path("../../../core/templates/#{file}.html", __dir__)
+          string = File.read(path).chop # read and remove trailing newline
+          @cached_templates[file] = string
+        end
+        locals_hash.each do |key, value|
+          string = string.sub("{{ #{key} }}", value.to_s)
+        end
+        string
+      end
+
+      def each_node(css_lookup, &blk)
+        # sort by youngest child and traverse backwards up the tree
+        doc.css(css_lookup).sort_by { |n| n.ancestors.size }.reverse!.each(&blk)
+      end
+
+      def add_class(node, class_name)
+        node['class'] ||= ''
+        node['class'] += class_name
+      end
+
+      def margin?(node)
+        margin_top?(node) || margin_bottom?(node)
+      end
+
+      def margin_top?(node)
+        node['class'].to_s.match?(/m[ty]{1}-(lg-)?\d+/)
+      end
+
+      def margin_bottom?(node)
+        node['class'].to_s.match?(/m[by]{1}-(lg-)?\d+/)
+      end
+
+      def table?(node)
+        node.name == 'table'
+      end
+
+      def td?(node)
+        node.name == 'td'
+      end
+    end
+  end
+end

data/lib/bootstrap-email/converters/block.rb

@@ -0,0 +1,13 @@
+module BootstrapEmail
+  module Converter
+    class Block < Base
+      def build
+        each_node('block, .to-table') do |node|
+          # add .to-table if it's not already there
+          class_name = node['class'].to_s.split << 'to-table'
+          node.replace(template('table', classes: class_name.uniq.join(' '), contents: node.inner_html))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/converters/body.rb

@@ -0,0 +1,10 @@
+module BootstrapEmail
+  module Converter
+    class Body < Base
+      def build
+        body = doc.at_css('body')
+        body.inner_html = template('body', classes: "#{body['class']} body", contents: body.inner_html)
+      end
+    end
+  end
+end

data/lib/bootstrap-email/{components → converters}/button.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Button < Base
       def build
         each_node('.btn') do |node|

data/lib/bootstrap-email/{components → converters}/card.rb

@@ -1,12 +1,12 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Card < Base
       def build
         each_node('.card') do |node|
-          node.replace(template('table', classes: node['class'], contents: node.delete('class') && node.inner_html))
+          node.replace(template('table', classes: node['class'], contents: node.inner_html))
         end
         each_node('.card-body') do |node|
-          node.replace(template('table', classes: node['class'], contents: node.delete('class') && node.inner_html))
+          node.replace(template('table', classes: node['class'], contents: node.inner_html))
         end
       end
     end

data/lib/bootstrap-email/{components → converters}/color.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Color < Base
       def build
         each_node('*[class*=bg-]') do |node|

data/lib/bootstrap-email/{components → converters}/container.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Container < Base
       def build
         each_node('.container') do |node|

data/lib/bootstrap-email/converters/force_encoding.rb

@@ -0,0 +1,16 @@
+module BootstrapEmail
+  module Converter
+    class ForceEncoding < Base
+      def build
+        body = doc.at_css('body')
+        body.add_child('<force-encoding></force-encoding>')
+      end
+
+      def self.replace(html)
+        # force utf-8 character encoded in iOS Mail: https://github.com/bootstrap-email/bootstrap-email/issues/50
+        # this needs to be done after the document has been outputted to a string so it doesn't get converted
+        html.sub('<force-encoding></force-encoding>', '<div id="force-encoding-to-utf-8" style="display: none;">&#10175;</div>')
+      end
+    end
+  end
+end

data/lib/bootstrap-email/converters/grid.rb

@@ -0,0 +1,14 @@
+module BootstrapEmail
+  module Converter
+    class Grid < Base
+      def build
+        each_node('.row') do |node|
+          node.replace(template('table-to-tr', classes: node['class'], contents: node.inner_html))
+        end
+        each_node('*[class*=col]') do |node|
+          node.replace(template('td', classes: node['class'], contents: node.inner_html))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/converters/head_style.rb

@@ -0,0 +1,33 @@
+module BootstrapEmail
+  module Converter
+    class HeadStyle < Base
+      def build
+        doc.at_css('head').add_child(bootstrap_email_head)
+      end
+
+      private
+
+      def bootstrap_email_head
+        html_string = <<-INLINE
+          <style type="text/css">
+            #{purged_css_from_head}
+          </style>
+        INLINE
+        html_string
+      end
+
+      def purged_css_from_head
+        default, custom = BootstrapEmail::SassCache.compile('bootstrap-head').split('/*! allow_purge_after */')
+        # get each CSS declaration
+        custom.scan(/\w*\.[\w\-]*[\s\S\n]+?(?=})}{1}/).each do |group|
+          # get the first class for each comma separated CSS declaration
+          exist = group.scan(/(\.[\w\-]*).*?((,+?)|{+?)/).map(&:first).uniq.any? do |selector|
+            !doc.at_css(selector).nil?
+          end
+          custom.sub!(group, '') unless exist
+        end
+        (default + custom).gsub(/\n\s*\n+/, "\n")
+      end
+    end
+  end
+end

data/lib/bootstrap-email/{components → converters}/hr.rb

@@ -1,9 +1,9 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Hr < Base
       def build
         each_node('hr') do |node|
-          default_margin = node['class'].to_s.match?(/m[tby]{1}-(lg-)?\d+/) ? '' : 'my-5'
+          default_margin = margin?(node) ? '' : 'my-5'
           node.replace(template('table', classes: "#{default_margin} hr #{node['class']}", contents: ''))
         end
       end

data/lib/bootstrap-email/{components → converters}/margin.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Margin < Base
       def build
         each_node('*[class*=my-], *[class*=mt-], *[class*=mb-]') do |node|

data/lib/bootstrap-email/{components → converters}/padding.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Padding < Base
       def build
         each_node('*[class*=p-], *[class*=pt-], *[class*=pr-], *[class*=pb-], *[class*=pl-], *[class*=px-], *[class*=py-]') do |node|

data/lib/bootstrap-email/converters/paragraph.rb

@@ -0,0 +1,13 @@
+module BootstrapEmail
+  module Converter
+    class Paragraph < Base
+      def build
+        each_node('p') do |node|
+          next if margin?(node)
+
+          add_class(node, 'mb-4')
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/converters/preview_text.rb

@@ -0,0 +1,18 @@
+module BootstrapEmail
+  module Converter
+    class PreviewText < Base
+      def build
+        preview_node = doc.at_css('preview')
+        return if preview_node.nil?
+
+        # apply spacing after the text max of 100 characters so it doesn't show body text
+        preview_node.inner_html += '&nbsp;' * [(100 - preview_node.content.length.to_i), 0].max
+        node = template('div', classes: 'preview', contents: preview_node.content)
+        preview_node.remove
+
+        body = doc.at_css('body')
+        body.prepend_child(node)
+      end
+    end
+  end
+end

data/lib/bootstrap-email/{components → converters}/spacer.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Spacer < Base
       def build
         each_node('*[class*=s-]') do |node|

data/lib/bootstrap-email/{components → converters}/spacing.rb

@@ -1,15 +1,14 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Spacing < Base
       def build
         each_node('*[class*=space-y-]') do |node|
           spacer = node['class'].scan(/space-y-((lg-)?\d+)/)[0][0]
           # get all direct children except the first
-          node.xpath('./*[position()>1] | ./tbody/tr/td/*[position()>1]').each do |child|
-            html = ''
-            html += template('div', classes: "s-#{spacer}", contents: nil)
-            html += child.to_html
-            child.replace(html)
+          node.xpath('./*[position() < last()] | ./tbody/tr/td/*[position() < last()]').each do |child|
+            next if margin_bottom?(child)
+
+            add_class(child, "mb-#{spacer}")
           end
         end
       end

data/lib/bootstrap-email/converters/stack.rb

@@ -0,0 +1,30 @@
+module BootstrapEmail
+  module Converter
+    class Stack < Base
+      def build
+        stack_x
+        stack_y
+      end
+
+      def stack_x
+        each_node('.stack-x') do |node|
+          html = ''
+          node.xpath('./*').each do |child|
+            html += template('td', classes: 'stack-cell', contents: child.to_html)
+          end
+          node.replace(template('table-to-tr', classes: node['class'], contents: html))
+        end
+      end
+
+      def stack_y
+        each_node('.stack-y') do |node|
+          html = ''
+          node.xpath('./*').each do |child|
+            html += template('tr', classes: 'stack-cell', contents: child.to_html)
+          end
+          node.replace(template('table-to-tbody', classes: node['class'], contents: html))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/{components → converters}/table.rb

@@ -1,5 +1,5 @@
 module BootstrapEmail
-  module Component
+  module Converter
     class Table < Base
       def build
         each_node('table') do |node|

data/lib/bootstrap-email/converters/version_comment.rb

@@ -0,0 +1,15 @@
+module BootstrapEmail
+  module Converter
+    class VersionComment < Base
+      def build
+        doc.at_css('head').prepend_child(bootstrap_email_comment)
+      end
+
+      private
+
+      def bootstrap_email_comment
+        "\n    <!-- Compiled with Bootstrap Email version: #{BootstrapEmail::VERSION} -->"
+      end
+    end
+  end
+end