inkcite 1.14.0 → 1.15.0

data/lib/inkcite/minifier.rb

@@ -1,9 +1,8 @@
+require_relative 'image/image_minifier'
+
 module Inkcite
   class Minifier
 
-    # Directory of optimized images
-    IMAGE_CACHE = 'images-optim'
-
     # Maximum line length for CSS and HTML - lines exceeding this length cause
     # problems in certain email clients.
     MAXIMUM_LINE_LENGTH = 800
@@ -124,81 +123,6 @@ module Inkcite
 
     end
 
-    def self.image email, img_name, force=false
-
-      # Original, unoptimized source image
-      source_img = File.join(email.image_dir, img_name)
-
-      # Cached, optimized path for this image.
-      cache_path = email.project_file(IMAGE_CACHE)
-      cached_img = File.join(cache_path, File.basename(img_name))
-
-      # Full path to the local project's kraken config if it exists
-      kraken_config_path = email.project_file(KRAKEN_CONFIG_YML)
-
-      # This is the array of config files that will be searched to
-      # determine which algorithm to use to compress the images.
-      config_paths = [
-          kraken_config_path,
-          email.project_file(IMAGE_OPTIM_CONFIG_YML),
-          File.join(Inkcite.asset_path, 'init', IMAGE_OPTIM_CONFIG_YML)
-      ]
-
-      # Grab the first file that exists for this project.
-      config_path = config_paths.detect { |p| File.exist?(p) }
-
-      unless force
-
-        # Get the last-modified date of the image optimization config
-        # file - if that file is newer than the image, re-optimization
-        # is necessary because the settings have changed.
-        config_last_modified = Util.last_modified(config_path)
-
-        # Get the last-modified date of the actual image.  If the source
-        # image is newer than the cached version, we'll need to run it
-        # through optimization again, too.
-        cache_last_modified = Util.last_modified(cached_img)
-        source_last_modified = Util.last_modified(source_img)
-
-        # Nothing to do unless the image in the cache is older than the
-        # source or the config file.
-        return unless config_last_modified > cache_last_modified || source_last_modified > cache_last_modified
-
-      end
-
-      # Make sure the image cache directory exists
-      FileUtils.mkpath(cache_path)
-
-      # Read the image compression configuration settings
-      config = Util::read_yml(config_path, :fail_if_not_exists => false)
-
-      if config_path == kraken_config_path
-        minify_with_kraken_io email, config, source_img, cached_img
-
-      else
-
-        # Default image optimization uses built-in ImageOptim
-        minify_with_image_optim email, config, source_img, cached_img
-
-      end
-
-      original_size = File.size(source_img)
-      compressed_size = File.size(cached_img)
-      percent_compressed = ((1.0 - (compressed_size / original_size.to_f)) * 100).round(1)
-      puts "Compressed #{img_name} #{percent_compressed}%"
-
-    end
-
-    def self.images email, force=false
-
-      images_path = email.image_dir
-
-      # Iterate through all of the images in the project and optimize them
-      # if necessary.
-      Dir.glob(File.join(images_path, '*.*')).each { |img| self.image(email, File.basename(img), force) }
-
-    end
-
     def self.js code, ctx
       minify?(ctx) ? js_compressor(ctx).compress(code) : code
     end
@@ -209,74 +133,6 @@ module Inkcite
 
     private
 
-    def self.minify_with_image_optim email, config, source_img, cached_img
-
-      # Copy the image into the destination directory and then use Image Optim
-      # to optimize it in place.
-      FileUtils.cp(source_img, cached_img)
-      ImageOptim.new(config).optimize_image!(cached_img)
-
-    end
-
-    def self.minify_with_kraken_io email, config, source_img, cached_img
-
-      require 'kraken-io'
-      require 'open-uri'
-
-      # Initialize the Kraken API using the API key and secret defined in the
-      # config.yml file.
-      kraken = Kraken::API.new(
-          :api_key => config[:api_key],
-          :api_secret => config[:api_secret]
-      )
-
-      # As you might expect, Outlook doesn't support webp so it needs to be
-      # disabled by default.  Otherwise, Kraken always compresses with webp.
-      kraken_opts = { :webp => false }
-
-      # Get the file format (e.g. gif) of the file being optimized.
-      source_fmt = File.extname(source_img).delete('.')
-
-      # True if the configuration file does not specifically exclude
-      # this format from being processed.
-      compress_this_fmt = config[source_fmt.to_sym] != false
-
-      # Typically, we're going to want lossy compression to minify the file
-      # but if the user has put lossy: false specifically in their config
-      # file, we'll disable that feature in Kraken too.  Defaults to true.
-      kraken_opts[:lossy] = compress_this_fmt
-
-      # Send the quality metric to Kraken only if specified.  Per their
-      # documentation, Kraken will attempt to guess the best quality to
-      # use but in my experience it errs on the side of higher quality
-      # whereas setting a quality factor around 50 produces a good
-      # balance of image detail and file size.
-      if compress_this_fmt
-        quality = config[:quality].to_i
-        kraken_opts[:quality] = quality if quality > 0 and quality <= 100
-      end
-
-      # Upload the image to Kraken which blocks by default until the image
-      # has been optimized.
-      data = kraken.upload(source_img, kraken_opts)
-      if data.success
-        File.write(cached_img, open(data.kraked_url).read, { :mode => 'wb' })
-      else
-        puts "Failed to optimize #{img_name}: #{data.message}"
-      end
-
-    end
-
-    # Name of the Image Optim configuration yml file that can be
-    # put in the project directory to explicitly control the image
-    # optimization process.
-    IMAGE_OPTIM_CONFIG_YML = 'image_optim.yml'
-
-    # Name of the Kraken configuration yml that, when present in
-    # the project directory and populated with an API key and secret
-    # causes Kraken.io paid image optimization service to be used.
-    KRAKEN_CONFIG_YML = 'kraken.yml'
-
     NEW_LINE = "\n"
 
     # Used to match inline styles that will be compressed when minifying

data/lib/inkcite/post_processor.rb

@@ -0,0 +1,13 @@
+module Inkcite
+  module PostProcessor
+
+    def post_process html, ctx
+      raise 'Extending class must implement process(html, ctx)'
+    end
+
+    def self.run_all html, ctx
+      ctx.post_processors.inject(html) { |h, pp| pp.post_process(h, ctx) }
+    end
+
+  end
+end

data/lib/inkcite/renderer.rb

@@ -7,6 +7,7 @@ require_relative 'renderer/table_base'
 
 require_relative 'renderer/background'
 require_relative 'renderer/button'
+require_relative 'renderer/carousel'
 require_relative 'renderer/div'
 require_relative 'renderer/fireworks'
 require_relative 'renderer/footnote'
@@ -30,8 +31,11 @@ require_relative 'renderer/snow'
 require_relative 'renderer/social'
 require_relative 'renderer/span'
 require_relative 'renderer/sparkle'
+require_relative 'renderer/sup'
 require_relative 'renderer/table'
 require_relative 'renderer/td'
+require_relative 'renderer/topic'
+require_relative 'renderer/trademark'
 require_relative 'renderer/video_preview'
 
 module Inkcite
@@ -64,6 +68,9 @@ module Inkcite
 
       end
 
+      # Remove unicode line break characters
+      value.gsub!(/\u2028/, '')
+
       value
     end
 
@@ -128,6 +135,10 @@ module Inkcite
 
       Parser.each(str) do |tag|
 
+        # Record to the context the most recent tag being processed in case
+        # there are errors associated with it.
+        context.last_rendered_markup = tag
+
         # Split the string into the tag and it's attributes.
         name, opts = tag.split(SPACE, 2)
 
@@ -171,6 +182,8 @@ module Inkcite
           :a                  => Link.new,
           :background         => Background.new,
           :button             => Button.new,
+          :carousel           => Carousel.new,
+          :'carousel-img'     => Carousel::Image.new,
           :div                => Div.new,
           :facebook           => Social::Facebook.new,
           :fireworks          => Fireworks.new,
@@ -180,6 +193,7 @@ module Inkcite
           :img                => Image.new,
           :'in-browser'       => InBrowser.new,
           :include            => Partial.new,
+          :instagram          => Social::Instagram.new,
           :like               => Like.new,
           :litmus             => LitmusAnalytics.new,
           :lorem              => Lorem.new,
@@ -189,12 +203,17 @@ module Inkcite
           :'mobile-toggle-on' => MobileToggleOn.new,
           :pintrest           => Social::Pintrest.new,
           :preheader          => Preheader.new,
+          :r                  => Trademark.new('®'),
           :redacted           => Redacted.new,
           :snow               => Snow.new,
           :span               => Span.new,
           :sparkle            => Sparkle.new,
+          :sup                => Sup.new,
           :table              => Table.new,
           :td                 => Td.new,
+          :tm                 => Trademark.new('™'),
+          :'topic'            => Topic.new,
+          :'topic-list'       => TopicList.new,
           :twitter            => Social::Twitter.new,
           :'video-preview'    => VideoPreview.new
       }

data/lib/inkcite/renderer/background.rb

@@ -14,8 +14,19 @@ module Inkcite
 
         html = ''
 
+
+        tag_stack = ctx.tag_stack(:background)
+
         if tag == '/background'
 
+          opening = tag_stack.pop
+          padding = opening[:padding].to_i
+
+          html << vs(padding) if padding > 0
+          html << '{/td}'
+          html << hs(padding) if padding > 0
+
+          html << '{/table}'
           html << '</div>'
 
           # If VML is enabled, then close the textbox and rect that were created
@@ -32,6 +43,8 @@ module Inkcite
 
         else
 
+          tag_stack << opt
+
           # Primary background image
           src = opt[:src]
 
@@ -45,7 +58,6 @@ module Inkcite
           fill_width = width.nil? || width == 'fill' || width == '100%' || width.to_i <= 0
 
           table = Element.new('table')
-          table[:height] = height if height > 0
           table[:width] = (fill_width ? '100%' : width)
           table[:background] = quote(src) unless none?(src)
 
@@ -55,7 +67,7 @@ module Inkcite
           # might interfere with the display of the background (e.g. padding)
           TABLE_PASSTHRU_OPS.each do |key|
             val = opt[key]
-            table[key] = quote(val) unless none?(val)
+            table[key] = quote(val) unless val.blank?
           end
 
           # Determine if a fallback background color has been defined.
@@ -66,13 +78,8 @@ module Inkcite
           bggradient = detect_bggradient(opt)
           table[:bggradient] = quote(bggradient) unless none?(bggradient)
 
-          td = Element.new('td')
-
-          valign = opt[:valign]
-          td[:valign] = valign unless valign.blank?
-
           html << table.to_helper
-          html << td.to_helper
+          html << '{td}'
 
           # VML is only added if it is enabled for the project.
           if ctx.vml_enabled?
@@ -117,16 +124,38 @@ module Inkcite
 
           end
 
-          div = Element.new('div')
+          html << '<div>'
+
+          html << '{table width=100%}'
+
+          padding = opt[:padding].to_i
+
+          html << hs(padding) if padding > 0
+
+          inner_td = Element.new('td')
+
+          # Height needs to be set on the inner TD to ensure that valign works
+          # in Outlook - which doesn't honor table height but will honor td height.
+          inner_td[:height] = height if height > 0
+
+          valign = opt[:valign]
+          inner_td[:valign] = valign unless valign.blank?
+
+          TD_PASSTHRU_OPS.each do |key|
+            val = opt[key]
+            inner_td[key] = quote(val) unless val.blank?
+          end
 
           # Font family and other attributes get reset within the v:textbox so allow
           # the font series of attributes to be applied.
-          mix_font div, opt, ctx
+          mix_font inner_td, opt, ctx
 
           # Text alignment within the div.
-          mix_text_align div, opt, ctx
+          mix_text_align inner_td, opt, ctx
 
-          html << div.to_s
+          html << inner_td.to_helper
+
+          html << vs(padding) if padding > 0
 
         end
 
@@ -135,8 +164,13 @@ module Inkcite
 
       private
 
-      # The custom
-      MOBILE_SRC = :'mobile-src'
+      def hs padding
+        Element.new('td', :width => padding, :mobile => 'hide').to_helper + '&nbsp;{/td}'
+      end
+
+      def vs padding
+        Element.new('div', :height => padding, LINE_HEIGHT => padding, FONT_SIZE => padding, :mobile => 'hide').to_helper + '&nbsp;{/div}'
+      end
 
       # These are the parameters that are passed directly from
       # the provided opt to the {table} rendered within the
@@ -148,6 +182,11 @@ module Inkcite
           MOBILE_SRC, MOBILE_BACKGROUND_SIZE, MOBILE_WIDTH
       ]
 
+      TD_PASSTHRU_OPS = [
+          :align, :color, :font, FONT_FAMILY, FONT_SIZE, FONT_WEIGHT, LETTER_SPACING, LINE_HEIGHT,
+          MOBILE_TEXT_ALIGN, :shadow, TEXT_ALIGN, TEXT_SHADOW, TEXT_SHADOW_BLUR, TEXT_SHADOW_OFFSET
+      ]
+
     end
   end
 end

data/lib/inkcite/renderer/base.rb

@@ -11,6 +11,7 @@ module Inkcite
       BACKGROUND_SIZE = :'background-size'
       BORDER_BOTTOM = :'border-bottom'
       BORDER_COLLAPSE = :'border-collapse'
+      BORDER_COLOR = :'border-color'
       BORDER_LEFT = :'border-left'
       BORDER_RADIUS = :'border-radius'
       BORDER_RIGHT = :'border-right'
@@ -28,6 +29,7 @@ module Inkcite
       MARGIN_LEFT = :'margin-left'
       MARGIN_RIGHT = :'margin-right'
       MARGIN_TOP = :'margin-top'
+      MAX_HEIGHT = :'max-height'
       MAX_WIDTH = :'max-width'
       PADDING_X = :'padding-x'
       PADDING_Y = :'padding-y'
@@ -40,6 +42,10 @@ module Inkcite
       WEBKIT_ANIMATION = :'-webkit-animation'
       WHITE_SPACE = :'white-space'
 
+      # Name of the property that allows an outlook-specific src to be specified
+      # for an image.
+      OUTLOOK_SRC = :'outlook-src'
+
       # CSS direction suffixes including nil/empty for convenience.
       DIRECTIONS = [ nil, :top, :right, :bottom, :left]
 
@@ -122,26 +128,34 @@ module Inkcite
         # Set the background color if the element has one.
         element.style[BACKGROUND_COLOR] = bgcolor if bgcolor
 
+        # Automatically include background gradient support when
+        # mixing in background color.
+        mix_background_gradient element, opt, ctx
+
+      end
+
+      def mix_background_gradient element, opt, ctx
+
         # Background gradient support
         bggradient = detect_bggradient(opt)
-        unless none?(bggradient)
-
-          # As a shortcut a gradient can be specified simply by designating
-          # both a bgcolor and the gradient color - this will insert a radial
-          # gradient automatically.
-          if bggradient.start_with?('#')
+        return if none?(bggradient)
 
-            # If a bgcolor is provided, the gradient goes bgcolor -> bggradient.
-            # Otherwise, it goes bggradient->darker(bggradient)
-            center_color = bgcolor ? bgcolor : bggradient
-            outer_color = bgcolor ? bggradient : Util.darken(bggradient)
+        # As a shortcut a gradient can be specified simply by designating
+        # both a bgcolor and the gradient color - this will insert a radial
+        # gradient automatically.
+        if bggradient.start_with?('#')
 
-            bggradient = %Q(radial-gradient(circle at center, #{center_color}, #{outer_color}))
-          end
+          # If a bgcolor is provided, the gradient goes bgcolor -> bggradient.
+          # Otherwise, it goes bggradient->darker(bggradient)
+          bgcolor = detect_bgcolor(opt)
+          center_color = bgcolor ? bgcolor : bggradient
+          outer_color = bgcolor ? bggradient : Util.darken(bggradient)
 
-          element.style[BACKGROUND_IMAGE] = bggradient
+          bggradient = %Q(radial-gradient(circle at center, #{center_color}, #{outer_color}))
         end
 
+        element.style[BACKGROUND_IMAGE] = bggradient
+
       end
 
       def mix_border element, opt, ctx
@@ -213,10 +227,10 @@ module Inkcite
         font
       end
 
-      def mix_margins element, opt, ctx
+      def mix_margins element, opt, ctx, outlookCompatible=true
 
         # Outlook supports Margin, not margin.
-        mix_directional element, element.style, opt, ctx, :margin, :Margin, true
+        mix_directional element, element.style, opt, ctx, :margin, outlookCompatible ? :Margin : :margin, true
 
       end