bootstrap-email 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c82d69b4546e02daeeff5fc09df8e91c3c372f6da42e39fd96b438bd0776a7c3
-  data.tar.gz: 8cc3f250c82b779ddb99ae0d9618523b716d8110e0cbd3b639a71255158c181d
+  metadata.gz: cbb329e67fb8b535a16ee1215af017f799873acbaf4282971555bdb546e5138b
+  data.tar.gz: 14a664c9e97bfcb6846866ffdfa99809cc007646361e9db733aaffaaf53dee45
 SHA512:
-  metadata.gz: 7154cdcef0287e4fbcb37f117f5c73ae4dbf15b11a28b287b13b082d1ac05b63d5010b664a230cf907e7eafb8c27901db5e584db8a65fa7eb7ea1101cf42c6a1
-  data.tar.gz: bc5f07bdcb6ffca350685b5b39114d121ed27e33d4e18b24ce624143a4bd29f7210e405958634e1b86bc0ae6acdd5b70c259b5a77c805a3085d345a392f412c0
+  metadata.gz: 35bfed648f7f86be0eb2bcbd5dba531d785f0c2b1bc82af1100806896f2480e1816a9275fd9678fcb86700cc4ae9c4052be7ebb33e614300a8ffcf005178cb53
+  data.tar.gz: d409bb910231e9e157ff375c379bc059e573a2ca44c860af183a72851b8ce825c3f52c193ade74d61551575dfa1bbfa4dadb6b7890ef8bfe3fe9dbcd530dcff1

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/bootstrap-email/bootstrap_email_cli.rb

@@ -42,6 +42,10 @@ parser = OptionParser.new do |opts|
     options[:config] = File.expand_path(v, Dir.pwd)
   end
 
+  opts.on('-t', '--text', 'Return the plain text version of the email.') do |v|
+    options[:plain_text] = true
+  end
+
   opts.on('-h', '--help', 'Prints this help') do
     puts opts
     exit
@@ -70,22 +74,23 @@ else
 end
 
 if input
+  method = options[:plain_text] ? :perform_text_compile : :perform_html_compile
   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
+      compiled = BootstrapEmail::Compiler.new(path, type: :file, options: { config_path: options[:config] }).public_send(method)
       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], sass_log_enabled: false }).perform_full_compile
+    puts BootstrapEmail::Compiler.new(path, type: :file, options: { config_path: options[:config], sass_log_enabled: false }).public_send(method)
   when :string
-    puts BootstrapEmail::Compiler.new(input, options: { config_path: options[:config], sass_log_enabled: false }).perform_full_compile
+    puts BootstrapEmail::Compiler.new(input, options: { config_path: options[:config], sass_log_enabled: false }).public_send(method)
   end
 else
   puts opts

data/lib/bootstrap-email/compiler.rb

@@ -8,29 +8,40 @@ module BootstrapEmail
       self.config = BootstrapEmail::Config.new(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)
+      html = add_layout(html)
       sass_load_paths
       build_premailer_doc(html)
     end
 
-    def perform_full_compile
-      compile_html!
-      inline_css!
-      configure_html!
-      finalize_document!
+    def perform_multipart_compile
+      @perform_multipart_compile ||= {
+        text: perform_text_compile,
+        html: perform_html_compile
+      }
     end
 
+    def perform_text_compile
+      @perform_text_compile ||= plain_text
+    end
+
+    def perform_html_compile
+      @perform_html_compile ||= begin
+        compile_html
+        inline_css
+        configure_html
+        finalize_document
+      end
+    end
+    alias perform_full_compile perform_html_compile
+
     private
 
-    def add_layout!(html)
+    def add_layout(html)
       document = Nokogiri::HTML(html)
       return html unless document.at_css('head').nil?
 
@@ -57,7 +68,7 @@ module BootstrapEmail
       self.doc = premailer.doc
     end
 
-    def compile_html!
+    def compile_html
       BootstrapEmail::Converter::Body.build(doc)
       BootstrapEmail::Converter::Block.build(doc)
 
@@ -81,28 +92,26 @@ module BootstrapEmail
       BootstrapEmail::Converter::Table.build(doc)
     end
 
-    def inline_css!
+    def inline_css
       premailer.to_inline_css
     end
 
-    def configure_html!
+    def plain_text
+      premailer.to_plain_text
+    end
+
+    def configure_html
       BootstrapEmail::Converter::HeadStyle.build(doc, config)
       BootstrapEmail::Converter::AddMissingMetaTags.build(doc)
       BootstrapEmail::Converter::VersionComment.build(doc)
     end
 
-    def finalize_document!
-      html = doc.to_html(encoding: 'US-ASCII')
-      BootstrapEmail::Converter::SupportUrlTokens.replace(html)
-      BootstrapEmail::Converter::EnsureDoctype.replace(html)
-      BootstrapEmail::Converter::ForceEncoding.replace(html)
-      BootstrapEmail::Converter::BeautifyHTML.replace(html)
-      case type
-      when :rails
-        (@mail.html_part || @mail).body = html
-        @mail
-      when :string, :file
-        html
+    def finalize_document
+      doc.to_html(encoding: 'US-ASCII').tap do |html|
+        BootstrapEmail::Converter::SupportUrlTokens.replace(html)
+        BootstrapEmail::Converter::EnsureDoctype.replace(html)
+        BootstrapEmail::Converter::ForceEncoding.replace(html)
+        BootstrapEmail::Converter::BeautifyHTML.replace(html)
       end
     end
   end

data/lib/bootstrap-email/config_store.rb

@@ -3,29 +3,31 @@
 module BootstrapEmail
   class ConfigStore
     OPTIONS = [
-      :sass_email_location, # path to main sass file
-      :sass_head_location,  # path to head sass file
-      :sass_email_string,   # main sass file passed in as a string
-      :sass_head_string,    # head sass file passed in as a string
-      :sass_load_paths,     # array of directories for loading sass imports
-      :sass_cache_location, # path to tmp folder for sass cache
-      :sass_log_enabled     # turn on or off sass log when caching new sass
+      :sass_email_location,     # path to main sass file
+      :sass_head_location,      # path to head sass file
+      :sass_email_string,       # main sass file passed in as a string
+      :sass_head_string,        # head sass file passed in as a string
+      :sass_load_paths,         # array of directories for loading sass imports
+      :sass_cache_location,     # path to tmp folder for sass cache
+      :sass_log_enabled,        # turn on or off sass log when caching new sass
+      :generate_rails_text_part # boolean for whether or not to generate the text part in rails, default: true
     ].freeze
 
-    attr_reader(*OPTIONS)
-
-    OPTIONS.each do |option|
-      define_method("#{option}=") do |value|
-        instance_variable_set("@#{option}", value)
-      end
-    end
+    attr_accessor(*OPTIONS)
 
     def initialize(options = [])
+      defaults
       options.each { |name, value| instance_variable_set("@#{name}", value) if OPTIONS.include?(name) }
     end
 
     def did_set?(option)
       instance_variable_defined?("@#{option}")
     end
+
+    private
+
+    def defaults
+      self.generate_rails_text_part = true
+    end
   end
 end

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

@@ -7,8 +7,9 @@ module BootstrapEmail
         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 += ' ' * [(100 - preview_node.content.length.to_i), 0].max
+        # https://www.litmus.com/blog/the-little-known-preview-text-hack-you-may-want-to-use-in-every-email/
+        # apply spacing after the text max of 278 characters so it doesn't show body text
+        preview_node.inner_html += '͏ ‌   ' * [(278 - preview_node.content.length.to_i), 0].max
         node = template('div', classes: 'preview', contents: preview_node.content)
         preview_node.remove
 

data/lib/bootstrap-email/rails/action_mailer.rb

@@ -2,15 +2,9 @@
 
 ActiveSupport.on_load(:action_mailer, { yield: true }) do |action_mailer|
   action_mailer.class_eval do # To support Rails less than 6
-    # sit in the middle and compile the html
     def bootstrap_mail(*args, &block)
-      mail_message = mail(*args, &block)
-      # if you override the #mail method in you ApplicationMailer you may intentionally return something other than a mail message
-      if mail_message
-        bootstrap = BootstrapEmail::Compiler.new(mail_message, type: :rails)
-        bootstrap.perform_full_compile
-      end
-      mail_message
+      message = mail(*args, &block)
+      BootstrapEmail::Rails::MailBuilder.perform(message)
     end
     alias_method :bootstrap_email, :bootstrap_mail
     alias_method :make_bootstrap_mail, :bootstrap_mail

data/lib/bootstrap-email/rails/mail_builder.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module BootstrapEmail
+  module Rails
+    class MailBuilder
+      attr_reader :mail, :bootstrap_email
+
+      def self.perform(mail)
+        new(mail) if mail
+      end
+
+      private
+
+      def initialize(mail)
+        @mail = mail
+        @bootstrap_email = BootstrapEmail::Compiler.new(html_part, type: :string)
+        perform
+      end
+
+      def perform
+        add_mail_parts
+        mail
+      end
+
+      def html_part
+        (mail.html_part || mail).body.raw_source
+      end
+
+      def add_mail_parts
+        if BootstrapEmail.static_config.generate_rails_text_part
+          mail.parts << build_alternative_part
+        else
+          html = bootstrap_email.perform_full_compile
+          mail.parts << build_html_part(html)
+        end
+      end
+
+      def build_alternative_part
+        compiled = bootstrap_email.perform_multipart_compile
+
+        part = Mail::Part.new(content_type: 'multipart/alternative')
+        part.add_part(build_text_part(compiled[:text]))
+        part.add_part(build_html_part(compiled[:html]))
+
+        part
+      end
+
+      def build_html_part(html)
+        Mail::Part.new do
+          content_type "text/html; charset=#{html.encoding}"
+          body html
+        end
+      end
+
+      def build_text_part(text)
+        Mail::Part.new do
+          content_type "text/plain; charset=#{text.encoding}"
+          body text
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email.rb

@@ -29,4 +29,5 @@ Dir[File.join(__dir__, 'bootstrap-email/converters', '*.rb')].each { |file| requ
 if defined?(Rails)
   require_relative 'bootstrap-email/rails/action_mailer'
   require_relative 'bootstrap-email/rails/engine'
+  require_relative 'bootstrap-email/rails/mail_builder'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-email
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Stuart Yamartino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -150,6 +150,7 @@ files:
 - lib/bootstrap-email/erb.rb
 - lib/bootstrap-email/rails/action_mailer.rb
 - lib/bootstrap-email/rails/engine.rb
+- lib/bootstrap-email/rails/mail_builder.rb
 - lib/bootstrap-email/sass_cache.rb
 - lib/bootstrap-email/setup.rb
 - lib/bootstrap-email/version.rb