inkcite 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4d3044cbc8db45ebd662ab451d759ef1f0aa25d
-  data.tar.gz: e87b26d745c307427fd53c7f1e55c19e242f3aaa
+  metadata.gz: c9a6108e258e26ebffcba5b417592af73932bede
+  data.tar.gz: c6390f145e38ebc22ab57c458e22ce3f1739bb1e
 SHA512:
-  metadata.gz: efb49479b68f7745f54902ea4d488c80532345baf772f74f6c939c22a77247c8f9635f4ac73cbf765cab9b3b96319c5af832f06f53c072e5ffd3541cda5a7460
-  data.tar.gz: 40b7fcc6f1bf820be7bfe5b890730a831b08f48fdd390061584c6808164b19998f1f038a1ad33740365f38689498e192d61f2f4d8719cb6280a235e9fd68b66a
+  metadata.gz: 12fa75df86d37aaf12ea3161a16533d2d09c17aa7b04629c7aaffc01cc28d8521d611dbaebc2a3be15c0fa589a81774df7ec6d4b069f923c0e29825ef39c23a0
+  data.tar.gz: da6c930926846bd56d665317ddca6014c61b7ac2e43488923ee9678b02a140b9f54aa8fb9c3fbb7abc4ae614289bfcbbe1d094ffa5ebeb28fe5d8d1f18793ffd

data/Rakefile

@@ -4,5 +4,5 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.libs.push "lib"
   t.test_files = FileList['test/*_spec.rb', 'test/renderer/*_spec.rb']
-  t.verbose = true
+  t.verbose = false
 end

data/assets/init/config.yml

@@ -22,6 +22,13 @@ optimize-images: true
 # and needs to be provided.
 missing-link-url: 'https://github.com/404'
 
+# Litmus (litmus.com) and Email on Acid (emailonacid.com) (paid services)
+# customers enter your static testing address here to enable instant
+# compatibility testing.
+# https://inkcite.readme.io/docs/compatibility-testing
+#
+test-address: ''
+
 # Add Google Fonts (https://www.google.com/fonts) to your emails.  Add
 # the URLs to the family and sizes needed in your email.  Then reference
 # the font family in either source.html:
@@ -78,14 +85,6 @@ recipients:
     - 'Creative Director <creative.director@domain.com>'
     - 'Proofreader <proof.reader@domain.com>'
 
-# Easy Litmus integration for compatibility testing.
-# https://inkcite.readme.io/docs/compatibility-testing
-#
-litmus:
-  subdomain: ''
-  username: ''
-  password: ''
-
 # Easy deployment of static assets to a CDN or publicly-accessible
 # server - required when your email has images.
 # https://dash.readme.io/project/inkcite/v1.0/docs/cdn-upload
@@ -112,6 +111,17 @@ tag-links: "from_email=myemail|{id}"
 #
 #tag-links-domain: 'clientdomain.com'
 
+# Easy Litmus (litmus.com) analytics integration. Provide your account
+# information here and Inkcite will automatically request a new
+# analytics ID for each version of your email.
+# https://inkcite.readme.io/docs/litmus-analytics
+#
+litmus:
+  subdomain: ''
+  username: ''
+  password: ''
+  merge-tag: ''
+
 
 # Environment-specific overrides allow you to change any setting
 # for each environment (e.g local development vs. client preview).

data/lib/inkcite/cli/base.rb

@@ -1,6 +1,10 @@
 require 'thor'
 require 'fileutils'
 
+# For improved heredoc
+# http://stackoverflow.com/a/9654275
+require 'active_support/core_ext/string/strip'
+
 module Inkcite
   module Cli
     class Base < Thor
@@ -37,8 +41,10 @@ module Inkcite
         Cli::Init.invoke(name, options)
       end
 
-      desc 'preview TO [options]', 'Send a preview of the email  recipient list: developer, internal or client'
-
+      desc 'preview TO [options]', 'Send a preview of the email to a recipient list: developer, internal or client'
+      option :version,
+          :aliases => '-v',
+          :desc => 'Preview a specific version of the email'
       def preview to=:developer
         require_relative 'preview'
         Cli::Preview.invoke(email, to, options)
@@ -80,12 +86,10 @@ module Inkcite
 
       end
 
-      desc 'test [options]', 'Tests (or re-tests) the email with Litmus'
-      option :new,
-          :aliases => '-n',
-          :desc => 'Forces a new test to be created, otherwise will revision an existing test if present',
-          :type => :boolean
-
+      desc 'test [options]', 'Tests (or re-tests) the email with Litmus or Email on Acid'
+      option :version,
+          :aliases => '-v',
+          :desc => 'Test a specific version of the email'
       def test
         require_relative 'test'
         Cli::Test.invoke(email, options)

data/lib/inkcite/cli/preview.rb

@@ -10,15 +10,13 @@ module Inkcite
         # latest images and "view in browser" versions are available.
         email.upload
 
-        puts "Sending preview to #{to} ..."
-
         case to.to_sym
           when :client
-            Inkcite::Mailer.client(email)
+            Inkcite::Mailer.client(email, opt)
           when :internal
-            Inkcite::Mailer.internal(email)
+            Inkcite::Mailer.internal(email, opt)
           when :developer
-            Inkcite::Mailer.developer(email)
+            Inkcite::Mailer.developer(email, opt)
           else
             raise "Invalid preview distribution target"
         end

data/lib/inkcite/cli/server.rb

@@ -37,7 +37,7 @@ module Inkcite
           guardfile = <<-EOF
             guard :livereload do
               watch(%r{^*.+\.(html|tsv|yml)})
-              watch(%r{^images/.+\.*})
+              watch(%r{images/.+\.(gif|jpg|png)})
             end
 
             logger level: :error
@@ -73,7 +73,15 @@ module Inkcite
                   :app => app
               })
         rescue Errno::EADDRINUSE
-          abort("Oops!  Port #{port} is unavailable. Either close the instance of Inkcite already running on #{port} or start this Inkcite instance on a new port with: --port=#{port+1}")
+          abort <<-USAGE.strip_heredoc
+
+            Oops!  Inkcite can't start its preview server.  Port #{port} is
+            unavailable. Either close the instance of Inkcite already running
+            on that port or start this Inkcite instance on a new port with:
+
+              inkcit server --port=#{port+1}
+
+          USAGE
         end
 
       end
@@ -124,9 +132,9 @@ module Inkcite
 
             html = view.render!
 
-            # If we're rendering the development version of the email, beautify the
-            # output so that
-            html = HtmlBeautifier.beautify(html) if view.development?
+            # If minification is disabled, then beautify the output to make it easier
+            # for the designer to inspect the code being produced by Inkcite.
+            html = HtmlBeautifier.beautify(html) unless view.is_enabled?(:minify)
 
             unless view.errors.blank?
               error_count = view.errors.count

data/lib/inkcite/cli/test.rb

@@ -7,40 +7,59 @@ module Inkcite
 
       def self.invoke email, opt
 
-        # Verify that a litmus: section is defined in the config.yml
-        config = email.config[:litmus]
-        if !config || config.blank?
-          puts "Unable to test with Litmus ('litmus:' section not found in config.yml)"
-          return false
+        # Check to see if the test-address has been specified.
+        send_to = email.config[TEST_ADDRESS]
+        if send_to.blank?
+
+          # Deprecated check for the test address buried in the Litmus section.
+          litmus_config = email.config[:litmus]
+          send_to = litmus_config[TEST_ADDRESS] unless litmus_config.blank?
+
         end
 
-        # The new Litmus launched in October, 2015 no longer uses the API for creating
-        # tests and instead just accepts emails sent to the account's static email address.
-        # Check to see if a test-address has been defined.
-        send_to = config[:'test-address']
-        if send_to.nil? || send_to.blank?
-          puts "Unable to test with Litmus! ('test-address' entry missing from 'litmus:' section in the config.yml)"
-          return false
+        if send_to.blank?
+          abort <<-USAGE.strip_heredoc
+
+            Oops! Inkcite can't start a compatibility test because of a missing
+            configuration value. In config.yml, please add or uncomment this line
+            and insert your Litmus or Email on Acid static testing email address:
+
+              test-address: '(your.static.address@testingservice.com)'
+
+          USAGE
         end
 
         # Push the browser preview up to the server to ensure that the
         # latest images are available.
         email.upload
 
-        # Send each version to Litmus separately
-        email.versions.each do |version|
+        # Typically the user will only provide a single test address but here
+        # we convert to an array in case the user is sending to multiple
+        # addresses for their own compatibility testing.
+        send_to = Array(send_to)
 
-          view = email.view(:preview, :email, version)
+        # Check to see if the user wants to test a specific version of the
+        # email - otherwise test all of them.
+        versions = Array(opt[:version] || email.versions)
+
+        # Send each version to the testing service separately
+        versions.each do |version|
 
-          puts "Sending '#{view.subject}' to #{send_to} ..."
+          view = email.view(:preview, :email, version)
+          puts "Sending '#{view.subject}' to #{send_to.join(', ')} ..."
 
-          Inkcite::Mailer.litmus(email, version, send_to)
+          Inkcite::Mailer.send_version(email, version, { :to => send_to })
 
         end
 
         true
       end
 
+      private
+
+      # Name of the config property that
+      TEST_ADDRESS = :'test-address'
+
     end
   end
 end

data/lib/inkcite/email.rb

@@ -27,7 +27,7 @@ module Inkcite
       Util.read_yml(File.join(path, 'config.yml'), :fail_if_not_exists => true)
     end
 
-    def formats env
+    def formats env=nil
 
       # Inkcite is always capable of producing an email version of
       # the project.

data/lib/inkcite/mailer.rb

@@ -4,7 +4,7 @@ require 'mailgun'
 module Inkcite
   class Mailer
 
-    def self.client email
+    def self.client email, opts
 
       # Determine which preview this is
       count = increment(email, :preview)
@@ -27,151 +27,187 @@ module Inkcite
       # Always cc internal recipients so everyone stays informed of feedback.
       cc = recipients[:internal]
 
-      self.send(email, {
-              :to => to,
-              :cc => cc,
-              :bcc => true,
-              :tag => "Preview ##{count}"
-          })
+      self.send(email, opts.merge({
+                  :to => to,
+                  :cc => cc,
+                  :bcc => true,
+                  :tag => "Preview ##{count}"
+              }))
 
     end
 
-    def self.developer email
+    def self.developer email, opts
 
       count = increment(email, :developer)
 
-      self.send(email, {
-              :tag => "Developer Test ##{count}"
-          })
+      self.send(email, opts.merge({
+                  :tag => "Developer Test ##{count}"
+              }))
 
     end
 
-    def self.litmus email, version, litmus_email
-      self.send_version(email, version, { :to => litmus_email })
-    end
-
-    def self.internal email
+    def self.internal email, opts
 
       recipients = email.config[:recipients]
 
       # Determine which preview this is
       count = increment(email, :internal)
 
-      self.send(email, {
-              :to => recipients[:internal],
-              :bcc => true,
-              :tag => "Internal Proof ##{count}"
-          })
+      self.send(email, opts.merge({
+                  :to => recipients[:internal],
+                  :bcc => true,
+                  :tag => "Internal Proof ##{count}"
+              }))
 
     end
 
-    private
+    # Sends each version of the provided email with the indicated options.
+    def self.send email, opts
 
-    # Name of the distribution list used on the first preview.  For one
-    # client, they wanted the first preview sent to additional people
-    # but subsequent previews went to a shorter list.
-    FIRST_PREVIEW = :'first-preview'
+      # Check to see if a specific version is requested or if unspecified
+      # all versions of the email should be sent.
+      versions = Array(opts[:version] || email.versions)
 
-    def self.increment email, sym
-      count = email.meta(sym).to_i + 1
-      email.set_meta sym, count
-    end
+      # Will hold the instance of the Mailer::Base that will handle the
+      # actual sending of the email.
+      mailer_base = nil
 
-    # Sends each version of the provided email with the indicated options.
-    def self.send email, opt
+      # Check to see if
+      if config = email.config[:mailgun]
+        mailer_base = MailgunMailer.new
+      elsif config = email.config[:smtp]
+        mailer_base = SmtpMailer.new
+      else
+        abort <<-USAGE.strip_heredoc
+
+          Oops! Inkcite can't send this email because of a configuration problem.
+          Please update the mailgun or smtp sections of your config.yml file.
+
+            smtp:
+              host: 'smtp.gmail.com'
+              port: 587
+              domain: 'yourdomain.com'
+              username: ''
+              password: ''
+              from: 'Your Name <email@domain.com>'
 
-      email.versions.each do |version|
-        self.send_version(email, version, opt)
+          Or send via Mailgun:
+
+            mailgun:
+              api-key: 'key-your-api-key'
+              domain: 'mg.sending-domain.com'
+              from: 'Your Name <email@domain.com>'
+
+        USAGE
       end
 
-    end
+      versions.each do |version|
 
-    def self.send_version email, version, opt
+        # The version of the email we will be sending.
+        view = email.view(:preview, :email, version)
 
-      # The version of the email we will be sending.
-      view = email.view(:preview, :email, version)
+        # Subject line tag such as "Preview #3"
+        tag = opts[:tag]
 
-      # Subject line tag such as "Preview #3"
-      tag = opt[:tag]
+        subject = view.subject
+        subject = "#{subject} (#{tag})" unless tag.blank?
 
-      subject = view.subject
-      subject = "#{subject} (#{tag})" unless tag.blank?
+        puts "Sending '#{subject}' ..."
+
+        mailer_base.send! config, view, subject, opts
 
-      if config = email.config[:mailgun]
-        send_version_via_mailgun config, view, subject, opt
-      elsif config = email.config[:smtp]
-        send_version_via_smtp config, view, subject, opt
-      else
-        puts 'Unable to send previews. Please configure mailgun or smtp sections in config.yml'
       end
 
     end
 
     private
 
-    def self.send_version_via_mailgun config, view, subject, opt
+    # Name of the distribution list used on the first preview.  For one
+    # client, they wanted the first preview sent to additional people
+    # but subsequent previews went to a shorter list.
+    FIRST_PREVIEW = :'first-preview'
 
-      # The address of the developer
-      from = config[:from]
+    def self.increment email, sym
+      count = email.meta(sym).to_i + 1
+      email.set_meta sym, count
+    end
 
-      # First, instantiate the Mailgun Client with your API key
-      mg_client = Mailgun::Client.new config[:'api-key']
+    # Abstract base class for the workhorses of the Mailer class.
+    # Instantiated based on the config.yml settings.
+    class Base
+      def send! config, view, subject, opt
+        raise NotImplementedError
+      end
+    end
 
-      # Define your message parameters
-      message_params = {
-          :from => from,
-          :to => opt[:to] || from,
-          :subject => subject,
-          :html => view.render!
-      }
+    class MailgunMailer < Base
+      def send! config, view, subject, opt
 
-      message_params[:cc] = opt[:cc] unless opt[:cc].blank?
-      message_params[:bcc] = from if opt[:bcc] == true
+        # The address of the developer
+        from = config[:from]
 
-      # Send your message through the client
-      mg_client.send_message config[:domain], message_params
+        # First, instantiate the Mailgun Client with your API key
+        mg_client = Mailgun::Client.new config[:'api-key']
 
-    end
+        # Define your message parameters
+        message_params = {
+            :from => from,
+            :to => opt[:to] || from,
+            :subject => subject,
+            :html => view.render!
+        }
+
+        message_params[:cc] = opt[:cc] unless opt[:cc].blank?
+        message_params[:bcc] = from if opt[:bcc] == true
+
+        # Send your message through the client
+        mg_client.send_message config[:domain], message_params
 
-    def self.send_version_via_smtp config, view, _subject, opt
-
-      Mail.defaults do
-        delivery_method :smtp, {
-                :address => config[:host],
-                :port => config[:port],
-                :user_name => config[:username],
-                :password => config[:password],
-                :authentication => :plain,
-                :enable_starttls_auto => true
-            }
       end
+    end
 
-      # The address of the developer
-      _from = config[:from]
+    class SmtpMailer < Base
+      def send! config, view, _subject, opt
+
+        Mail.defaults do
+          delivery_method :smtp, {
+                  :address => config[:host],
+                  :port => config[:port],
+                  :user_name => config[:username],
+                  :password => config[:password],
+                  :authentication => :plain,
+                  :enable_starttls_auto => true
+              }
+        end
 
-      # True if the developer should be bcc'd.
-      _bcc = opt[:bcc] == true
+        # The address of the developer
+        _from = config[:from]
 
-      mail = Mail.new do
+        # True if the developer should be bcc'd.
+        _bcc = !!opt[:bcc]
 
-        to opt[:to] || _from
-        cc opt[:cc]
-        from _from
-        subject _subject
+        mail = Mail.new do
 
-        bcc(_from) if _bcc
+          to opt[:to] || _from
+          cc opt[:cc]
+          from _from
+          subject _subject
 
-        html_part do
-          content_type 'text/html; charset=UTF-8'
-          body view.render!
-        end
+          bcc(_from) if _bcc
 
-      end
+          html_part do
+            content_type 'text/html; charset=UTF-8'
+            body view.render!
+          end
+
+        end
 
-      mail.deliver!
+        mail.deliver!
 
+      end
     end
 
   end
 end
 
+

data/lib/inkcite/renderer/base.rb

@@ -74,6 +74,10 @@ module Inkcite
         val
       end
 
+      def detect_bgcolor opt
+        detect(opt[:bgcolor], opt[BACKGROUND_COLOR])
+      end
+
       # Convenience pass-thru to Renderer's static helper method.
       def hex color
         Renderer.hex(color)
@@ -92,7 +96,7 @@ module Inkcite
       def mix_background element, opt
 
         # Background color of the image, if populated.
-        bgcolor = detect(opt[:bgcolor], opt[BACKGROUND_COLOR])
+        bgcolor = detect_bgcolor(opt)
         element.style[BACKGROUND_COLOR] = hex(bgcolor) unless none?(bgcolor)
 
       end

data/lib/inkcite/renderer/image_base.rb

@@ -5,10 +5,13 @@ module Inkcite
       protected
 
       # Display mode constants
-      BLOCK   = 'block'
+      BLOCK = 'block'
       DEFAULT = 'default'
-      INLINE  = 'inline'
+      INLINE = 'inline'
 
+      # For the given image source URL provided, returns either the fully-qualfied
+      # path to the image (via View's image_url method) or returns a placeholder
+      # if the image is missing.
       def image_url _src, opt, ctx
 
         src = _src
@@ -18,7 +21,7 @@ module Inkcite
 
         # Fully-qualify the image path for this version of the email unless it
         # is already includes a full address.
-        unless src.include?('://')
+        unless Util::is_fully_qualified?(src)
 
           # Verify that the image exists.
           if ctx.assert_image_exists(src) || ctx.is_disabled?(Inkcite::Email::IMAGE_PLACEHOLDERS)
@@ -36,15 +39,25 @@ module Inkcite
 
           elsif DIMENSIONS.all? { |dim| opt[dim].to_i > MINIMUM_DIMENSION_FOR_PLACEHOLDER }
 
+            width = opt[:width]
+            height = opt[:height]
+
             # As a convenience, replace missing images with placehold.it as long as they
             # meet the minimum dimensions.  No need to spam the design with tiny, tiny
             # placeholders.
-            src = "http://placehold.it/#{opt[:width]}x#{opt[:height]}#{File.extname(src)}"
+            src = "http://placehold.it/#{width}x#{height}.jpg"
+
+            # Check to see if the image has a background color.  If so, we'll use that
+            # to set the background color of the placeholder.
+            bgcolor = detect_bgcolor(opt)
+            src << "/#{bgcolor}".gsub('#', '') unless none?(bgcolor)
 
             # Check to see if the designer specified FPO text for this placeholder -
             # otherwise default to the dimensions of the image.
             fpo = opt[:fpo]
-            src << "&text=#{URI::encode(fpo)}" unless fpo.blank?
+            fpo = _src.dup if fpo.blank?
+            fpo << "\n(#{width}×#{height})"
+            src << "?text=#{URI::encode(fpo)}"
 
           end
 

data/lib/inkcite/renderer/link.rb

@@ -44,7 +44,7 @@ module Inkcite
 
         # If a URL wasn't provided in the HTML, then check to see if there is
         # a link declared in the project's links_tsv file.
-        href = ctx.links_tsv[id] if href.blank?
+        href = ctx.links_tsv[id].dup if href.blank? && ctx.links_tsv[id]
 
         # True if the href is missing.  If so, we may try to look it up by it's ID
         # or we'll insert a default TBD link.
@@ -200,20 +200,7 @@ module Inkcite
           # href matches the desired domain name.
           tag_domain = ctx[TAG_LINKS_DOMAIN]
           if tag_domain.blank? || href =~ /^https?:\/\/[^\/]*#{tag_domain}/
-
-            # Prepend it with a question mark or an ampersand depending on the current
-            # state of the lin.
-            stag = href.include?('?') ? '&' : '?'
-            stag << replace_tag(tag, id, ctx)
-
-            # Inject before the pound sign if present - otherwise, just tack it on
-            # to the end of the href.
-            if hash = href.index(POUND_SIGN)
-              href[hash..0] = stag
-            else
-              href << stag
-            end
-
+            Util::add_query_param(href, replace_tag(tag, id, ctx))
           end
 
         end

data/lib/inkcite/renderer/responsive.rb

@@ -2,17 +2,18 @@ module Inkcite
   module Renderer
     class Responsive < Base
 
-      BUTTON     = 'button'
-      DROP       = 'drop'
-      FILL       = 'fill'
-      FLUID      = 'fluid'
-      FLUID_DROP = 'fluid-drop'
-      HIDE       = 'hide'
-      IMAGE      = 'img'
-      SHOW       = 'show'
-      SWITCH     = 'switch'
-      SWITCH_UP  = 'switch-up'
-      TOGGLE     = 'toggle'
+      BUTTON      = 'button'
+      DROP        = 'drop'
+      FILL        = 'fill'
+      FLUID       = 'fluid'
+      FLUID_DROP  = 'fluid-drop'
+      FLUID_STACK = 'fluid-stack'
+      HIDE        = 'hide'
+      IMAGE       = 'img'
+      SHOW        = 'show'
+      SWITCH      = 'switch'
+      SWITCH_UP   = 'switch-up'
+      TOGGLE      = 'toggle'
 
       # For elements that take on different background properties
       # when they go responsive
@@ -185,7 +186,14 @@ module Inkcite
       # Returns true if the mobile klass provided matches any of the
       # Fluid-Hybrid classes.
       def is_fluid? mobile
-        mobile == FLUID || mobile == FLUID_DROP
+        mobile == FLUID || is_fluid_drop?(mobile)
+      end
+
+      # Returns true if the mobile klass provided matches any of the
+      # Fluid-Hybrid classes that result in a table's columns stacking
+      # vertically.
+      def is_fluid_drop? mobile
+        mobile == FLUID_DROP || mobile == FLUID_STACK
       end
 
       def mix_font element, opt, ctx, parent=nil

data/lib/inkcite/renderer/table.rb

@@ -21,7 +21,7 @@ module Inkcite
           # If the table was declared as Fluid-Hybrid Drop, then there are some additional
           # elements that need to be closed before the regular row-table closure that
           # the Table helper normally produces.
-          if open_mobile == FLUID_DROP
+          if is_fluid_drop?(open_mobile)
 
             # Close the interior conditional table for Outlook that contains the floating blocks.
             html << if_mso('</tr></table>')
@@ -50,7 +50,7 @@ module Inkcite
 
           # Check if fluid-drop has been specified.  This will force a lot more HTML to
           # be produced for this table and its child TDs.
-          is_fluid_drop = mobile == FLUID_DROP
+          is_fluid_drop = is_fluid_drop?(mobile)
 
           # Inherit base cell attributes - border, background color and image, etc.
           mix_all table, opt, ctx
@@ -129,7 +129,14 @@ module Inkcite
             #
             # The zero-size font addresses a rendering problem in Outlook:
             # https://css-tricks.com/fighting-the-space-between-inline-block-elements/
-            html << Element.new('td', :style => { TEXT_ALIGN => :center, VERTICAL_ALIGN => opt[:valign], FONT_SIZE => 0 }).to_s
+            fluid_td = Element.new('td', :style => { TEXT_ALIGN => :center, VERTICAL_ALIGN => opt[:valign], FONT_SIZE => 0 })
+
+            # If fluid-stack is specified, then reverse the order of the columns to make
+            # the right-most orient to the top.
+            # http://webdesign.tutsplus.com/tutorials/creating-a-future-proof-responsive-email-without-media-queries--cms-23919
+            fluid_td[:dir] = :rtl if mobile == FLUID_STACK
+
+            html << fluid_td.to_s
 
             # Lastly, Outlook needs yet another conditional table that will be used
             # to contain the floating blocks.  The TD elements are generated by

data/lib/inkcite/renderer/td.rb

@@ -12,6 +12,7 @@ module Inkcite
         # Grab the attributes of the parent table so that the TD can inherit
         # specific values like padding, valign, responsiveness, etc.
         table_opt = ctx.parent_opts(:table)
+        table_mobile = table_opt[:mobile]
 
         # Check to see if the parent table was set to fluid-drop which causes
         # the table cells to be wrapped in <div> elements and floated to
@@ -19,7 +20,7 @@ module Inkcite
         #
         # Fluid-Hybrid TD courtesy of @moonstrips and our friends at Campaign Monitor
         # https://www.campaignmonitor.com/blog/email-marketing/2014/07/creating-a-centred-responsive-design-without-media-queries/
-        is_fluid_drop = table_opt[:mobile] == FLUID_DROP
+        is_fluid_drop = is_fluid_drop?(table_mobile)
 
         if tag == CLOSE_TD
 
@@ -77,8 +78,8 @@ module Inkcite
             # Width must be specified for Fluid-Drop cells.  Vertical-alignment is
             # also important but should have been preset by the Table Helper if it
             # was omitted by the designer.
-            ctx.error("Width is a required attribute when #{FLUID_DROP} is specified", opt) unless width > 0
-            ctx.error("Vertical alignment should be specified when #{FLUID_DROP} is specified", opt) if valign.blank?
+            ctx.error("Width is a required attribute when #{table_mobile} is specified", opt) unless width > 0
+            ctx.error("Vertical alignment should be specified when #{table_mobile} is specified", opt) if valign.blank?
 
             # Conditional Outlook cell to prevent the 100%-wide table within from
             # stretching beyond the max-width.  Also, valign necessary to get float

data/lib/inkcite/uploader.rb

@@ -101,55 +101,78 @@ module Inkcite
 
       puts "Uploading to #{host} ..."
 
-      # Get a local handle on the litmus configuration.
-      Net::SFTP.start(host, username, :password => password) do |sftp|
+      begin
 
-        # Upload each version of the email.
-        email.versions.each do |version|
+        # Get a local handle on the litmus configuration.
+        Net::SFTP.start(host, username, :password => password) do |sftp|
 
-          view = email.view(:preview, :email, version)
+          # Upload each version of the email.
+          email.versions.each do |version|
 
-          # Need to pass the upload path through the renderer to ensure
-          # that embedded tags will be converted into data.
-          remote_root = Inkcite::Renderer.render(path, view)
+            view = email.view(:preview, :email, version)
 
-          # Recursively ensure that the full directory structure necessary for
-          # the content and images is present.
-          mkdir! sftp, remote_root
+            # Need to pass the upload path through the renderer to ensure
+            # that embedded tags will be converted into data.
+            remote_root = Inkcite::Renderer.render(path, view)
 
-          # Upload the images to the remote directory.  We use the last_remote_root
-          # 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
+            # Recursively ensure that the full directory structure necessary for
+            # the content and images is present.
+            mkdir! sftp, remote_root
 
-          # Check to see if we're creating an in-browser version of the email.
-          next unless email.formats.include?(:browser)
+            # Upload the images to the remote directory.  We use the last_remote_root
+            # 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
 
-          browser_view = email.view(:preview, :browser, version)
+            # Check to see if we're creating an in-browser version of the email.
+            next unless email.formats.include?(:browser)
 
-          # Check to see if there is a HTML version of this preview.  Some emails
-          # do not have a hosted version and so it is not necessary to upload the
-          # HTML version of the email - but this is a bad practice.
-          file_name = view.file_name
-          next if file_name.blank?
+            browser_view = email.view(:preview, :browser, version)
 
-          remote_file_name = File.join(remote_root, file_name)
-          puts "Uploading #{remote_file_name}"
+            # Check to see if there is a HTML version of this preview.  Some emails
+            # do not have a hosted version and so it is not necessary to upload the
+            # HTML version of the email - but this is a bad practice.
+            file_name = browser_view.file_name
+            next if file_name.blank?
 
-          # We need to use StringIO to write the email to a buffer in order to upload
-          # the email's content in binary so that its encoding is honored.  SFTP defaults
-          # to ASCII-8bit in non-binary mode, so it was blowing up on UTF-8 special
-          # characters (e.g. "Mäkinen").
-          # http://stackoverflow.com/questions/9439289/netsftp-transfer-mode-binary-vs-text
-          io = StringIO.new(browser_view.render!)
-          sftp.upload!(io, remote_file_name)
+            remote_file_name = File.join(remote_root, file_name)
+            puts "Uploading #{remote_file_name}"
+
+            # We need to use StringIO to write the email to a buffer in order to upload
+            # the email's content in binary so that its encoding is honored.  SFTP defaults
+            # to ASCII-8bit in non-binary mode, so it was blowing up on UTF-8 special
+            # characters (e.g. "Mäkinen").
+            # http://stackoverflow.com/questions/9439289/netsftp-transfer-mode-binary-vs-text
+            io = StringIO.new(browser_view.render!)
+            sftp.upload!(io, remote_file_name)
+
+          end
 
         end
 
+      rescue SocketError => e
+        abort <<-USAGE.strip_heredoc
+
+          Oops! There was an unexpected error trying to upload to your
+          CDN or image host:
+
+            #{e.message}
+
+          Please check that the sftp section of config.yml is correct:
+
+            sftp:
+              host: '#{host}'
+              path: '#{path}'
+              username: '#{username}'
+              password: '#{password.gsub(/./, '*')}'
+
+        USAGE
+
       end
 
+
       # Timestamp to indicate we uploaded now
       email.set_meta :last_upload, Time.now.to_i
 

data/lib/inkcite/util.rb

@@ -3,6 +3,22 @@
 module Inkcite
   module Util
 
+    def self.add_query_param href, value
+
+      # Start with either a question mark or an ampersand depending on
+      # whether or not there is already a question mark in the URI.
+      param = href.include?('?') ? '&' : '?'
+      param << value.to_s
+
+      if hash_position = href.index('#')
+        href[hash_position..0] = param
+      else
+        href << param
+      end
+
+      href
+    end
+
     def self.brightness_value color
       color.nil? ? 0 : (color.gsub('#', '').scan(/../).map { |c| c.hex }).inject { |sum, c| sum + c }
     end
@@ -45,6 +61,10 @@ module Inkcite
 
     end
 
+    def self.is_fully_qualified? href
+      href.include?('//')
+    end
+
     def self.last_modified file
       file && File.exists?(file) ? File.mtime(file).to_i : 0
     end

data/lib/inkcite/version.rb

@@ -1,3 +1,3 @@
 module Inkcite
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

data/lib/inkcite/view.rb

@@ -216,29 +216,47 @@ module Inkcite
       fn
     end
 
+    # Returns the fully-qualified URL to the designated image (e.g. logo.gif)
+    # appropriate for the current rendering environment.  In development
+    # mode, local will have either images/ or images-optim/ prepended on them
+    # depending on the status of image optimization.
+    #
+    # For non-development builds, fully-qualified URLs may be returned depending
+    # on the state of the config.yml and how image-host attributes have been
+    # configured.
+    #
+    # If a fully-qualified URL is provided, the URL will be returned with the
+    # possible addition of the cache-breaker tag.
     def image_url src
 
       src_url = ''
 
-      # 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?? Minifier::IMAGE_CACHE : Email::IMAGES) + '/'
+      if Util.is_fully_qualified?(src)
+        src_url << src
+
       else
 
-        # Use the image host defined in config.yml or, out-of-the-box refer to images/
-        # in the build directory.
-        self[Email::IMAGE_HOST] || (Email::IMAGES + '/')
+        # 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?? Minifier::IMAGE_CACHE : Email::IMAGES) + '/'
+        else
+
+          # Use the image host defined in config.yml or, out-of-the-box refer to images/
+          # in the build directory.
+          self[Email::IMAGE_HOST] || (Email::IMAGES + '/')
 
-      end
+        end
+
+        src_url << image_host unless image_host.blank?
 
-      src_url << image_host unless image_host.blank?
+        # Add the source of the image.
+        src_url << src
 
-      # Add the source of the image.
-      src_url << src
+      end
 
       # Cache-bust the image if the caller is expecting it to be there.
-      src_url << "?#{Time.now.to_i}" if !production? && is_enabled?(Email::CACHE_BUST)
+      Util::add_query_param(src_url, Time.now.to_i) if !production? && is_enabled?(Email::CACHE_BUST)
 
       # Transpose any embedded tags into actual values.
       Renderer.render(src_url, self)
@@ -548,10 +566,6 @@ module Inkcite
     # Empty hash used when there is no environment or format-specific configuration
     EMPTY_HASH = {}
 
-    # Name of the property holding the email field used to ensure that an unsubscribe has
-    # been placed into emails.
-    EMAIL_MERGE_TAG = :'email-merge-tag'
-
     # Used when there is no subject or title for this email.
     UNTITLED_EMAIL = 'Untitled Email'
 

data/test/renderer/image_spec.rb

@@ -20,12 +20,12 @@ describe Inkcite::Renderer::Image do
 
   it 'substitutes a placeholder for a missing image of sufficient size' do
     @view.config[Inkcite::Email::IMAGE_PLACEHOLDERS] = true
-    Inkcite::Renderer.render('{img src=missing.jpg height=50 width=100}', @view).must_equal('<img border=0 height=50 src="http://placehold.it/100x50.jpg" style="display:block" width=100>')
+    Inkcite::Renderer.render('{img src=missing.jpg height=50 width=100}', @view).must_equal('<img border=0 height=50 src="http://placehold.it/100x50.jpg?text=missing.jpg%0A(100%C3%9750)" style="display:block" width=100>')
   end
 
   it 'has configurable placeholder text' do
     @view.config[Inkcite::Email::IMAGE_PLACEHOLDERS] = true
-    Inkcite::Renderer.render('{img src=missing.jpg height=50 width=100 fpo="F P O"}', @view).must_equal('<img border=0 height=50 src="http://placehold.it/100x50.jpg&text=F%20P%20O" style="display:block" width=100>')
+    Inkcite::Renderer.render('{img src=missing.jpg height=50 width=100 fpo="F P O"}', @view).must_equal('<img border=0 height=50 src="http://placehold.it/100x50.jpg?text=F%20P%20O%0A(100%C3%9750)" style="display:block" width=100>')
   end
 
   it 'does not substitute placeholders for small images' do
@@ -33,6 +33,10 @@ describe Inkcite::Renderer::Image do
     Inkcite::Renderer.render('{img src=missing.jpg height=5 width=15}', @view).must_equal('<img border=0 height=5 src="missing.jpg" style="display:block" width=15>')
   end
 
+  it 'does not alter externally referenced images' do
+    Inkcite::Renderer.render('{img src=://i.imgur.com/YJOX1PC.png height=5 width=15}', @view).must_equal('<img border=0 height=5 src="://i.imgur.com/YJOX1PC.png" style="display:block" width=15>')
+  end
+
   it 'has configurable dimensions' do
     Inkcite::Renderer.render('{img src=inkcite.jpg height=73 width=73}', @view).must_equal('<img border=0 height=73 src="images/inkcite.jpg" style="display:block" width=73>')
   end

data/test/renderer/link_spec.rb

@@ -34,6 +34,12 @@ describe Inkcite::Renderer::Link do
     Inkcite::Renderer.render('{a href="#news"}Latest News{/a}', @view).must_equal('<a href="#news" style="color:#0099cc;text-decoration:none">Latest News</a>')
   end
 
+  it 'tags a reused link once and only once' do
+    @view.config[:'tag-links'] = "tag=inkcite|{id}"
+    Inkcite::Renderer.render('{a id="litmus" href="http://litmus.com"}Test Emails Here{/a}{a id="litmus"}Also Here{/a}', @view).must_equal('<a href="http://litmus.com?tag=inkcite|litmus" style="color:#0099cc;text-decoration:none" target=_blank>Test Emails Here</a><a href="http://litmus.com?tag=inkcite|litmus" style="color:#0099cc;text-decoration:none" target=_blank>Also Here</a>')
+
+  end
+
   it 'raises a warning and generates an ID if one is not present' do
     Inkcite::Renderer.render('{a href="http://inkceptional.com"}Click Here{/a}', @view).must_equal('<a href="http://inkceptional.com" style="color:#0099cc;text-decoration:none" target=_blank>Click Here</a>')
     @view.errors.must_include('Link missing ID (line 0) [href=http://inkceptional.com]')

data/test/renderer/mobile_image_spec.rb

@@ -17,7 +17,7 @@ describe Inkcite::Renderer::MobileImage do
   it 'substitutes a placeholder for a missing image of sufficient size' do
     @view.config[Inkcite::Email::IMAGE_PLACEHOLDERS] = true
     Inkcite::Renderer.render('{mobile-img src=inkcite-mobile.jpg height=100 width=300}{/mobile-img}', @view).must_equal('<span class="i01 img"></span>')
-    @view.media_query.find_by_klass('i01').to_css.must_equal('span[class~="i01"] { background-image:url("http://placehold.it/300x100.jpg");height:100px;width:300px }')
+    @view.media_query.find_by_klass('i01').to_css.must_equal('span[class~="i01"] { background-image:url("http://placehold.it/300x100.jpg?text=inkcite-mobile.jpg%0A(300%C3%97100)");height:100px;width:300px }')
   end
 
   it 'hides any images it wraps' do

data/test/renderer/table_spec.rb

@@ -51,4 +51,16 @@ describe Inkcite::Renderer::Table do
     Inkcite::Renderer.render(markup, @view).must_equal(%Q(<!--[if mso]><table border=0 cellpadding=0 cellspacing=0 width=600><tr><td><![endif]--><table bgcolor=#009900 border=0 cellpadding=0 cellspacing=0 style="border:5px solid #f0f;max-width:600px" width=100%><tr><td style="font-size:0;text-align:center;vertical-align:middle"><!--[if mso]><table align=center border=0 cellpadding=0 cellspacing=0 width=100%><tr><![endif]--><!--[if mso]><td valign=top width=195><![endif]--><div class="fill" style="display:inline-block;vertical-align:top;width:195px"><table border=0 cellpadding=15 cellspacing=0 width=100%><tr><td align=left bgcolor=#000099 style="color:#ffffff;font-size:25px;padding:15px;text-align:left" valign=top>left</td></tr></table></div><!--[if mso]></td><![endif]--><!--[if mso]><td valign=middle width=195><![endif]--><div class="fill" style="display:inline-block;vertical-align:middle;width:195px"><table border=0 cellpadding=15 cellspacing=0 width=100%><tr><td align=center style="font-size:25px;padding:15px" valign=middle>centered two-line</td></tr></table></div><!--[if mso]></td><![endif]--><!--[if mso]><td valign=middle width=195><![endif]--><div class="fill" style="display:inline-block;vertical-align:middle;width:195px"><table border=0 cellpadding=15 cellspacing=0 width=100%><tr><td align=right bgcolor=#990000 style="color:#ffffff;font-size:30px;padding:15px" valign=middle>right<br>three<br>lines</td></tr></table></div><!--[if mso]></td><![endif]--><!--[if mso]></tr></table><![endif]--></td></tr></table><!--[if mso]></td></tr></table><![endif]-->))
   end
 
+  it 'supports fluid-stack desktop and style' do
+
+    markup = ''
+    markup << %Q({table font-size=25 bgcolor=#090 border="5px solid #f0f" padding=15 width=600 mobile="fluid-stack"})
+    markup << %Q({td width=195 bgcolor=#009 color=#fff valign=top}left{/td})
+    markup << %Q({td width=195 align=center}centered two-line{/td})
+    markup << %Q({td width=195 bgcolor=#900 color=#fff align=right font-size=30}right<br>three<br>lines{/td})
+    markup << %Q({/table})
+
+    Inkcite::Renderer.render(markup, @view).must_equal(%Q(<!--[if mso]><table border=0 cellpadding=0 cellspacing=0 width=600><tr><td><![endif]--><table bgcolor=#009900 border=0 cellpadding=0 cellspacing=0 style="border:5px solid #f0f;max-width:600px" width=100%><tr><td dir=rtl style="font-size:0;text-align:center;vertical-align:middle"><!--[if mso]><table align=center border=0 cellpadding=0 cellspacing=0 width=100%><tr><![endif]--><!--[if mso]><td valign=top width=195><![endif]--><div class="fill" style="display:inline-block;vertical-align:top;width:195px"><table border=0 cellpadding=15 cellspacing=0 width=100%><tr><td align=left bgcolor=#000099 style="color:#ffffff;font-size:25px;padding:15px;text-align:left" valign=top>left</td></tr></table></div><!--[if mso]></td><![endif]--><!--[if mso]><td valign=middle width=195><![endif]--><div class="fill" style="display:inline-block;vertical-align:middle;width:195px"><table border=0 cellpadding=15 cellspacing=0 width=100%><tr><td align=center style="font-size:25px;padding:15px" valign=middle>centered two-line</td></tr></table></div><!--[if mso]></td><![endif]--><!--[if mso]><td valign=middle width=195><![endif]--><div class="fill" style="display:inline-block;vertical-align:middle;width:195px"><table border=0 cellpadding=15 cellspacing=0 width=100%><tr><td align=right bgcolor=#990000 style="color:#ffffff;font-size:30px;padding:15px" valign=middle>right<br>three<br>lines</td></tr></table></div><!--[if mso]></td><![endif]--><!--[if mso]></tr></table><![endif]--></td></tr></table><!--[if mso]></td></tr></table><![endif]-->))
+  end
+
 end

data/test/renderer/td_spec.rb

@@ -103,6 +103,10 @@ describe Inkcite::Renderer::Td do
     Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom}', @view).must_equal('<td style="background:url(images/floor.jpg) bottom no-repeat">')
   end
 
+  it 'can have an externally hosted background image' do
+    Inkcite::Renderer.render('{td background=//i.imgur.com/YJOX1PC.png background-position=bottom}', @view).must_equal('<td style="background:url(//i.imgur.com/YJOX1PC.png) bottom no-repeat">')
+  end
+
   it 'can have a background image on mobile' do
     Inkcite::Renderer.render('{td mobile-background-image=wall.jpg mobile-background-position=right mobile-background-repeat=repeat-y}', @view).must_equal('<td class="m1">')
     @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/wall.jpg) right repeat-y }')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inkcite
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Jeffrey D. Hoffman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport