inkcite 1.2.0 → 1.6.0

data/lib/inkcite/minifier.rb

@@ -1,10 +1,11 @@
+require 'image_optim'
 require 'yui/compressor'
 
 module Inkcite
   class Minifier
 
     # Directory of optimized images
-    IMAGE_CACHE = ".images"
+    IMAGE_CACHE = "images-optim"
 
     def self.css code, ctx
       minify?(ctx) ? css_compressor(ctx).compress(code) : code
@@ -60,15 +61,15 @@ module Inkcite
 
     end
 
-    def self.images email
-
-      image_optim_path = '/Applications/ImageOptim.app/Contents/MacOS/ImageOptim'
-      image_optim = File.exists?(image_optim_path)
-      abort "Can't find ImageOptim (#{image_optim_path}) - download it from https://imageoptim.com" unless image_optim
+    def self.images email, force=false
 
       images_path = email.image_dir
       cache_path = email.project_file(IMAGE_CACHE)
 
+      # Check to see if there is an image optim configuration file.
+      config_path = email.project_file(IMAGE_OPTIM_CONFIG_YML)
+      config_last_modified = Util.last_modified(config_path)
+
       # If the image cache exists, we need to check to see if any images have been
       # removed since the last build.
       if File.exists?(cache_path)
@@ -80,42 +81,54 @@ module Inkcite
 
           # Convert the images to fully-qualified paths and then remove
           # those files from the cache
-          removed_images = removed_images.collect { |img| File.join(cache_path, img ) }
-          FileUtils.rm (removed_images)
+          removed_images = removed_images.collect { |img| File.join(cache_path, img) }
+          FileUtils.rm(removed_images)
 
         end
 
       end
 
       # Check to see if there are new or updated images that need to be re-optimized.
-      updated_images = Dir.entries(images_path).select do |img|
-        unless img.start_with?('.')
-          cimg = File.join(cache_path, img)
-          !File.exists?(cimg) || (File.stat(File.join(images_path, img)).mtime > File.stat(cimg).mtime)
-        end
+      # Compare existing images against both the most recently cached version and
+      # the timestamp of the config file.
+      updated_images = Dir.glob(File.join(images_path, '*.*')).select do |img|
+        cached_img = File.join(cache_path, File.basename(img))
+        cache_last_modified = Util.last_modified(cached_img)
+        force || config_last_modified > cache_last_modified || Util.last_modified(img) > cache_last_modified
       end
 
+      # Return unless there is something to compress
       return if updated_images.blank?
 
-      # This is the temporary path into which new or updated images will
-      # be copied and then optimized.
-      temp_path = email.project_file(IMAGE_TEMP)
+      FileUtils.mkpath(cache_path)
+
+      # Check to see if there is an image_optim.yml file in this directory that
+      # overrides the default settings.
+      image_optim_opts = if config_last_modified > 0
+        {
+            :config_paths => [IMAGE_OPTIM_CONFIG_YML]
+        }
+      else
+        {
+            :allow_lossy => true,
+            :gifsicle => { :level => 3 },
+            :jpegoptim => { :max_quality => 50 },
+            :jpegrecompress => { :quality => 1 },
+            :pngout => false,
+            :svgo => false
+        }
+      end
 
-      # Make sure there is no existing temporary directory to interfere
-      # with the image processing.
-      FileUtils.rm_rf(temp_path)
-      FileUtils.mkpath(temp_path)
+      image_optim = ImageOptim.new(image_optim_opts)
 
       # Copy all of the images that need updating into the temporary directory.
       # Specifically joining the images_path to the image to avoid Email's
       # image_path which may change it's directory if optimization is enabled.
-      updated_images.each { |img| FileUtils.cp(File.join(images_path, img), File.join(temp_path, img)) }
-
-      # Optimize all of the images.
-      system("#{image_optim_path} #{temp_path}") if image_optim
-
-      FileUtils.cp_r(File.join(temp_path, "."), cache_path)
-      FileUtils.rm_rf(temp_path)
+      updated_images.each do |img|
+        cached_img = File.join(cache_path, File.basename(img))
+        FileUtils.cp(img, cached_img)
+        image_optim.optimize_image!(cached_img)
+      end
 
     end
 
@@ -125,9 +138,11 @@ module Inkcite
 
     private
 
-    # Temporary directory that new or updated images will be copied into
-    # to be optimized and then cached in .images
-    IMAGE_TEMP = ".images-temp"
+    # 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'
+
 
     NEW_LINE = "\n"
     MAXIMUM_LINE_LENGTH = 800
@@ -145,7 +160,7 @@ module Inkcite
     end
 
     def self.css_compressor ctx
-      ctx.css_compressor ||= YUI::CssCompressor.new(:line_break => (ctx.email?? MAXIMUM_LINE_LENGTH : nil))
+      ctx.css_compressor ||= YUI::CssCompressor.new(:line_break => (ctx.email? ? MAXIMUM_LINE_LENGTH : nil))
     end
 
   end

data/lib/inkcite/renderer/button.rb

@@ -12,7 +12,7 @@ module Inkcite
         end
 
         def bgcolor
-          hex(@opt[:bgcolor] || @ctx[BUTTON_BACKGROUND_COLOR] || @ctx[Base::LINK_COLOR])
+          hex(@opt[:bgcolor] || @ctx[BUTTON_BGCOLOR] || @ctx[BUTTON_BACKGROUND_COLOR] || @ctx[Base::LINK_COLOR])
         end
 
         def border
@@ -89,6 +89,7 @@ module Inkcite
         BEVEL_COLOR = :'bevel-color'
 
         BUTTON_BACKGROUND_COLOR = :'button-background-color'
+        BUTTON_BGCOLOR = :'button-bgcolor'
         BUTTON_BEVEL = :'button-bevel'
         BUTTON_BEVEL_COLOR = :'button-bevel-color'
         BUTTON_BORDER = :'button-border'
@@ -129,26 +130,34 @@ module Inkcite
 
           # Responsive button is just a highly styled table/td combination with optional
           # curved corners and a lower bevel (border).
-          html << "{table bgcolor=#{cfg.bgcolor}"
+          bgcolor = cfg.bgcolor
+          html << "{table bgcolor=#{bgcolor}"
           html << " padding=#{cfg.padding}" if cfg.padding > 0
-          html << " border=#{cfg.border}" if cfg.border
+          html << %Q( border="#{cfg.border}") if cfg.border
           html << " border-radius=#{cfg.border_radius}" if cfg.border_radius > 0
+          html << %Q( border-bottom="#{cfg.border_bottom}") if cfg.bevel > 0
 
           # Need to separate borders that are collapsed by default - otherwise, the bevel
           # renders incorrectly.
-          html << " border-bottom=\"#{cfg.border_bottom}\" border-collapse=separate" if cfg.bevel > 0
+          html << " border-collapse=separate" if cfg.border || cfg.bevel > 0
 
           html << " margin-top=#{cfg.margin_top}" if cfg.margin_top > 0
           html << " width=#{cfg.width}" if cfg.width > 0
           html << " float=#{cfg.float}" if cfg.float
-          html << " mobile=\"fill\"}\n"
+          html << %Q( mobile="fill"}\n)
           html << "{td align=center"
           html << " height=#{cfg.height} valign=middle" if cfg.height > 0
           html << " font=\"#{cfg.font}\""
           html << " line-height=#{cfg.line_height}" unless cfg.line_height.blank?
-          html << " font-size=\"#{cfg.font_size}\"" if cfg.font_size > 0
-          html << " font-weight=\"#{cfg.font_weight}\"" unless cfg.font_weight.blank?
-          html << " shadow=\"#{cfg.text_shadow}\" shadow-offset=-1}"
+          html << %Q( font-size="#{cfg.font_size}") if cfg.font_size > 0
+          html << %Q( font-weight="#{cfg.font_weight}") unless cfg.font_weight.blank?
+
+          # Text on the button gets a shadow automatically unless the shadow
+          # color matches the background color of the button.
+          shadow = cfg.text_shadow
+          html << %Q( shadow="#{shadow}" shadow-offset=-1) if shadow != bgcolor
+
+          html << '}'
 
           # Second, internal link for Outlook users that makes the inside of the button
           # clickable.

data/lib/inkcite/renderer/footnote.rb

@@ -17,10 +17,16 @@ module Inkcite
         # when the {footnotes} tag is rendered.
         attr_reader :text
 
-        def initialize id, symbol, text
+        # True if this footnote is active. By default all footnotes are
+        # activate but those read from footnotes.tsv are inactive until
+        # referenced in the source.
+        attr_accessor :active
+
+        def initialize id, symbol, text, active=true
           @id = id
           @symbol = symbol.to_s
           @text = text
+          @active = active
         end
 
         def number
@@ -33,6 +39,10 @@ module Inkcite
           @symbol == @symbol.to_i.to_s
         end
 
+        def symbol=symbol
+          @symbol = symbol.to_s
+        end
+
         def symbol?
           !numeric?
         end
@@ -59,19 +69,13 @@ module Inkcite
           # this isn't specified count the number of existing numeric footnotes
           # and increment it for this new footnote's symbol.
           symbol = opt[:symbol]
-          if symbol.blank?
-
-            # Grab the last numeric footnote that was specified and, assuming
-            # there is one, increment the count.  Otherwise, start the count
-            # off at one.
-            last_instance = ctx.footnotes.select(&:numeric?).last
-            symbol = last_instance.nil? ? 1 : last_instance.symbol.to_i + 1
-
-          end
 
           # Grab the text associated with this footnote.
           text = opt[:text]
-          ctx.error("Footnote requires text attribute", { :id => id, :symbol => symbol }) if text.blank?
+          if text.blank?
+            ctx.error("Footnote requires text attribute", { :id => id, :symbol => symbol })
+            return
+          end
 
           # Create a new Footnote instance
           instance = Instance.new(id, symbol, text)
@@ -81,6 +85,24 @@ module Inkcite
 
         end
 
+        # Check to see if the footnote's symbol is blank (either because one
+        # wasn't defined in the source.html or because the one read from the
+        # footnotes.tsv had no symbol associated with it) and if so, generate
+        # one based on the number of previously declared numeric footnotes.
+        if instance.symbol.blank?
+
+          # Grab the last numeric footnote that was specified and, assuming
+          # there is one, increment the count.  Otherwise, start the count
+          # off at one.
+          last_instance = ctx.footnotes.select(&:numeric?).last
+          instance.symbol = last_instance.nil? ? 1 : last_instance.symbol.to_i + 1
+
+        end
+
+        # Make sure the instance is marked as having been used so it will
+        # appear in the {footnotes} rendering.
+        instance.active = true
+
         # Allow footnotes to be defined without showing a symbol
         hidden = opt[:hidden].to_i == 1
         "#{instance.symbol}" unless hidden
@@ -94,6 +116,10 @@ module Inkcite
         # Nothing to do if footnotes are blank.
         return if ctx.footnotes.blank?
 
+        # Grab the active footnotes.
+        active_footnotes = ctx.footnotes.select(&:active)
+        return if active_footnotes.blank?
+
         # Check to see if a template has been provided.  Otherwise use a default one based
         # on the format of the email.
         tmpl = opt[:tmpl] || opt[:template]
@@ -114,11 +140,11 @@ module Inkcite
 
         # First, collect all symbols in the natural order they are defined
         # in the email.
-        footnotes = ctx.footnotes.select(&:symbol?)
+        footnotes = active_footnotes.select(&:symbol?)
 
         # Now add to the list all numeric footnotes ordered naturally
         # regardless of how they were ordered in the email.
-        footnotes += ctx.footnotes.select(&:numeric?).sort { |f1, f2| f1.number <=> f2.number }
+        footnotes += active_footnotes.select(&:numeric?).sort { |f1, f2| f1.number <=> f2.number }
 
         html = ''
 

data/lib/inkcite/renderer/litmus_analytics.rb

@@ -0,0 +1,79 @@
+require 'litmus'
+
+module Inkcite
+  module Renderer
+    class LitmusAnalytics < Base
+
+      def render tag, opt, ctx
+
+        # Litmus tracking is enabled only for production emails.
+        return nil unless ctx.production? && ctx.email?
+
+        # Deprecated code/id parameters.  They shouldn't be passed anymore.
+        report_id = opt[:code] || opt[:id]
+        merge_tag = opt[MERGE_TAG] || ctx[MERGE_TAG]
+
+        # Initialize the Litmus API.
+        config = ctx.config[:litmus]
+        Litmus::Base.new(config[:subdomain], config[:username], config[:password], true)
+
+        # Will hold the Litmus Report object from which we'll retrieve the
+        # bug HTML to inject into the email.
+        report = nil
+
+        # If no code has been provided by the designer, check to see
+        # if one has been previously recorded for this version.  If
+        # so, use it - otherwise, require one from litmus automatically.
+        if report_id.blank?
+
+          # Check to see if a campaign has been previously created for this
+          # version so the ID can be reused.
+          report_id = ctx.meta(:litmus_report_id)
+          if report_id.blank?
+
+            # Create a new report object using the title of the email specified
+            # in the helpers file.
+            report = Litmus::Report.create(ctx.title)
+
+            # Retrieve the unique ID assigned by Litmus and then stuff it
+            # into the meta data so we don't create a new one on future
+            # builds.
+            report_id = report['id']
+            ctx.set_meta :litmus_report_id, report_id
+
+          end
+
+        end
+
+        if report.nil?
+
+          report = Litmus::Report.show(report_id)
+          if report.nil?
+            ctx.error 'Invalid Litmus Analytics code or id', :code => report_id
+            return nil
+          end
+
+        end
+
+        # Grab the HTML from Litmus that needs to be injected into the source
+        # of the email.
+        bug_html = report[BUG_HTML]
+
+        # Replace the merge tag, if one was provided.
+        bug_html.gsub!('[UNIQUE]', merge_tag) unless merge_tag.nil?
+
+        # Inject HTML into the footer of the email where it won't be subject
+        # to inline'n or compression.
+        ctx.footer << bug_html
+
+        nil
+      end
+
+      private
+
+      BUG_HTML  =  'bug_html'
+      MERGE_TAG = :'merge-tag'
+
+    end
+  end
+end

data/lib/inkcite/renderer/span.rb

@@ -8,8 +8,13 @@ module Inkcite
 
         span = Element.new('span')
 
+        padding = opt[:padding].to_i
+        span.style[:padding] = px(padding) if padding > 0
+
         mix_font span, opt, ctx
 
+        mix_background span, opt
+
         mix_responsive span, opt, ctx
 
         span.to_s

data/lib/inkcite/renderer/table_base.rb

@@ -21,34 +21,43 @@ module Inkcite
         # css isn't supported.
         element[:bgcolor] = hex(bgcolor) unless bgcolor.blank?
 
-        # Assisted background image handling for maximum compatibility.
         bgimage    = opt[:background]
         bgposition = opt[BACKGROUND_POSITION]
         bgrepeat   = opt[BACKGROUND_REPEAT]
+        bgsize     = opt[BACKGROUND_SIZE]
+
+        # Sets the background image attributes in the element's style
+        # attribute.  These values take precedence on the desktop
+        # version of the email.
+        desktop_background = mix_background_shorthand(
+            bgcolor,
+            bgimage,
+            bgposition,
+            bgrepeat,
+            bgsize,
+            ctx
+        )
 
-        # No need to set any CSS if there is no background image present on this
-        # element.  Previously, it would also set the background-color attribute
-        # for unnecessary duplication.
-        background_css(element.style, bgcolor, bgimage, bgposition, bgrepeat, nil, false, ctx)  unless bgimage.blank?
-
-        m_bgcolor = detect(opt[MOBILE_BACKGROUND_COLOR], opt[MOBILE_BGCOLOR])
-        m_bgimage = detect(opt[MOBILE_BACKGROUND_IMAGE], opt[MOBILE_BACKGROUND])
+        element.style[:background] = desktop_background unless bgimage.blank?
 
-        mobile_background = background_css(
-            {},
-            m_bgcolor,
-            m_bgimage,
+        # Set the mobile background image attributes.  These values take
+        # precedence on the mobile version of the email.  If unset the
+        # mobile version inherits from the desktop version.
+        mobile_background = mix_background_shorthand(
+            detect(opt[MOBILE_BACKGROUND_COLOR], opt[MOBILE_BGCOLOR], bgcolor),
+            detect(opt[MOBILE_BACKGROUND_IMAGE], opt[MOBILE_BACKGROUND], bgimage),
             detect(opt[MOBILE_BACKGROUND_POSITION], bgposition),
             detect(opt[MOBILE_BACKGROUND_REPEAT], bgrepeat),
-            detect(opt[MOBILE_BACKGROUND_SIZE]),
-            (m_bgcolor && bgcolor) || (m_bgimage && bgimage),
+            detect(opt[MOBILE_BACKGROUND_SIZE], bgsize),
             ctx
         )
 
-        unless mobile_background.blank?
+        unless mobile_background.blank? || mobile_background == desktop_background
+
+          mobile_background << ' !important' unless desktop_background.blank?
 
           # Add the responsive rule that applies to this element.
-          rule = Rule.new(element.tag, unique_klass(ctx), mobile_background)
+          rule = Rule.new(element.tag, unique_klass(ctx), { :background => mobile_background })
 
           # Add the rule to the view and the element
           ctx.media_query << rule
@@ -87,61 +96,43 @@ module Inkcite
 
       private
 
-      def background_css into, bgcolor, img, position, repeat, size, important, ctx
+      def mix_background_shorthand bgcolor, img, position, repeat, size, ctx
 
-        unless bgcolor.blank? && img.blank?
+        values = []
 
-          bgcolor = hex(bgcolor) unless bgcolor.blank?
+        values << hex(bgcolor) unless none?(bgcolor)
+
+        unless img.blank?
 
           # If no image has been provided or if the image provided is equal
           # to "none" then we'll set the values independently.  Otherwise
           # we'll use a composite background declaration.
           if none?(img)
+            values << 'none'
 
-            unless bgcolor.blank?
-              bgcolor << ' !important' if important
-              into[BACKGROUND_COLOR] = bgcolor
-            end
+          else
 
-            # Check specifically for a value of "none" which allows the email
-            # designer to the background that is otherwise present on the
-            # desktop version of the email.
-            if img == NONE
-              img = 'none'
-              img << ' !important' if important
-              into[BACKGROUND_IMAGE] = img
-            end
+            values << "url(#{ctx.image_url(img)})"
 
-          else
+            position = '0% 0%' if position.blank? && !size.blank?
+            unless position.blank?
+              values << position
+              unless size.blank?
+                values << '/'
+                values << (size == 'fill' ? '100% auto' : size)
+              end
+            end
 
             # Default to no-repeat if a position has been supplied or replace
             # 'none' as a convenience (cause none is easier to type than no-repeat).
             repeat = 'no-repeat' if (repeat.blank? && !position.blank?) || repeat == NONE
+            values << repeat unless repeat.blank?
 
-            sty = []
-            sty << bgcolor unless bgcolor.blank?
-
-            ctx.assert_image_exists(img)
-
-            sty << "url(#{ctx.image_url(img)})"
-            sty << position unless position.blank?
-            sty << repeat unless repeat.blank?
-            sty << '!important' if important
-
-            into[:background] = sty.join(' ')
-
-          end
-
-          # Background size needs to be set independently.  Perhaps it can be
-          # mixed into background: but I couldn't make it work.
-          unless size.blank?
-            into[BACKGROUND_SIZE] = size
-            into[BACKGROUND_SIZE] << ' !important' if important
           end
 
         end
 
-        into
+        values.blank?? nil : values.join(' ')
       end
 
     end

data/lib/inkcite/renderer/td.rb

@@ -84,9 +84,6 @@ module Inkcite
       CLOSE_TD = '/td'
       LEFT = 'left'
 
-      # Property which controls the color of text
-      TEXT_COLOR = :'#text'
-
     end
   end
 end

data/lib/inkcite/renderer.rb

@@ -13,7 +13,7 @@ require_relative 'renderer/in_browser'
 require_relative 'renderer/increment'
 require_relative 'renderer/like'
 require_relative 'renderer/link'
-require_relative 'renderer/litmus'
+require_relative 'renderer/litmus_analytics'
 require_relative 'renderer/lorem'
 require_relative 'renderer/mobile_image'
 require_relative 'renderer/mobile_style'
@@ -161,7 +161,7 @@ module Inkcite
           :'in-browser'       => InBrowser.new,
           :include            => Partial.new,
           :like               => Like.new,
-          :litmus             => Litmus.new,
+          :litmus             => LitmusAnalytics.new,
           :lorem              => Lorem.new,
           :'mobile-img'       => MobileImage.new,
           :'mobile-style'     => MobileStyle.new,

data/lib/inkcite/uploader.rb

@@ -75,6 +75,10 @@ module Inkcite
       # The preview version defines the configuration for the server to which
       # the files will be sftp'd.
       config = email.config[:sftp]
+      if config.nil? || config.blank?
+        puts "Unable to upload assets to CDN ('sftp:' section not found in config.yml)"
+        return
+      end
 
       # TODO: Verify SFTP configuration
       host     = config[:host]

data/lib/inkcite/util.rb

@@ -45,6 +45,10 @@ module Inkcite
 
     end
 
+    def self.last_modified file
+      file && File.exists?(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)

data/lib/inkcite/version.rb

@@ -1,3 +1,3 @@
 module Inkcite
-  VERSION = "1.2.0"
+  VERSION = "1.6.0"
 end