bootstrap-email 1.0.0.alpha1 → 1.0.0.alpha3

data/lib/bootstrap-email/erb.rb

@@ -0,0 +1,9 @@
+module BootstrapEmail
+  class Erb
+    def self.template(path, locals_hash = {})
+      namespace = OpenStruct.new(locals_hash)
+      template_html = File.read(path)
+      ERB.new(template_html).result(namespace.instance_eval { binding })
+    end
+  end
+end

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

@@ -2,9 +2,14 @@ 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)
-      bootstrap = BootstrapEmail::Compiler.new(mail(*args, &block), type: :rails)
-      bootstrap.perform_full_compile
+      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
     end
+    alias bootstrap_email bootstrap_mail
     alias make_bootstrap_mail bootstrap_mail
   end
 end

data/lib/bootstrap-email/sass_cache.rb

@@ -1,38 +1,45 @@
 module BootstrapEmail
   class SassCache
-    CACHE_DIR = File.expand_path('../../.sass-cache', __dir__)
     SASS_DIR = File.expand_path('../../core', __dir__)
 
-    def self.compile(name, config_path: nil, style: :compressed)
-      path = "#{SASS_DIR}/#{name}"
-      config_file = nil
+    def self.compile(type, style: :compressed)
+      new(type, style).compile
+    end
 
-      lookup_locations = ["#{name}.config.scss", "app/assets/stylesheets/#{name}.config.scss"]
-      locations = lookup_locations.select { |location| File.exist?(File.expand_path(location, Dir.pwd)) }
+    attr_accessor :type, :style, :file_path, :config_file, :checksum
 
-      if config_path && File.exist?(config_path)
-        # check if custom config was passed in
-        config_file = File.read(config_path)
-      elsif locations.any?
-        config_file = File.read(File.expand_path(locations.first, Dir.pwd))
-      end
+    def initialize(type, style)
+      self.type = type
+      self.style = style
+      self.file_path = "#{SASS_DIR}/#{type}"
+      self.config_file = load_config
+      self.checksum = checksum_files
+    end
 
-      check = checksum(config_file&.gsub("//= @import #{name};", "@import '#{path}';"))
-      cache_path = "#{CACHE_DIR}/#{check}/#{name}.css"
-      if cached?(cache_path)
-        File.read(cache_path)
-      else
-        file = config_file.nil? ? File.read("#{path}.scss") : config_file
-        SassC::Engine.new(file, style: style).render.tap do |css|
-          Dir.mkdir(CACHE_DIR) unless File.directory?(CACHE_DIR)
-          Dir.mkdir("#{CACHE_DIR}/#{check}") unless File.directory?("#{CACHE_DIR}/#{check}")
-          File.write(cache_path, css)
-          puts "New css file cached for #{name}"
-        end
+    def cache_dir
+      BootstrapEmail.config.sass_cache_location
+    end
+
+    def compile
+      cache_path = "#{cache_dir}/#{checksum}/#{type}.css"
+      unless cached?(cache_path)
+        compile_and_cache_scss(cache_path)
       end
+      File.read(cache_path)
     end
 
-    def self.checksum(config_file)
+    private
+
+    def load_config
+      path = BootstrapEmail.config.sass_location_for(type: type)
+      replace_config(File.read(path)) if path
+    end
+
+    def replace_config(config_file)
+      config_file.gsub("//= @import #{type};", "@import '#{file_path}';")
+    end
+
+    def checksum_files
       checksums = config_file.nil? ? [] : [Digest::SHA1.hexdigest(config_file)]
       Dir.glob('../../core/**/*.scss', base: __dir__).each do |path|
         checksums << Digest::SHA1.file(File.expand_path(path, __dir__)).hexdigest
@@ -40,8 +47,18 @@ module BootstrapEmail
       Digest::SHA1.hexdigest(checksums.join)
     end
 
-    def self.cached?(cache_path)
+    def cached?(cache_path)
       File.file?(cache_path)
     end
+
+    def compile_and_cache_scss(cache_path)
+      file = config_file || 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)
+      if BootstrapEmail.config.sass_log_enabled?
+        puts "New css file cached for #{type}"
+      end
+    end
   end
 end

data/lib/bootstrap-email/setup.rb

@@ -0,0 +1,27 @@
+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
+    end
+
+    def configure(&proc)
+      @config ||= BootstrapEmail::Config.new
+      yield @config
+    end
+
+    def reset_config!
+      remove_instance_variable :@config if defined?(@config)
+    end
+
+    def clear_sass_cache!
+      FileUtils.rm_rf(BootstrapEmail.config.sass_cache_location)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-email
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha3
 platform: ruby
 authors:
 - Stuart Yamartino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.0'
 description:
 email: stu@stuyam.com
 executables:
@@ -80,6 +80,7 @@ files:
 - core/scss/components/_hr.scss
 - core/scss/components/_image.scss
 - core/scss/components/_preview.scss
+- core/scss/components/_stack.scss
 - core/scss/components/_table.scss
 - core/scss/utilities/_background.scss
 - core/scss/utilities/_border-radius.scss
@@ -90,38 +91,50 @@ files:
 - core/scss/utilities/_spacing.scss
 - core/scss/utilities/_text-decoration.scss
 - core/scss/utilities/_typography.scss
-- core/templates/body.html.erb
-- core/templates/col.html.erb
-- core/templates/container.html.erb
-- core/templates/div.html.erb
-- core/templates/row.html.erb
-- core/templates/table-left.html.erb
-- core/templates/table.html.erb
+- core/scss/utilities/_valign.scss
+- core/templates/body.html
+- core/templates/container.html
+- core/templates/div.html
+- core/templates/table-left.html
+- core/templates/table-to-tbody.html
+- core/templates/table-to-tr.html
+- core/templates/table.html
+- core/templates/td.html
+- core/templates/tr.html
+- lib/bootstrap-email.rb
 - lib/bootstrap-email/bootstrap_email_cli.rb
 - lib/bootstrap-email/compiler.rb
-- lib/bootstrap-email/components/alert.rb
-- lib/bootstrap-email/components/align.rb
-- lib/bootstrap-email/components/badge.rb
-- lib/bootstrap-email/components/base.rb
-- lib/bootstrap-email/components/body.rb
-- lib/bootstrap-email/components/button.rb
-- lib/bootstrap-email/components/card.rb
-- lib/bootstrap-email/components/color.rb
-- lib/bootstrap-email/components/container.rb
-- lib/bootstrap-email/components/grid.rb
-- lib/bootstrap-email/components/hr.rb
-- lib/bootstrap-email/components/margin.rb
-- lib/bootstrap-email/components/padding.rb
-- lib/bootstrap-email/components/paragraph.rb
-- lib/bootstrap-email/components/spacer.rb
-- lib/bootstrap-email/components/spacing.rb
-- lib/bootstrap-email/components/table.rb
+- lib/bootstrap-email/config.rb
+- lib/bootstrap-email/converters/alert.rb
+- lib/bootstrap-email/converters/align.rb
+- lib/bootstrap-email/converters/badge.rb
+- lib/bootstrap-email/converters/base.rb
+- lib/bootstrap-email/converters/block.rb
+- lib/bootstrap-email/converters/body.rb
+- lib/bootstrap-email/converters/button.rb
+- lib/bootstrap-email/converters/card.rb
+- lib/bootstrap-email/converters/color.rb
+- lib/bootstrap-email/converters/container.rb
+- lib/bootstrap-email/converters/force_encoding.rb
+- lib/bootstrap-email/converters/grid.rb
+- lib/bootstrap-email/converters/head_style.rb
+- lib/bootstrap-email/converters/hr.rb
+- lib/bootstrap-email/converters/margin.rb
+- lib/bootstrap-email/converters/padding.rb
+- lib/bootstrap-email/converters/paragraph.rb
+- lib/bootstrap-email/converters/preview_text.rb
+- lib/bootstrap-email/converters/spacer.rb
+- lib/bootstrap-email/converters/spacing.rb
+- lib/bootstrap-email/converters/stack.rb
+- lib/bootstrap-email/converters/table.rb
+- lib/bootstrap-email/converters/version_comment.rb
+- lib/bootstrap-email/erb.rb
 - lib/bootstrap-email/initialize.rb
 - lib/bootstrap-email/rails/action_mailer.rb
 - lib/bootstrap-email/rails/engine.rb
 - lib/bootstrap-email/sass_cache.rb
+- lib/bootstrap-email/setup.rb
 - lib/bootstrap-email/version.rb
-- lib/bootstrap_email.rb
 homepage: https://bootstrapemail.com
 licenses:
 - MIT

data/core/templates/body.html.erb

@@ -1,9 +0,0 @@
-<table valign="top" class="<%= classes %>">
-  <tbody>
-    <tr>
-      <td valign="top">
-        <%= contents %>
-      </td>
-    </tr>
-  </tbody>
-</table>

data/core/templates/col.html.erb

@@ -1,3 +0,0 @@
-<td class="<%= classes %>" align="left" valign="top">
-  <%= contents %>
-</td>

data/core/templates/div.html.erb

@@ -1,3 +0,0 @@
-<div class="<%= classes %>">
-  <%= contents %>
-</div>

data/core/templates/row.html.erb

@@ -1,7 +0,0 @@
-<table class="<%= classes %>">
-  <tbody>
-    <tr>
-      <%= contents %>
-    </tr>
-  </tbody>
-</table>

data/core/templates/table-left.html.erb

@@ -1,9 +0,0 @@
-<table class="<%= classes %>" align="left">
-  <tbody>
-    <tr>
-      <td>
-        <%= contents %>
-      </td>
-    </tr>
-  </tbody>
-</table>

data/core/templates/table.html.erb

@@ -1,9 +0,0 @@
-<table class="<%= classes %>">
-  <tbody>
-    <tr>
-      <td>
-        <%= contents %>
-      </td>
-    </tr>
-  </tbody>
-</table>

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

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

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

@@ -1,26 +0,0 @@
-module BootstrapEmail
-  module Component
-    class Base
-      attr_reader :doc
-      def initialize(doc)
-        @doc = doc
-      end
-
-      def self.build(doc)
-        new(doc).build
-      end
-
-      def template(file, locals_hash = {})
-        locals_hash[:classes] = locals_hash[:classes].split.join(' ') if locals_hash[:classes]
-        namespace = OpenStruct.new(locals_hash)
-        template_html = File.read(File.expand_path("../../../core/templates/#{file}.html.erb", __dir__))
-        ERB.new(template_html).result(namespace.instance_eval { binding })
-      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
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-module BootstrapEmail
-  module Component
-    class Body < Base
-      def build
-        each_node('body') do |node|
-          node.replace('<body>' + preview_text.to_s + template('body', classes: "#{node['class']} body", contents: node.inner_html) + '</body>')
-        end
-      end
-
-      def preview_text
-        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.content += '&nbsp;' * [(100 - preview_node.content.length.to_i), 0].max
-        node = template('div', classes: 'preview', contents: preview_node.content)
-        preview_node.remove
-        node
-      end
-    end
-  end
-end

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

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

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

@@ -1,24 +0,0 @@
-module BootstrapEmail
-  module Component
-    class Paragraph < Base
-      def build
-        each_node('p') do |node|
-          next if margin?(node) || space_y?(node)
-
-          node['class'] ||= ''
-          node['class'] += 'mb-4'
-        end
-      end
-
-      private
-
-      def margin?(node)
-        node['class'].to_s.match?(/m[tby]{1}-(lg-)?\d+/)
-      end
-
-      def space_y?(node)
-        node.parent['class'].to_s.match?(/space-y-(lg-)?\d+/)
-      end
-    end
-  end
-end