inkcite 1.11.0 → 1.12.0

data/lib/inkcite/renderer.rb

@@ -17,6 +17,7 @@ require_relative 'renderer/link'
 require_relative 'renderer/litmus_analytics'
 require_relative 'renderer/lorem'
 require_relative 'renderer/mobile_image'
+require_relative 'renderer/mobile_only'
 require_relative 'renderer/mobile_style'
 require_relative 'renderer/mobile_toggle'
 require_relative 'renderer/outlook_background'
@@ -25,9 +26,11 @@ require_relative 'renderer/preheader'
 require_relative 'renderer/property'
 require_relative 'renderer/redacted'
 require_relative 'renderer/snow'
+require_relative 'renderer/social'
 require_relative 'renderer/span'
 require_relative 'renderer/table'
 require_relative 'renderer/td'
+require_relative 'renderer/video_preview'
 
 module Inkcite
   module Renderer
@@ -116,7 +119,7 @@ module Inkcite
     end
 
     def self.quote val
-      "\"#{val}\""
+      %Q("#{val}")
     end
 
     def self.render str, context
@@ -166,6 +169,7 @@ module Inkcite
           :a                  => Link.new,
           :button             => Button.new,
           :div                => Div.new,
+          :facebook           => Social::Facebook.new,
           :footnote           => Footnote.new,
           :footnotes          => Footnotes.new,
           :google             => GoogleAnalytics.new,
@@ -176,15 +180,19 @@ module Inkcite
           :litmus             => LitmusAnalytics.new,
           :lorem              => Lorem.new,
           :'mobile-img'       => MobileImage.new,
+          :'mobile-only'      => MobileOnly.new,
           :'mobile-style'     => MobileStyle.new,
           :'mobile-toggle-on' => MobileToggleOn.new,
           :'outlook-bg'       => OutlookBackground.new,
+          :pintrest           => Social::Pintrest.new,
           :preheader          => Preheader.new,
           :redacted           => Redacted.new,
           :snow               => Snow.new,
           :span               => Span.new,
           :table              => Table.new,
-          :td                 => Td.new
+          :td                 => Td.new,
+          :twitter            => Social::Twitter.new,
+          :'video-preview'    => VideoPreview.new
       }
 
     end

data/lib/inkcite/renderer/base.rb

@@ -4,6 +4,7 @@ module Inkcite
 
       # Constants for style and property names with dashes in them.
       BACKGROUND_COLOR = :'background-color'
+      BACKGROUND_GRADIENT = :'background-gradient'
       BACKGROUND_IMAGE = :'background-image'
       BACKGROUND_REPEAT = :'background-repeat'
       BACKGROUND_POSITION = :'background-position'
@@ -33,6 +34,7 @@ module Inkcite
       TEXT_SHADOW_BLUR = :'shadow-blur'
       TEXT_SHADOW_OFFSET = :'shadow-offset'
       VERTICAL_ALIGN = :'vertical-align'
+      WEBKIT_ANIMATION = :'-webkit-animation'
       WHITE_SPACE = :'white-space'
 
       # CSS Margins
@@ -51,6 +53,9 @@ module Inkcite
       # Zero-width space character
       ZERO_WIDTH_SPACE = '​'
 
+      # Zero-width non-breaking character
+      ZERO_WIDTH_NON_BREAKING_SPACE = ''
+
       def render tag, opt, ctx
         raise "Not implemented: #{tag} #{opts}"
       end
@@ -75,8 +80,9 @@ module Inkcite
         val
       end
 
-      def detect_bgcolor opt
-        detect(opt[:bgcolor], opt[BACKGROUND_COLOR])
+      def detect_bgcolor opt, default=nil
+        bgcolor = detect(opt[:bgcolor], opt[BACKGROUND_COLOR], default)
+        none?(bgcolor) ? nil : hex(bgcolor)
       end
 
       # Convenience pass-thru to Renderer's static helper method.
@@ -92,13 +98,45 @@ module Inkcite
         val.blank? || val == NONE
       end
 
+      def mix_animation element, opt, ctx
+
+        animation = opt[:animation]
+        unless none?(animation)
+          element.style[:animation] = animation
+          element.style[WEBKIT_ANIMATION] = animation
+        end
+      end
+
       # Sets the element's in-line bgcolor style if it has been defined
       # in the provided options.
       def mix_background element, opt, ctx
 
         # Background color of the image, if populated.
         bgcolor = detect_bgcolor(opt)
-        element.style[BACKGROUND_COLOR] = hex(bgcolor) unless none?(bgcolor)
+
+        # Set the background color if the element has one.
+        element.style[BACKGROUND_COLOR] = bgcolor if bgcolor
+
+        # Background gradient support
+        bggradient = detect(opt[:bggradient] || opt[BACKGROUND_GRADIENT])
+        unless none?(bggradient)
+
+          # As a shortcut a gradient can be specified simply by designating
+          # both a bgcolor and the gradient color - this will insert a radial
+          # gradient automatically.
+          if bggradient.start_with?('#')
+            bggradient = hex(bggradient)
+
+            # If a bgcolor is provided, the gradient goes bgcolor -> bggradient.
+            # Otherwise, it goes bggradient->darker(bggradient)
+            center_color = bgcolor ? bgcolor : bggradient
+            outer_color = bgcolor ? bggradient : Util.darken(bggradient)
+
+            bggradient = %Q(radial-gradient(circle at center, #{center_color}, #{outer_color}))
+          end
+
+          element.style[BACKGROUND_IMAGE] = bggradient
+        end
 
       end
 
@@ -201,6 +239,10 @@ module Inkcite
 
       end
 
+      def pct val
+        "#{val}%"
+      end
+
       def px val
         Renderer.px(val)
       end

data/lib/inkcite/renderer/button.rb

@@ -12,7 +12,7 @@ module Inkcite
         end
 
         def bgcolor
-          hex(@opt[:bgcolor] || @ctx[BUTTON_BGCOLOR] || @ctx[BUTTON_BACKGROUND_COLOR] || @ctx[Base::LINK_COLOR])
+          hex(@opt[:bgcolor] || @ctx[BUTTON_BGCOLOR] || @ctx[BUTTON_BACKGROUND_COLOR])
         end
 
         def border
@@ -28,8 +28,7 @@ module Inkcite
         end
 
         def bevel_color
-          bc = @opt[BEVEL_COLOR] || @ctx[BUTTON_BEVEL_COLOR]
-          !bc.blank?? hex(bc) : text_shadow
+          @opt[BEVEL_COLOR] || @ctx[BUTTON_BEVEL_COLOR]
         end
 
         def border_radius
@@ -37,7 +36,7 @@ module Inkcite
         end
 
         def color
-          hex(@opt[:color] || @ctx[BUTTON_COLOR] || Util::contrasting_text_color(bgcolor))
+          hex(@opt[:color] || @ctx[BUTTON_COLOR])
         end
 
         def float
@@ -60,6 +59,10 @@ module Inkcite
           (@opt[:height] || @ctx[BUTTON_HEIGHT]).to_i
         end
 
+        def letter_spacing
+          @opt[Base::LETTER_SPACING] || @ctx[BUTTON_LETTER_SPACING]
+        end
+
         def line_height
           @opt[Base::LINE_HEIGHT] || @ctx[BUTTON_LINE_HEIGHT]
         end
@@ -73,11 +76,7 @@ module Inkcite
         end
 
         def text_shadow
-          ts = @opt[Base::TEXT_SHADOW] || @ctx[BUTTON_TEXT_SHADOW]
-          unless ts
-            ts = Util::brightness_value(bgcolor) > 382.5 ? Util::lighten(bgcolor, 0.25) : Util::darken(bgcolor)
-          end
-          hex(ts)
+          hex(@opt[Base::TEXT_SHADOW] || @ctx[BUTTON_TEXT_SHADOW])
         end
 
         def width
@@ -100,6 +99,7 @@ module Inkcite
         BUTTON_FONT_SIZE = :'button-font-size'
         BUTTON_FONT_WEIGHT = :'button-font-weight'
         BUTTON_HEIGHT = :'button-height'
+        BUTTON_LETTER_SPACING = :'button-letter-spacing'
         BUTTON_LINE_HEIGHT = :'button-line-height'
         BUTTON_MARGIN_TOP = :'button-margin-top'
         BUTTON_PADDING = :'button-padding'
@@ -131,7 +131,8 @@ module Inkcite
           # Responsive button is just a highly styled table/td combination with optional
           # curved corners and a lower bevel (border).
           bgcolor = cfg.bgcolor
-          html << "{table bgcolor=#{bgcolor}"
+          html << '{table'
+          html << %Q( bgcolor="#{bgcolor}") unless bgcolor.blank?
           html << " padding=#{cfg.padding}" if cfg.padding > 0
           html << %Q( border="#{cfg.border}") if cfg.border
           html << " border-radius=#{cfg.border_radius}" if cfg.border_radius > 0
@@ -139,7 +140,7 @@ module Inkcite
 
           # Need to separate borders that are collapsed by default - otherwise, the bevel
           # renders incorrectly.
-          html << " border-collapse=separate" if cfg.border || 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
@@ -161,7 +162,10 @@ module Inkcite
 
           # Second, internal link for Outlook users that makes the inside of the button
           # clickable.
-          html << "{a id=\"#{id}\" href=\"#{href}\" color=\"#{cfg.color}\"}"
+          html << %Q({a id="#{id}" href="#{href}" color="#{cfg.color}")
+          html << %Q( letter-spacing="#{cfg.letter_spacing}") unless cfg.letter_spacing.blank?
+          html << %q(})
+
 
         else
 

data/lib/inkcite/renderer/container_base.rb

@@ -6,19 +6,17 @@ module Inkcite
 
       def mix_all element, opt, ctx
 
+        mix_animation element, opt, ctx
         mix_background element, opt, ctx
         mix_border element, opt, ctx
         mix_border_radius element, opt, ctx
         mix_font element, opt, ctx
+        mix_text_align element, opt, ctx
 
         # Supports both integers and mixed padding (e.g. 10px 20px)
         padding = opt[:padding]
         element.style[:padding] = px(padding) unless none?(padding)
 
-        # Text alignment - left, right, center.
-        align = opt[:align]
-        element.style[TEXT_ALIGN] = align unless none?(align)
-
         # Vertical alignment - top, middle, bottom.
         valign = opt[:valign]
         element.style[VERTICAL_ALIGN] = valign unless none?(valign)
@@ -26,11 +24,23 @@ module Inkcite
         display = opt[:display]
         element.style[:display] = display unless display.blank?
 
+        # If boolean 'nowrap' attribute is present, apply the 'white-space: nowrap'
+        # style to the element.
+        element.style[WHITE_SPACE] = :nowrap if opt[:nowrap]
+
         mix_responsive element, opt, ctx
 
         element.to_s
       end
 
+      # Text alignment - left, right, center.
+      def mix_text_align element, opt, ctx
+
+        align = opt[:align]
+        element.style[TEXT_ALIGN] = align unless none?(align)
+
+      end
+
     end
   end
 end

data/lib/inkcite/renderer/element.rb

@@ -10,6 +10,10 @@ module Inkcite
         @tag = tag
         @att = att
 
+        # Initializing @classes to avoid a Ruby warning that it hasn't been
+        # declared when it is lazy-initialized in the classes() method.
+        @classes = nil
+
         # True if the tag self-closes as in "<img .../>"
         @self_close = att.delete(:self_close) == true
 
@@ -67,7 +71,13 @@ module Inkcite
         @styles
       end
 
-      def to_s
+      # Generates a Helper tag rather than a string tag - e.g. {img src=test.png}
+      # rather than <img src=test.png>
+      def to_helper
+        to_s('{', '}')
+      end
+
+      def to_s open='<', close='>'
 
         # Convert the style hash into CSS style attribute.
         @att[:style] = Renderer.quote(Renderer.render_styles(@styles)) unless @styles.blank?
@@ -75,7 +85,7 @@ module Inkcite
         # Convert the list of CSS classes assigned to this element into an attribute
         self[:class] = Renderer.quote(@classes.to_a.sort.join(' ')) unless @classes.blank?
 
-        html = '<'
+        html = open
         html << @tag
 
         unless @att.empty?
@@ -84,7 +94,7 @@ module Inkcite
         end
 
         html << ' /' if self_close?
-        html << '>'
+        html << close
 
         html
       end

data/lib/inkcite/renderer/image.rb

@@ -9,10 +9,6 @@ module Inkcite
         # Ensure that height and width are defined in the image's attributes.
         mix_dimensions img, opt, ctx
 
-        # Get the fully-qualified URL to the image or placeholder image if it's
-        # missing from the images directory.
-        img[:src] = image_url(opt[:src], opt, ctx)
-
         mix_background img, opt, ctx
         mix_border img, opt, ctx
 
@@ -23,10 +19,18 @@ module Inkcite
         if alt
 
           # Allow "\n" to be placed within alt text and converted into a line
-          # break for convenience.  Need to add an extra space for the email
-          # clients (ahem, Gmail, cough) that don't support alt text with
-          # line breaks.
-          alt.gsub!('\n', "\n ")
+          # break for convenience.
+          alt.gsub!('\n', "\n")
+
+          # Need to add an extra space for the email clients (ahem, Gmail,
+          # cough) that don't support alt text with line breaks.
+          alt.gsub!("\n", " \n")
+
+          # Remove all HTML from the alt text.  Ran into a situation where a
+          # custom Helper was applying styled text as image alt text.  Since
+          # HTML isn't allowed within alt text, as a convenience we'll just
+          # delete said markup.
+          alt.gsub!(/<[^>]*>/, '')
 
           # Ensure that the alt-tag has quotes around it.
           img[:alt] = quote(alt)
@@ -38,9 +42,6 @@ module Inkcite
             # Copy the text to the title attribute if enabled for this issue
             img[:title] = img[:alt] if ctx.is_enabled?(COPY_ALT_TO_TITLE)
 
-            # All images with alt text inherit small font unless otherwise specified.
-            opt[:font] ||= 'small'
-
             mix_font img, opt, ctx
 
             text_align = opt[TEXT_ALIGN]
@@ -71,6 +72,29 @@ module Inkcite
         valign = opt[:valign] || ('middle' if inline)
         img.style[VERTICAL_ALIGN] = valign unless valign.blank?
 
+        html = ''
+
+        # Check to see if an outlook-specific image source has been
+        # specified - typically used when there is an animated gif as
+        # the main source but a static image for Outlook clients.
+        outlook_src = opt[OUTLOOK_SRC]
+        unless outlook_src.blank?
+
+          # Initially set the image's URL to the outlook-specific image.
+          img[:src] = image_url(outlook_src, opt, ctx)
+
+          # Wrap the image in the outlook-specific conditionals.
+          html << '<!--[if mso]>'
+          html << img.to_s
+          html << '<![endif]-->'
+          html << '<!--[if !mso]><!-- -->'
+
+        end
+
+        # Get the fully-qualified URL to the image or placeholder image if it's
+        # missing from the images directory.
+        img[:src] = image_url(opt[:src], opt, ctx)
+
         mobile_src = opt[:'mobile-src']
         unless mobile_src.blank?
 
@@ -79,7 +103,7 @@ module Inkcite
           klass = klass_name(mobile_src, ctx)
 
           # Fully-qualify the image URL.
-          mobile_src = image_url(mobile_src, opt, ctx)
+          mobile_src = image_url(mobile_src, opt, ctx, false)
 
           # Add a responsive rule that replaces the image with a different source
           # with the same dimensions.  Warning, this isn't supported on earlier
@@ -106,17 +130,16 @@ module Inkcite
           # maintain aspect ratio if present.
           img[:height] = nil
 
-        else
-
-          # Check to see if this image is inside of a mobile-image declaration.
-          # If so, the image defaults to hide on mobile.
-          mobile = HIDE if mobile.blank? && !ctx.parent_opts(:mobile_image).blank?
-
         end
 
         mix_responsive img, opt, ctx, mobile
 
-        img.to_s
+        html << img.to_s
+
+        # Conclude the outlook-specific conditional if opened.
+        html << '<!--<![endif]-->' unless outlook_src.blank?
+
+        html
       end
 
       private
@@ -125,6 +148,10 @@ module Inkcite
       # be copied to the title field.
       COPY_ALT_TO_TITLE = :'copy-alt-to-title'
 
+      # Name of the property that allows an outlook-specific src to be specified
+      # for an image.
+      OUTLOOK_SRC = :'outlook-src'
+
     end
   end
 end

data/lib/inkcite/renderer/image_base.rb

@@ -12,7 +12,7 @@ module Inkcite
       # 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
+      def image_url _src, opt, ctx, assert_dimensions=true
 
         src = _src
 
@@ -71,7 +71,7 @@ module Inkcite
             # Replace the missing image with an imgix.net-powered placeholder using
             # the query parameters assembled above.
             # e.g. https://placeholdit.imgix.net/~text?txtsize=18&txt=left.jpg%0A%28155%C3%97155%29&w=155&h=155&fm=jpg&txttrack=0
-            src = "//placeholdit.imgix.net/~text?#{query.to_query}"
+            src = "http://placeholdit.imgix.net/~text?#{query.to_query}"
 
           end
 
@@ -79,7 +79,7 @@ module Inkcite
 
         # Don't let an image go into production without dimensions.  Using the original
         # src so that we don't display the verbose qualified URL to the developer.
-        ctx.error('Missing image dimensions', { :src => _src }) if missing_dimensions
+        ctx.error('Missing image dimensions', { :src => _src }) if missing_dimensions && assert_dimensions
 
         quote(src)
       end