inkcite 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d4ec18570e9ba801f756e6594a3737bbc3ced90
-  data.tar.gz: df1c113816730b99cb4ced73b9c9965252ea4d97
+  metadata.gz: c14c10f673644c60a3e92d4c511858d562c16f58
+  data.tar.gz: 0690d93ebed3be3f26735c9e6ecdd70301936a43
 SHA512:
-  metadata.gz: 143670d23d2712b7eddcc6e93358c9f3cf0155df60f6917d9258e1fc0c0be5dbc7bdde461ad15b035cc458e3cfe41f4bc5420cab295e44b87b65cc1efa45bab9
-  data.tar.gz: d6bf7f13e73984a4c85097c06074b26e85e6bb43c0c12b91f764b629cdbccdc3be312db47430377a1e5996c9ed6a934c9b38843210076c690358331dceb7c4ba
+  metadata.gz: 2553f347fb054d2cf5ab68be3696a1223eabda24b7f1196d09871c3068c6cab2ccdda81214b8890720f8bf9463bd560d9093bee9f4db9d9c2e1aeaae1f240f30
+  data.tar.gz: 62224686033d05c4587995d4c92268287fac082a16013f54d71d9f185d5fb98ca7afbc54d14b9576170c24d4792069cfa0478841448cab82ec29e77296f9bb37

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.test_files = FileList['test/*_spec.rb', 'test/renderer/*_spec.rb']
+  t.libs.push 'lib'
+  t.test_files = FileList['test/test_helper.rb', 'test/*_spec.rb', 'test/renderer/*_spec.rb']
   t.verbose = false
 end

data/assets/init/helpers.tsv

@@ -15,3 +15,10 @@ title	Welcome to Inkcite
 
 // This defines the default font family used throughout your email.
 font-family	sans-serif
+
+// Defaults for all buttons in the email
+button-border	2px solid #0099cc
+button-border-radius	5
+button-color	#99ffff
+button-float	center
+button-padding	8

data/inkcite.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'builder'
+  spec.add_dependency 'chunky_png'
   spec.add_dependency 'erubis'
   spec.add_dependency 'faker'
   spec.add_dependency 'guard'
@@ -32,19 +33,19 @@ Gem::Specification.new do |spec|
   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 'net-sftp'
-  spec.add_dependency 'nokogiri'
   spec.add_dependency 'rack'
   spec.add_dependency 'rack-livereload'
   spec.add_dependency 'rubyzip'
   spec.add_dependency 'thor'
   spec.add_dependency 'yui-compressor'
 
-  spec.add_development_dependency "bundler", "~> 1.1"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
 
 end

data/lib/inkcite.rb

@@ -1,9 +1,19 @@
-require 'csv'
-require 'erubis'
-require 'i18n'
-require 'set'
-require 'uri'
-require 'yaml'
+require 'active_support/core_ext/kernel/reporting.rb'  # silence_warnings
+
+# Need to silence warnings when we import these other gems as
+# there are numerous messages produced as a result of circular
+# dependencies and other problems within these gems, outside
+# of my control.
+silence_warnings do
+  require 'csv'
+  require 'erubis'
+  require 'i18n'
+  require 'image_optim'
+  require 'set'
+  require 'uri'
+  require 'yaml'
+  require 'yui/compressor'
+end
 
 require 'active_support/core_ext/hash/keys.rb'  # Symbolize keys!
 require 'active_support/core_ext/module/delegation.rb'
@@ -19,6 +29,7 @@ require 'inkcite/view'
 require 'inkcite/minifier'
 require 'inkcite/parser'
 require 'inkcite/renderer'
+require 'inkcite/animation'
 
 module Inkcite
 

data/lib/inkcite/animation.rb

@@ -0,0 +1,135 @@
+module Inkcite
+  module Animation
+
+    class Keyframe
+
+      attr_reader :percent
+
+      def initialize percent, styles={}
+        # Animation percents are always rounded to the nearest whole number.
+        @percent = percent.round(0)
+        @styles = styles
+      end
+
+      def [] key
+        @styles[key]
+      end
+
+      def []= key, val
+        @styles[key] = val
+      end
+
+      def add key, val
+        self[key] = val
+        self
+      end
+
+      def add_with_prefixes key, val, ctx
+
+        Animation.get_prefixes(ctx).each do |prefix|
+          _key = "#{prefix}#{key}".to_sym
+          self[_key] = val
+        end
+        self
+      end
+
+      def to_s
+
+        css = ''
+        css << "  #{@percent}%"
+        css << ' ' * (7 - css.length)
+        css << '{ '
+        css << Renderer.render_styles(@styles)
+        css << ' }'
+
+        css
+      end
+
+    end
+
+    class Keyframes
+
+      def initialize name, context
+        @name = name
+        @ctx = context
+        @keyframes = []
+      end
+
+      def << keyframe
+        @keyframes << keyframe
+      end
+
+      def add_keyframe percent, styles
+        self << Keyframe.new(percent, styles)
+      end
+
+      def to_s
+
+        css = ''
+
+        keyframe_css = @keyframes.sort { |kf1,kf2| kf1.percent <=> kf2.percent }.collect(&:to_s).join("\n")
+
+        prefixes = Animation.get_prefixes(@ctx)
+
+        prefixes.each do |prefix|
+          css << "@#{prefix}keyframes #{@name} {\n"
+          css << keyframe_css
+          css << "\n}\n"
+        end
+
+        css
+      end
+
+    end
+
+    def self.get_prefixes ctx
+      ALL_BROWSERS
+    end
+
+    # True if we're limiting the animation to webkit only.  In development
+    # or in the browser version of the email, the animation should be as
+    # compatible as possible but in all other cases it should be webkit only.
+    def self.webkit_only? ctx
+      false #&& !(ctx.development? || ctx.browser?)
+    end
+
+    # Renders the CSS with the appropriate browser prefixes based
+    # on whether or not this version of the email is webkit only.
+    def self.with_browser_prefixes css, ctx, opts={}
+
+      indentation = opts[:indentation] || ''
+
+      # Convert an integer indentation value into that number of spaces.
+      indentation = ' ' * indentation if indentation.is_a?(Integer)
+
+      separator = opts[:separator] || "\n"
+
+      # Determine which prefixes will be applied.
+      browser_prefixes = webkit_only?(ctx) ? WEBKIT_BROWSERS : ALL_BROWSERS
+
+      # This will hold the completed CSS with all prefixes applied.
+      _css = ''
+
+      # Iterate through the prefixes and apply them with the indentation
+      # and CSS declaration with line breaks.
+      browser_prefixes.each do |prefix|
+        _css << indentation
+        _css << prefix
+        _css << css
+        _css << separator
+      end
+
+      _css
+    end
+
+    private
+
+
+    # Static arrays with browser prefixes.  Turns out that Firefox, IE and Opera
+    # don't require a prefix so to target everything we need the non-prefixed version
+    # (hence the blank entry) plus the webkit prefix.
+    WEBKIT_BROWSERS = ['-webkit-']
+    ALL_BROWSERS = [''] + WEBKIT_BROWSERS
+
+  end
+end

data/lib/inkcite/cli/base.rb

@@ -45,6 +45,10 @@ module Inkcite
       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
       def preview to=:developer
         require_relative 'preview'
         Cli::Preview.invoke(email, to, options)
@@ -75,7 +79,7 @@ module Inkcite
           :desc => 'The ip address Inkcite will bind to'
       method_option :port,
           :aliases => '-p',
-          :default => '4567',
+          :default => 4567,
           :desc => 'The port Inkcite will listen on',
           :type => :numeric
       option :version,
@@ -113,19 +117,6 @@ module Inkcite
         options[:force] ? email.upload! : email.upload
       end
 
-      desc 'validate', 'Validate the email against W3C standards'
-      option :environment,
-          :aliases => '-e',
-          :default => 'production',
-          :desc => 'The environment (production, preview, development) to be Inkcite will run under'
-      option :version,
-          :aliases => '-v',
-          :desc => 'Preview a specific version of the email'
-      def validate
-        require_relative 'validate'
-        Cli::Validate.invoke(email, options)
-      end
-
       private
 
       # Resolves the desired environment (e.g. :development or :preview)

data/lib/inkcite/cli/build.rb

@@ -45,7 +45,7 @@ module Inkcite
 
         # The Zip::File will try to update an existing archive so just blow the old
         # one away if it still exists.
-        File.delete(zip_file) if File.exists?(zip_file)
+        File.delete(zip_file) if File.exist?(zip_file)
 
         # The absolute path to the build directories
         build_html_to = build_path(email)
@@ -54,7 +54,7 @@ module Inkcite
         Zip::File.open(zip_file, Zip::File::CREATE) do |zip|
 
           # Add the minified images to the .zip archive
-          if File.exists?(build_images_to)
+          if File.exist?(build_images_to)
             Dir.foreach(build_images_to) do |img|
               img_path = File.join(build_images_to, img)
               zip.add(File.join(Inkcite::Email::IMAGES, img), img_path) unless File.directory?(img_path)
@@ -113,7 +113,7 @@ module Inkcite
         # Copy all of the source images into the build directory in preparation
         # for optimization
         build_images_from = email.optimized_image_dir
-        FileUtils.cp_r(File.join(build_images_from, '.'), build_images_to) if File.exists?(build_images_from)
+        FileUtils.cp_r(File.join(build_images_from, '.'), build_images_to) if File.exist?(build_images_from)
 
       end
 

data/lib/inkcite/cli/init.rb

@@ -8,7 +8,7 @@ module Inkcite
 
         # Sanity check to make sure we're not writing over an existing
         # Inkcite project.
-        abort "It appears that an Inkcite already exists in #{path}" if File.exists?(File.join(full_init_path, 'config.yml'))
+        abort "It appears that an Inkcite already exists in #{path}" if File.exist?(File.join(full_init_path, 'config.yml'))
 
         # Check to see if the user specified a --from path that is used to
         # clone an existing project rather than init a new one.
@@ -41,7 +41,7 @@ module Inkcite
 
         # Verify that the source directory contains the config.yml file
         # signifying an existing Inkcite project.
-        abort "Can't find #{from_path} or it isn't an existing Inkcite project" unless File.exists?(File.join(from_path, 'config.yml'))
+        abort "Can't find #{from_path} or it isn't an existing Inkcite project" unless File.exist?(File.join(from_path, 'config.yml'))
 
         # Copy the main Inkcite project files
         Dir.glob(File.join(from_path, '*.{html,tsv,txt,yml}')).each do |from_file|
@@ -59,7 +59,7 @@ module Inkcite
 
         # Check to see if there are images and copy those as well.
         from_path = File.join(from_path, Inkcite::Email::IMAGES)
-        if File.exists?(from_path)
+        if File.exist?(from_path)
           FileUtils.cp_r(File.join(from_path, '.'), full_init_image_path)
           puts "Copied images to #{init_image_path}"
         end

data/lib/inkcite/cli/preview.rb

@@ -10,6 +10,23 @@ module Inkcite
         # latest images and "view in browser" versions are available.
         email.upload
 
+        also = opt[:also]
+        unless also.blank?
+
+          # 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
+
+            # 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
           when :client
             Inkcite::Mailer.client(email, opt)
@@ -18,7 +35,14 @@ module Inkcite
           when :developer
             Inkcite::Mailer.developer(email, opt)
           else
-            raise "Invalid preview distribution target"
+            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
         end
 
       end

data/lib/inkcite/cli/server.rb

@@ -79,7 +79,7 @@ module Inkcite
             unavailable. Either close the instance of Inkcite already running
             on that port or start this Inkcite instance on a new port with:
 
-              inkcit server --port=#{port+1}
+              inkcite server --port=#{port+1}
 
           USAGE
         end

data/lib/inkcite/cli/validate.rb

@@ -20,28 +20,19 @@ module Inkcite
           # The version of the email we will be sending.
           view = email.view(environment, :email, version)
 
-          # Always disable minification
-          view.config[:minify] = false
-
           subject = view.subject
 
           print "Validating '#{subject}' ... "
 
-          source = view.render!
-
-          validator = Nokogiri::HTML(source) do |config|
+          validator = Nokogiri::HTML(view.render!) do |config|
             config.strict
           end
 
           if validator.errors.any?
             puts 'Invalid!'
-
-            lines = source.split(/\n/)
-
             validator.errors.each do |err|
               puts err.inspect
-              puts "#{err.line}: #{lines[err.line - 1]}"
-              puts [ err.column, err.int1, err.str1, err.str2, err.str3 ].inspect
+              puts err.line
             end
 
           else

data/lib/inkcite/email.rb

@@ -37,7 +37,7 @@ module Inkcite
 
       # Need to make sure a source.txt exists before we can include
       # it in the list of known formats.
-      f << :text if File.exists?(project_file('source.txt'))
+      f << :text if File.exist?(project_file('source.txt'))
 
       f
     end

data/lib/inkcite/mailer.rb

@@ -64,6 +64,11 @@ module Inkcite
     # Sends each version of the provided email with the indicated options.
     def self.send email, opts
 
+      # Check to see if additional one-time recipients have been added
+      # to the command line.
+      also_to = opts[:also]
+      opts[:cc] = [*opts[:cc]] + also_to unless also_to.blank?
+
       # Check to see if a specific version is requested or if unspecified
       # all versions of the email should be sent.
       versions = Array(opts[:version] || email.versions)

data/lib/inkcite/minifier.rb

@@ -1,14 +1,60 @@
-require 'image_optim'
-require 'yui/compressor'
-
 module Inkcite
   class Minifier
 
     # Directory of optimized images
     IMAGE_CACHE = "images-optim"
 
+    # Maximum line length for CSS and HTML - lines exceeding this length cause
+    # problems in certain email clients.
+    MAXIMUM_LINE_LENGTH = 800
+
     def self.css code, ctx
-      minify?(ctx) ? css_compressor(ctx).compress(code) : code
+
+      # Do nothing to the code unless minification is enabled.
+      if minify?(ctx)
+
+        # After YUI's CSS compressor started introducing problems into CSS3
+        # animations, I've switched to a homegrown, extremely simple compression
+        # algorithm for CSS.  Instead of messing with parameters, we're simply
+        # eliminating whitespace.
+
+        # Replace all line breaks with spaces
+        code.gsub!(/[\n\r\f]/, ' ')
+
+        # Remove whitespace at the beginning or ending of the code
+        code.gsub!(/^\s+/, '')
+        code.gsub!(/\s+$/, '')
+
+        # Compress multiple whitespace characters into a single space.
+        code.gsub!(/\s{2,}/, ' ')
+
+        # Remove whitespace preceding or following open and close curly brackets.
+        code.gsub!(/\s*([{};:])\s*/, "\\1")
+
+        # Remove semicolons preceding close brackets.
+        code.gsub!(';}', '}')
+
+        # Certain versions of outlook have a problem with excessively long lines
+        # so if this minified code now exceeds the maximum line limit, re-introduce
+        # wrapping in spots where it won't break anything to do so - e.g. following
+        # a semicolon or close bracket.
+        if ctx.email? && code.length > MAXIMUM_LINE_LENGTH
+
+          # Position at which a line break will be inserted at.
+          break_at = 0
+
+          # Work through the code injecting line breaks until either no further
+          # breakable characters are found or we've reached the end of the code.
+          while break_at < code.length
+            break_at = code.rindex(/[;}]/, break_at + MAXIMUM_LINE_LENGTH) + 1
+            code.insert(break_at, "\n") if break_at && break_at < code.length
+          end
+
+        end
+
+      end
+
+      code
     end
 
     def self.html lines, ctx
@@ -72,7 +118,7 @@ module Inkcite
 
       # If the image cache exists, we need to check to see if any images have been
       # removed since the last build.
-      if File.exists?(cache_path)
+      if File.exist?(cache_path)
 
         # Get a list of the files in the cache that do not also exist in the
         # project's images/ directory.
@@ -137,7 +183,7 @@ module Inkcite
     end
 
     def self.remove_comments html, ctx
-      minify?(ctx) ? html.gsub(HTML_COMMENT_REGEX, '') : html
+      remove_comments?(ctx) ? html.gsub(HTML_COMMENT_REGEX, '') : html
     end
 
     private
@@ -148,7 +194,6 @@ module Inkcite
     IMAGE_OPTIM_CONFIG_YML = 'image_optim.yml'
 
     NEW_LINE = "\n"
-    MAXIMUM_LINE_LENGTH = 800
 
     # Used to match inline styles that will be compressed when minifying
     # the entire email.
@@ -163,12 +208,14 @@ module Inkcite
       ctx.is_enabled?(:minify)
     end
 
-    def self.js_compressor ctx
-      ctx.js_compressor ||= YUI::JavaScriptCompressor.new(:munge => true)
+    # Config attribute that allows for comment striping to be disabled.
+    # e.g. strip-comments: false
+    def self.remove_comments? ctx
+      minify?(ctx) && !ctx.is_disabled?(:'strip-comments')
     end
 
-    def self.css_compressor ctx
-      ctx.css_compressor ||= YUI::CssCompressor.new(:line_break => (ctx.email? ? MAXIMUM_LINE_LENGTH : nil))
+    def self.js_compressor ctx
+      ctx.js_compressor ||= YUI::JavaScriptCompressor.new(:munge => true)
     end
 
   end