inkcite 1.15.0 → 1.16.0

data/lib/inkcite/renderer/special_effect.rb

@@ -258,6 +258,11 @@ module Inkcite
           styles << Inkcite::Renderer::Style.new(".gmail-fix", sfx.ctx, { FONT_SIZE => '3*px' })
         end
 
+        # True if we're limiting the rendering of the animation to iOS clients
+        only_ios = ctx.email? && !ctx.development?
+
+        styles << '@media screen and (-webkit-min-device-pixel-ratio:0) {' if only_ios
+
         # Create the <div> that wraps the entire animation.
         create_wrap_element html, sfx
 
@@ -276,6 +281,8 @@ module Inkcite
         # the individual children are configured.
         sfx.animations.each { |a| styles << a.to_keyframe_css }
 
+        styles << '}' if only_ios
+
         # Push the completed list of styles into the context's stack.
         ctx.styles << styles.join("\n")
 

data/lib/inkcite/renderer/sup.rb

@@ -1,5 +1,8 @@
 module Inkcite
   module Renderer
+
+    # Renders a bulletproof superscript tag.
+    # https://litmus.com/community/discussions/488-best-method-for-superscripts
     class Sup < Base
 
       def render tag, opt, ctx
@@ -13,11 +16,14 @@ module Inkcite
 
           sup = Element.new('sup', :style => { VERTICAL_ALIGN => :top })
 
-          font_size = (opt[FONT_SIZE] || 10).to_i
-          sup.style[FONT_SIZE] = px(font_size)
+          font_size = (opt[FONT_SIZE] || DEFAULT_FONT_SIZE_PERCENT).to_i
+          sup.style[FONT_SIZE] = pct(font_size)
+
+          line_height = (opt[LINE_HEIGHT] || 1).to_i
+          sup.style[LINE_HEIGHT] = line_height
 
-          line_height = (opt[LINE_HEIGHT] || 10).to_i
-          sup.style[LINE_HEIGHT] = px(line_height)
+          mso_text_raise = (font_size.to_f * (DEFAULT_MSO_TEST_RAISE_PERCENT / DEFAULT_FONT_SIZE_PERCENT)).round(0)
+          sup.style[MSO_TEXT_RAISE] = pct(mso_text_raise)
 
           html << sup.to_s
 
@@ -26,6 +32,14 @@ module Inkcite
         html
       end
 
+      private
+
+      # Name of the CSS style used to force
+      MSO_TEXT_RAISE = :'mso-text-raise'
+
+      DEFAULT_FONT_SIZE_PERCENT = 70.0
+      DEFAULT_MSO_TEST_RAISE_PERCENT = 60.0
+
     end
   end
 end

data/lib/inkcite/renderer/table.rb

@@ -67,7 +67,15 @@ module Inkcite
           # If Fluid-Drop is enabled, padding is always zero at this top-level table
           # and will be applied in the TD renderer when it creates a new table to
           # wrap itself in.
-          table[:cellpadding] = is_fluid_drop ? 0 : get_padding(opt)
+          cellpadding = is_fluid_drop ? 0 : get_padding(opt)
+          table[:cellpadding] = cellpadding
+
+          # Need to specify padding as px to ensure that the table plays nicely
+          # with high-DPI email clients like Outlook.
+          if cellpadding > 0
+            cellpaddingpx = px(cellpadding)
+            table.style[MSO_PADDING_ALT] = "#{cellpaddingpx} #{cellpaddingpx} #{cellpaddingpx} #{cellpaddingpx}"
+          end
 
           # Conveniently accept both float and align to mean the same thing.
           align = opt[:align] || opt[:float]

data/lib/inkcite/renderer/table_base.rb

@@ -73,13 +73,31 @@ module Inkcite
         # Not taking .to_i because we want to accept both integer values
         # or percentages - e.g. 50%
         width = opt[:width]
-        element[:width] = width unless width.blank?
+        unless width.blank?
+          element[:width] = width
+
+          # Need to redefine px-based width as a style to fix rendering
+          # problems in high DPI Outlook
+          # https://litmus.com/community/discussions/151-mystery-solved-dpi-scaling-in-outlook-2007-2013
+          element.style[:width] = px(width) unless width[-1] == '%' || is_fluid?(opt[:mobile])
+
+        end
+
 
         mobile_width = opt[MOBILE_WIDTH]
         element.mobile_style[:width] = px(mobile_width) unless none?(mobile_width)
 
         height = opt[:height].to_i
-        element[:height] = height if height > 0
+        if height > 0
+          element[:height] = height
+
+          # Height also needs to be copied into the style to ensure that
+          # high DPI Outlook displays the table properly.
+          # https://litmus.com/community/discussions/151-mystery-solved-dpi-scaling-in-outlook-2007-2013
+          element.style[:height] = px(height)
+
+        end
+
 
         mobile_height = opt[MOBILE_HEIGHT]
         element.mobile_style[:height] = px(mobile_height) unless none?(mobile_height)

data/lib/inkcite/renderer/td.rb

@@ -141,11 +141,16 @@ module Inkcite
           # you know, Outlook.
           align = opt[:align]
           unless align.blank?
-            td[:align] = align
+
+            # If the alignment is justified, force the text alignment attribute to
+            # be left aligned so Outlook doesn't center the text.
+            td[:align] = align == JUSTIFY ? LEFT : align
 
             # Must use style to reinforce left-align text in certain email clients.
             # All other alignments are accepted naturally.
-            td.style[TEXT_ALIGN] = align if align == LEFT
+            td.style[TEXT_ALIGN] = align if align == LEFT || align == JUSTIFY
+
+            mix_text_justify(td, opt, ctx) if align === JUSTIFY
 
           end
 

data/lib/inkcite/renderer/video_preview.rb

@@ -94,7 +94,7 @@ module Inkcite
 
         # Using an Element to produce the appropriate anchor helper with
         # the desired
-        html << Element.new('a', { :id => id, :href => quote(href), :class => hover_klass, :bgcolor => bgcolor, :bggradient => gradient, :block => true }).to_helper
+        html << Element.new('a', { :id => id, :href => quote(href), :class => hover_klass, :bgcolor => bgcolor, :bggradient => gradient, BACKGROUND_GRADIENT_SHAPE => CIRCLE, :block => true }).to_helper
 
         table = Element.new('table', {
                 :width => '100%', :background => frame_srcs[0], BACKGROUND_SIZE => 'cover',

data/lib/inkcite/uploader.rb

@@ -4,45 +4,57 @@ require 'stringio'
 module Inkcite
   class Uploader
 
-    def self.upload email
+    def self.upload email, opts
 
-      times = []
+      # True if we're only uploading images.
+      images_only = !!opts[:images]
 
-      Dir.glob(File.join(email.path, '*.{html,tsv,txt,yml}')).each do |file|
-        times << File.mtime(file).to_i
-      end
+      # Check to see if forcing the upload is specified.  If not, check to see
+      # when the most recent file was updated and
+      force = !!opts[:force]
+      unless force
+
+        times = []
 
-      local_images = email.image_dir
-      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?('.')
+        unless images_only
+          Dir.glob(File.join(email.path, '*.{html,tsv,txt,yml}')).each do |file|
+            times << File.mtime(file).to_i
+          end
         end
-      end
 
-      # Get the most recently updated file.
-      last_update = times.max
+        local_images = email.image_dir
+        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
+        end
 
-      # Determine when the last upload was completed.
-      last_upload = email.meta(:last_upload).to_i
+        # Get the most recently updated file.
+        last_update = times.max
 
-      self.do_upload(email, false) if last_update > last_upload
+        # Determine when the last upload was completed.
+        last_upload = email.meta(:last_upload).to_i
 
-    end
+        return unless last_update > last_upload
+
+      end
+
+      self.do_upload(email, force, images_only)
 
-    def self.upload! email
-      self.do_upload(email, true)
     end
 
     private
 
     IMAGE_PATH = :'image-path'
 
-    def self.copy! sftp, local, remote, force=true
+    def self.copy! email, sftp, local, remote, force=true
 
       # Nothing to copy unless the local directory exists (e.g. some emails don't
       # have an images directory.)
       return unless File.exist?(local)
 
+      last_upload = email.meta(:last_upload).to_i
+
       Dir.foreach(local) do |file|
         next if file.starts_with?('.')
 
@@ -52,11 +64,7 @@ module Inkcite
           remote_file = File.join(remote, file)
 
           unless force
-            next unless begin
-              File.stat(local_file).mtime > Time.at(sftp.stat!(remote_file).mtime)
-            rescue Net::SFTP::StatusException
-              true # File doesn't exist, so assume it's changed.
-            end
+            next unless File.mtime(local_file).to_i > last_upload
           end
 
           puts "Uploading #{local_file} -> #{remote_file} ..."
@@ -69,7 +77,7 @@ module Inkcite
 
     # Internal method responsive for doing the actual upload and
     # forcing (if necessary) the update of the graphics.
-    def self.do_upload email, force
+    def self.do_upload email, force, images_only
 
       # The preview version defines the configuration for the server to which
       # the files will be sftp'd.
@@ -122,8 +130,13 @@ module Inkcite
             # to ensure that we're not repeatedly uploading the same images over and
             # over when force is enabled -- but will re-upload images to distinct
             # remote roots.
-            copy! sftp, local_images, remote_root, force && last_remote_root != remote_root
-            last_remote_root = remote_root
+            if last_remote_root != remote_root
+              copy! email, sftp, local_images, remote_root, force
+              last_remote_root = remote_root
+            end
+
+            # Nothing left to do if this is an image-only upload
+            next if images_only
 
             # Check to see if we're creating an in-browser version of the email.
             next unless email.formats.include?(:browser)

data/lib/inkcite/version.rb

@@ -1,3 +1,3 @@
 module Inkcite
-  VERSION = "1.15.0"
+  VERSION = "1.16.0"
 end

data/lib/inkcite/view.rb

@@ -239,9 +239,6 @@ module Inkcite
 
       tag = tag.to_sym
 
-      # 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
 
@@ -262,7 +259,11 @@ module Inkcite
 
       src_url = ''
 
-      if Util.is_fully_qualified?(src)
+      # Check to see if images are disabled - if so, return a broken image.
+      if self[IMAGES_OFF]
+        src_url = "__#{src}"
+
+      elsif Util.is_fully_qualified?(src)
         src_url << src
 
       else
@@ -270,7 +271,7 @@ module Inkcite
         # Prepend the image host onto the src if one is specified in the properties.
         # During local development, images are always expected in an images/ subdirectory.
         image_host = if development?
-          (@email.optimize_images? ? Image::ImageMinifier::IMAGE_CACHE : Email::IMAGES) + '/'
+          (@email.optimize_images? ? ImageMinifier::IMAGE_CACHE : Email::IMAGES) + '/'
         else
 
           # Use the image host defined in config.yml or, out-of-the-box refer to images/
@@ -293,6 +294,14 @@ module Inkcite
       Renderer.render(src_url, self)
     end
 
+    def images_off?
+      is_enabled?(IMAGES_OFF)
+    end
+
+    def images_off= off
+      @config[IMAGES_OFF] = !!off
+    end
+
     # Tests if a configuration value has been enabled.  This assumes
     # it is disabled by default but that a value of true, 'true' or 1
     # for the value indicates it is enabled.
@@ -309,7 +318,6 @@ module Inkcite
       !val.nil? && (val == false || val == false.to_s)
     end
 
-
     def links_file_name
 
       # There is nothing to return if trackable links aren't enabled.
@@ -463,14 +471,20 @@ module Inkcite
 
         # 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"'
-        html_declaration << ' xmlns:v="urn:schemas-microsoft-com:vml" lang="en" xml:lang="en"' if vml_used?
+        html_declaration << ' xmlns:v="urn:schemas-microsoft-com:vml"' if vml_used?
+        html_declaration << ' xmlns:o="urn:schemas-microsoft-com:office:office"' if email?
         html_declaration << '>'
         html << html_declaration
 
         html << '<head>'
         html << '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>'
+
+        # iOS 10 auto-scale fix
+        # https://emails.hteumeuleu.com/what-you-need-to-know-about-apple-mail-in-ios-10-c7031f6d704d
+        html << '<meta name="x-apple-disable-message-reformatting"/>'
         html << '<meta name="viewport" content="width=device-width"/>'
-        html << "<meta name=\"generator\" content=\"Inkcite #{Inkcite::VERSION}\"/>"
+
+        html << %Q(<meta name="generator" content="Inkcite #{Inkcite::VERSION}"/>)
 
         # 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/
@@ -490,6 +504,8 @@ module Inkcite
 
         html << outlook_styles
 
+        html << outlook_high_dpi_fix if email?
+
         html << '</head>'
 
         html << body_declaration
@@ -514,6 +530,13 @@ module Inkcite
       # process) with a chance to operate on the final HTML.
       @content = PostProcessor.run_all(@content, self)
 
+      # Some ESPs have link tracking/opt-out code that uses greater-than and
+      # less-than symbols.  Encode them as their HTML escape code equivalents
+      # in the source and replace them with their original characters in the
+      # final output.
+      @content.gsub!('&#62;', '>')
+      @content.gsub!('&#60;', '<')
+
       # Ensure that all failsafes pass
       assert_failsafes
 
@@ -695,6 +718,10 @@ module Inkcite
     # Tab-separated file containing global substitution values.
     SUBSTITUTIONS_TSV_FILE = 'substitutions.tsv'
 
+    # Config value which disables images (e.g. shows their size, position
+    # background color and alt text).
+    IMAGES_OFF = :'images-off'
+
     def assert_in_browser msg
       raise msg if email? && !development?
     end
@@ -907,7 +934,7 @@ module Inkcite
         # http://www.ianhoar.com/2008/04/29/outlook-2007-borders-and-1px-padding-on-table-cells
         # http://www.campaignmonitor.com/blog/post/3392/1px-borders-padding-on-table-cells-in-outlook-07
         reset << 'table { border-spacing: 0; }'
-        reset << 'table, td { border-collapse: collapse; }'
+        reset << 'table, td { border-collapse: collapse; mso-table-lspace: 0pt !important; mso-table-rspace: 0pt !important; }'
 
         # Ensure that telephone numbers are displayed using the same style as links.
         reset << "a[href^=tel] { color: #{self[Renderer::Base::LINK_COLOR]}; text-decoration:none;}"
@@ -921,6 +948,9 @@ module Inkcite
       # Reset the font on every cell to the default family.
       reset << "td { font-family: #{self[Renderer::Base::FONT_FAMILY]}; }"
 
+      # Allow smoother rendering of resized image in Internet Explorer
+      reset << "img { -ms-interpolation-mode:bicubic !important; }"
+
       reset.join(NEW_LINE)
     end
 
@@ -971,24 +1001,108 @@ module Inkcite
       html.join(NEW_LINE)
     end
 
+    def outlook_high_dpi_fix
+
+      # This is the XML required to ensure high-DPI Outlook plays nicely with the
+      # email when it is displayed.
+      # https://www.emailonacid.com/blog/article/email-development/dpi_scaling_in_outlook_2007-2013
+      html = []
+      html << '<!--[if gte mso 9]>'
+      html << '<xml>'
+      html << '<o:OfficeDocumentSettings>'
+      html << '<o:AllowPNG/>'
+      html << '<o:PixelsPerInch>96</o:PixelsPerInch>'
+      html << '</o:OfficeDocumentSettings>'
+      html << '</xml>'
+      html << '<![endif]-->'
+
+      return html.join(NEW_LINE)
+    end
+
     def outlook_styles
 
       html = []
+      html << '<!--[if mso]>' if email?
+      html << '<style>'
+
+      if email?
+
+        # These are the Outlook-specific styles necessary to block the
+        # visited link from changing color in Outlook 2007-2013.
+        # https://litmus.com/community/discussions/4164-outlook-07-13-visited-link-color-fix
+        vlink_styles = { :'mso-style-priority' => 99, :color => 'inherit' }
+        %w(MsoHyperlink MsoHyperlinkFollowed).each do |l|
+          html << Inkcite::Renderer::Style.new("span.#{l}", self, vlink_styles).to_s
+        end
+
+      end
 
       # VML-specific CSS needed only if VML was used in the email.
       if vml_used?
-        html << '<style>'
-
         %w(v o).each do |l|
           html << Inkcite::Renderer::Style.new("#{l}\:*", self, { :behavior => 'url(#default#VML)', :display => 'inline-block' }).to_s
         end
+      end
 
         html << '</style>'
-      end
+      html << '<![endif]-->' if email?
 
       html.join(NEW_LINE)
     end
 
+    def load_google_sheets_helpers url, into
+
+      # Add a timestamp to break google's cache and force the page to
+      # be reloaded each time
+      url = Util::add_query_param(url, Time.now.to_i)
+
+      raw = Net::HTTP.get(URI.parse(url))
+
+      # Consolidate line-breaks for simplicity
+      raw.gsub!(/[\r\f\n]{1,}/, NEW_LINE)
+      raw.gsub!(/ \& /, " &amp; ")
+
+      fields = nil
+
+      raw.split(NEW_LINE).each do |line|
+        columns = line.split(TAB)
+        if fields.nil?
+          fields = columns.collect(&:to_sym)
+
+        else
+
+          version = columns[0]
+
+          # Check to see if this version includes an asterisk
+          is_any_version = if version == '*'
+            true
+          elsif version.include?('*')
+            prefix, suffix = version.split('*')
+            (prefix.blank? || @version.to_s.start_with?(prefix)) && (suffix.blank? || @version.to_s.end_with?(suffix))
+          else
+            false
+          end
+
+          is_version = version.to_sym == @version
+
+          if is_any_version || is_version
+            fields.each_with_index do |field, index|
+              unless index == 0
+                value = columns[index]
+                into[field] = value unless value.blank?
+              end
+            end
+
+            break if is_version
+          end
+
+
+        end
+      end
+
+      true
+    end
+
     def load_helper_file file, into, abort_on_fail=true
 
       unless File.exist?(file)
@@ -1053,7 +1167,13 @@ module Inkcite
       # Check to see if the config.yml includes a "helpers:" array which allows
       # additional out-of-project, shared helper files to be loaded.
       included_helpers = [*@email.config[:helpers]]
-      included_helpers.each { |file| load_helper_file(File.join(path, file), _helpers) }
+      included_helpers.each do |file|
+        if file.start_with?('http')
+          load_google_sheets_helpers file, _helpers
+        else
+          load_helper_file(File.join(path, file), _helpers)
+        end
+      end
 
       # Load the project's properties, which may include references to additional
       # properties in other directories.