bootstrap-email 1.1.7 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1145fbba3e6a8db2d8fe571b8f5a4d05ff78ba0ddd4c40dea9ce317e06e5f1fe
-  data.tar.gz: f2aa2c03962d575448af829b381f18cfde6bacee0a2caf03b66a9ae0f218824f
+  metadata.gz: 0af8d16392d189b851cad1448686b2fda2a322b61c0b98553090394a598d0b32
+  data.tar.gz: '009e81f356b5f8519113b32f44b1c82cac62692b1bf035b2449da4dea46e60a0'
 SHA512:
-  metadata.gz: 150353d9f8a03a0b8fe0434013c5c814a97dc2eb1b03287517174c95d9df30fa22e1564d3dc8d2fc7cc9bc33734da0d845341cc4d8e07bfee1ca23db84490a9e
-  data.tar.gz: ce8b05c478d2bda5a46518d90a2bb3c8c6c8a1fe01bf197524b95c2b3182d5ca9f9b24e08bce6022f3af68779d7b087c54605dbe3b861b32bd601a1f551f5e8d
+  metadata.gz: 2f2f9702d22b020da0968896dd7e3134a716c450492569fd3597676e4ad8305c340ba7abc26bd93b6d0b78b5f60de70a0d7bca2b0f310ccd15c73763e0bc3ca2
+  data.tar.gz: fd7db09c66be97a4082768c8b66025f714932dc356bac007033bb7f7a333d722d45caac63818cfca54344c23cf74bbd882045fc8cfeb11e2fef50217799a34a3

data/VERSION

@@ -1 +1 @@
-1.1.7
+1.3.1

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

@@ -2,35 +2,46 @@
 
 module BootstrapEmail
   class Compiler
-    attr_accessor :type, :doc, :premailer
+    attr_accessor :type, :config, :doc, :premailer
 
     def initialize(input, type: :string, options: {})
-      BootstrapEmail.load_options(options)
+      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?
 
@@ -41,11 +52,11 @@ module BootstrapEmail
     end
 
     def sass_load_paths
-      SassC.load_paths << BootstrapEmail.config.sass_load_paths
+      SassC.load_paths << config.sass_load_paths
     end
 
     def build_premailer_doc(html)
-      css_string = BootstrapEmail::SassCache.compile('bootstrap-email', style: :expanded)
+      css_string = BootstrapEmail::SassCache.compile('bootstrap-email', config, style: :expanded)
       self.premailer = Premailer.new(
         html,
         with_html_string: true,
@@ -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!
-      BootstrapEmail::Converter::HeadStyle.build(doc)
+    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.rb

@@ -2,51 +2,64 @@
 
 module BootstrapEmail
   class Config
-    attr_writer :sass_email_location, # path to main sass file
-                :sass_head_location,  # path to head sass file
-                :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
-
-    def load_options(options)
+    def initialize(options = {})
+      @config_store = BootstrapEmail::ConfigStore.new(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
+    def sass_string_for(type:)
+      # look for custom sass string
+      sub_type = type.sub('bootstrap-', '')
+      string = config_for_option("sass_#{sub_type}_string")
+      return string unless string.nil?
+
+      # look for custom sass path
+      path = config_for_option("sass_#{sub_type}_location")
+      return File.read(path) unless path.nil?
 
+      # look up and return others if found in default locations
       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?
+      File.read(locations.first) if locations.any?
     end
 
     def sass_load_paths
       paths_array = [SassCache::SASS_DIR]
-      @sass_load_paths ||= []
-      paths_array.concat(@sass_load_paths)
+      custom_load_paths = config_for_option(:sass_load_paths) || []
+      paths_array.concat(custom_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
+      option = config_for_option(:sass_cache_location)
+      return option unless option.nil?
+
+      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
 
     def sass_log_enabled?
-      defined?(@sass_log_enabled) ? @sass_log_enabled : true
+      option = config_for_option(:sass_log_enabled)
+      option.nil? ? true : option
+    end
+
+    private
+
+    def config_for_option(option)
+      if @config_store.did_set?(option)
+        @config_store.public_send(option)
+      else
+        BootstrapEmail.static_config.public_send(option)
+      end
     end
   end
 end

data/lib/bootstrap-email/config_store.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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
+      :generate_rails_text_part # boolean for whether or not to generate the text part in rails, default: true
+    ].freeze
+
+    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/base.rb

@@ -10,8 +10,8 @@ module BootstrapEmail
         @cached_templates = {}
       end
 
-      def self.build(doc)
-        new(doc).build
+      def self.build(doc, *args)
+        new(doc).build(*args)
       end
 
       private

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

@@ -3,7 +3,8 @@
 module BootstrapEmail
   module Converter
     class HeadStyle < Base
-      def build
+      def build(config)
+        @config = config
         doc.at_css('head').add_child(bootstrap_email_head)
       end
 
@@ -18,7 +19,7 @@ module BootstrapEmail
       end
 
       def purged_css_from_head
-        default, custom = BootstrapEmail::SassCache.compile('bootstrap-head').split('/*! allow_purge_after */')
+        default, custom = BootstrapEmail::SassCache.compile('bootstrap-head', @config).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

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,115 @@
+# frozen_string_literal: true
+
+module BootstrapEmail
+  module Rails
+    class MailBuilder
+      attr_reader :message, :bootstrap_email
+
+      def self.perform(mail)
+        new(mail).perform if mail
+      end
+
+      def initialize(mail)
+        @message = mail
+        @bootstrap_email = BootstrapEmail::Compiler.new(html_part.decoded, type: :string)
+      end
+
+      def perform
+        replace_html_part(generate_html_part_replacement)
+        message
+      end
+
+      private
+
+      # Much of this files derives from: https://github.com/fphilipe/premailer-rails/blob/2870060f9740de1c3f7a1da0acfc7b88e3181077/lib/premailer/rails/hook.rb
+
+      def message_contains_html?
+        html_part.present?
+      end
+
+      # Returns true if the message itself has a content type of text/html, thus
+      # it does not contain other parts such as alternatives and attachments.
+      def pure_html_message?
+        message.content_type&.include?('text/html')
+      end
+
+      def generate_html_part_replacement
+        if generate_text_part?
+          generate_alternative_part
+        else
+          html = bootstrap_email.perform_html_compile
+          build_html_part(html)
+        end
+      end
+
+      def generate_text_part?
+        BootstrapEmail.static_config.generate_rails_text_part && !message.text_part
+      end
+
+      def generate_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=UTF-8'
+          body html
+        end
+      end
+
+      def build_text_part(text)
+        Mail::Part.new do
+          content_type "text/plain; charset=#{text.encoding}"
+          body text
+        end
+      end
+
+      def html_part
+        if pure_html_message?
+          message
+        else
+          message.html_part
+        end
+      end
+
+      def replace_html_part(new_part)
+        if pure_html_message?
+          replace_in_pure_html_message(new_part)
+        else
+          replace_part_in_list(message.parts, html_part, new_part)
+        end
+      end
+
+      # If the new part is a pure text/html part, the body and its content type
+      # are used for the message. If the new part is
+      def replace_in_pure_html_message(new_part)
+        if new_part.content_type.include?('text/html')
+          message.body = new_part.decoded
+          message.content_type = new_part.content_type
+        else
+          message.body = nil
+          message.content_type = new_part.content_type
+          new_part.parts.each do |part|
+            message.add_part(part)
+          end
+        end
+      end
+
+      def replace_part_in_list(parts_list, old_part, new_part)
+        if (index = parts_list.index(old_part))
+          parts_list[index] = new_part
+        else
+          parts_list.any? do |part|
+            replace_part_in_list(part.parts, old_part, new_part) if part.respond_to?(:parts)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/sass_cache.rb

@@ -4,22 +4,20 @@ module BootstrapEmail
   class SassCache
     SASS_DIR = File.expand_path('../../core', __dir__)
 
-    def self.compile(type, style: :compressed)
-      new(type, style).compile
+    def self.compile(type, config, style: :compressed)
+      new(type, config, style).compile
     end
 
-    attr_accessor :type, :style, :file_path, :config_file, :checksum
+    attr_accessor :type, :config, :style, :file_path, :sass_config, :checksum, :cache_dir
 
-    def initialize(type, style)
+    def initialize(type, config, style)
       self.type = type
+      self.config = config
       self.style = style
       self.file_path = "#{SASS_DIR}/#{type}"
-      self.config_file = load_config
+      self.sass_config = load_sass_config
       self.checksum = checksum_files
-    end
-
-    def cache_dir
-      BootstrapEmail.config.sass_cache_location
+      self.cache_dir = config.sass_cache_location
     end
 
     def compile
@@ -30,18 +28,18 @@ module BootstrapEmail
 
     private
 
-    def load_config
-      path = BootstrapEmail.config.sass_location_for(type: type)
-      replace_config(File.read(path)) if path
+    def load_sass_config
+      sass_string = config.sass_string_for(type: type)
+      replace_config(sass_string) if sass_string
     end
 
-    def replace_config(config_file)
-      config_file.gsub("//= @import #{type};", "@import '#{file_path}';")
+    def replace_config(sass_config)
+      sass_config.gsub("//= @import #{type};", "@import '#{file_path}';")
     end
 
     def checksum_files
-      checksums = config_file.nil? ? [] : [Digest::SHA1.hexdigest(config_file)]
-      BootstrapEmail.config.sass_load_paths.each do |load_path|
+      checksums = sass_config.nil? ? [] : [Digest::SHA1.hexdigest(sass_config)]
+      config.sass_load_paths.each do |load_path|
         Dir.glob(File.join(load_path, '**', '*.scss'), base: __dir__).each do |path|
           checksums << Digest::SHA1.file(File.expand_path(path, __dir__)).hexdigest
         end
@@ -55,11 +53,11 @@ module BootstrapEmail
     end
 
     def compile_and_cache_scss(cache_path)
-      file = config_file || File.read("#{file_path}.scss")
+      file = sass_config || File.read("#{file_path}.scss")
       css = SassC::Engine.new(file, style: style).render
       FileUtils.mkdir_p("#{cache_dir}/#{checksum}") unless File.directory?("#{cache_dir}/#{checksum}")
       File.write(cache_path, css)
-      puts "New css file cached for #{type}" if BootstrapEmail.config.sass_log_enabled?
+      puts "New css file cached for #{type}" if config.sass_log_enabled?
     end
   end
 end

data/lib/bootstrap-email/setup.rb

@@ -2,28 +2,20 @@
 
 module BootstrapEmail
   class << self
-    def config
-      @config ||= BootstrapEmail::Config.new
-      @config
-    end
-
-    def load_options(options)
-      @config ||= BootstrapEmail::Config.new
-      @config.load_options(options)
-      @config
+    def static_config
+      @static_config ||= BootstrapEmail::ConfigStore.new
     end
 
     def configure
-      @config ||= BootstrapEmail::Config.new
-      yield @config
+      yield static_config
     end
 
     def reset_config!
-      remove_instance_variable :@config if defined?(@config)
+      remove_instance_variable :@static_config if defined?(@static_config)
     end
 
     def clear_sass_cache!
-      FileUtils.rm_rf(BootstrapEmail.config.sass_cache_location)
+      FileUtils.rm_rf(BootstrapEmail::Config.new.sass_cache_location)
     end
   end
 end

data/lib/bootstrap-email.rb

@@ -16,6 +16,7 @@ rescue LoadError; end
 
 require 'action_mailer' if defined?(Rails)
 
+require_relative 'bootstrap-email/config_store'
 require_relative 'bootstrap-email/config'
 require_relative 'bootstrap-email/setup'
 require_relative 'bootstrap-email/erb'
@@ -28,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.1.7
+  version: 1.3.1
 platform: ruby
 authors:
 - Stuart Yamartino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -119,6 +119,7 @@ files:
 - lib/bootstrap-email/bootstrap_email_cli.rb
 - lib/bootstrap-email/compiler.rb
 - lib/bootstrap-email/config.rb
+- lib/bootstrap-email/config_store.rb
 - lib/bootstrap-email/converters/add_missing_meta_tags.rb
 - lib/bootstrap-email/converters/alert.rb
 - lib/bootstrap-email/converters/align.rb
@@ -149,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