inkcite 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dff1fb6ce80d821e6c797a6c691e904ed6dfb60d
-  data.tar.gz: dcea60b5e3efe7edabc97186822e09e8cf43c8d5
+  metadata.gz: b0303ddbd80b228a0fd359eb646834a24e0c8e37
+  data.tar.gz: 720d1a683829b80e35e1b21162ab0e54120763af
 SHA512:
-  metadata.gz: 8b19819db8870689817a7947159c7d30ff14e7a237c485dd42d43443691da47f2af0573e34df9f1873cdb14c8a20b71516ff0a23e6b9abdf06eac3747fd7a315
-  data.tar.gz: 118adc599578c2d779d841ea78c8808a8a49334b084809e48eae9e6499e505d93218e5c5ab25026c7cf14b34ec930c39b4bc45401a928d3562eaed823f43aa80
+  metadata.gz: 0babd93ce009462a59b296af9c5675d4c41e2d2e96c307bbbc7bac093496bdd523bde613b823a18d450c576ca57a6bfe5e120b35afdbf099188539db39741a57
+  data.tar.gz: 915e2f2941af36147805a1c0b5ac3383c28b4933bd08eeb20d560eab3b735364b205c236d773f7700556098af3179fffed5f57d7214635a1225b912e81d0d9ef

data/assets/init/config.yml

@@ -39,6 +39,15 @@ smtp:
   password: ''
   from: 'Your Name <email@domain.com>'
 
+# Mailgun settings for sending previews via their 3x faster API.  Sign up for
+# a free account and retrieve your API key and sending domain from your
+# Mailgun account dashboard.
+#
+# mailgun:
+#  api-key: 'key-your-api-key'
+#  domain: 'mg.sending-domain.com'
+#  from: 'Your Name <email@domain.com>'
+
 # Specify the distribution lists for preview versions of your email.
 recipients:
   client:

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/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/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/version.rb

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

data/lib/inkcite/view.rb

@@ -151,7 +151,32 @@ module Inkcite
     end
 
     def footnotes
-      @footnotes ||= []
+
+      if @footnotes.nil?
+        @footnotes = []
+
+        # Preload the array of footnotes if they exist
+        footnotes_tsv_file = @email.project_file(FOOTNOTES_TSV_FILE)
+        if File.exists?(footnotes_tsv_file)
+          CSV.foreach(footnotes_tsv_file, { :col_sep => "\t" }) do |fn|
+
+            id = fn[0]
+            next if id.blank?
+
+            text = fn[2]
+            next if text.blank?
+
+            # Read the symbol and replace it with nil (so that one will be auto-generated)
+            symbol = fn[1]
+            symbol = nil if symbol.blank?
+
+            @footnotes << Renderer::Footnote::Instance.new(id, symbol, text, false)
+
+          end
+        end
+      end
+
+      @footnotes
     end
 
     def file_name ext=nil
@@ -347,10 +372,10 @@ module Inkcite
         # Render the body statement and apply the email's background color to it.
         bgcolor = Renderer.hex(self[BACKGROUND])
 
-        # Intentially not setting the link colors because those should be entirely
+        # Intentionally not setting the link colors because those should be entirely
         # controlled by the styles and attributes of the links themselves.  By not
         # setting it, links created sans-helper should be visually distinct.
-        html << Renderer.render("<body bgcolor=\"#{bgcolor}\" style=\"background-color: #{bgcolor}; width: 100% !important; min-width: 100% !important; margin: 0; padding: 0; -webkit-text-size-adjust: none; -ms-text-size-adjust: none;\">", self)
+        html << Renderer.render("<body bgcolor=\"#{bgcolor}\" style=\"background-color: #{bgcolor}; width: 100% !important; min-width: 100% !important; margin: 0 !important; padding: 0; -webkit-text-size-adjust: none; -ms-text-size-adjust: none;\">", self)
 
         html << minified
 
@@ -522,6 +547,9 @@ module Inkcite
     # Tab-separated file containing links declarations.
     LINKS_TSV_FILE = 'links.tsv'
 
+    # Tab-separated file containing footnote declarations.
+    FOOTNOTES_TSV_FILE = 'footnotes.tsv'
+
     def assert_in_browser msg
       raise msg if email? && !development?
     end
@@ -716,6 +744,10 @@ module Inkcite
         # 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;}"
 
+        # Remove extraneous left-margins on Android 4.4
+        # https://litmus.com/community/code/4194-why-is-email-not-centered-on-android-4-4#comment-5727
+        reset << 'div[style*="margin: 16px 0"] { margin:0 !important; }'
+
       end
 
       # Reset the font on every cell to the default family.

data/test/renderer/td_spec.rb

@@ -91,12 +91,12 @@ describe Inkcite::Renderer::Td do
 
   it 'can have a custom background color on mobile' do
     Inkcite::Renderer.render('{td mobile-bgcolor=#f09}', @view).must_equal('<td class="m1">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background-color:#ff0099 }')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:#ff0099 }')
   end
 
   it 'can override background color on mobile' do
     Inkcite::Renderer.render('{td bgcolor=#f00 mobile-bgcolor=#00f}', @view).must_equal('<td bgcolor=#ff0000 class="m1">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background-color:#0000ff !important }')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:#0000ff !important }')
   end
 
   it 'can have a background image' do
@@ -109,18 +109,18 @@ describe Inkcite::Renderer::Td do
   end
 
   it 'can override background image on mobile' do
-    Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom mobile-background-image=sky.jpg mobile-background-position=top}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg) bottom no-repeat">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/sky.jpg) top no-repeat !important }')
+    Inkcite::Renderer.render('{td background=floor.jpg mobile-background-image=sky.jpg }', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg)">')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/sky.jpg) !important }')
   end
 
-  it 'can disable background image on mobile' do
-    Inkcite::Renderer.render('{td bgcolor=#f00 background=floor.jpg background-position=bottom mobile-bgcolor=#0f0 mobile-background-image=none}', @view).must_equal('<td bgcolor=#ff0000 class="m1" style="background:#ff0000 url(images/floor.jpg) bottom no-repeat">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background-color:#00ff00 !important;background-image:none !important }')
+  it 'can override background position on mobile' do
+    Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom mobile-background-position=top}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg) bottom no-repeat">')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/floor.jpg) top no-repeat !important }')
   end
 
-  it 'inherits background position and repeat on mobile' do
-    Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom mobile-background-image=sky.jpg}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg) bottom no-repeat">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/sky.jpg) bottom no-repeat !important }')
+  it 'can disable background image on mobile' do
+    Inkcite::Renderer.render('{td background=floor.jpg mobile-background-image=none}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg)">')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:none !important }')
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inkcite
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeffrey D. Hoffman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -267,7 +267,7 @@ files:
 - lib/inkcite/renderer/increment.rb
 - lib/inkcite/renderer/like.rb
 - lib/inkcite/renderer/link.rb
-- lib/inkcite/renderer/litmus.rb
+- lib/inkcite/renderer/litmus_analytics.rb
 - lib/inkcite/renderer/lorem.rb
 - lib/inkcite/renderer/mobile_image.rb
 - lib/inkcite/renderer/mobile_style.rb

data/lib/inkcite/renderer/litmus.rb

@@ -1,33 +0,0 @@
-module Inkcite
-  module Renderer
-    class Litmus < Base
-
-      def render tag, opt, ctx
-
-        # Litmus tracking is enabled only for production emails.
-        return nil unless ctx.production? && ctx.email?
-
-        code = opt[:code] || opt[:id]
-        return nil if code.blank?
-
-        merge_tag = opt[MERGE_TAG] || ctx[MERGE_TAG]
-
-        ctx.styles << "@media print{#_t { background-image: url('https://#{code}.emltrk.com/#{code}?p&d=#{merge_tag}');}}"
-        ctx.styles << "div.OutlookMessageHeader {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.styles << "table.moz-email-headers-table {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.styles << "blockquote #_t {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.styles << "#MailContainerBody #_t {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-
-        ctx.footer << '<div id="_t"></div>'
-        ctx.footer << "<img src=\"https://#{code}.emltrk.com/#{code}?d=#{merge_tag}\" width=1 height=1 border=0 />"
-
-        nil
-      end
-
-      private
-
-      MERGE_TAG = :'merge-tag'
-
-    end
-  end
-end