inkcite 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f77f5972f324c7fd1d94e0e62ad167331636c78
-  data.tar.gz: 86ce04170afb3b33b76aae7b484eac7247de870d
+  metadata.gz: 4288c340956699599f226510e4d407f05f9800b9
+  data.tar.gz: ec0def8a09ffa81f5e6acaa620d058f3b7c94d85
 SHA512:
-  metadata.gz: 78f601288da10bd3db71580b7439c70582a0ec1b9bed2458b9bb79e1e4f6266c8c60cb2c55756fb36809e0ffb003791c150b0a9a010fd375bd4ac9bebd1a5d19
-  data.tar.gz: 7e817e4e9e5d38df8950ecc8d390bbfe9f3540703b95149e700b90327ce002fcbbe1a492b94baccff4c9faed55a1efe2b8f8ad5e95f044d8d299f1c0cb880fef
+  metadata.gz: 7b20720b8716b6ed506383d4e8df220202e00afaf8cc1f48e02d5975952f4c42375cda55b1d4fcd8832d730248f9defd6aca904f47fbdeb17389a228c15cd308
+  data.tar.gz: f11d762ebaab6d41e45b6affe121ce9165701a695329fa3220cc817e36c6a40298ad5c6d36114ea11f84684de6bce33e10d2d91c244bde304982f01742994439

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/inkcite.gemspec

@@ -31,13 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'guard'
   spec.add_dependency 'guard-livereload'
   spec.add_dependency 'htmlbeautifier'
-  spec.add_dependency 'image_optim'
-  spec.add_dependency 'image_optim_pack'
   spec.add_dependency 'listen'
   spec.add_dependency 'litmus'
   spec.add_dependency 'mail'
   spec.add_dependency 'mailgun-ruby'
-  spec.add_dependency 'mozjpeg'
   spec.add_dependency 'net-sftp'
   spec.add_dependency 'rack'
   spec.add_dependency 'rack-livereload'

data/lib/inkcite.rb

@@ -8,7 +8,6 @@ silence_warnings do
   require 'csv'
   require 'erubis'
   require 'i18n'
-  require 'image_optim'
   require 'set'
   require 'uri'
   require 'yaml'

data/lib/inkcite/cli/base.rb

@@ -41,28 +41,29 @@ module Inkcite
         Cli::Init.invoke(name, options)
       end
 
-      desc 'minify', 'Minify the images in the project'
+      desc 'imageoptim', 'Minify the images in the project using ImageOptim'
       option :force,
           :aliases => '-f',
-          :desc => 'Force re-optimize every image, not just the updated ones',
+          :desc => 'Force re-optimize every image, not just ones that were updated since the last minification',
           :type => :boolean
       option :image,
           :aliases => '-i',
           :desc => 'Optimize a specific image',
           :type => :string
-      def minify
+      def imageoptim
 
         if options[:image]
-          Image::ImageMinifier.minify(email, options[:image], true)
+          ImageMinifier.minify(email, options[:image], true)
 
         else
-          Image::ImageMinifier.minify_all(email, options[:force])
+          ImageMinifier.minify_all(email, options[:force])
 
           original_size = Util.dir_size(email.image_dir)
           compressed_size = Util.dir_size(email.optimized_image_dir)
-          compressed_percent = Image::ImageMinifier.compressed_percent(original_size, compressed_size)
+          compressed_percent = ImageMinifier.compressed_percent(original_size, compressed_size)
+          image_count = Dir.glob(File.join(email.optimized_image_dir, '*.*')).count
 
-          puts "Compressed from #{Util.pretty_file_size(original_size)} to #{Util.pretty_file_size(compressed_size)} (#{compressed_percent}%)"
+          puts "Compressed #{image_count} images from #{Util.pretty_file_size(original_size)} to #{Util.pretty_file_size(compressed_size)} (#{compressed_percent}%)"
         end
 
       end
@@ -145,8 +146,11 @@ module Inkcite
           :aliases => '-f',
           :desc => "Forces files to be uploaded regardless of whether or not they've changed",
           :type => :boolean
+      option :'images',
+          :aliases => '-i',
+          :desc => 'Uploads images only (not the email HTML)'
       def upload
-        options[:force] ? email.upload! : email.upload
+        email.upload options
       end
 
       private

data/lib/inkcite/cli/preview.rb

@@ -27,16 +27,6 @@ module Inkcite
           else
             preview_opt[:tag] = "#{list.to_s.titleize} Test"
             preview_opt[:bcc] = true
-            # abort <<-USAGE.strip_heredoc
-            #
-            #   Oops!  Inkcite doesn't recognize that distribution list.  It needs
-            #   to be one of 'client', 'internal' or 'developer':
-            #
-            #     inkcite preview internal
-            #
-            # USAGE
-            #
-            # return
         end
 
         Mailer.send_to_list email, list, opt.merge(preview_opt)

data/lib/inkcite/cli/server.rb

@@ -5,6 +5,8 @@ require 'rack'
 require 'rack-livereload'
 require 'webrick'
 
+require 'inkcite/view/developer_scripts'
+
 module Inkcite
   module Cli
     class Server
@@ -108,7 +110,7 @@ module Inkcite
           # Minify the image if the source version in images/ is newer
           # or if the configuration file controlling optimization has
           # been updated since the last time the image was requested.
-          Image::ImageMinifier.minify(@email, File.basename(path), false) if can_serve(path)
+          ImageMinifier.minify(@email, File.basename(path), false) if can_serve(path)
 
           # Let the super method handle the actual serving of the image.
           res = super
@@ -158,6 +160,12 @@ module Inkcite
 
             view = @email.view(environment, format, version)
 
+            # Check to see if images have been disabled in this rendering.
+            view.images_off = true if params.key?('images-off')
+
+            # Install the developer toolkit into the view.
+            Inkcite::View::DeveloperScripts.install!(view)
+
             html = view.render!
 
             # If minification is disabled, then beautify the output to make it easier

data/lib/inkcite/email.rb

@@ -61,12 +61,12 @@ module Inkcite
     # Optimizes this email's images if optimize-images is enabled
     # in the email configuration.
     def optimize_images
-      Image::ImageMinifier.minify_all(self, false) if optimize_images?
+      ImageMinifier.minify_all(self, false) if optimize_images?
     end
 
     # Optimizes all of the images in this email.
     def optimize_images!
-      Image::ImageMinifier.minify_all(self, true)
+      ImageMinifier.minify_all(self, true)
     end
 
     def optimize_images?
@@ -76,7 +76,7 @@ module Inkcite
     # Returns the directory that optimized, compressed images
     # have been saved to.
     def optimized_image_dir
-      File.join(path, optimize_images?? Image::ImageMinifier::IMAGE_CACHE : IMAGES)
+      File.join(path, optimize_images?? ImageMinifier::IMAGE_CACHE : IMAGES)
     end
 
     def project_file file
@@ -90,14 +90,9 @@ module Inkcite
       value
     end
 
-    def upload
+    def upload opts={}
       require_relative 'uploader'
-      Uploader.upload(self)
-    end
-
-    def upload!
-      require_relative 'uploader'
-      Uploader.upload!(self)
+      Uploader.upload(self, opts)
     end
 
     def versions

data/lib/inkcite/facade/animation.rb

@@ -105,7 +105,10 @@ module Inkcite
           @timing_function
       ]
 
-      css << seconds(@delay) if @delay > 0
+      # Negative delays start the animation mid-sequence whereas positive
+      # values cause the animation to delay start.
+      # https://css-tricks.com/starting-css-animations-mid-way/
+      css << seconds(@delay) if @delay != 0
 
       css << @iteration_count
 

data/lib/inkcite/image_minifier.rb

@@ -0,0 +1,96 @@
+module Inkcite
+  class ImageMinifier
+
+    # Directory of optimized images
+    IMAGE_CACHE = 'images-optim'
+
+    # Path to ImageOption app on OS X
+    IMAGE_OPTIM_PATH = "/Applications/ImageOptim.app/Contents/MacOS/ImageOptim"
+
+    # Extension to put on files tha have been optimized already in the images/
+    # source folder
+    OPTIMIZED_EXTENSION = '.optimized'
+
+    def self.minify email, img_name, force=false
+
+      # Original, unoptimized source image
+      source_img = File.join(email.image_dir, img_name)
+
+      # Cached, optimized path for this image.
+      cache_path = email.project_file(IMAGE_CACHE)
+      cached_img = File.join(cache_path, File.basename(img_name))
+
+      unless force
+
+        # Get the last-modified date of the actual image.  If the source
+        # image is newer than the cached version, we'll need to run it
+        # through optimization again, too.
+        cache_last_modified = Util.last_modified(cached_img)
+        source_last_modified = Util.last_modified(source_img)
+
+        # Nothing to do unless the image in the cache is older than the
+        # source or the config file.
+        return unless source_last_modified > cache_last_modified
+
+      end
+
+      # Make sure the image cache directory exists
+      FileUtils.mkpath(cache_path)
+
+      # Copy the original image to the cache where it can be processed.
+      FileUtils.copy(source_img, cached_img)
+
+      # Can only optimize the image if ImageOptim app is installed.
+      # @TODO Need to do the right thing on Windows.
+      if File.file?(IMAGE_OPTIM_PATH)
+
+        original_size = File.size(source_img)
+
+        # Check to see if there is a .optimized marker file indicating that a file
+        # shouldn't be further optimized.
+        if File.exists?("#{source_img}#{OPTIMIZED_EXTENSION}")
+          msg = "Copying #{img_name} #{Util.pretty_file_size(original_size)}"
+
+          compressed_size = original_size
+
+        else
+          msg = "Compressing #{img_name} #{Util.pretty_file_size(original_size)}"
+
+          Util.exec("#{IMAGE_OPTIM_PATH} #{cached_img}")
+
+          compressed_size = File.size(cached_img)
+          msg << " → #{Util.pretty_file_size(compressed_size)}"
+
+        end
+
+        # Get the final compressed size of the image so we can print the
+        # resulting compression ratio.
+        msg << " (#{self.compressed_percent(original_size, compressed_size)}%)"
+
+        Util.log msg
+      end
+
+
+    end
+
+    # Minifies all of the images in the provided email's project directory.
+    def self.minify_all email, force=false
+
+      images_path = File.join(email.image_dir, '*.*')
+
+      # Iterate through all of the images in the project and optimize them
+      # if necessary.
+      Dir.glob(images_path).each do |img|
+        next if img.to_s.end_with?(OPTIMIZED_EXTENSION)
+        self.minify(email, File.basename(img), force)
+      end
+
+    end
+
+    def self.compressed_percent original_size, compressed_size
+      ((1.0 - (compressed_size / original_size.to_f)) * 100).round(1)
+    end
+
+  end
+end
+

data/lib/inkcite/mailer.rb

@@ -196,10 +196,10 @@ module Inkcite
               clients = recipient_yml[:clients] || recipient_yml[:client]
               recipients[:to] = first_preview || clients
               recipients[:cc] = recipient_yml[:internal]
-            when :internal
-              recipients[:to] = recipient_yml[:internal]
             when :developer
               recipients[:to] = from
+            else # internal or any custom list
+              recipients[:to] = recipient_yml[list]
           end
 
         end

data/lib/inkcite/minifier.rb

@@ -1,4 +1,4 @@
-require_relative 'image/image_minifier'
+require_relative 'image_minifier'
 
 module Inkcite
   class Minifier

data/lib/inkcite/renderer.rb

@@ -17,6 +17,7 @@ require_relative 'renderer/in_browser'
 require_relative 'renderer/increment'
 require_relative 'renderer/like'
 require_relative 'renderer/link'
+require_relative 'renderer/list'
 require_relative 'renderer/litmus_analytics'
 require_relative 'renderer/lorem'
 require_relative 'renderer/mobile_image'
@@ -27,6 +28,7 @@ require_relative 'renderer/partial'
 require_relative 'renderer/preheader'
 require_relative 'renderer/property'
 require_relative 'renderer/redacted'
+require_relative 'renderer/slant'
 require_relative 'renderer/snow'
 require_relative 'renderer/social'
 require_relative 'renderer/span'
@@ -71,6 +73,10 @@ module Inkcite
       # Remove unicode line break characters
       value.gsub!(/\u2028/, '')
 
+      # Nuclear option to remove invisible unicode characters injected
+      # when pasting text from MS Word or Google Docs.
+      value.gsub!(/[^\P{C}\n]+/u, '')
+
       value
     end
 
@@ -194,6 +200,7 @@ module Inkcite
           :'in-browser'       => InBrowser.new,
           :include            => Partial.new,
           :instagram          => Social::Instagram.new,
+          :li                 => List.new,
           :like               => Like.new,
           :litmus             => LitmusAnalytics.new,
           :lorem              => Lorem.new,
@@ -201,10 +208,12 @@ module Inkcite
           :'mobile-only'      => MobileOnly.new,
           :'mobile-style'     => MobileStyle.new,
           :'mobile-toggle-on' => MobileToggleOn.new,
+          :ol                 => List.new,
           :pintrest           => Social::Pintrest.new,
           :preheader          => Preheader.new,
           :r                  => Trademark.new('®'),
           :redacted           => Redacted.new,
+          :slant              => Slant.new,
           :snow               => Snow.new,
           :span               => Span.new,
           :sparkle            => Sparkle.new,
@@ -215,6 +224,7 @@ module Inkcite
           :'topic'            => Topic.new,
           :'topic-list'       => TopicList.new,
           :twitter            => Social::Twitter.new,
+          :ul                 => List.new,
           :'video-preview'    => VideoPreview.new
       }
 

data/lib/inkcite/renderer/base.rb

@@ -5,6 +5,8 @@ module Inkcite
       # Constants for style and property names with dashes in them.
       BACKGROUND_COLOR = :'background-color'
       BACKGROUND_GRADIENT = :'background-gradient'
+      BACKGROUND_GRADIENT_POSITION = :'background-gradient-position'
+      BACKGROUND_GRADIENT_SHAPE = :'background-gradient-shape'
       BACKGROUND_IMAGE = :'background-image'
       BACKGROUND_REPEAT = :'background-repeat'
       BACKGROUND_POSITION = :'background-position'
@@ -16,7 +18,9 @@ module Inkcite
       BORDER_RADIUS = :'border-radius'
       BORDER_RIGHT = :'border-right'
       BORDER_SPACING = :'border-spacing'
+      BORDER_STYLE = :'border-style'
       BORDER_TOP = :'border-top'
+      BORDER_WIDTH = :'border-width'
       BOX_SHADOW = :'box-shadow'
       FONT_FAMILY = :'font-family'
       FONT_SIZE = :'font-size'
@@ -31,10 +35,13 @@ module Inkcite
       MARGIN_TOP = :'margin-top'
       MAX_HEIGHT = :'max-height'
       MAX_WIDTH = :'max-width'
+      MSO_HIDE = :'mso-hide'
+      MSO_PADDING_ALT = :'mso-padding-alt'
       PADDING_X = :'padding-x'
       PADDING_Y = :'padding-y'
       TEXT_ALIGN = :'text-align'
       TEXT_DECORATION = :'text-decoration'
+      TEXT_JUSTIFY = :'text-justify'
       TEXT_SHADOW = :'text-shadow'
       TEXT_SHADOW_BLUR = :'shadow-blur'
       TEXT_SHADOW_OFFSET = :'shadow-offset'
@@ -62,6 +69,14 @@ module Inkcite
       # Zero-width non-breaking character
       ZERO_WIDTH_NON_BREAKING_SPACE = ''
 
+      # Constant for justified text alignment.
+      JUSTIFY = 'justify'
+
+      # For gradients
+      LINEAR = 'linear'
+      CIRCLE = 'circle'
+      RADIAL = 'radial'
+
       def render tag, opt, ctx
         raise "Not implemented: #{tag} #{opts}"
       end
@@ -151,7 +166,26 @@ module Inkcite
           center_color = bgcolor ? bgcolor : bggradient
           outer_color = bgcolor ? bggradient : Util.darken(bggradient)
 
-          bggradient = %Q(radial-gradient(circle at center, #{center_color}, #{outer_color}))
+          # The default position of the gradient when not specified
+          # by the designer.
+          default_position = 'center'
+
+          shape = opt[BACKGROUND_GRADIENT_SHAPE] || LINEAR
+          if shape == LINEAR
+            type = LINEAR
+            shape = 'to '
+
+            # Linear gradients default to the bottom.
+            default_position = 'bottom'
+
+          else
+            type = RADIAL
+            shape = "#{shape} at "
+          end
+
+          position = detect(opt[BACKGROUND_GRADIENT_POSITION], default_position)
+
+          bggradient = %Q(#{type}-gradient(#{shape}#{position}, #{center_color}, #{outer_color}))
         end
 
         element.style[BACKGROUND_IMAGE] = bggradient
@@ -238,7 +272,18 @@ module Inkcite
       def mix_text_align element, opt, ctx
 
         align = detect(opt[:align] || opt[TEXT_ALIGN])
-        element.style[TEXT_ALIGN] = align unless none?(align)
+        return if none?(align)
+
+        element.style[TEXT_ALIGN] = align
+
+        mix_text_justify(element, opt, ctx) if align == JUSTIFY
+
+      end
+
+      def mix_text_justify element, opt, ctx
+
+        text_justify = opt[TEXT_JUSTIFY]
+        element.style[TEXT_JUSTIFY] = text_justify unless none?(text_justify)
 
       end