RubyGems - inkcite - Versions diffs - 1.2.0 → 1.6.0 - Mend

inkcite 1.2.0 → 1.6.0

Files changed (33) hide show

checksums.yaml +4 -4
data/assets/blueprint.png +0 -0
data/assets/example/helpers.tsv +37 -0
data/assets/example/source.html +32 -0
data/assets/{init → example}/source.txt +0 -0
data/assets/init/config.yml +42 -4
data/assets/init/helpers.tsv +12 -26
data/assets/init/image_optim.yml +37 -0
data/assets/init/source.html +0 -60
data/inkcite.gemspec +2 -0
data/lib/inkcite/cli/base.rb +5 -1
data/lib/inkcite/cli/build.rb +1 -1
data/lib/inkcite/cli/init.rb +31 -16
data/lib/inkcite/cli/server.rb +5 -0
data/lib/inkcite/cli/test.rb +16 -31
data/lib/inkcite/email.rb +2 -2
data/lib/inkcite/minifier.rb +46 -31
data/lib/inkcite/renderer/button.rb +17 -8
data/lib/inkcite/renderer/footnote.rb +39 -13
data/lib/inkcite/renderer/litmus_analytics.rb +79 -0
data/lib/inkcite/renderer/span.rb +5 -0
data/lib/inkcite/renderer/table_base.rb +43 -52
data/lib/inkcite/renderer/td.rb +0 -3
data/lib/inkcite/renderer.rb +2 -2
data/lib/inkcite/uploader.rb +4 -0
data/lib/inkcite/util.rb +4 -0
data/lib/inkcite/version.rb +1 -1
data/lib/inkcite/view.rb +50 -8
data/lib/inkcite.rb +10 -1
data/test/renderer/span_spec.rb +97 -0
data/test/renderer/td_spec.rb +10 -10
metadata +38 -4
data/lib/inkcite/renderer/litmus.rb +0 -33

data/lib/inkcite/view.rb CHANGED Viewed

@@ -151,7 +151,32 @@ module Inkcite
     end
     def footnotes
-      @footnotes ||= []
+      if @footnotes.nil?
+        @footnotes = []
+        # Preload the array of footnotes if they exist
+        footnotes_tsv_file = @email.project_file(FOOTNOTES_TSV_FILE)
+        if File.exists?(footnotes_tsv_file)
+          CSV.foreach(footnotes_tsv_file, { :col_sep => "\t" }) do |fn|
+            id = fn[0]
+            next if id.blank?
+            text = fn[2]
+            next if text.blank?
+            # Read the symbol and replace it with nil (so that one will be auto-generated)
+            symbol = fn[1]
+            symbol = nil if symbol.blank?
+            @footnotes << Renderer::Footnote::Instance.new(id, symbol, text, false)
+          end
+        end
+      end
+      @footnotes
     end
     def file_name ext=nil
@@ -190,7 +215,12 @@ 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 = development?? "#{Email::IMAGES}/" : self[Email::IMAGE_HOST]
+      image_host = if development?
+        (@email.optimize_images?? Minifier::IMAGE_CACHE : Email::IMAGES) + '/'
+      else
+        self[Email::IMAGE_HOST]
+      end
       src_url << image_host unless image_host.blank?
       # Add the source of the image.
@@ -344,13 +374,19 @@ module Inkcite
         html << '</style>'
         html << '</head>'
-        # Render the body statement and apply the email's background color to it.
-        bgcolor = Renderer.hex(self[BACKGROUND])
-        # Intentially not setting the link colors because those should be entirely
+        # 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 << Renderer.render("<body bgcolor=\"#{bgcolor}\" style=\"background-color: #{bgcolor}; width: 100% !important; min-width: 100% !important; margin: 0; padding: 0; -webkit-text-size-adjust: none; -ms-text-size-adjust: none;\">", self)
+        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;'
+        # 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 << %q(">)
         html << minified
@@ -479,7 +515,6 @@ module Inkcite
     private
     ASSETS          = 'assets'
-    BACKGROUND      = :'#background'
     FILE_SCHEME     = 'file'
     FILE_NAME       = :'file-name'
     HTML_EXTENSION  = '.html'
@@ -522,6 +557,9 @@ module Inkcite
     # Tab-separated file containing links declarations.
     LINKS_TSV_FILE = 'links.tsv'
+    # Tab-separated file containing footnote declarations.
+    FOOTNOTES_TSV_FILE = 'footnotes.tsv'
     def assert_in_browser msg
       raise msg if email? && !development?
     end
@@ -716,6 +754,10 @@ module Inkcite
         # Ensure that telephone numbers are displayed using the same style as links.
         reset << "a[href^=tel] { color: #{self[Renderer::Base::LINK_COLOR]}; text-decoration:none;}"
+        # Remove extraneous left-margins on Android 4.4
+        # https://litmus.com/community/code/4194-why-is-email-not-centered-on-android-4-4#comment-5727
+        reset << 'div[style*="margin: 16px 0"] { margin:0 !important; }'
       end
       # Reset the font on every cell to the default family.

data/lib/inkcite.rb CHANGED Viewed

@@ -23,7 +23,16 @@ require 'inkcite/renderer'
 module Inkcite
   def self.asset_path
-    File.expand_path('../../..', File.dirname(__FILE__))
+    File.join(File.expand_path('../', File.dirname(__FILE__)), 'assets')
+  end
+  # Loads (and caches) the base64-encoded PNG data for the subtle background
+  # texture that Inkcite installs on the <body> tag in development mode.
+  def self.blueprint_image64
+    @blueprint64 ||= begin
+      blueprint_path = File.join(asset_path, 'blueprint.png')
+      Base64.encode64(File.read(blueprint_path)).gsub(/[\r\f\n]/, '')
+    end
   end
 end

data/test/renderer/span_spec.rb ADDED Viewed

@@ -0,0 +1,97 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'inkcite'
+describe Inkcite::Renderer::Span do
+  before do
+    @view = Inkcite::Email.new('test/project/').view(:development, :email)
+  end
+  it 'can have empty parameters' do
+    Inkcite::Renderer.render('{span}{/span}', @view).must_equal('<span></span>')
+  end
+  it 'can have a custom font color' do
+    Inkcite::Renderer.render('{span color=#f90}{/span}', @view).must_equal('<span style="color:#ff9900"></span>')
+  end
+  it 'can have a custom font family' do
+    Inkcite::Renderer.render('{span font-family="Comic Sans"}{/span}', @view).must_equal('<span style="font-family:Comic Sans"></span>')
+  end
+  it 'can have a custom font size' do
+    Inkcite::Renderer.render('{span font-size=18}{/span}', @view).must_equal('<span style="font-size:18px"></span>')
+  end
+  it 'can have a custom font weight' do
+    Inkcite::Renderer.render('{span font-weight=bold}{/span}', @view).must_equal('<span style="font-weight:bold"></span>')
+  end
+  it 'can have a custom line height' do
+    Inkcite::Renderer.render('{span line-height=15}{/span}', @view).must_equal('<span style="line-height:15px"></span>')
+  end
+  it 'can inherit a font from the context' do
+    Inkcite::Renderer.render('{span font=large}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:24px;font-weight:bold;line-height:24px"></span>')
+  end
+  it 'can override the font size of an inherited font' do
+    Inkcite::Renderer.render('{span font=large font-size=8}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:8px;font-weight:bold;line-height:24px"></span>')
+    Inkcite::Renderer.render('{span font=large font-size=none}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-weight:bold;line-height:24px"></span>')
+  end
+  it 'can override the color of an inherited font' do
+    Inkcite::Renderer.render('{span font=large color=#00f}{/span}', @view).must_equal('<span style="color:#0000ff;font-family:serif;font-size:24px;font-weight:bold;line-height:24px"></span>')
+    Inkcite::Renderer.render('{span font=large color=none}{/span}', @view).must_equal('<span style="font-family:serif;font-size:24px;font-weight:bold;line-height:24px"></span>')
+  end
+  it 'can override the font weight of an inherited font' do
+    Inkcite::Renderer.render('{span font=large font-weight=normal}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:24px;font-weight:normal;line-height:24px"></span>')
+    Inkcite::Renderer.render('{span font=large font-weight=none}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:24px;line-height:24px"></span>')
+  end
+  it 'can override the line height of an inherited font' do
+    Inkcite::Renderer.render('{span font=large line-height=12}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:24px;font-weight:bold;line-height:12px"></span>')
+    Inkcite::Renderer.render('{span font=large line-height=normal}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:24px;font-weight:bold;line-height:normal"></span>')
+    Inkcite::Renderer.render('{span font=large line-height=none}{/span}', @view).must_equal('<span style="color:#ff0000;font-family:serif;font-size:24px;font-weight:bold"></span>')
+  end
+  it 'can have a text shadow' do
+    Inkcite::Renderer.render('{span shadow=#99c}{/span}', @view).must_equal('<span style="text-shadow:0 1px 0 #9999cc"></span>')
+    Inkcite::Renderer.render('{span shadow=#9c9 shadow-blur=2}{/span}', @view).must_equal('<span style="text-shadow:0 1px 2px #99cc99"></span>')
+    Inkcite::Renderer.render('{span shadow=#c99 shadow-offset=-1}{/span}', @view).must_equal('<span style="text-shadow:0 -1px 0 #cc9999"></span>')
+  end
+  it 'can have a background color' do
+    Inkcite::Renderer.render('{span bgcolor=#06c}{/span}', @view).must_equal('<span style="background-color:#0066cc"></span>')
+  end
+  it 'can be responsive' do
+    Inkcite::Renderer.render('{span mobile=hide}{/span}', @view).must_equal('<span class="hide"></span>')
+  end
+  it 'can have custom letter spacing' do
+    Inkcite::Renderer.render('{span letter-spacing=3}{/span}', @view).must_equal('<span style="letter-spacing:3px"></span>')
+  end
+  it 'can have a custom font size on mobile' do
+    Inkcite::Renderer.render('{span font-size=15 mobile-font-size=20}{/span}', @view).must_equal('<span class="m1" style="font-size:15px"></span>')
+    @view.media_query.find_by_klass('m1').declarations.must_match('font-size:20px !important')
+  end
+  it 'can have a custom line height on mobile' do
+    Inkcite::Renderer.render('{span line-height=15 mobile-line-height=20}{/span}', @view).must_equal('<span class="m1" style="line-height:15px"></span>')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('span[class~="m1"] { line-height:20px !important }')
+  end
+  it 'can inherit a custom font size on mobile from the context' do
+    Inkcite::Renderer.render('{span font=responsive}{/span}', @view).must_equal('<span class="m1" style="font-size:20px"></span>')
+    @view.media_query.find_by_klass('m1').declarations.must_match('font-size:40px')
+  end
+  it 'supports padding' do
+    Inkcite::Renderer.render('{span padding=15}{/span}', @view).must_equal('<span style="padding:15px"></span>')
+  end
+end

data/test/renderer/td_spec.rb CHANGED Viewed

@@ -91,12 +91,12 @@ describe Inkcite::Renderer::Td do
   it 'can have a custom background color on mobile' do
     Inkcite::Renderer.render('{td mobile-bgcolor=#f09}', @view).must_equal('<td class="m1">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background-color:#ff0099 }')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:#ff0099 }')
   end
   it 'can override background color on mobile' do
     Inkcite::Renderer.render('{td bgcolor=#f00 mobile-bgcolor=#00f}', @view).must_equal('<td bgcolor=#ff0000 class="m1">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background-color:#0000ff !important }')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:#0000ff !important }')
   end
   it 'can have a background image' do
@@ -109,18 +109,18 @@ describe Inkcite::Renderer::Td do
   end
   it 'can override background image on mobile' do
-    Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom mobile-background-image=sky.jpg mobile-background-position=top}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg) bottom no-repeat">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/sky.jpg) top no-repeat !important }')
+    Inkcite::Renderer.render('{td background=floor.jpg mobile-background-image=sky.jpg }', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg)">')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/sky.jpg) !important }')
   end
-  it 'can disable background image on mobile' do
-    Inkcite::Renderer.render('{td bgcolor=#f00 background=floor.jpg background-position=bottom mobile-bgcolor=#0f0 mobile-background-image=none}', @view).must_equal('<td bgcolor=#ff0000 class="m1" style="background:#ff0000 url(images/floor.jpg) bottom no-repeat">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background-color:#00ff00 !important;background-image:none !important }')
+  it 'can override background position on mobile' do
+    Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom mobile-background-position=top}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg) bottom no-repeat">')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/floor.jpg) top no-repeat !important }')
   end
-  it 'inherits background position and repeat on mobile' do
-    Inkcite::Renderer.render('{td background=floor.jpg background-position=bottom mobile-background-image=sky.jpg}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg) bottom no-repeat">')
-    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:url(images/sky.jpg) bottom no-repeat !important }')
+  it 'can disable background image on mobile' do
+    Inkcite::Renderer.render('{td background=floor.jpg mobile-background-image=none}', @view).must_equal('<td class="m1" style="background:url(images/floor.jpg)">')
+    @view.media_query.find_by_klass('m1').to_css.must_equal('td[class~="m1"] { background:none !important }')
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inkcite
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jeffrey D. Hoffman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_optim_pack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: litmus
   requirement: !ruby/object:Gem::Requirement
@@ -232,12 +260,16 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- assets/blueprint.png
+- assets/example/helpers.tsv
+- assets/example/source.html
+- assets/example/source.txt
 - assets/facebook-like.css
 - assets/facebook-like.js
 - assets/init/config.yml
 - assets/init/helpers.tsv
+- assets/init/image_optim.yml
 - assets/init/source.html
-- assets/init/source.txt
 - bin/inkcite
 - bin/release-major
 - bin/release-minor
@@ -267,7 +299,7 @@ files:
 - lib/inkcite/renderer/increment.rb
 - lib/inkcite/renderer/like.rb
 - lib/inkcite/renderer/link.rb
-- lib/inkcite/renderer/litmus.rb
+- lib/inkcite/renderer/litmus_analytics.rb
 - lib/inkcite/renderer/lorem.rb
 - lib/inkcite/renderer/mobile_image.rb
 - lib/inkcite/renderer/mobile_style.rb
@@ -304,6 +336,7 @@ files:
 - test/renderer/link_spec.rb
 - test/renderer/mobile_image_spec.rb
 - test/renderer/mobile_style_spec.rb
+- test/renderer/span_spec.rb
 - test/renderer/table_spec.rb
 - test/renderer/td_spec.rb
 - test/renderer_spec.rb
@@ -349,6 +382,7 @@ test_files:
 - test/renderer/link_spec.rb
 - test/renderer/mobile_image_spec.rb
 - test/renderer/mobile_style_spec.rb
+- test/renderer/span_spec.rb
 - test/renderer/table_spec.rb
 - test/renderer/td_spec.rb
 - test/renderer_spec.rb

data/lib/inkcite/renderer/litmus.rb DELETED Viewed

@@ -1,33 +0,0 @@
-module Inkcite
-  module Renderer
-    class Litmus < Base
-      def render tag, opt, ctx
-        # Litmus tracking is enabled only for production emails.
-        return nil unless ctx.production? && ctx.email?
-        code = opt[:code] || opt[:id]
-        return nil if code.blank?
-        merge_tag = opt[MERGE_TAG] || ctx[MERGE_TAG]
-        ctx.styles << "@media print{#_t { background-image: url('https://#{code}.emltrk.com/#{code}?p&d=#{merge_tag}');}}"
-        ctx.styles << "div.OutlookMessageHeader {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.styles << "table.moz-email-headers-table {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.styles << "blockquote #_t {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.styles << "#MailContainerBody #_t {background-image:url('https://#{code}.emltrk.com/#{code}?f&d=#{merge_tag}')}"
-        ctx.footer << '<div id="_t"></div>'
-        ctx.footer << "<img src=\"https://#{code}.emltrk.com/#{code}?d=#{merge_tag}\" width=1 height=1 border=0 />"
-        nil
-      end
-      private
-      MERGE_TAG = :'merge-tag'
-    end
-  end
-end