inkcite 1.14.0 → 1.15.0

data/lib/inkcite/renderer/footnote.rb

@@ -104,9 +104,29 @@ module Inkcite
         # appear in the {footnotes} rendering.
         instance.active = true
 
+        unless id.blank?
+
+          # Check to see if the once flag is enabled.  If enabled, check to see if
+          # this footnote has appeared before.
+          once = opt[:once]
+          return '' if once && !ctx.once?("#{id}-footnote")
+
+        end
+
         # Allow footnotes to be defined without showing a symbol
         hidden = opt[:hidden] || (opt[:hidden] == '1')
-        "#{instance.symbol}" unless hidden
+        return '' if hidden
+
+        # Check to see if the footnote should be automatically surrounded
+        # by the superscript helper.
+        sup = opt[:sup] && !ctx.text?
+
+        html = ''
+        html << '{sup}' if sup
+        html << instance.symbol
+        html << '{/sup}' if sup
+
+        html
       end
 
     end
@@ -125,7 +145,7 @@ module Inkcite
         # on the format of the email.
         tmpl = opt[:tmpl] || opt[:template]
         if tmpl.blank?
-          tmpl = ctx.text? ? "($symbol$) $text$\n\n" : "<sup>$symbol$</sup> $text$<br><br>"
+          tmpl = ctx.text? ? '($symbol$) $text$\n\n' : '<sup>$symbol$</sup> $text$<br><br>'
 
         elsif ctx.text?
 

data/lib/inkcite/renderer/image.rb

@@ -11,6 +11,7 @@ module Inkcite
 
         mix_background img, opt, ctx
         mix_border img, opt, ctx
+        mix_margins img, opt, ctx
 
         # Check to see if there is alt text specified for this image.  We are
         # testing against nil because sometimes the author desires an empty
@@ -66,12 +67,22 @@ module Inkcite
         # vertically aligns the image with the text.
         inline = (display == INLINE)
 
+        # Allow max-height to be specified.
+        max_height = opt[MAX_HEIGHT]
+        img.style[MAX_HEIGHT] = px(max_height) unless max_height.blank?
+
         align = opt[:align] || ('absmiddle' if inline)
         img[:align] = align unless align.blank?
 
         valign = opt[:valign] || ('middle' if inline)
         img.style[VERTICAL_ALIGN] = valign unless valign.blank?
 
+        # Fix for unexpected whitespace underneath images when emails
+        # are viewed in Outlook.com.  Thanks to @HTeuMeuLeu
+        # https://emails.hteumeuleu.com/outlook-coms-latest-bug-and-how-to-fix-gaps-under-images-ee1816671461
+        id = ctx.unique_id :img
+        img[:id] = quote("OWATemporaryImageDivContainer#{id}")
+
         html = ''
 
         # Check to see if an outlook-specific image source has been

data/lib/inkcite/renderer/image_base.rb

@@ -4,10 +4,6 @@ module Inkcite
 
       protected
 
-      # Name of the property that allows an outlook-specific src to be specified
-      # for an image.
-      OUTLOOK_SRC = :'outlook-src'
-
       # Display mode constants
       BLOCK = 'block'
       DEFAULT = 'default'
@@ -96,11 +92,12 @@ module Inkcite
       end
 
       def missing_dimensions? att
-        DIMENSIONS.any? { |dim| att[dim].to_i <= 0 }
+        DIMENSIONS.any? { |dim| att[dim].blank? }
       end
 
       def mix_dimensions img, opt, ctx
-        DIMENSIONS.each { |dim| img[dim] = opt[dim].to_i }
+        super
+        DIMENSIONS.each { |dim| img[dim] = opt[dim] }
       end
 
       private

data/lib/inkcite/renderer/in_browser.rb

@@ -15,6 +15,10 @@ module Inkcite
         # Make sure we're converting any embedded values in the host URL
         url = Renderer.render(url, browser_view)
 
+        # Cache-bust the URL to ensure recipients see the most recent version of
+        # the uploaded HTML
+        Util::add_query_param(url, Time.now.to_i) if !ctx.production? && ctx.is_enabled?(Email::CACHE_BUST)
+
         # Optional link override color.
         color = opt[:color]
 

data/lib/inkcite/renderer/link.rb

@@ -41,7 +41,12 @@ module Inkcite
         # including font, background color, border, etc.
         mix_all a, opt, ctx
 
-        id, href, target_blank = Link.process(opt[:id], opt[:href], opt[:force], ctx)
+        # If no-tag is specified, override the default tagging
+        # behavior.  Useful when the tagging interferes with
+        # behavior on dynamic pages.
+        add_tag = opt[:'no-tag'] != true
+
+        id, href, target_blank = Link.process(opt[:id], opt[:href], opt[:force], ctx, add_tag)
 
         a[:target] = BLANK if target_blank
 
@@ -100,7 +105,7 @@ module Inkcite
         html
       end
 
-      def self.process id, href, force, ctx
+      def self.process id, href, force, ctx, add_tag=true
 
         # Initially assume a blank target isn't needed
         target_blank = false
@@ -163,7 +168,7 @@ module Inkcite
             ctx.error('Link href appears to be invalid', { :id => id, :href => href }) unless force || valid?(href)
 
             # Optionally tag the link's query string for post-send log analytics.
-            href = add_tagging(id, href, ctx)
+            href = add_tagging(id, href, ctx) if add_tag
 
             if last_href.blank?
 
@@ -189,7 +194,7 @@ module Inkcite
 
         end
 
-        [ id, href, target_blank ]
+        [id, href, target_blank]
       end
 
       private
@@ -220,16 +225,38 @@ module Inkcite
       def self.add_tagging id, href, ctx
 
         # Check to see if we're tagging links.
-        tag = ctx[TAG_LINKS]
-        unless tag.blank?
-
-          # Blank tag domain means tag all the links - otherwise, make sure the
-          # href matches the desired domain name.
-          tag_domain = ctx[TAG_LINKS_DOMAIN]
-          if tag_domain.blank? || href =~ /^https?:\/\/[^\/]*#{tag_domain}/
-            Util::add_query_param(href, replace_tag(tag, id, ctx))
+        tag_map = ctx[TAG_LINKS]
+        unless tag_map.blank?
+
+          # This is the tag to be applied.
+          tag = nil
+
+          # Support for a map of tags where the matching domain is
+          # the key and the value is the tagging.
+          if tag_map.is_a?(Hash)
+            longest_domain = ''
+
+            tag_map.each do |domain, _tag|
+              if href =~ /^https?:\/\/[^\/]*#{domain}/
+                if domain.length > longest_domain.length
+                  longest_domain = domain
+                  tag = _tag
+                end
+              end
+            end
+
+          else
+
+            # Blank tag domain means tag all the links - otherwise, make sure the
+            # href matches the desired domain name.
+            tag_domain = ctx[TAG_LINKS_DOMAIN]
+            tag = tag_map if tag_domain.blank? || href =~ /^https?:\/\/[^\/]*#{tag_domain}/
+
           end
 
+          # If a tag was identified then apply it to the href.
+          href = Util::add_query_param(href, replace_tag(tag, id, ctx)) unless tag.blank?
+
         end
 
         href

data/lib/inkcite/renderer/mobile_image.rb

@@ -16,7 +16,7 @@ module Inkcite
 
         mix_background img, opt, ctx
 
-        mix_margins img, opt, ctx
+        mix_margins img, opt, ctx, false
 
         display = opt[:display]
         img.style[:display] = "#{display}" if display && display != BLOCK && display != DEFAULT

data/lib/inkcite/renderer/responsive.rb

@@ -29,6 +29,7 @@ module Inkcite
 
       # Other mobile-specific properties
       MOBILE_HEIGHT = :'mobile-height'
+      MOBILE_MAX_WIDTH = :'mobile-max-width'
       MOBILE_PADDING = :'mobile-padding'
       MOBILE_WIDTH = :'mobile-width'
 
@@ -209,6 +210,13 @@ module Inkcite
         mix_directional element, element.mobile_style, opt, ctx, MOBILE_BORDER, :border
       end
 
+      def mix_dimensions element, opt, ctx
+
+        max_width = opt[MOBILE_MAX_WIDTH]
+        element.mobile_style[MAX_WIDTH] = px(max_width) unless max_width.blank?
+
+      end
+
       def mix_font element, opt, ctx, parent=nil
 
         # Let the super class do its thing and grab the name of the font
@@ -237,7 +245,7 @@ module Inkcite
         font
       end
 
-      def mix_margins element, opt, ctx
+      def mix_margins element, opt, ctx, outlookCompatible=true
         super
         mix_directional element, element.mobile_style, opt, ctx, MOBILE_MARGIN, :margin, true
       end

data/lib/inkcite/renderer/social.rb

@@ -43,7 +43,35 @@ module Inkcite
         protected
 
         def get_share_href url, text, opts, ctx
-          %Q(https://twitter.com/share?url=#{url}&text=#{text})
+
+          params = {}
+          params[:url] = url unless url.blank?
+          params[:text] = text
+          params[:hashtags] = opts[:hashtags]
+
+          val = "https://twitter.com/intent/tweet?"
+          val << Renderer.join_hash(params, '=', '&')
+          val
+        end
+
+      end
+
+      class Instagram < Social
+
+        def initialize
+          super(:src => 'instagram.png', :alt => 'Instagram', :cta => 'Post')
+        end
+
+        protected
+
+        def get_share_href url, text, opts, ctx
+
+          val = "https://www.instagram.com"
+
+          username = opts[:username]
+          val << "/#{username}" unless username.blank?
+
+          val
         end
 
       end
@@ -62,10 +90,10 @@ module Inkcite
         id = opts[:id]
 
         share_url = opts.delete(:href).to_s
-        ctx.error("Social sharing 'href' attribute can't be blank", :tag => tag, :id => id) if share_url.blank?
+        #ctx.error("Social sharing 'href' attribute can't be blank", :tag => tag, :id => id) if share_url.blank?
 
         share_text = opts.delete(:text).to_s
-        ctx.error("Social sharing 'text' attribute can't be blank", :tag => tag, :id => id, :href => share_url) if share_text.blank?
+        #ctx.error("Social sharing 'text' attribute can't be blank", :tag => tag, :id => id, :href => share_url) if share_text.blank?
 
         # Let the extending class format the fully-qualified URL to the sharing service.
         service_href = get_share_href Util.escape(share_url), Util.escape(share_text), opts, ctx

data/lib/inkcite/renderer/special_effect.rb

@@ -165,18 +165,17 @@ module Inkcite
           (min_speed..max_speed)
         end
 
+        # An array of source images to be applied to the children or
+        # an empty array if there are none.
         def src
-          return @src if defined?(@src)
+          @src ||= begin
 
-          # Check to see if a source image has been specified for the snowflakes.
-          @src = @opt[:src]
+            # Check to see if a source image has been specified for the snowflakes.
+            # Split on a comma to treat the source listing as an array. Then verify
+            # that each of the referenced images exists
+            @opt[:src].to_s.split(',').select { |img| @ctx.assert_image_exists(img) }
 
-          # Release the image name if one has been provided but doesn't exist in
-          # the project - this will cause the special effect to default to the
-          # non-image default behavior.
-          @src = nil if @src && !@ctx.assert_image_exists(@src)
-
-          @src
+          end
         end
 
         def position_range
@@ -304,9 +303,8 @@ module Inkcite
       OPACITY_MAX = :'max-opacity'
       OPACITY_CEIL = 1.0
 
-      # Static constants for animation-specific CSS
-      ANIMATION_DELAY = :'animation-delay'
-      ANIMATION_DURATION = :'animation-duration'
+      # For converting degrees to radians and back
+      PI_OVER_180 = Math::PI / 180.0
 
       # The extending class can override this method to perform any
       # additional configuration on the style that affects all
@@ -361,7 +359,7 @@ module Inkcite
           color = sfx.color
           style[BACKGROUND_COLOR] = color unless none?(color)
         else
-          style[BACKGROUND_IMAGE] = "url(#{sfx.ctx.image_url(src)})"
+          style[BACKGROUND_IMAGE] = "url(#{sfx.ctx.image_url(src.first)})" unless src.length > 1
           style[BACKGROUND_SIZE] = '100%'
         end
 
@@ -377,6 +375,10 @@ module Inkcite
       # CSS classes to them allowing each to be sized, animated uniquely.
       def create_child_elements html, styles, sfx
 
+        # Get a local handle on the src array in case we need to apply
+        # a random one to each child (because there are multiple)
+        src = sfx.src
+
         sfx.count.times do |n|
 
           child_class_name = sfx.child_class_name(n)
@@ -387,6 +389,13 @@ module Inkcite
           # This is the custom style to be applied to the child.
           style = Inkcite::Renderer::Style.new(".#{child_class_name}", sfx.ctx)
 
+          # If there are multiple images, apply the next image based on the
+          # child's index.
+          if src.length > 1
+            src_index = n % src.length
+            style[BACKGROUND_IMAGE] = "url(#{sfx.ctx.image_url(src[src_index])})"
+          end
+
           # This is the animation declaration (timing, duration, etc.) for this child.
           animation = Inkcite::Animation.new(sfx.animation_class_name(n), sfx.ctx)
 

data/lib/inkcite/renderer/sup.rb

@@ -0,0 +1,32 @@
+module Inkcite
+  module Renderer
+    class Sup < Base
+
+      def render tag, opt, ctx
+
+        html = ''
+
+        if tag == '/sup'
+          html << '</sup>'
+
+        else
+
+          sup = Element.new('sup', :style => { VERTICAL_ALIGN => :top })
+
+          font_size = (opt[FONT_SIZE] || 10).to_i
+          sup.style[FONT_SIZE] = px(font_size)
+
+          line_height = (opt[LINE_HEIGHT] || 10).to_i
+          sup.style[LINE_HEIGHT] = px(line_height)
+
+          html << sup.to_s
+
+        end
+
+        html
+      end
+
+    end
+  end
+end
+

data/lib/inkcite/renderer/table_base.rb

@@ -28,6 +28,9 @@ module Inkcite
         # css isn't supported.
         element[:bgcolor] = bgcolor unless bgcolor.nil?
 
+        # Allow background gradients on tables and tds.
+        mix_background_gradient element, opt, ctx
+
         bgimage    = opt[:background]
         bgposition = opt[BACKGROUND_POSITION]
         bgrepeat   = opt[BACKGROUND_REPEAT]

data/lib/inkcite/renderer/topic.rb

@@ -0,0 +1,76 @@
+module Inkcite
+  module Renderer
+    class Topic < Base
+
+      class Instance
+
+        # Name of the topic as it will appear in the topic list.
+        attr_reader :name
+
+        # Order of the topic, higher wins
+        attr_reader :priority
+
+        def initialize name, priority
+          @name = name
+          @priority = priority
+        end
+
+      end
+
+      def render tag, opt, ctx
+
+        name = opt[:name]
+
+        if name.blank?
+          ctx.error 'Every topic must have a name'
+
+        else
+
+          # Initialize the array of topic instances that live in the
+          # View's arbitrary data holder.
+          ctx.data[:topics] ||= []
+
+          # Push a topic instance onto the list
+          ctx.data[:topics] << Instance.new(name, opt[:priority].to_i)
+
+        end
+
+        nil
+      end
+
+    end
+
+    class TopicList < Base
+
+      include PostProcessor
+
+      def post_process html, ctx
+
+        topics = ctx.data[:topics]
+        if topics.blank?
+          ctx.error '{topic-list} included but no topics defined'
+
+        else
+
+          # Sort the topics highest priority first.
+          sorted_topics = topics.sort { |lhs, rhs| rhs.priority <=> lhs.priority }.collect(&:name).join(', ')
+          html.gsub!(TOC_INTERMEDIARY, sorted_topics)
+
+        end
+
+        html
+      end
+
+      def render tag, opt, ctx
+        ctx.post_processors << self
+        TOC_INTERMEDIARY
+      end
+
+      private
+
+      TOC_INTERMEDIARY = '%%TOPIC-LIST-PLACEHOLDER%%'
+
+    end
+
+  end
+end