inkcite 1.11.0 → 1.12.0

data/lib/inkcite/uploader.rb

@@ -10,11 +10,11 @@ module Inkcite
 
       ['source.html', 'source.txt', 'helpers.tsv'].each do |file|
         file = email.project_file(file)
-        times << File.mtime(file).to_i if File.exists?(file)
+        times << File.mtime(file).to_i if File.exist?(file)
       end
 
       local_images = email.image_dir
-      if File.exists?(local_images)
+      if File.exist?(local_images)
         Dir.foreach(local_images) do |file|
           times << File.mtime(File.join(local_images, file)).to_i unless file.starts_with?('.')
         end
@@ -42,7 +42,7 @@ module Inkcite
 
       # Nothing to copy unless the local directory exists (e.g. some emails don't
       # have an images directory.)
-      return unless File.exists?(local)
+      return unless File.exist?(local)
 
       Dir.foreach(local) do |file|
         next if file.starts_with?('.')

data/lib/inkcite/util.rb

@@ -25,7 +25,7 @@ module Inkcite
 
     def self.darken color, amount=0.4
       return BLACK if color.nil?
-      rgb = color.gsub('#', '').scan(/../).map { |color| color.hex }
+      rgb = color.gsub('#', '').scan(/../).map { |c| c.hex }
       rgb[0] = (rgb[0].to_i * amount).round
       rgb[1] = (rgb[1].to_i * amount).round
       rgb[2] = (rgb[2].to_i * amount).round
@@ -38,9 +38,23 @@ module Inkcite
       opts.detect { |o| !o.blank? }
     end
 
+    # Centralizing the URL/CGI encoding for all HREF processing because
+    # URI.escape/encode is obsolete.
+    def self.encode *arg
+      silence_warnings do
+        URI.escape(*arg)
+      end
+    end
+
+    def self.escape *arg
+      silence_warnings do
+        URI.escape(*arg)
+      end
+    end
+
     def self.lighten color, amount=0.6
       return WHITE if color.nil?
-      rgb = color.gsub('#', '').scan(/../).map { |color| color.hex }
+      rgb = color.gsub('#', '').scan(/../).map { |c| c.hex }
       rgb[0] = [(rgb[0].to_i + 255 * amount).round, 255].min
       rgb[1] = [(rgb[1].to_i + 255 * amount).round, 255].min
       rgb[2] = [(rgb[2].to_i + 255 * amount).round, 255].min
@@ -53,7 +67,7 @@ module Inkcite
 
     def self.each_line path, fail_if_not_exists, &block
 
-      if File.exists?(path)
+      if File.exist?(path)
         File.open(path).each { |line| yield line.strip }
       elsif fail_if_not_exists
         raise "File not found: #{path}"
@@ -66,12 +80,12 @@ module Inkcite
     end
 
     def self.last_modified file
-      file && File.exists?(file) ? File.mtime(file).to_i : 0
+      file && File.exist?(file) ? File.mtime(file).to_i : 0
     end
 
     def self.read *argv
       path = File.join(File.expand_path('../..', File.dirname(__FILE__)), argv)
-      if File.exists?(path)
+      if File.exist?(path)
         line = File.open(path).read
         line.gsub!(/[\r\f\n]+/, "\n")
         line.gsub!(/ {2,}/, ' ')

data/lib/inkcite/version.rb

@@ -1,3 +1,3 @@
 module Inkcite
-  VERSION = "1.11.0"
+  VERSION = "1.12.0"
 end

data/lib/inkcite/view.rb

@@ -24,7 +24,7 @@ module Inkcite
     attr_reader :media_query
 
     # Line number of the email file being processed
-    attr_accessor :line
+    attr_accessor :line_number
 
     # The configuration hash for the view
     attr_accessor :config
@@ -35,7 +35,6 @@ module Inkcite
     # Will be populated with the css and js compressor objects
     # after first use.  Ensures we can reset the compressors
     # after a rendering is complete.
-    attr_accessor :css_compressor
     attr_accessor :js_compressor
 
     def initialize email, environment, format, version
@@ -60,6 +59,9 @@ module Inkcite
       @config[:format] = format.to_s
       @config[FILE_NAME] = file_name
 
+      # Expose the project's directory name as the project entry.
+      @config[:project] = File.basename(@email.path)
+
       # The MediaQuery object manages the responsive styles that are applied to
       # the email during rendering.  Check to see if a breakwidth has been supplied
       # in helpers.tsv so the designer can control the primary breakpoint.
@@ -77,11 +79,14 @@ module Inkcite
 
       # Tracks the line number and is recorded when errors are encountered
       # while rendering said line.
-      @line = 0
+      @line_number = 0
 
       # True if VML is used during the preparation of this email.
       @vml_used = false
 
+      # Initializing to prevent a ruby verbose warning.
+      @footnotes = nil
+
     end
 
     def [] key
@@ -110,7 +115,7 @@ module Inkcite
 
       # This is the full path to the image on the dev's harddrive.
       path = @email.image_path(src)
-      exists = File.exists?(path)
+      exists = File.exist?(path)
 
       error('Missing image', { :src => src }) if !exists
 
@@ -121,6 +126,11 @@ module Inkcite
       @format == :browser
     end
 
+    # Arbitrary storage of data
+    def data
+      @data ||= {}
+    end
+
     def default?
       @version == :default
     end
@@ -140,7 +150,7 @@ module Inkcite
     # Records an error message on the currently processing line of the source.
     def error message, obj=nil
 
-      message << " (line #{self.line.to_i})"
+      message << " (line #{self.line_number.to_i})"
       unless obj.blank?
         message << ' ['
         message << obj.collect { |k, v| "#{k}=#{v}" }.join(', ')
@@ -164,7 +174,7 @@ module Inkcite
 
         # Preload the array of footnotes if they exist
         footnotes_tsv_file = @email.project_file(FOOTNOTES_TSV_FILE)
-        if File.exists?(footnotes_tsv_file)
+        if File.exist?(footnotes_tsv_file)
           CSV.foreach(footnotes_tsv_file, { :col_sep => "\t" }) do |fn|
 
             id = fn[0]
@@ -303,7 +313,7 @@ module Inkcite
     def links_tsv
       @links_tsv ||= begin
         links_tsv_file = @email.project_file(LINKS_TSV_FILE)
-        if File.exists?(links_tsv_file)
+        if File.exist?(links_tsv_file)
           Hash[CSV.read(links_tsv_file, { :col_sep => "\t" })]
         else
           {}
@@ -392,7 +402,10 @@ module Inkcite
 
         # Prepare a copy of the HTML for saving as the file.
         html = []
-        html << '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
+
+        # Using HTML5 DOCTYPE
+        # https://emails.hteumeuleu.com/which-doctype-should-you-use-in-html-emails-cd323fdb793c#.cxet9febe
+        html << '<!DOCTYPE html>'
 
         # Resolve the HTML declaration for this email based on whether or not VML was used.
         html_declaration = '<html xmlns="http://www.w3.org/1999/xhtml"'
@@ -407,7 +420,7 @@ module Inkcite
 
         # Enable responsive media queries on Windows phones courtesy of @jamesmacwhite
         # https://blog.jmwhite.co.uk/2014/03/01/windows-phone-does-support-css3-media-queries-in-html-email/
-        html << '<!--[if !mso]><!-->'
+        html << '<!--[if !mso]><!-- -->'
         html << '<meta http-equiv="X-UA-Compatible" content="IE=edge" />'
         html << '<!--<![endif]-->'
 
@@ -527,7 +540,7 @@ module Inkcite
     # Returns true if vml is enabled in this context.  This requires that the
     # context is for an email and that the VML property is enabled.
     def vml_enabled?
-      email? && is_enabled?(:vml)
+      email? && !is_disabled?(:vml)
     end
 
     # Signifies that VML was used during the rendering and that
@@ -727,8 +740,9 @@ module Inkcite
             begin
               font_cache[url] = open(url).read
               updated = true
-            rescue
-              error 'Unable to load Google Web Font', { :url => url }
+            rescue Exception => error
+              error 'Unable to load Google Web Font', { :url => url, :error => error.inspect }
+              next
             end
           end
 
@@ -769,9 +783,6 @@ module Inkcite
 
     def inline_styles
 
-      # This is the default font family for the email.
-      font_family = self[Renderer::Base::FONT_FAMILY]
-
       reset = []
 
       if email?
@@ -840,7 +851,7 @@ module Inkcite
 
       path = @email.path
       file = File.join(path, filename)
-      unless File.exists?(file)
+      unless File.exist?(file)
         error("Unable to load helper file", :file => file) if abort_on_fail
         return
       end
@@ -932,7 +943,7 @@ module Inkcite
 
           # Look for full month names (e.g. February) and add a zero-width space
           # afterwards which prevents iOS from detecting said date.
-          raw.gsub!(/#{mon}/, "#{mon}#{Renderer::Base::ZERO_WIDTH_SPACE}")
+          raw.gsub!(/#{mon}/, "#{mon.dup.insert(1, Renderer::Base::ZERO_WIDTH_NON_BREAKING_SPACE)}")
 
         end
 
@@ -948,7 +959,7 @@ module Inkcite
       filtered.split("\n").each do |line|
 
         # Increment the line number as we read the file.
-        @line += 1
+        @line_number += 1
 
         begin
           line = Renderer.render(line, self)

data/lib/inkcite/view/context.rb

@@ -11,6 +11,36 @@ module Inkcite
         @view = view
       end
 
+      # Defines a new helper via ERB, which allows designers to keep helper
+      # markup alongside the usage of it inside of partial.  Helps keep
+      # code clean and prevents helper.tsv pollution for one-offs
+      def helper tag, open, close=nil
+
+        tag = tag.to_sym
+
+        # The config object holds the defined helpers
+        config = @view.config
+
+        # Warn the user if the helper is already defined.
+        view.error("Helper '#{tag}' already defined", :open => open, :close => close) unless config[tag].nil?
+
+        config[tag] = open.to_s
+        config[:"/#{tag}"] = close.to_s
+
+      end
+
+      def once? key
+
+        # Initialize the 'once' data hash which maps
+        @view.data[:once] ||= {}
+
+        # True if this is the first time we've encountered this key.
+        first_time = @view.data[:once][key].nil?
+        @view.data[:once][key] = true if first_time
+
+        first_time
+      end
+
       def method_missing(m, *args, &block)
         if m[-1] == QUESTION_MARK
           start_at = m[0] == UNDERSCORE ? 1 : 0

data/test/animation_spec.rb

@@ -0,0 +1,38 @@
+
+
+describe Inkcite::Animation do
+
+  before do
+    @view = Inkcite::Email.new('test/project/').view(:development, :email)
+  end
+
+  it 'supports browser prefixing' do
+    Inkcite::Animation.with_browser_prefixes("animation: video-frames 5s ease infinite", @view, { :separator => '; ' }).must_equal('animation: video-frames 5s ease infinite; -webkit-animation: video-frames 5s ease infinite; ')
+  end
+
+  it 'can instantiate an animation keyframe' do
+    Inkcite::Animation::Keyframe.new(5, { :top => '-10px', :left => '22%' }).to_s.must_equal('  5%   { left:22%;top:-10px }')
+  end
+
+  it 'can add style to an animation keyframe' do
+    keyframe = Inkcite::Animation::Keyframe.new(25)
+    keyframe[:top] = '-15%'
+    keyframe[:left] = '78px'
+    keyframe.to_s.must_equal('  25%  { left:78px;top:-15% }')
+  end
+
+  it 'can prefix a style on a keyframe' do
+    keyframe = Inkcite::Animation::Keyframe.new(33)
+    keyframe.add_with_prefixes :transform, 'rotate(14deg)', @view
+    keyframe.to_s.must_equal('  33%  { -webkit-transform:rotate(14deg);transform:rotate(14deg) }')
+  end
+
+  it 'can instantiate an animation and add keyframes' do
+    anim = Inkcite::Animation::Keyframes.new('snowflake7', @view)
+    anim << Inkcite::Animation::Keyframe.new(5, { :top => '-10px', :left => '22%' }).add_with_prefixes(:transform, 'rotate(14deg)', @view)
+    anim.add_keyframe 25, { :top => '100%', :left => '18%' }
+    anim.to_s.must_equal(%Q(@keyframes snowflake7 {\n  5%   { -webkit-transform:rotate(14deg);left:22%;top:-10px;transform:rotate(14deg) }\n  25%  { left:18%;top:100% }\n}\n@-webkit-keyframes snowflake7 {\n  5%   { -webkit-transform:rotate(14deg);left:22%;top:-10px;transform:rotate(14deg) }\n  25%  { left:18%;top:100% }\n}\n))
+  end
+
+
+end

data/test/email_spec.rb

@@ -1,7 +1,3 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'inkcite'
-
 describe Inkcite::Email do
 
   before do

data/test/minifier_spec.rb

@@ -1,7 +1,3 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'inkcite'
-
 describe Inkcite::View do
 
   before do
@@ -25,4 +21,247 @@ describe Inkcite::View do
     Inkcite::Minifier.remove_comments(%Q(I am not <!-- This is a\n\nmulti-line HTML\ncomment -->commented out), @view).must_equal('I am not commented out')
   end
 
+  it "compresses CSS whitespace" do
+    css = <<-EOF
+          table {
+            border-spacing: 0;
+          }
+
+          table, td {
+            border-collapse: collapse;
+          }
+
+          a[href^=tel] {
+            color: #336699;
+            text-decoration: none;
+          }
+
+          div[style*="margin:16px 0"] {
+            margin: 0 !important;
+          }
+    EOF
+
+    Inkcite::Minifier.css(css, @view).must_equal(%Q(table{border-spacing:0}table, td{border-collapse:collapse}a[href^=tel]{color:#336699;text-decoration:none}div[style*="margin:16px 0"]{margin:0 !important}))
+  end
+
+  it "does not interfere with CSS3 animation keyframe at 0%" do
+    css = <<-EOF
+        @-webkit-keyframes s1a2 {
+           0% {
+             top: -3%;
+             left: 68.75%
+           }
+           100% {
+             top: 100%;
+             left: 66%
+           }
+         }
+    EOF
+    Inkcite::Minifier.css(css, @view).must_equal('@-webkit-keyframes s1a2{0%{top:-3%;left:68.75%}100%{top:100%;left:66%}}')
+  end
+
+  it "does not interfere with CSS3 animation rotation in degrees" do
+    css = <<-EOF
+      @-webkit-keyframes snow1-anim8 {
+        0%   { top: -3%; left: 57%; }
+        100% { top: 100%; left: 60%; transform: rotate(-93deg); -webkit-transform: rotate(-93deg); }
+      }
+    EOF
+
+    Inkcite::Minifier.css(css, @view).must_equal('@-webkit-keyframes snow1-anim8{0%{top:-3%;left:57%}100%{top:100%;left:60%;transform:rotate(-93deg);-webkit-transform:rotate(-93deg)}}')
+  end
+
+  it "wraps lines of CSS exceeding #{Inkcite::Minifier::MAXIMUM_LINE_LENGTH} characters" do
+    css = <<-EOF
+      .ExternalClass, .ReadMsgBody {
+        width: 100%;
+      }
+
+      .ExternalClass, .ExternalClass p, .ExternalClass span, .ExternalClass font, .ExternalClass td, .ExternalClass div {
+        line-height: 100%;
+      }
+
+      #outlook a {
+        padding: 0;
+      }
+
+      .yshortcuts, .yshortcuts a, .yshortcuts a:link, .yshortcuts a:visited, .yshortcuts a:hover, .yshortcuts a span {
+        color: black;
+        text-decoration: none !important;
+        border-bottom: none !important;
+        background: none !important;
+      }
+
+      XHTML-STRIPONREPLY {
+        display: none;
+      }
+
+      table {
+        border-spacing: 0;
+      }
+
+      table, td {
+        border-collapse: collapse;
+      }
+
+      a[href^=tel] {
+        color: #336699;
+        text-decoration: none;
+      }
+
+      div[style*="margin: 16px 0"] {
+        margin: 0 !important;
+      }
+
+      td {
+        font-family: sans-serif;
+      }
+
+      @media only screen and (max-width: 480px) {
+        [class~="hide"] {
+          display: none !important;
+        }
+
+        td[class~="drop"] {
+          display: block;
+          width: 100% !important;
+          background-size: 100% auto !important;
+          -moz-box-sizing: border-box;
+          -webkit-box-sizing: border-box;
+          box-sizing: border-box;
+        }
+
+        img[class~="fill"] {
+          width: 100% !important;
+          height: auto !important;
+        }
+
+        table[class~="fill"], td[class~="fill"] {
+          width: 100% !important;
+          background-size: 100% auto !important;
+        }
+
+        span[class~="img"] {
+          display: block;
+          background-position: center;
+          background-size: cover;
+        }
+
+        a[class~="button"] {
+          border: 2px solid #336699;
+          border-radius: 5px;
+          color: #336699 !important;
+          display: block;
+          font-weight: bold;
+          margin-top: 5px;
+          padding: 9px;
+          text-align: center
+        }
+
+        img[class~="i01"] {
+          content: url("images-optim/xxxxxx-xxxxxxxx.jpg?1457623072") !important;
+        }
+
+        td[class~="m1"] {
+          font-size: 15px !important;
+          line-height: 20px !important
+        }
+
+        td[class~="m2"] {
+          text-align: center;
+        }
+
+        table[class~="m3"], td[class~="m3"] {
+          padding: 15px !important;
+        }
+
+        img[class~="i02"] {
+          content: url("images-optim/xxxxxx.jpg?1457623072") !important;
+        }
+
+        td[class~="m4"] {
+          height: 15px;
+          display: block;
+          width: 100%;
+          margin-top: 12px;
+          border-top: 1px dotted #cfcfcf;
+        }
+
+        img[class~="i03"] {
+          content: url("images-optim/xxxxxx.jpg?1457623072") !important;
+        }
+
+        img[class~="i04"] {
+          content: url("images-optim/xxxxxx.jpg?1457623072") !important;
+        }
+
+        table[class~="m5"] {
+          background: #5EAE3F url(images-optim/xxx-xx-x.jpg?1457623072) bottom left / 100% auto no-repeat !important
+        }
+
+        img[class~="i05"] {
+          content: url("images-optim/xxxxx.gif?1457623072") !important;
+        }
+
+        img[class~="i06"] {
+          content: url("images-optim/xxxxx.jpg?1457623072") !important;
+        }
+
+        td[class~="m6"] {
+          padding: 15px;
+        }
+
+        img[class~="i07"] {
+          content: url("images-optim/xxxxx.jpg?1457623072") !important;
+        }
+
+        img[class~="i08"] {
+          content: url("images-optim/xxxxx.jpg?1457623072") !important;
+        }
+
+        img[class~="i09"] {
+          content: url("images-optim/xxxxxx.jpg?1457623072") !important;
+        }
+
+        td[class~="m7"] {
+          height: 15px;
+        }
+
+        img[class~="i10"] {
+          content: url("images-optim/xxxxxx.jpg?1457623072") !important;
+        }
+
+        img[class~="i11"] {
+          content: url("images-optim/xxxxxx.jpg?1457623072") !important;
+        }
+
+        td[class~="m8"] {
+          background: url(images-optim/xxxxx-xx.gif?1457623072) center no-repeat
+        }
+
+        img[class~="i12"] {
+          content: url("images-optim/xxxxx.jpg?1457623072") !important;
+        }
+
+        img[class~="i13"] {
+          content: url("images-optim/xxxxx.jpg?1457623072") !important;
+        }
+
+        img[class~="i14"] {
+          content: url("images-optim/xxxxx.jpg?1457623072") !important;
+        }
+
+        span[class~="i15"] {
+          background-image: url("images-optim/xxx.gif?1457623072");
+          float: right;
+          height: 101px;
+          width: 139px
+        }
+      }
+    EOF
+
+    minified_css = Inkcite::Minifier.css(css, @view)
+    minified_css.split("\n").all? { |l| l.length <= Inkcite::Minifier::MAXIMUM_LINE_LENGTH }.must_equal(true)
+  end
+
 end