inkcite 1.0.0

data/lib/inkcite/view/context.rb

@@ -0,0 +1,38 @@
+module Inkcite
+  class View
+
+    # Private class used to convey view attributes to the Erubis rendering
+    # engine without exposing all of the view's attributes.
+    class Context
+
+      delegate :browser?, :development?, :email?, :environment, :format, :production?, :preview?, :version, :to => :view
+
+      def initialize view
+        @view = view
+      end
+
+      def method_missing(m, *args, &block)
+        if m[-1] == QUESTION_MARK
+          start_at = m[0] == UNDERSCORE ? 1 : 0
+          symbol = m[start_at, m.length - (start_at + 1)].to_sym
+
+          @view.version == symbol
+        else
+          super
+        end
+      end
+
+      protected
+
+      def view
+        @view
+      end
+
+      private
+
+      UNDERSCORE = '_'
+      QUESTION_MARK = '?'
+
+    end
+  end
+end

data/lib/inkcite/view/media_query.rb

@@ -0,0 +1,60 @@
+module Inkcite
+  class View
+    class MediaQuery
+
+      def initialize view, max_width
+
+        @view = view
+        @max_width = max_width
+
+        # Initialize the responsive styles used in this email.  This will hold
+        # an array of Responsive::Rule objects.
+        @responsive_styles = Renderer::Responsive.presets(view)
+
+      end
+
+      def << rule
+
+        # Rules only get added once
+        @responsive_styles << rule unless @responsive_styles.include?(rule)
+
+        rule
+      end
+
+      def active_styles
+        @responsive_styles.select(&:active?)
+      end
+
+      def blank?
+        @responsive_styles.none?(&:active?)
+      end
+
+      def find_by_declaration declarations
+        @responsive_styles.detect { |r| r.declarations == declarations }
+      end
+
+      def find_by_klass klass
+        @responsive_styles.detect { |r| r.klass == klass }
+      end
+
+      def find_by_tag_and_klass tag, klass
+        @responsive_styles.detect { |r| r.klass == klass  && r.include?(tag) }
+      end
+
+      def to_a
+
+        css = []
+        css << "@media only screen and (max-width: #{Inkcite::Renderer::px(@max_width)}) {"
+        css += active_styles.collect(&:to_css)
+        css << "}"
+
+        css
+      end
+
+      def to_css
+        to_a.join("\n")
+      end
+
+    end
+  end
+end

data/lib/inkcite/view/tag_stack.rb

@@ -0,0 +1,38 @@
+module Inkcite
+  class View
+    class TagStack
+
+      attr_reader :tag
+
+      delegate :empty?, :length, :to => :opts
+
+      def initialize tag, ctx
+        @tag = tag
+        @ctx = ctx
+        @opts = []
+      end
+
+      # Pushes a new set of options onto the stack for this tag.
+      def << opt
+        @opts << opt
+      end
+      alias_method :push, :<<
+
+      # Retrieves the most recent set of options for this tag.
+      def opts
+        @opts.last || {}
+      end
+
+      # Pops the most recent tag off of the stack.
+      def pop
+        if @opts.empty?
+          @ctx.error 'Attempt to close an unopened tag', { :tag => tag }
+          nil
+        else
+          @opts.pop
+        end
+      end
+
+    end
+  end
+end

data/test/email_spec.rb

@@ -0,0 +1,16 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'inkcite'
+
+describe Inkcite::Email do
+
+  before do
+    @email = Inkcite::Email.new('test/project/')
+  end
+
+  it 'supports multi-line property declarations' do
+    @email.properties[:multiline].must_equal("This\n    is a\n      multiline tag.")
+    @email.properties[:"/multiline"].must_equal("This\n    ends the\n  multiline tag.")
+  end
+
+end

data/test/parser_spec.rb

@@ -0,0 +1,72 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'inkcite'
+
+describe Inkcite::Parser do
+
+  it 'can resolve name=value parameters' do
+    Inkcite::Parser.parameters('border=1').must_equal({ :border => '1' })
+  end
+
+  it 'can resolve parameters with dashes in the name' do
+    Inkcite::Parser.parameters('border-radius=5').must_equal({ :'border-radius' => '5' })
+  end
+
+  it 'can resolve single word values sans double quotes' do
+    Inkcite::Parser.parameters('color=#f90').must_equal({ :'color' => '#f90' })
+  end
+
+  it 'can resolve multi-word values wrapped in double quotes' do
+    Inkcite::Parser.parameters('alt="Click Here!"').must_equal({ :alt => 'Click Here!' })
+  end
+
+  it 'can resolve complex, mixed parameters' do
+    Inkcite::Parser.parameters('src="images/logo.png" height=50 width=100 alt="Generic Logo" mobile-style=hide').must_equal({ :src => 'images/logo.png', :height => '50', :width => '100', :alt => 'Generic Logo', :'mobile-style' => 'hide' })
+  end
+
+  it 'ignores malformed parameters' do
+    Inkcite::Parser.parameters('a=1 b="2 c=3').must_equal({ :a => '1' })
+  end
+
+  it 'can identify an expression and replace it with a value' do
+
+    results = Inkcite::Parser.each('{table border=1}') do |e|
+      e.must_equal('table border=1')
+      'OK'
+    end
+
+    results.must_equal('OK')
+  end
+
+  it 'can parse multiple expressions' do
+    expressions = [ 'table border=1', 'img src=logo.png height=15' ]
+    results = Inkcite::Parser.each('{table border=1}{img src=logo.png height=15}') do |e|
+      expressions.wont_be_empty
+      expressions -= [ e ]
+      'OK'
+    end
+    expressions.must_be_empty
+    results.must_equal('OKOK')
+  end
+
+  it 'can parse nested expression' do
+    expressions = [ '#offwhite', 'table bgcolor=OK' ]
+    results = Inkcite::Parser.each('{table bgcolor={#offwhite}}') do |e|
+      expressions.wont_be_empty
+      expressions -= [ e ]
+      'OK'
+    end
+    expressions.must_be_empty
+    results.must_equal('OK')
+  end
+
+  it 'does not loop forever' do
+    begin
+      Inkcite::Parser.each('{ok}') { |e| '{ok}' }
+      false.must_equal(true) # Intentional, should never be thrown.
+    rescue Exception => e
+      e.message.must_equal("Infinite replacement detected: 1000 {ok}")
+    end
+  end
+
+end

data/test/project/config.yml

@@ -0,0 +1,98 @@
+# When true, appends a cache-busting timestamp to the images referenced
+# in the email.  This ensures the client always retrieves the latest
+# version of the image and helpful during client previews.  Generally
+# this should be disabled in production.
+cache-bust: false
+
+# When true copies image alt-text to the title property.  Populating both
+# presents a more consistent image tooltip experience.
+copy-alt-to-title: false
+
+# When true minifies the HTML and CSS of the email.  Should usually be
+# disabled in development to make debugging easier.
+minify: true
+
+# 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.
+missing-link-url: 'https://github.com/404'
+
+# No placeholders during image testing unless the spec turns this
+# back on itself.
+image-placeholders: false
+
+# Inkcite can generate multiple versions of an email from a single source
+# file which is useful for targeted mailings and a/b testing.  Specify a
+# unique, single-word identifier for each version.
+#versions:
+#  - new_customer
+#  - past_customer
+
+# SMTP settings for sending previews to the small list of internal and client
+# addresses specified below.  Most importantly, specify the address your test
+# emails will be sent 'from:'
+smtp:
+  host: 'smtp.gmail.com'
+  port: 587
+  domain: 'yourdomain.com'
+  username: ''
+  password: ''
+  from: 'Your Name <email@domain.com>'
+
+# Specify the distribution lists for preview versions of the email.
+recipients:
+  clients:
+    - 'Awesome Customer <awesome.customer@domain.com>'
+  internal:
+    - 'Creative Director <creative.director@domain.com>'
+    - 'Proofreader <proof.reader@domain.com>'
+
+# Easy Litmus integration for compatibility testing.
+# http://litmusapp.com
+litmus:
+  subdomain: ''
+  username: ''
+  password: ''
+
+# Easy deployment of static assets to a preview server.
+sftp:
+  host: ''
+  path: ''
+  username: ''
+  password: ''
+
+# Link tagging ensures that every link in the email includes a
+# name-value pair.  This is useful if you harvest data from your
+# website analytics.  {id} will be replaced with the unique ID
+# from the link if you're concerned about which link the
+# recipient clicked to get to your website.
+#tag-links: "tag=inkcite|{id}"
+
+# Optionally, if your email newsletter links to multiple websites
+# and you only want to tag links to a specific domain, include
+# that domain in this setting.
+#tag-links-domain: 'inkceptional.com'
+
+# Environment-specific overrides allow you to change any setting
+# for each environment (e.g local development vs. client preview).
+
+# These overrides apply to your local development environment when
+# you are viewing the email in your browser via Inkcite's server.
+development:
+  minify: false
+
+# These overrides apply to previews both internally and to external
+# clients and sent with Inkcite's preview function.
+preview:
+  email:
+    view-in-browser-url: 'http://preview.contenthost.com/path/{filename}'
+    image-host: 'http://preview.imagehost.com/emails/'
+
+# These overrides apply to the final, ready-to-send files.
+production:
+  cache-bust: false
+  image-host: "http://production.imagehost.com/emails/myemail"
+
+  email:
+    view-in-browser-url: 'http://production.contenthost.com/path/{filename}'
+

data/test/project/helpers.tsv

@@ -0,0 +1,56 @@
+// This file helps you keep your email code DRY (don't repeat yourself)
+// by allowing you to easily define constants and custom tags.
+//
+// The keys and values in this file are tab-delimited.
+
+// Palette
+#background	#ffffff
+#text	#000000
+#link	#0099cc
+
+font-family	sans-serif
+font-size	15
+line-height	19
+
+default-color	{#text}
+default-font-size	{font-size}
+default-font-weight	normal
+default-line-height	{line-height}
+
+responsive-font-size	20
+responsive-mobile-font-size	40
+
+large-color	#f00
+large-font-family	serif
+large-font-size	24
+large-font-weight	bold
+large-line-height	24
+
+small-color	#ccc
+small-font-size	11
+
+// This is an example of a custom tag.  Tabs delimit the tag name, its open and
+// close values.  Inkcite will replace instances of {big} and {/big} with these
+// values, respectively.  Notice that it allows its color, which defaults to
+// #444444, to be configured in your HTML as in {big color=#ff0000}.
+big	<div style="font-size: 18px; font-weight: bold; color: $color=#444444$">	</div>
+
+// Bullet-proof buttons
+button-border-radius	5
+button-float	center
+button-padding	8
+button-width	175
+
+// Dimensions
+width	500
+
+// Test for multiline tag declaration
+multiline	<<-START
+  This
+    is a
+      multiline tag.
+END->>	<<-START
+			This
+		ends the
+	multiline tag.
+END->>

data/test/project/source.html

@@ -0,0 +1,58 @@
+{table padding=10 width=100% mobile="hide"}
+  {td font=default align=center}This preheader will disappear on a mobile device.{/td}
+{/table}
+
+{table padding=10 width={width} float=center mobile="fill"}
+  {td align=left font=default}
+
+    {img src=logo.gif height=50 width=200 alt="Company Logo"}<br>
+
+    {lorem sentences=3}<br><br>
+
+    {img src=billboard.jpg height=180 width={width} mobile="fill"}<br>
+
+    {lorem sentences=10}<br><br>
+
+    {button id="call-to-action" href="http://inkceptional.com"}Call To Action{/button}<br>
+
+  {/td}
+{/table}
+
+{table width={width} padding=10 float=center valign=top mobile="stack"}
+  {td width=50%}
+
+    {img src=kittens.jpg width=250 height=150 mobile="fill"}<br>
+
+    {big}{lorem type=headline}{/big}
+
+    {lorem sentences=8}<br><br>
+
+    {button id="call-to-action2" href="http://inkceptional.com"}Create &amp; Send{/button}
+
+  {/td}
+  {td width=50% bgcolor=#eeeeee font=default}
+
+    {big}{lorem type=headline}{/big}
+    {lorem sentences=3}<br><br>
+
+    {big}{lorem type=headline}{/big}
+    {lorem sentences=3}<br><br>
+
+    {big color=#990000}{lorem type=headline}{/big}
+    {lorem sentences=3}
+
+  {/td}
+{/table}
+
+{table padding=10 width={width} float=center mobile="fill"}
+  {td align=left font=small}
+
+    {img src=footer.jpg height=100 width={width} mobile="hide"}<br>
+
+    <% if email? %>
+      This email was sent to [email].  {a id="unsubscribe" href=#}Click here to unsubscribe{/a}.
+      Using ERB, this unsubscribe notice will only appear in the 'email' format of this project.
+    <% end %>
+
+  {/td}
+{/table}