RubyGems - bootstrap-email - Versions diffs - 0.3.0 → 1.0.0.alpha1 - Mend

bootstrap-email 0.3.0 → 1.0.0.alpha1

Files changed (79) hide show

checksums.yaml +4 -4
data/VERSION +1 -1
data/bin/bootstrap-email +2 -0
data/core/bootstrap-email.scss +27 -18
data/core/bootstrap-head.scss +143 -0
data/core/layout.html.erb +11 -0
data/core/scss/_colors.scss +161 -0
data/core/scss/_functions.scss +29 -0
data/core/scss/_helper_groups.scss +21 -0
data/core/{sass → scss}/_reboot_email.scss +7 -22
data/core/scss/_selectors_for_utils.scss +100 -0
data/core/scss/_utilities.scss +125 -0
data/core/scss/_variables.scss +52 -0
data/core/{sass → scss/components}/_alert.scss +0 -1
data/core/{sass → scss/components}/_badge.scss +8 -15
data/core/{sass → scss/components}/_button.scss +21 -17
data/core/{sass → scss/components}/_card.scss +3 -2
data/core/{sass → scss/components}/_container.scss +0 -0
data/core/scss/components/_grid.scss +35 -0
data/core/scss/components/_hr.scss +8 -0
data/core/{sass → scss/components}/_image.scss +2 -1
data/core/{sass → scss/components}/_preview.scss +0 -0
data/core/{sass → scss/components}/_table.scss +0 -0
data/core/scss/utilities/_background.scss +5 -0
data/core/scss/utilities/_border-radius.scss +21 -0
data/core/scss/utilities/_border.scss +13 -0
data/core/scss/utilities/_color.scss +9 -0
data/core/scss/utilities/_display.scss +7 -0
data/core/scss/utilities/_sizing.scss +16 -0
data/core/scss/utilities/_spacing.scss +18 -0
data/core/scss/utilities/_text-decoration.scss +9 -0
data/core/scss/utilities/_typography.scss +54 -0
data/core/templates/col.html.erb +2 -2
data/core/templates/row.html.erb +2 -2
data/lib/bootstrap-email/bootstrap_email_cli.rb +91 -0
data/lib/bootstrap-email/compiler.rb +118 -0
data/lib/bootstrap-email/components/alert.rb +11 -0
data/lib/bootstrap-email/components/align.rb +21 -0
data/lib/bootstrap-email/components/badge.rb +11 -0
data/lib/bootstrap-email/components/base.rb +26 -0
data/lib/bootstrap-email/components/body.rb +22 -0
data/lib/bootstrap-email/components/button.rb +11 -0
data/lib/bootstrap-email/components/card.rb +14 -0
data/lib/bootstrap-email/components/color.rb +13 -0
data/lib/bootstrap-email/components/container.rb +14 -0
data/lib/bootstrap-email/components/grid.rb +14 -0
data/lib/bootstrap-email/components/hr.rb +12 -0
data/lib/bootstrap-email/components/margin.rb +22 -0
data/lib/bootstrap-email/components/padding.rb +16 -0
data/lib/bootstrap-email/components/paragraph.rb +24 -0
data/lib/bootstrap-email/components/spacer.rb +11 -0
data/lib/bootstrap-email/components/spacing.rb +18 -0
data/lib/bootstrap-email/components/table.rb +13 -0
data/lib/bootstrap-email/initialize.rb +1 -0
data/lib/bootstrap-email/rails/action_mailer.rb +10 -0
data/lib/bootstrap-email/{engine.rb → rails/engine.rb} +0 -0
data/lib/bootstrap-email/sass_cache.rb +47 -0
data/lib/bootstrap-email/version.rb +3 -5
data/lib/bootstrap_email.rb +26 -0
metadata +76 -64
data/core/head.scss +0 -269
data/core/sass/_border.scss +0 -73
data/core/sass/_color.scss +0 -33
data/core/sass/_display.scss +0 -7
data/core/sass/_functions.scss +0 -14
data/core/sass/_grid.scss +0 -131
data/core/sass/_hr.scss +0 -14
data/core/sass/_spacing.scss +0 -100
data/core/sass/_typography.scss +0 -50
data/core/sass/_variables.scss +0 -150
data/core/template.html.erb +0 -11
data/core/templates/align-center.html.erb +0 -9
data/core/templates/align-left.html.erb +0 -9
data/core/templates/align-right.html.erb +0 -9
data/core/templates/hr.html.erb +0 -9
data/lib/assets/stylesheets/bootstrap-email.scss +0 -1
data/lib/bootstrap-email.rb +0 -230
data/lib/bootstrap-email/action_mailer.rb +0 -12
data/lib/bootstrap-email/premailer_railtie.rb +0 -5

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

@@ -0,0 +1,26 @@
+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 ADDED

@@ -0,0 +1,22 @@
+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/button.rb ADDED

@@ -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 ADDED

@@ -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.delete('class') && node.inner_html))
+        end
+        each_node('.card-body') do |node|
+          node.replace(template('table', classes: node['class'], contents: node.delete('class') && node.inner_html))
+        end
+      end
+    end
+  end
+end

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

@@ -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 ADDED

@@ -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/grid.rb ADDED

@@ -0,0 +1,14 @@
+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/hr.rb ADDED

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

data/lib/bootstrap-email/components/margin.rb ADDED

@@ -0,0 +1,22 @@
+module BootstrapEmail
+  module Component
+    class Margin < Base
+      def build
+        each_node('*[class*=my-], *[class*=mt-], *[class*=mb-]') do |node|
+          top_class = node['class'][/m[ty]{1}-(lg-)?(\d+)/]
+          bottom_class = node['class'][/m[by]{1}-(lg-)?(\d+)/]
+          node['class'] = node['class'].gsub(/(m[tby]{1}-(lg-)?\d+)/, '')
+          html = ''
+          if top_class
+            html += template('div', classes: "s-#{top_class.gsub(/m[ty]{1}-/, '')}", contents: nil)
+          end
+          html += node.to_html
+          if bottom_class
+            html += template('div', classes: "s-#{bottom_class.gsub(/m[by]{1}-/, '')}", contents: nil)
+          end
+          node.replace(html)
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/components/padding.rb ADDED

@@ -0,0 +1,16 @@
+module BootstrapEmail
+  module Component
+    class Padding < Base
+      def build
+        each_node('*[class*=p-], *[class*=pt-], *[class*=pr-], *[class*=pb-], *[class*=pl-], *[class*=px-], *[class*=py-]') do |node|
+          next if ['table', 'td', 'a'].include?(node.name)
+          padding_regex = /(p[trblxy]?-\d+)/
+          classes = node['class'].scan(padding_regex).join(' ')
+          node['class'] = node['class'].gsub(padding_regex, '')
+          node.replace(template('table', classes: classes, contents: node.to_html))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+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

data/lib/bootstrap-email/components/spacer.rb ADDED

@@ -0,0 +1,11 @@
+module BootstrapEmail
+  module Component
+    class Spacer < Base
+      def build
+        each_node('*[class*=s-]') do |node|
+          node.replace(template('table', classes: "#{node['class']} w-full", contents: '&nbsp;'))
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/components/spacing.rb ADDED

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

data/lib/bootstrap-email/components/table.rb ADDED

@@ -0,0 +1,13 @@
+module BootstrapEmail
+  module Component
+    class Table < Base
+      def build
+        each_node('table') do |node|
+          node['border'] = 0
+          node['cellpadding'] = 0
+          node['cellspacing'] = 0
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap-email/initialize.rb ADDED

	@@ -0,0 +1 @@
1	+ Premailer::Adapter.use = :nokogiri_fast

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

@@ -0,0 +1,10 @@
+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
+    end
+    alias make_bootstrap_mail bootstrap_mail
+  end
+end

data/lib/bootstrap-email/{engine.rb → rails/engine.rb} RENAMED

File without changes

data/lib/bootstrap-email/sass_cache.rb ADDED

@@ -0,0 +1,47 @@
+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
+      lookup_locations = ["#{name}.config.scss", "app/assets/stylesheets/#{name}.config.scss"]
+      locations = lookup_locations.select { |location| File.exist?(File.expand_path(location, Dir.pwd)) }
+      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
+      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
+      end
+    end
+    def self.checksum(config_file)
+      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
+      end
+      Digest::SHA1.hexdigest(checksums.join)
+    end
+    def self.cached?(cache_path)
+      File.file?(cache_path)
+    end
+  end
+end

data/lib/bootstrap-email/version.rb CHANGED

@@ -1,7 +1,5 @@
 module BootstrapEmail
-  module Rails
-    VERSION = File.read(
-      File.expand_path('../../VERSION', __dir__)
-    ).strip
-  end
+  VERSION = File.read(
+    File.expand_path('../../VERSION', __dir__)
+  ).strip.freeze
 end

data/lib/bootstrap_email.rb ADDED

@@ -0,0 +1,26 @@
+require 'nokogiri'
+require 'erb'
+require 'ostruct'
+require 'premailer'
+require 'sassc'
+require 'digest/sha1'
+require 'css_parser'
+begin
+  require 'rails'
+rescue LoadError; end
+if defined?(Rails)
+  require 'action_mailer'
+end
+require_relative 'bootstrap-email/initialize'
+require_relative 'bootstrap-email/compiler'
+require_relative 'bootstrap-email/sass_cache'
+require_relative 'bootstrap-email/version'
+Dir[File.join(__dir__, 'bootstrap-email/components', '*.rb')].each { |file| require_relative file }
+if defined?(Rails)
+  require_relative 'bootstrap-email/rails/action_mailer'
+  require_relative 'bootstrap-email/rails/engine'
+end

metadata CHANGED

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-email
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Stuart Yamartino
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionmailer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -39,100 +25,126 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: premailer-rails
+  name: premailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-description:
-email: stuartyamartino@gmail.com
-executables: []
+        version: '2.4'
+description:
+email: stu@stuyam.com
+executables:
+- bootstrap-email
 extensions: []
 extra_rdoc_files: []
 files:
 - VERSION
+- bin/bootstrap-email
 - core/bootstrap-email.scss
-- core/head.scss
-- core/sass/_alert.scss
-- core/sass/_badge.scss
-- core/sass/_border.scss
-- core/sass/_button.scss
-- core/sass/_card.scss
-- core/sass/_color.scss
-- core/sass/_container.scss
-- core/sass/_display.scss
-- core/sass/_functions.scss
-- core/sass/_grid.scss
-- core/sass/_hr.scss
-- core/sass/_image.scss
-- core/sass/_preview.scss
-- core/sass/_reboot_email.scss
-- core/sass/_spacing.scss
-- core/sass/_table.scss
-- core/sass/_typography.scss
-- core/sass/_variables.scss
-- core/template.html.erb
-- core/templates/align-center.html.erb
-- core/templates/align-left.html.erb
-- core/templates/align-right.html.erb
+- core/bootstrap-head.scss
+- core/layout.html.erb
+- core/scss/_colors.scss
+- core/scss/_functions.scss
+- core/scss/_helper_groups.scss
+- core/scss/_reboot_email.scss
+- core/scss/_selectors_for_utils.scss
+- core/scss/_utilities.scss
+- core/scss/_variables.scss
+- core/scss/components/_alert.scss
+- core/scss/components/_badge.scss
+- core/scss/components/_button.scss
+- core/scss/components/_card.scss
+- core/scss/components/_container.scss
+- core/scss/components/_grid.scss
+- core/scss/components/_hr.scss
+- core/scss/components/_image.scss
+- core/scss/components/_preview.scss
+- core/scss/components/_table.scss
+- core/scss/utilities/_background.scss
+- core/scss/utilities/_border-radius.scss
+- core/scss/utilities/_border.scss
+- core/scss/utilities/_color.scss
+- core/scss/utilities/_display.scss
+- core/scss/utilities/_sizing.scss
+- 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/hr.html.erb
 - core/templates/row.html.erb
 - core/templates/table-left.html.erb
 - core/templates/table.html.erb
-- lib/assets/stylesheets/bootstrap-email.scss
-- lib/bootstrap-email.rb
-- lib/bootstrap-email/action_mailer.rb
-- lib/bootstrap-email/engine.rb
-- lib/bootstrap-email/premailer_railtie.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/initialize.rb
+- lib/bootstrap-email/rails/action_mailer.rb
+- lib/bootstrap-email/rails/engine.rb
+- lib/bootstrap-email/sass_cache.rb
 - lib/bootstrap-email/version.rb
+- lib/bootstrap_email.rb
 homepage: https://bootstrapemail.com
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key:
 specification_version: 4
-summary: Bootstrap 4 stylesheet, compiler, and inliner for responsive and consistent
-  emails with the Bootstrap syntax you know and love.
+summary: 'Bootstrap 5 stylesheet, compiler, and inliner for responsive and consistent
+  emails with the Bootstrap syntax you know and love. Support: command line, ruby,
+  rails'
 test_files: []