premailer 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31108244f6afc74508eef1337a9b99adc7f2643b5412e2aacf808ecb8c520101
-  data.tar.gz: b2f10188d4b7143050eb86e04776c38fc220ebb834da7871e838fe47db5fe9c5
+  metadata.gz: 7e9ea60eb04b53f20269417902391f03464d1dd263f98cb0884b65e1d019a9e5
+  data.tar.gz: 448daeae92d362f8ec092300793d729bed26622590f98122c27e379ab24b631f
 SHA512:
-  metadata.gz: 4cd3655f0aa411da6d874dd50e2e1ab1c6f1cae4f9882cfa84a6ec2022174f5d9670d439527bb27618774f7f731f7ac24b35420c58926db159b4f81e85cb660d
-  data.tar.gz: aa583335ee3a7b0de99320aff3c162d233825c99fbfe287ae13f12790c4b54728b7b0460861f928efe9ddae07416aafb229058f698267214e8b740ff94ea20a8
+  metadata.gz: 57c3c0f79e925c133c999c683e683bc1c7a3b0889baaa184b0bc39d41c869d677e269eb371b3231c20607bb267ff5797ea7b323a80d57db3d62266cd964e603b
+  data.tar.gz: fb2bb6a1f120102a6f6f4e54543fb315257f69bf8f1564dc3ba10d7fcbcc29bf8ff8247e38fd7bd3abbb6beeb38e899dc5e0015e858c371e1742c292cd3b8b92

data/README.md

@@ -127,6 +127,75 @@ Premailer.new(
 
 [available options](https://premailer.github.io/premailer/Premailer.html#initialize-instance_method)
 
+## Support for CSS variables
+
+The gem does not automatically replace CSS variables with their static values.
+
+For example, if a variable is used to set the `font-weight` of an `h1` element, the result will be
+```html
+<h1 style="
+  font-size:3rem;
+  font-weight:var(--bulma-content-heading-weight);">
+  Title</h1>
+```
+
+This causes the `font-weight` value to be the CSS variable call `var(--bulma-content-heading-weight);` instead of its static value.
+
+### Replace CSS variable calls with their static values
+
+The following section instructs how to replace CSS variables with their static value in the context of a Ruby on Rails application.
+
+Install the `postcss-css-variables` plugin for PostCSS to process the CSS variables.
+
+```shell
+yarn add postcss postcss-cli postcss-css-variables
+```
+
+To configure the plugin, create the file `postcss.config.js` in the root directory with the content:
+
+```javascript
+module.exports = {
+    plugins: [
+        // https://github.com/MadLittleMods/postcss-css-variables to transform the css
+      require("postcss-css-variables")({
+        preserve: false, // Set to false to replace variables with static values
+      }),
+    ],
+  };
+```
+
+In the `package.json` file, add the new "build:emails" to the scripts.<br>Replace `./app/assets/stylesheets/emails.css` with your file path:
+```json
+"scripts": {
+  "build:emails": "postcss ./app/assets/stylesheets/emails.css -o ./app/assets/builds/emails.css"
+}
+```
+
+The previous script processes and overwrites the file at `./app/assets/stylesheets/emails.css` with PostCSS using its `postcss-css-variables` plugin, replacing the CSS variables with their static value.
+
+If the file to be processed is not `.css`, but `.scss`, it needs to be converted first to `.css`, then have its variables replaced. The script would then be
+
+```json
+"scripts": {
+  "build:emails": "sass ./app/assets/stylesheets/emails.scss:./app/assets/builds/emails.css --no-source-map --load-path=node_modules && postcss ./app/assets/builds/emails.css -o ./app/assets/builds/emails.css"
+}
+```
+
+Next, to execute the script when running `bin/dev`, add the following line in the file `Procfile.dev`
+
+```
+emails_css: yarn build:emails --watch
+```
+
+The srcipt can also be executed separately with the command
+
+```shell
+yarn build:emails
+```
+
+### Caveat
+
+The variables must be declared before use. Otherwise, their values when called will be set to `undefined`.
 
 ## Contributions
 

data/lib/premailer/adapter/nokogiri.rb

@@ -23,19 +23,19 @@ class Premailer
         # Iterate through the rules and merge them into the HTML
         @css_parser.each_selector(:all) do |selector, declaration, specificity, media_types|
           # Save un-mergable rules separately
-          selector.gsub!(/:link([\s]*)+/i) { |m| $1 }
+          selector.gsub!(/:link([\s]*)+/i) { |_m| $1 }
 
           # Convert element names to lower case
-          selector.gsub!(/([\s]|^)([\w]+)/) { |m| $1.to_s + $2.to_s.downcase }
+          selector.gsub!(/([\s]|^)([\w]+)/) { |_m| $1.to_s + $2.to_s.downcase }
 
-          if Premailer.is_media_query?(media_types) || selector =~ Premailer::RE_UNMERGABLE_SELECTORS
+          if Premailer.media_query?(media_types) || selector =~ Premailer::RE_UNMERGABLE_SELECTORS
             @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selectors: selector, block: declaration), media_types) unless @options[:preserve_styles]
           else
             begin
-              if Premailer::RE_RESET_SELECTORS.match?(selector)
+              if Premailer::RE_RESET_SELECTORS.match?(selector) && !!@options[:preserve_reset]
                 # this is in place to preserve the MailChimp CSS reset: http://github.com/mailchimp/Email-Blueprints/
                 # however, this doesn't mean for testing pur
-                @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selectors: selector, block: declaration)) unless !@options[:preserve_reset]
+                @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selectors: selector, block: declaration))
               end
 
               # Change single ID CSS selectors into xpath so that we can match more
@@ -43,14 +43,14 @@ class Premailer
               selector.gsub!(/\A\#([\w_\-]+)\Z/, '*[@id=\1]')
 
               doc.search(selector).each do |el|
-                if el.elem? and (el.name != 'head' and el.parent.name != 'head')
+                if el.elem? && ((el.name != 'head') && (el.parent.name != 'head'))
                   # Add a style attribute or append to the existing one
                   block = "[SPEC=#{specificity}[#{declaration}]]"
                   el['style'] = (el.attributes['style'].to_s ||= '') + ' ' + block
                 end
               end
             rescue ::Nokogiri::SyntaxError, RuntimeError, ArgumentError
-              $stderr.puts "CSS syntax error with selector: #{selector}" if @options[:verbose]
+              warn "CSS syntax error with selector: #{selector}" if @options[:verbose]
               next
             end
           end
@@ -63,7 +63,7 @@ class Premailer
         doc.search("*[@style]").each do |el|
           style = el.attributes['style'].to_s
 
-          declarations = style.scan(/\[SPEC\=([\d]+)\[(.[^\]\]]*)\]\]/m).filter_map do |declaration|
+          declarations = style.scan(/\[SPEC=([\d]+)\[(.[^\]]*)\]\]/m).filter_map do |declaration|
             rs = Premailer::CachedRuleSet.new(block: declaration[1].to_s, specificity: declaration[0].to_i)
             rs.expand_shorthand!
             rs
@@ -80,9 +80,9 @@ class Premailer
           end
 
           # Duplicate CSS attributes as HTML attributes
-          if Premailer::RELATED_ATTRIBUTES.has_key?(el.name) && @options[:css_to_attributes]
+          if Premailer::RELATED_ATTRIBUTES.key?(el.name) && @options[:css_to_attributes]
             Premailer::RELATED_ATTRIBUTES[el.name].each do |css_attr, html_attr|
-              if el[html_attr].nil? and not merged[css_attr].empty?
+              if el[html_attr].nil? && !merged[css_attr].empty?
                 new_val = merged[css_attr].dup
 
                 # Remove url() function wrapper
@@ -117,9 +117,9 @@ class Premailer
 
         doc = write_unmergable_css_rules(doc, @unmergable_rules) unless @options[:drop_unmergeable_css_rules]
 
-        if @options[:remove_classes] or @options[:remove_comments]
+        if @options[:remove_classes] || @options[:remove_comments]
           doc.traverse do |el|
-            if el.comment? and @options[:remove_comments]
+            if el.comment? && @options[:remove_comments]
               el.remove
             elsif el.element?
               el.remove_attribute('class') if @options[:remove_classes]
@@ -131,7 +131,7 @@ class Premailer
           # find all anchor's targets and hash them
           targets = []
           doc.search("a[@href^='#']").each do |el|
-            target = el.get_attribute('href')[1..-1]
+            target = el.get_attribute('href')[1..]
             targets << target
             el.set_attribute('href', "#" + Digest::SHA256.hexdigest(target))
           end
@@ -153,7 +153,7 @@ class Premailer
         end
 
         @processed_doc = doc
-        if is_xhtml?
+        if xhtml?
           # we don't want to encode carriage returns
           @processed_doc.to_xhtml(:encoding => @options[:output_encoding]).gsub(/&\#(xD|13);/i, "\r")
         else
@@ -175,17 +175,16 @@ class Premailer
             style_tag.content = styles
             doc.add_child(style_tag)
           else
-            style_tag = doc.create_element "style", "#{styles}"
+            style_tag = doc.create_element "style", styles.to_s
             head = doc.at_css('head')
-            head ||=  doc.root.first_element_child.add_previous_sibling(doc.create_element "head")  if doc.root && doc.root.first_element_child
-            head ||=  doc.add_child(doc.create_element "head")
+            head ||=  doc.root.first_element_child.add_previous_sibling(doc.create_element("head")) if doc.root&.first_element_child
+            head ||=  doc.add_child(doc.create_element("head"))
             head << style_tag
           end
         end
         doc
       end
 
-
       # Converts the HTML document to a format suitable for plain-text e-mail.
       #
       # If present, uses the <body> element as its base; otherwise uses the whole document.
@@ -195,17 +194,17 @@ class Premailer
         html_src = ''
         begin
           html_src = @doc.at("body").inner_html
-        rescue;
+        rescue StandardError
         end
 
-        html_src = @doc.to_html unless html_src and not html_src.empty?
+        html_src = @doc.to_html unless html_src && !html_src.empty?
         convert_to_text(html_src, @options[:line_length], @html_encoding)
       end
 
       # Gets the original HTML as a string.
       # @return [String] HTML.
       def to_s
-        if is_xhtml?
+        if xhtml?
           @doc.to_xhtml(:encoding => nil)
         else
           @doc.to_html(:encoding => nil)
@@ -219,13 +218,13 @@ class Premailer
         thing = nil
 
         # TODO: duplicate options
-        if @options[:with_html_string] or @options[:inline] or input.respond_to?(:read)
+        if @options[:with_html_string] || @options[:inline] || input.respond_to?(:read)
           thing = input
         elsif @is_local_file
           @base_dir = File.dirname(input)
           thing = File.open(input, 'r')
         else
-          thing = URI.open(input)
+          thing = URI.parse(input).open
         end
 
         if thing.respond_to?(:read)
@@ -236,7 +235,7 @@ class Premailer
         doc = nil
 
         # Handle HTML entities
-        if @options[:replace_html_entities] == true and thing.is_a?(String)
+        if (@options[:replace_html_entities] == true) && thing.is_a?(String)
           thing = +thing
           HTML_ENTITIES.map do |entity, replacement|
             thing.gsub! entity, replacement
@@ -246,7 +245,7 @@ class Premailer
         doc = if @options[:html_fragment]
           ::Nokogiri::HTML.fragment(thing, encoding)
         else
-          ::Nokogiri::HTML(thing, nil, encoding) { |c| c.recover }
+          ::Nokogiri::HTML(thing, nil, encoding, &:recover)
         end
 
         # Fix for removing any CDATA tags from both style and script tags inserted per
@@ -254,13 +253,12 @@ class Premailer
         # https://github.com/premailer/premailer/issues/199
         ['style', 'script'].each do |tag|
           doc.search(tag).children.each do |child|
-            child.swap(child.text()) if child.cdata?
+            child.swap(child.text) if child.cdata?
           end
         end
 
         doc
       end
-
     end
   end
 end

data/lib/premailer/adapter/nokogiri_fast.rb

@@ -27,34 +27,33 @@ class Premailer
 
         # Iterate through the rules and merge them into the HTML
         @css_parser.each_selector(:all) do |selector, declaration, specificity, media_types|
-
           # Save un-mergable rules separately
-          selector.gsub!(/:link([\s]*)+/i) { |m| $1 }
+          selector.gsub!(/:link([\s]*)+/i) { |_m| $1 }
 
           # Convert element names to lower case
-          selector.gsub!(/([\s]|^)([\w]+)/) { |m| $1.to_s + $2.to_s.downcase }
+          selector.gsub!(/([\s]|^)([\w]+)/) { |_m| $1.to_s + $2.to_s.downcase }
 
-          if Premailer.is_media_query?(media_types) || selector =~ Premailer::RE_UNMERGABLE_SELECTORS
+          if Premailer.media_query?(media_types) || selector =~ Premailer::RE_UNMERGABLE_SELECTORS
             @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selectors: selector, block: declaration), media_types) unless @options[:preserve_styles]
           else
             begin
-              if Premailer::RE_RESET_SELECTORS.match?(selector)
+              if Premailer::RE_RESET_SELECTORS.match?(selector) && !!@options[:preserve_reset]
                 # this is in place to preserve the MailChimp CSS reset: http://github.com/mailchimp/Email-Blueprints/
                 # however, this doesn't mean for testing pur
-                @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selectors: selector, block: declaration)) unless !@options[:preserve_reset]
+                @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selectors: selector, block: declaration))
               end
 
               # Try the new index based technique. If not supported, fall back to the old brute force one.
               nodes = match_selector(index, all_nodes, descendants, selector) || doc.search(selector)
               nodes.each do |el|
-                if el.elem? and (el.name != 'head' and el.parent.name != 'head')
+                if el.elem? && ((el.name != 'head') && (el.parent.name != 'head'))
                   # Add a style attribute or append to the existing one
                   block = "[SPEC=#{specificity}[#{declaration}]]"
                   el['style'] = (el.attributes['style'].to_s ||= '') + ' ' + block
                 end
               end
             rescue ::Nokogiri::SyntaxError, RuntimeError, ArgumentError
-              $stderr.puts "CSS syntax error with selector: #{selector}" if @options[:verbose]
+              warn "CSS syntax error with selector: #{selector}" if @options[:verbose]
               next
             end
           end
@@ -68,13 +67,11 @@ class Premailer
           style = el.attributes['style'].to_s
 
           declarations = []
-          style.scan(/\[SPEC\=([\d]+)\[(.[^\]\]]*)\]\]/m).each do |declaration|
-            begin
-              rs = CssParser::RuleSet.new(block: declaration[1].to_s, specificity: declaration[0].to_i)
-              declarations << rs
-            rescue ArgumentError => e
-              raise e if @options[:rule_set_exceptions]
-            end
+          style.scan(/\[SPEC=([\d]+)\[(.[^\]]*)\]\]/m).each do |declaration|
+            rs = CssParser::RuleSet.new(block: declaration[1].to_s, specificity: declaration[0].to_i)
+            declarations << rs
+          rescue ArgumentError => e
+            raise e if @options[:rule_set_exceptions]
           end
 
           # Perform style folding
@@ -86,9 +83,9 @@ class Premailer
           end
 
           # Duplicate CSS attributes as HTML attributes
-          if Premailer::RELATED_ATTRIBUTES.has_key?(el.name) && @options[:css_to_attributes]
+          if Premailer::RELATED_ATTRIBUTES.key?(el.name) && @options[:css_to_attributes]
             Premailer::RELATED_ATTRIBUTES[el.name].each do |css_attr, html_attr|
-              if el[html_attr].nil? and not merged[css_attr].empty?
+              if el[html_attr].nil? && !merged[css_attr].empty?
                 new_val = merged[css_attr].dup
 
                 # Remove url() function wrapper
@@ -123,9 +120,9 @@ class Premailer
 
         doc = write_unmergable_css_rules(doc, @unmergable_rules) unless @options[:drop_unmergeable_css_rules]
 
-        if @options[:remove_classes] or @options[:remove_comments]
+        if @options[:remove_classes] || @options[:remove_comments]
           doc.traverse do |el|
-            if el.comment? and @options[:remove_comments]
+            if el.comment? && @options[:remove_comments]
               el.remove
             elsif el.element?
               el.remove_attribute('class') if @options[:remove_classes]
@@ -137,7 +134,7 @@ class Premailer
           # find all anchor's targets and hash them
           targets = []
           doc.search("a[@href^='#']").each do |el|
-            target = el.get_attribute('href')[1..-1]
+            target = el.get_attribute('href')[1..]
             targets << target
             el.set_attribute('href', "#" + Digest::SHA256.hexdigest(target))
           end
@@ -159,7 +156,7 @@ class Premailer
         end
 
         @processed_doc = doc
-        if is_xhtml?
+        if xhtml?
           # we don't want to encode carriage returns
           @processed_doc.to_xhtml(:encoding => @options[:output_encoding]).gsub(/&\#(xD|13);/i, "\r")
         else
@@ -183,15 +180,14 @@ class Premailer
           else
             style_tag = doc.create_element "style", styles
             head = doc.at_css('head')
-            head ||= doc.root.first_element_child.add_previous_sibling(doc.create_element "head") if doc.root && doc.root.first_element_child
-            head ||= doc.add_child(doc.create_element "head")
+            head ||= doc.root.first_element_child.add_previous_sibling(doc.create_element("head")) if doc.root&.first_element_child
+            head ||= doc.add_child(doc.create_element("head"))
             head << style_tag
           end
         end
         doc
       end
 
-
       # Converts the HTML document to a format suitable for plain-text e-mail.
       #
       # If present, uses the <body> element as its base; otherwise uses the whole document.
@@ -201,17 +197,17 @@ class Premailer
         html_src = ''
         begin
           html_src = @doc.at("body").inner_html
-        rescue;
+        rescue StandardError
         end
 
-        html_src = @doc.to_html unless html_src and not html_src.empty?
+        html_src = @doc.to_html unless html_src && !html_src.empty?
         convert_to_text(html_src, @options[:line_length], @html_encoding)
       end
 
       # Gets the original HTML as a string.
       # @return [String] HTML.
       def to_s
-        if is_xhtml?
+        if xhtml?
           @doc.to_xhtml(:encoding => nil)
         else
           @doc.to_html(:encoding => nil)
@@ -225,13 +221,13 @@ class Premailer
         thing = nil
 
         # TODO: duplicate options
-        if @options[:with_html_string] or @options[:inline] or input.respond_to?(:read)
+        if @options[:with_html_string] || @options[:inline] || input.respond_to?(:read)
           thing = input
         elsif @is_local_file
           @base_dir = File.dirname(input)
           thing = File.open(input, 'r')
         else
-          thing = URI.open(input)
+          thing = URI.parse(input).open
         end
 
         if thing.respond_to?(:read)
@@ -242,7 +238,7 @@ class Premailer
         doc = nil
 
         # Handle HTML entities
-        if @options[:replace_html_entities] == true and thing.is_a?(String)
+        if (@options[:replace_html_entities] == true) && thing.is_a?(String)
           HTML_ENTITIES.map do |entity, replacement|
             thing.gsub! entity, replacement
           end
@@ -251,7 +247,7 @@ class Premailer
         doc = if @options[:html_fragment]
           ::Nokogiri::HTML.fragment(thing, encoding)
         else
-          ::Nokogiri::HTML(thing, nil, encoding) { |c| c.recover }
+          ::Nokogiri::HTML(thing, nil, encoding, &:recover)
         end
 
         # Fix for removing any CDATA tags from both style and script tags inserted per
@@ -259,7 +255,7 @@ class Premailer
         # https://github.com/premailer/premailer/issues/199
         ['style', 'script'].each do |tag|
           doc.search(tag).children.each do |child|
-            child.swap(child.text()) if child.cdata?
+            child.swap(child.text) if child.cdata?
           end
         end
 
@@ -283,7 +279,7 @@ class Premailer
         page.traverse do |node|
           all_nodes.push(node)
 
-          if node != page then
+          if node != page
             index_ancestry(page, node, node.parent, descendants)
           end
 
@@ -294,7 +290,7 @@ class Premailer
           # Index the node by all class attributes it possesses.
           # Classes are modestly selective. Usually more than tag names
           # but less selective than ids.
-          if node.has_attribute?("class") then
+          if node.has_attribute?("class")
             node.get_attribute("class").split(/\s+/).each do |c|
               c = '.' + c
               index[c] = (index[c] || Set.new).add(node)
@@ -303,7 +299,7 @@ class Premailer
 
           # Index the node by its "id" attribute if it has one.
           # This is usually the most selective of the three.
-          if node.has_attribute?("id") then
+          if node.has_attribute?("id")
             id = '#' + node.get_attribute("id")
             index[id] = (index[id] || Set.new).add(node)
           end
@@ -325,9 +321,9 @@ class Premailer
       # @param descendants The running hash map of node -> set of nodes that maps descendants of a node.
       # @return The descendants argument after updating it.
       def index_ancestry(doc, elem, parent, descendants)
-        if parent then
+        if parent
           descendants[parent] = (descendants[parent] || Set.new).add(elem)
-          if doc != parent then
+          if doc != parent
             index_ancestry(doc, elem, parent.parent, descendants)
           end
         end
@@ -356,14 +352,14 @@ class Premailer
       # It will return nil when such a selector is passed, so you can take
       # action on the falsity of the return value.
       def match_selector(index, all_nodes, descendants, selector)
-        if /[^-a-zA-Z0-9_\s.#]/.match?(selector) then
+        if /[^-a-zA-Z0-9_\s.#]/.match?(selector)
           return nil
         end
 
         take_children = false
         selector.split(/\s+/).reduce(all_nodes) do |base, spec|
           desc = base
-          if take_children then
+          if take_children
             desc = Set.new
             base.each do |n|
               desc.merge(descendants[n])