bootstrap-email 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1145fbba3e6a8db2d8fe571b8f5a4d05ff78ba0ddd4c40dea9ce317e06e5f1fe
-  data.tar.gz: f2aa2c03962d575448af829b381f18cfde6bacee0a2caf03b66a9ae0f218824f
+  metadata.gz: c82d69b4546e02daeeff5fc09df8e91c3c372f6da42e39fd96b438bd0776a7c3
+  data.tar.gz: 8cc3f250c82b779ddb99ae0d9618523b716d8110e0cbd3b639a71255158c181d
 SHA512:
-  metadata.gz: 150353d9f8a03a0b8fe0434013c5c814a97dc2eb1b03287517174c95d9df30fa22e1564d3dc8d2fc7cc9bc33734da0d845341cc4d8e07bfee1ca23db84490a9e
-  data.tar.gz: ce8b05c478d2bda5a46518d90a2bb3c8c6c8a1fe01bf197524b95c2b3182d5ca9f9b24e08bce6022f3af68779d7b087c54605dbe3b861b32bd601a1f551f5e8d
+  metadata.gz: 7154cdcef0287e4fbcb37f117f5c73ae4dbf15b11a28b287b13b082d1ac05b63d5010b664a230cf907e7eafb8c27901db5e584db8a65fa7eb7ea1101cf42c6a1
+  data.tar.gz: bc5f07bdcb6ffca350685b5b39114d121ed27e33d4e18b24ce624143a4bd29f7210e405958634e1b86bc0ae6acdd5b70c259b5a77c805a3085d345a392f412c0

data/VERSION

@@ -1 +1 @@
-1.1.7
+1.2.0

data/lib/bootstrap-email/compiler.rb

@@ -2,10 +2,10 @@
 
 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
@@ -41,11 +41,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,
@@ -86,7 +86,7 @@ module BootstrapEmail
     end
 
     def configure_html!
-      BootstrapEmail::Converter::HeadStyle.build(doc)
+      BootstrapEmail::Converter::HeadStyle.build(doc, config)
       BootstrapEmail::Converter::AddMissingMetaTags.build(doc)
       BootstrapEmail::Converter::VersionComment.build(doc)
     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,31 @@
+# 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
+    ].freeze
+
+    attr_reader(*OPTIONS)
+
+    OPTIONS.each do |option|
+      define_method("#{option}=") do |value|
+        instance_variable_set("@#{option}", value)
+      end
+    end
+
+    def initialize(options = [])
+      options.each { |name, value| instance_variable_set("@#{name}", value) if OPTIONS.include?(name) }
+    end
+
+    def did_set?(option)
+      instance_variable_defined?("@#{option}")
+    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/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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-email
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Stuart Yamartino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-18 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