inkcite 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5968f3e718b373eb3740d89dd019165130776a2
-  data.tar.gz: e961a846c6e2d0664a66a1ae5abc9ed791db34dd
+  metadata.gz: 6f77f5972f324c7fd1d94e0e62ad167331636c78
+  data.tar.gz: 86ce04170afb3b33b76aae7b484eac7247de870d
 SHA512:
-  metadata.gz: 068fe33972b2d0f91a9c8be212ac3781392860d518aaf5277104cb3af1e1491766e2f3a5da47bed778bea41273bbd1fba3335c8f0d026845e16d29da85e06311
-  data.tar.gz: 4f39b31b971373bb1beb2ab1c6689a53bdd73a0e75d3def5bc2eeaae61e83449e7a43581bce9375d2434c2c7e6178a4b912b098459a304080acb11be46664595
+  metadata.gz: 78f601288da10bd3db71580b7439c70582a0ec1b9bed2458b9bb79e1e4f6266c8c60cb2c55756fb36809e0ffb003791c150b0a9a010fd375bd4ac9bebd1a5d19
+  data.tar.gz: 7e817e4e9e5d38df8950ecc8d390bbfe9f3540703b95149e700b90327ce002fcbbe1a492b94baccff4c9faed55a1efe2b8f8ad5e95f044d8d299f1c0cb880fef

data/assets/init/config.yml

@@ -17,6 +17,8 @@ minify: true
 # https://inkcite.readme.io/v1.0/docs/image-optimization
 optimize-images: true
 
+jpg-quality: 90
+
 # When empty links are found in content, this is the URL that will be
 # included instead - so that clients understand this link is missing
 # and needs to be provided.

data/inkcite.gemspec

@@ -27,17 +27,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'builder'
   spec.add_dependency 'chunky_png'
   spec.add_dependency 'erubis'
-  spec.add_dependency 'faker'
+  spec.add_dependency 'faker', '1.7.2'
   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 'kraken-io'
   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

@@ -29,6 +29,7 @@ require 'inkcite/util'
 require 'inkcite/view'
 require 'inkcite/minifier'
 require 'inkcite/parser'
+require 'inkcite/post_processor'
 require 'inkcite/renderer'
 
 module Inkcite

data/lib/inkcite/cli/base.rb

@@ -41,20 +41,46 @@ module Inkcite
         Cli::Init.invoke(name, options)
       end
 
+      desc 'minify', 'Minify the images in the project'
+      option :force,
+          :aliases => '-f',
+          :desc => 'Force re-optimize every image, not just the updated ones',
+          :type => :boolean
+      option :image,
+          :aliases => '-i',
+          :desc => 'Optimize a specific image',
+          :type => :string
+      def minify
+
+        if options[:image]
+          Image::ImageMinifier.minify(email, options[:image], true)
+
+        else
+          Image::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)
+
+          puts "Compressed from #{Util.pretty_file_size(original_size)} to #{Util.pretty_file_size(compressed_size)} (#{compressed_percent}%)"
+        end
+
+      end
+
       desc 'preview TO [options]', 'Send a preview of the email to a recipient list: developer, internal or client'
       option :version,
           :aliases => '-v',
           :desc => 'Preview a specific version of the email'
-      option :also,
-          :aliases => '-a',
-          :desc => 'Add one or more (space-separated) recipients to this specific mailing',
-          :type => :array
+      option :count,
+          :aliases => '-c',
+          :desc => 'Override the automatic preview numbering',
+          :type => :numeric
       option :'no-upload',
           :desc => 'Skip the asset upload, email the preview immediately',
           :type => :boolean
-      def preview to=:developer
+      def preview list=:developer
         require_relative 'preview'
-        Cli::Preview.invoke(email, to, options)
+        Cli::Preview.invoke(email, list, options)
       end
 
       desc 'scope [options]', 'Share this email using Litmus Scope (https://litmus.com/scope/)'

data/lib/inkcite/cli/preview.rb

@@ -4,47 +4,43 @@ module Inkcite
   module Cli
     class Preview
 
-      def self.invoke email, to, opt
+      def self.invoke email, list, opt
 
         # Push the browser preview(s) up to the server to ensure that the
         # latest images and "view in browser" versions are available.
         email.upload unless opt[:'no-upload']
 
-        also = opt[:also]
-        unless also.blank?
+        # Ensure we're dealing with a symbol rather than string.
+        list = list.to_sym
 
-          # Sometimes people use commas to separate the --also addresses so
-          # explode those into an array for convenience. Email is already
-          # hard enough.
-          if also.any? { |a| a.match(',') }
-            also = also.collect { |a| a.split(',') }.flatten
+        preview_opt = {}
 
-            # Since opt is frozen by Thor we need to make a copy of it in order
-            # to inject the new array of recipients back into it.
-            opt = opt.dup
-            opt[:also] = also
-
-          end
-        end
-
-        case to.to_sym
+        case list
           when :client
-            Inkcite::Mailer.client(email, opt)
+            preview_opt[:tag] = 'Preview'
+            preview_opt[:bcc] = true
           when :internal
-            Inkcite::Mailer.internal(email, opt)
+            preview_opt[:tag] = 'Internal Preview'
+            preview_opt[:bcc] = true
           when :developer
-            Inkcite::Mailer.developer(email, opt)
+            preview_opt[:tag] = 'Developer Test'
           else
-            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
+            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)
+
       end
 
     end

data/lib/inkcite/cli/server.rb

@@ -11,10 +11,8 @@ module Inkcite
 
       def self.start email, opts
 
-        puts
-        puts "Inkcite #{Inkcite::VERSION} is starting up ..."
-        puts 'Documentation available at http://inkcite.readme.io'
-        puts
+        Util.log "Inkcite #{Inkcite::VERSION} is starting up ..."
+        Util.log 'Documentation available at http://inkcite.readme.io'
 
         # Read the hostname and port from the opts provided on the command
         # line - or inherit the default of localhost:4567
@@ -58,10 +56,11 @@ module Inkcite
           run InkciteApp.new(email, opts)
         end
 
-        puts "Your email is being served at http://#{host}:#{port}"
-        puts "Point your mobile device to http://#{ip}:#{port}" if ip
-        puts 'Press CTRL-C to exit server mode'
-        puts ''
+        Util.log ''
+        Util.log "Your email is being served at http://#{host}:#{port}"
+        Util.log "Point your mobile device to http://#{ip}:#{port}" if ip
+        Util.log 'Press CTRL-C to exit server mode'
+        Util.log ''
 
         begin
 
@@ -109,11 +108,15 @@ 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.
-          Minifier.image(@email, File.basename(path), false) if can_serve(path)
+          Image::ImageMinifier.minify(@email, File.basename(path), false) if can_serve(path)
 
           # Let the super method handle the actual serving of the image.
-          super
+          res = super
+
+          # Install cache control into the response.  Tried using
+          res[1][Rack::CACHE_CONTROL] = NO_CACHE
 
+          res
         end
 
       end
@@ -136,6 +139,11 @@ module Inkcite
           response = Rack::Response.new
           response[Rack::CONTENT_TYPE] = 'text/html'
 
+          # Speedup for local development ensuring that a substantial number of reloads
+          # (generated when developing multi-version emails simultaneously) can cause
+          # the browser to slow down.
+          response[Rack::CACHE_CONTROL] = NO_CACHE
+
           begin
 
             # Allow the designer to specify both short- and long-form versions of
@@ -146,12 +154,7 @@ module Inkcite
             format = Util.detect(params['f'], params['format'], @opts[:format])
             version = Util.detect(params['v'], params['version'], @opts[:version])
 
-            # Timestamp all of the messages from this rendering so it is clear which
-            # messages are associated with this reload.
-            ts = "[#{Time.now.strftime(DATEFORMAT)}]"
-
-            puts ''
-            puts "#{ts} Rendering your email [environment=#{environment}, format=#{format}, version=#{version || 'default'}]"
+            Util.log "Rendering your email", :environment => environment, :format => format, :version => version || 'default'
 
             view = @email.view(environment, format, version)
 
@@ -163,8 +166,8 @@ module Inkcite
 
             unless view.errors.blank?
               error_count = view.errors.count
-              puts "#{ts} #{error_count} error#{'s' if error_count > 1} or warning#{'s' if error_count > 1}:"
-              puts "#{ts} - #{view.errors.join("\n#{ts} - ")}"
+              Util.log "#{error_count} error#{'s' if error_count > 1} or warning#{'s' if error_count > 1}:"
+              view.errors.each { |e| Util.log(e) }
             end
 
             response.write html
@@ -186,7 +189,7 @@ module Inkcite
 
       REQUEST_ROOT = '/'
 
-      DATEFORMAT = '%Y-%m-%d %H:%M:%S'
+      NO_CACHE = 'no-cache, no-store'
 
     end
   end

data/lib/inkcite/cli/test.rb

@@ -33,7 +33,7 @@ module Inkcite
         # that the latest images are available.
         email.upload unless opts[:'no-upload']
 
-        Inkcite::Mailer.send(email, opts.merge({ :to => send_to }))
+        Inkcite::Mailer.send_test(email, send_to, opts)
 
         true
       end

data/lib/inkcite/email.rb

@@ -24,7 +24,11 @@ module Inkcite
     end
 
     def config
-      Util.read_yml(File.join(path, 'config.yml'), :fail_if_not_exists => true)
+      Util.read_yml(config_file, :fail_if_not_exists => true)
+    end
+
+    def config_file
+      File.join(path, 'config.yml')
     end
 
     def formats env=nil
@@ -57,12 +61,12 @@ module Inkcite
     # Optimizes this email's images if optimize-images is enabled
     # in the email configuration.
     def optimize_images
-      Minifier.images(self, false) if optimize_images?
+      Image::ImageMinifier.minify_all(self, false) if optimize_images?
     end
 
     # Optimizes all of the images in this email.
     def optimize_images!
-      Minifier.images(self, true)
+      Image::ImageMinifier.minify_all(self, true)
     end
 
     def optimize_images?
@@ -72,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?? Minifier::IMAGE_CACHE : IMAGES)
+      File.join(path, optimize_images?? Image::ImageMinifier::IMAGE_CACHE : IMAGES)
     end
 
     def project_file file

data/lib/inkcite/facade/animation.rb

@@ -36,6 +36,10 @@ module Inkcite
     EASE_IN_OUT = 'ease-in-out'
     EASE_OUT = 'ease-out'
 
+    # Advanced easing functions courtesy of https://matthewlein.com/ceaser/
+    EASE_IN_CUBIC = 'cubic-bezier(0.550, 0.055, 0.675, 0.190)'
+    EASE_OUT_QUART = 'cubic-bezier(0.165, 0.840, 0.440, 1.000)'
+
     # Animation name, view context and array of keyframes
     attr_reader :name, :ctx
 

data/lib/inkcite/facade/keyframe.rb

@@ -9,11 +9,15 @@ module Inkcite
       # of 19.9% would render as 25%, 39.9% { ... }
       attr_accessor :duration
 
+      # Alternative to duration, the ending percentage
+      attr_accessor :end_percent
+
       def initialize percent, ctx, styles={}
 
         # Animation percents are always rounded to the nearest whole number.
-        @percent = percent.round(0)
-        @duration = 0
+        @percent = percent
+        @end_percent = nil
+        @duration = nil
 
         # Instantiate a new Style for this percentage.
         @style = Inkcite::Renderer::Style.new(nil, ctx, styles)
@@ -55,7 +59,10 @@ module Inkcite
 
       def to_css prefix
         css = "#{@percent}%"
-        css << ", #{@percent + @duration.to_f}%" if @duration > 0
+
+        ends_at = calc_ends_at
+        css << ", #{ends_at}%" if ends_at
+
         css << ' { '
         css << @style.to_inline_css(prefix)
         css << ' }'
@@ -64,6 +71,22 @@ module Inkcite
 
       private
 
+      # Returns the percent at which the animation keyframe ends
+      # based on either end_percent (preferred) or duration (deprecated)
+      # being set.  Will return nil if neither is present.
+      def calc_ends_at
+        ends_at = if @end_percent
+          @end_percent
+        elsif @duration
+          (@percent + @duration).round(1)
+        end
+
+        # Ensure that the ending percentage never exceeds 100%
+        ends_at = 100 if ends_at && ends_at >= 100.0
+
+        ends_at
+      end
+
       # Creates a copy of the array of styles with the appropriate
       # properties (e.g. transform) prefixed.
       def get_prefixed_styles prefix

data/lib/inkcite/image/base.rb

@@ -0,0 +1,38 @@
+module Inkcite
+  module Image
+    class ImageMinifier
+
+      # Base class for all image minifiers in the optimization pipeline
+      class Base
+
+        attr_reader :name
+
+        def initialize name
+          @name = name
+        end
+
+        def minify! email, source_img, cache_img
+          raise 'The extending class must implement this method'
+        end
+
+        protected
+
+        # Common configuration names
+        JPG_QUALITY = :'jpg-quality'
+
+        # JPG quality bounds
+        MIN_QUALITY = 0
+        MAX_QUALITY = 100
+
+        def get_jpg_quality config, override_key, default
+          quality = (config[override_key] || config[JPG_QUALITY] || default).to_i
+          quality = MIN_QUALITY if quality < MIN_QUALITY
+          quality = MAX_QUALITY if quality > MAX_QUALITY
+          quality
+        end
+
+      end
+
+    end
+  end
+end

data/lib/inkcite/image/guetzli_minifier.rb

@@ -0,0 +1,62 @@
+module Inkcite
+  module Image
+    class GuetzliMinifier < ImageMinifier::Base
+
+      def initialize
+        super('Guetzli')
+      end
+
+      def minify! email, source_img, cache_img
+
+        # Grab the full path to the guetzli binary
+        guetzli_path = `which guetzli`.delete("\n")
+        unless guetzli_path.blank?
+
+          cmd = []
+          cmd << guetzli_path
+
+          config = email.config
+
+          quality = get_jpg_quality(config, GUETZLI_QUALITY, DEFAULT_QUALITY)
+          if quality > 0 && quality < MAX_QUALITY
+
+            # Per the Guetzli documentation, a value less than 84 isn't useful.
+            quality = MIN_GUETZLI_QUALITY if quality < MIN_GUETZLI_QUALITY
+            cmd << "--quality #{quality}"
+
+          end
+
+          cmd << %Q("#{source_img}")
+          cmd << %Q("#{cache_img}")
+
+          Util::exec(cmd)
+
+          true
+
+        else
+
+          # No guetzli, so simply move the source image into the destination
+          # position without compression.
+          FileUtils.copy(source_img, cache_img)
+
+          false
+        end
+
+
+      end
+
+      private
+
+      # Default quality is zero - which lets Guetzli decide how best to
+      # optimize the image.
+      DEFAULT_QUALITY = 0
+
+      # The minimum quality setting per the Guetzli runtime.
+      MIN_GUETZLI_QUALITY = 84
+
+      # Configuration field names
+      GUETZLI_QUALITY = :'guetzli-quality'
+
+    end
+  end
+end