bootstrap-email 0.3.4 → 1.0.0.alpha2.1

data/lib/bootstrap-email/bootstrap_email_cli.rb

@@ -0,0 +1,92 @@
+require_relative '../bootstrap-email'
+require 'optparse'
+require 'fileutils'
+
+input = nil
+options = {
+  destination: 'compiled',
+  type: :file
+}
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Bootstrap 5 stylesheet, compiler, and inliner for responsive and consistent emails with the Bootstrap syntax you know and love.\n\n"
+  opts.define_head 'Usage: bootstrap-email <path> [options]'
+  opts.separator ''
+  opts.separator 'Examples:'
+  opts.separator '  bootstrap-email'
+  opts.separator '  bootstrap-email email.html > out.html'
+  opts.separator '  bootstrap-email ./public/index.html'
+  opts.separator '  bootstrap-email -s \'<a href="#" class="btn btn-primary">Some Button</a>\''
+  opts.separator '  bootstrap-email -p \'emails/*\' -d emails/compiled'
+  opts.separator '  bootstrap-email -p \'views/emails/*\' -d \'views/compiled_emails\''
+  opts.separator '  cat input.html | bootstrap-email'
+  opts.separator ''
+  opts.separator 'Options:'
+
+  opts.on('-s', '--string STRING', String, 'HTML string to be to be compiled rather than a file.') do |v|
+    input = v
+    options[:type] = :string
+  end
+
+  opts.on('-p', '--pattern STRING', String, 'Specify a pattern of files to compile and save multiple files at once.') do |v|
+    input = v
+    options[:type] = :pattern
+  end
+
+  opts.on('-d', '--destination STRING', String, 'Destination for compiled files (used with the --pattern option).') do |v|
+    options[:destination] = v
+  end
+
+  opts.on('-c', '--config STRING', String, 'Relative path to SCSS config config file to customize Bootstrap Email.') do |v|
+    options[:config] = File.expand_path(v, Dir.pwd)
+  end
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+
+  opts.on('-v', '--version', 'Show version') do
+    puts BootstrapEmail::VERSION
+    exit
+  end
+end
+parser.parse!
+
+if input
+  # input already set by pattern
+elsif ARGV.any?
+  # Executed via command line or shell script
+  input = ARGV.shift
+elsif !STDIN.tty?
+  # Called in piped command
+  input = STDIN.read
+  options[:type] = :string
+else
+  # Running just the blank command to compile all files in directory containing .html
+  input = '*.html*'
+  options[:type] = :pattern
+end
+
+if input
+  case options[:type]
+  when :pattern
+    Dir.glob(input, base: Dir.pwd).each do |path|
+      next unless File.file?(path)
+
+      puts "Compiling file #{path}"
+      compiled = BootstrapEmail::Compiler.new(path, type: :file, options: {config_path: options[:config]}).perform_full_compile
+      destination = options[:destination].chomp('/*')
+      FileUtils.mkdir_p("#{Dir.pwd}/#{destination}")
+      File.write(File.expand_path("#{destination}/#{path.split('/').last}", Dir.pwd), compiled)
+    end
+  when :file
+    path = File.expand_path(input, Dir.pwd)
+    puts BootstrapEmail::Compiler.new(path, type: :file, options: {config_path: options[:config]}).perform_full_compile
+  when :string
+    puts BootstrapEmail::Compiler.new(input, options: {config_path: options[:config]}).perform_full_compile
+  end
+else
+  puts opts
+  exit 1
+end

data/lib/bootstrap-email/compiler.rb

@@ -0,0 +1,98 @@
+module BootstrapEmail
+  class Compiler
+    attr_accessor :type, :doc, :premailer
+
+    def initialize(input, type: :string, options: {})
+      self.type = type
+      case type
+      when :rails
+        @mail = input
+        html = (@mail.html_part || @mail).body.raw_source
+      when :string
+        html = input
+      when :file
+        html = File.read(input)
+      end
+      html = add_layout!(html)
+      build_premailer_doc(html, options)
+    end
+
+    def perform_full_compile
+      compile_html!
+      inline_css!
+      configure_html!
+      finalize_document!
+    end
+
+    private
+
+    def add_layout!(html)
+      document = Nokogiri::HTML(html)
+      return html unless document.at_css('head').nil?
+
+      BootstrapEmail::Erb.template(
+        File.expand_path('../../core/layout.html.erb', __dir__),
+        contents: html
+      )
+    end
+
+    def build_premailer_doc(html, options)
+      SassC.load_paths << File.expand_path('../../core', __dir__)
+      css_string = BootstrapEmail::SassCache.compile('bootstrap-email', config_path: options[:config_path], style: :expanded)
+      self.premailer = Premailer.new(
+        html,
+        with_html_string: true,
+        preserve_reset: false,
+        css_string: css_string
+      )
+      self.doc = premailer.doc
+    end
+
+    def compile_html!
+      BootstrapEmail::Component::Block.build(doc)
+
+      BootstrapEmail::Component::Button.build(doc)
+      BootstrapEmail::Component::Badge.build(doc)
+      BootstrapEmail::Component::Alert.build(doc)
+      BootstrapEmail::Component::Card.build(doc)
+      # BootstrapEmail::Component::Paragraph.build(doc) this might be too much
+      BootstrapEmail::Component::Hr.build(doc)
+      BootstrapEmail::Component::Container.build(doc)
+      BootstrapEmail::Component::Grid.build(doc)
+      BootstrapEmail::Component::Stack.build(doc)
+
+      BootstrapEmail::Component::Spacing.build(doc)
+      BootstrapEmail::Component::Padding.build(doc)
+      BootstrapEmail::Component::Margin.build(doc)
+      BootstrapEmail::Component::Spacer.build(doc)
+
+      BootstrapEmail::Component::Table.build(doc)
+      BootstrapEmail::Component::Body.build(doc)
+      BootstrapEmail::Component::Align.build(doc)
+      BootstrapEmail::Component::Color.build(doc)
+
+      BootstrapEmail::Component::PreviewText.build(doc)
+    end
+
+    def inline_css!
+      premailer.to_inline_css
+    end
+
+    def configure_html!
+      BootstrapEmail::Component::ForceEncoding.build(doc)
+      BootstrapEmail::Component::HeadStyle.build(doc)
+      BootstrapEmail::Component::VersionComment.build(doc)
+    end
+
+    def finalize_document!
+      html = BootstrapEmail::Component::ForceEncoding.replace(doc.to_html)
+      case type
+      when :rails
+        (@mail.html_part || @mail).body = html
+        @mail
+      when :string, :file
+        html
+      end
+    end
+  end
+end

data/lib/bootstrap-email/components/alert.rb

@@ -0,0 +1,11 @@
+module BootstrapEmail
+  module Component
+    class Alert < Base
+      def build
+        each_node('.alert') do |node|
+          node.replace(template('table', classes: node['class'], contents: node.delete('class') && node.to_html))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module BootstrapEmail
+  module Component
+    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/badge.rb

@@ -0,0 +1,11 @@
+module BootstrapEmail
+  module Component
+    class Badge < Base
+      def build
+        each_node('.badge') do |node|
+          node.replace(template('table-left', classes: node['class'], contents: node.delete('class') && node.to_html))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module BootstrapEmail
+  module Component
+    class Base
+      attr_reader :doc
+      def initialize(doc)
+        @doc = doc
+      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]
+        BootstrapEmail::Erb.template(
+          File.expand_path("../../../core/templates/#{file}.html.erb", __dir__),
+          locals_hash
+        )
+      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/components/block.rb

@@ -0,0 +1,13 @@
+module BootstrapEmail
+  module Component
+    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/components/body.rb

@@ -0,0 +1,10 @@
+module BootstrapEmail
+  module Component
+    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/button.rb

@@ -0,0 +1,11 @@
+module BootstrapEmail
+  module Component
+    class Button < Base
+      def build
+        each_node('.btn') do |node|
+          node.replace(template('table', classes: node['class'], contents: node.delete('class') && node.to_html))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/components/card.rb

@@ -0,0 +1,14 @@
+module BootstrapEmail
+  module Component
+    class Card < Base
+      def build
+        each_node('.card') do |node|
+          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.inner_html))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/components/color.rb

@@ -0,0 +1,13 @@
+module BootstrapEmail
+  module Component
+    class Color < Base
+      def build
+        each_node('*[class*=bg-]') do |node|
+          next unless ['div'].include?(node.name) # only do automatic thing for div
+
+          node.replace(template('table', classes: "#{node['class']} w-full", contents: node.delete('class') && node.inner_html))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/components/container.rb

@@ -0,0 +1,14 @@
+module BootstrapEmail
+  module Component
+    class Container < Base
+      def build
+        each_node('.container') do |node|
+          node.replace(template('container', classes: node['class'], contents: node.inner_html))
+        end
+        each_node('.container-fluid') do |node|
+          node.replace(template('table', classes: node['class'], contents: node.inner_html))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module BootstrapEmail
+  module Component
+    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/components/grid.rb

@@ -0,0 +1,14 @@
+module BootstrapEmail
+  module Component
+    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/components/head_style.rb

@@ -0,0 +1,33 @@
+module BootstrapEmail
+  module Component
+    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