inkcite 1.14.0 → 1.15.0

data/lib/inkcite/renderer/trademark.rb

@@ -0,0 +1,47 @@
+module Inkcite
+  module Renderer
+    class Trademark < Base
+
+      def initialize sym
+        @sym = sym
+      end
+
+      def render tag, opt, ctx
+
+        # Check to see if there is an ID associated with this symbol.
+        # If so, it only needs to appear once.
+        id = opt[:id]
+
+        if id.blank?
+          ctx.error('Missing id on trademark/registered symbol')
+          id = "tm#{ctx.unique_id(:trademark)}"
+        end
+
+        return '' unless ctx.once?("#{id}-trademark")
+
+        no_sup = opt[:'no-sup']
+
+        html = ''
+        html << '{sup}' unless no_sup
+        html << @sym
+
+        # If the trademark symbol should be followed immediately with a footnote
+        # render the {footnote} Helper with the once flag and the no-sup attribute
+        # to ensure unnecessary superscripts don't get rendered.
+        footnote = opt[:footnote]
+        unless footnote.blank?
+          html << %Q({footnote id="#{id}")
+
+          # Only include the footnote text if the attribute is not boolean
+          html << %Q( text="#{footnote}") if footnote != true
+          html << %q( once}) unless footnote.blank?
+        end
+
+        html << '{/sup}' unless no_sup
+
+        html
+      end
+
+    end
+  end
+end

data/lib/inkcite/renderer/video_preview.rb

@@ -242,9 +242,10 @@ module Inkcite
           frames.each do |f|
             this_frame_url = "url(#{f})"
 
-            animation.add_keyframe(percent, { BACKGROUND_IMAGE => this_frame_url })
+            keyframe = animation.add_keyframe(percent.round(0), { BACKGROUND_IMAGE => this_frame_url })
             percent += percent_per_frame
-            animation.add_keyframe(percent, { BACKGROUND_IMAGE => this_frame_url })
+            keyframe.end_percent = percent.round(0)
+
             percent += percent_per_transition
 
           end

data/lib/inkcite/uploader.rb

@@ -8,9 +8,8 @@ module Inkcite
 
       times = []
 
-      ['source.html', 'source.txt', 'helpers.tsv'].each do |file|
-        file = email.project_file(file)
-        times << File.mtime(file).to_i if File.exist?(file)
+      Dir.glob(File.join(email.path, '*.{html,tsv,txt,yml}')).each do |file|
+        times << File.mtime(file).to_i
       end
 
       local_images = email.image_dir

data/lib/inkcite/util.rb

@@ -38,6 +38,10 @@ module Inkcite
       opts.detect { |o| !o.blank? }
     end
 
+    def self.dir_size path
+      Dir.glob(File.join(path, '*.*')).inject(0) { |size, file| size + File.size(file) }
+    end
+
     # Centralizing the URL/CGI encoding for all HREF processing because
     # URI.escape/encode is obsolete.
     def self.encode *arg
@@ -52,6 +56,15 @@ module Inkcite
       end
     end
 
+    def self.exec command
+      command = command.join(' ') if command.is_a?(Array)
+      `#{command} 2>&1`
+    end
+
+    def self.file_extension path_to_file
+      File.extname(path_to_file).delete('.').downcase
+    end
+
     # Conversion of HSL to RGB color courtesy of
     # http://axonflux.com/handy-rgb-to-hsl-and-rgb-to-hsv-color-model-c
     def self.hsl_to_color h, s, l
@@ -102,6 +115,40 @@ module Inkcite
       p
     end
 
+    def self.log message, meta=nil
+
+      msg = "#{Time.now.strftime(DATE_FORMAT)} - INFO - #{message}"
+      unless meta.blank?
+        msg << '['
+        msg << Renderer.join_hash(meta, '=', ', ')
+        msg << ']'
+      end
+
+      puts msg
+    end
+
+    def self.pretty_file_size size
+
+      size = size.to_f
+      decimals = 2
+      ext = 'b'
+
+      if size > KB
+        size = size / KB
+        if size > KB
+          size = size / KB
+          ext = 'MB'
+        else
+          ext = 'Kb'
+        end
+      else
+        round = 0
+        "#{size}b"
+      end
+
+      "#{size.round(decimals)}#{ext}"
+    end
+
     # RGB to hex courtesy of
     # http://blog.lebrijo.com/converting-rgb-colors-to-hexadecimal-with-ruby/
     def self.rgb_to_hex val
@@ -166,6 +213,10 @@ module Inkcite
     BLACK = '#000000'
     WHITE = '#111111'
 
+    DATE_FORMAT = '%H:%M:%S'
+
+    KB = 1024
+
     # Recursive key symbolization for the provided Hash.
     def self.symbolize_keys hash
       unless hash.nil?

data/lib/inkcite/version.rb

@@ -1,3 +1,3 @@
 module Inkcite
-  VERSION = "1.14.0"
+  VERSION = "1.15.0"
 end

data/lib/inkcite/view.rb

@@ -23,9 +23,6 @@ module Inkcite
     # Manages the Responsive::Rules applied to this email view.
     attr_reader :media_query
 
-    # Line number of the email file being processed
-    attr_accessor :line_number
-
     # The configuration hash for the view
     attr_accessor :config
 
@@ -37,6 +34,14 @@ module Inkcite
     # after a rendering is complete.
     attr_accessor :js_compressor
 
+    # Array of post-processors that can modify the HTML of the email
+    # after it is rendered but before it is saved.
+    attr_accessor :post_processors
+
+    # The most recently processed tag populated from the renderer and
+    # used when reporting errors.
+    attr_accessor :last_rendered_markup
+
     def initialize email, environment, format, version
       @email = email
       @environment = environment
@@ -77,10 +82,6 @@ module Inkcite
       # version in the list of those defined.
       @config[:'version-index'] = (email.versions.index(version) + 1).to_s
 
-      # Tracks the line number and is recorded when errors are encountered
-      # while rendering said line.
-      @line_number = 0
-
       # True if VML is used during the preparation of this email.
       @vml_used = false
 
@@ -88,6 +89,9 @@ module Inkcite
       @footnotes = nil
       @substitutions = nil
 
+      # Will hold any post processors installed during rendering.
+      @post_processors = []
+
     end
 
     def [] key
@@ -149,9 +153,10 @@ module Inkcite
     end
 
     # Records an error message on the currently processing line of the source.
-    def error message, obj=nil
+    def error message, obj={}
+
+      obj[:markup] = %Q({#{self.last_rendered_markup}})
 
-      message << " (line #{self.line_number.to_i})"
       unless obj.blank?
         message << ' ['
         message << obj.collect { |k, v| "#{k}=#{v}" }.join(', ')
@@ -206,12 +211,12 @@ module Inkcite
         # Default naming based on the number of versions - only the format if there is
         # a single version or version and format when there are multiple versions.
         fn = if email.versions.length > 1
-               '{version}-{format}'
-             elsif text?
-               'email'
-             else
-               '{format}'
-             end
+          '{version}-{format}'
+        elsif text?
+          'email'
+        else
+          '{format}'
+        end
 
       end
 
@@ -221,12 +226,27 @@ module Inkcite
 
       # Sanity check to ensure there is an appropriate extension on the
       # file name.
-      ext ||= (text?? TXT_EXTENSION : HTML_EXTENSION)
+      ext ||= (text? ? TXT_EXTENSION : HTML_EXTENSION)
       fn << ext unless File.extname(fn) == ext
 
       fn
     end
 
+    # Defines a new helper, which allows designers to keep helper
+    # markup alongside the usage of it inside of partial.  Helps keep
+    # code clean and prevents helper.tsv pollution for one-offs
+    def helper tag, open, close=nil
+
+      tag = tag.to_sym
+
+      # Warn the user if the helper is already defined.
+      view.error("Helper '#{tag}' already defined", :open => open, :close => close) unless @config[tag].nil?
+
+      @config[tag] = open.to_s
+      @config[:"/#{tag}"] = close.to_s
+
+    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
@@ -250,7 +270,7 @@ module Inkcite
         # 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) + '/'
+          (@email.optimize_images? ? Image::ImageMinifier::IMAGE_CACHE : Email::IMAGES) + '/'
         else
 
           # Use the image host defined in config.yml or, out-of-the-box refer to images/
@@ -327,7 +347,23 @@ module Inkcite
 
     def meta key
       md = meta_data
-      md.nil?? nil : md[key]
+      md.nil? ? nil : md[key]
+    end
+
+    # Returns true if the specified key has been queried once and
+    # only once.  Any additional queries will return false
+    def once? key
+
+      # Initialize the 'once' data hash which maps
+      data[:once] ||= {}
+
+      key = key.to_sym
+
+      # True if this is the first time we've encountered this key.
+      first_time = data[:once][key].nil?
+      data[:once][key] = true if first_time
+
+      first_time
     end
 
     # Returns the opts for the parent matching the designated
@@ -339,7 +375,7 @@ module Inkcite
     # Returns the array of browser prefixes that need to be included in
     # CSS styles based on which version of the email this is.
     def prefixes
-      _prefixes = [ '' ]
+      _prefixes = ['']
 
       # In development mode, include all prefixes for maximum compatibility.
       _prefixes += %w(-moz- -ms- -o-) if development?
@@ -365,7 +401,7 @@ module Inkcite
 
       # Will be used to assemble the parameters passed to File.open.
       # First, always open the file in read mode.
-      mode = [ 'r' ]
+      mode = ['r']
 
       # Detect abnormal file encoding and construct the string to
       # convert such encoding to UTF-8 if specified.
@@ -398,7 +434,7 @@ module Inkcite
       raise "Already rendered" unless @content.blank?
 
       source_file = 'source'
-      source_file << (text?? TXT_EXTENSION : HTML_EXTENSION)
+      source_file << (text? ? TXT_EXTENSION : HTML_EXTENSION)
 
       # Read the original source which may include embedded Ruby.
       filtered = read_source(@email.project_file(source_file))
@@ -451,21 +487,12 @@ module Inkcite
         html += external_styles
 
         html << inline_styles
-        html << '</head>'
 
-        # 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 << '<body style="width: 100% !important; min-width: 100% !important; margin: 0 !important; padding: 0; -webkit-text-size-adjust: none; -ms-text-size-adjust: none;'
+        html << outlook_styles
 
-        # A pleasing but obvious background exposed in development mode to alert
-        # the designer that they have exposed the body background - which means
-        # unpredictable results if sent.
-        if development?
-          html << " background: #ccc url('data:image/png;base64,#{Inkcite.blueprint_image64}');"
-        end
+        html << '</head>'
 
-        html << %q(">)
+        html << body_declaration
 
         html << minified
 
@@ -483,6 +510,10 @@ module Inkcite
 
       end
 
+      # Provide each post processor (if any were installed during the rendering
+      # process) with a chance to operate on the final HTML.
+      @content = PostProcessor.run_all(@content, self)
+
       # Ensure that all failsafes pass
       assert_failsafes
 
@@ -619,17 +650,17 @@ module Inkcite
 
     private
 
-    ASSETS          = 'assets'
-    FILE_SCHEME     = 'file'
-    FILE_NAME       = :'file-name'
-    HTML_EXTENSION  = '.html'
+    ASSETS = 'assets'
+    FILE_SCHEME = 'file'
+    FILE_NAME = :'file-name'
+    HTML_EXTENSION = '.html'
     LINKS_EXTENSION = '-links.csv'
-    NEW_LINE        = "\n"
-    REGEX_SLASH     = '/'
+    NEW_LINE = "\n"
+    REGEX_SLASH = '/'
     SOURCE_ENCODING = :'source-encoding'
-    TAB             = "\t"
-    TXT_EXTENSION   = '.txt'
-    UTF_8           = 'utf-8'
+    TAB = "\t"
+    TXT_EXTENSION = '.txt'
+    UTF_8 = 'utf-8'
 
     # Empty hash used when there is no environment or format-specific configuration
     EMPTY_HASH = {}
@@ -696,6 +727,31 @@ module Inkcite
       passes
     end
 
+    def body_declaration
+
+      # 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.
+      body = '<body'
+
+      # The body class is used to fix the width problem in new Gmail iOS.
+      # https://litmus.com/community/discussions/5913-new-gmail-app-not-respect-full-width
+      body << ' class="body"' if email?
+
+      body << ' style="margin: 0; padding: 0; -webkit-text-size-adjust: none; -ms-text-size-adjust: none;'
+
+      # A pleasing but obvious background exposed in development mode to alert
+      # the designer that they have exposed the body background - which means
+      # unpredictable results if sent.
+      if development?
+        body << %Q( background: #ccc url('data:image/png;base64,#{Inkcite.blueprint_image64}');)
+      end
+
+      body << '">'
+
+      body
+    end
+
     # Returns true if the content in this email either matches the
     # regular expression provided or if it includes the exact string
     # that is provided.
@@ -865,12 +921,6 @@ module Inkcite
       # Reset the font on every cell to the default family.
       reset << "td { font-family: #{self[Renderer::Base::FONT_FAMILY]}; }"
 
-      # VML-specific CSS needed only if VML was used in the email.
-      if vml_used?
-        reset << 'v\:* { behavior: url(#default#VML); display: inline-block; }'
-        reset << 'o\:* { behavior: url(#default#VML); display: inline-block; }'
-      end
-
       reset.join(NEW_LINE)
     end
 
@@ -907,7 +957,7 @@ module Inkcite
 
       # Join all of the style blocks into a single block if this
       # is not an email - otherwise, keep them separate.
-      style_blocks = [ style_blocks.join(NEW_LINE) ] unless email?
+      style_blocks = [style_blocks.join(NEW_LINE)] unless email?
 
       html = []
 
@@ -921,6 +971,24 @@ module Inkcite
       html.join(NEW_LINE)
     end
 
+    def outlook_styles
+
+      html = []
+
+      # VML-specific CSS needed only if VML was used in the email.
+      if vml_used?
+        html << '<style>'
+
+        %w(v o).each do |l|
+          html << Inkcite::Renderer::Style.new("#{l}\:*", self, { :behavior => 'url(#default#VML)', :display => 'inline-block' }).to_s
+        end
+
+        html << '</style>'
+      end
+
+      html.join(NEW_LINE)
+    end
+
     def load_helper_file file, into, abort_on_fail=true
 
       unless File.exist?(file)
@@ -973,7 +1041,7 @@ module Inkcite
     def load_helpers
 
       _helpers = {
-        :n => NEW_LINE
+          :n => NEW_LINE
       }
 
       # Get the project path from which most helpers will be loaded.
@@ -995,9 +1063,30 @@ module Inkcite
       # on its version - e.g. difference colors in the "no orders for 30 days" email.
       load_helper_file File.join(path, "helpers-#{@version}.tsv"), _helpers, false
 
+      project_path = File.basename(@email.path)
+
+      # If the project directory name is all numbers and is either six or eight
+      # characters in length, assume it is a date - e.g. 201706 or 20170513.
+      # Automatically extract the year, month and day (optional).
+      if project_path.to_i.to_s == project_path
+        path_length = project_path.length
+        if path_length >= 4 && path_length <= 8
+
+          # These substrings need to remain strings so that properties can be
+          # cloned when a view is instanted.
+          _helpers[:yyyy] = project_path[0..3]
+          _helpers[:mm] = project_path[4..5] if path_length >= 6
+          _helpers[:dd] = project_path[6..7] if path_length == 8
+
+        end
+      end
+
       # As a convenience pre-populate the month name of the email.
       mm = _helpers[:mm].to_i
-      _helpers[:month] = Date::MONTHNAMES[mm] if mm > 0
+      if mm > 0
+        _helpers[:month] = Date::MONTHNAMES[mm]
+        _helpers[:MONTH] = _helpers[:month].upcase
+      end
 
       _helpers
     end
@@ -1036,9 +1125,6 @@ module Inkcite
 
       filtered.split("\n").each do |line|
 
-        # Increment the line number as we read the file.
-        @line_number += 1
-
         begin
           line = Renderer.render(line, self)
         rescue Exception => e