inkcite 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3066d2404f84bcdf743a160b8c85cc838cd19c0
-  data.tar.gz: 73adb02dd0f48a81a2b9223a5f03d221c18fa908
+  metadata.gz: 3e391fed5c45670dba9e4bb01afdec27bb9ce9a8
+  data.tar.gz: 07dded169cb4a67d56cad26c7f39ead9c3118dfa
 SHA512:
-  metadata.gz: 39ff00165434c67e13ae7b72fa5cb90c4991530ab5005059d0c7f64c118c62a55b7be3cc60d147f44536bbf710934a4c7c455c248f205e75c7ca87730451fe41
-  data.tar.gz: aa990339b0f3ef6b949231ad2d5efd27eb5218f2e6ccd525a4413a8e421a84d480c3579a11a2bb5e89be862f6483e45130b396f3d66cdb71c1c99f075d695146
+  metadata.gz: 541565fcca55aaa6253a29bc437f3350ea4376514da88c13ae1efad1ed2c5d8eff7449949136d406a336d3ee0d36b9c7468e21d63044f6f83bc0af38018153a4
+  data.tar.gz: 31fb64ab71c6973d79a92d706ce2328016db9e9f36c9364eba715838088a0f3e631c6ba6a4624c68c04b9d31db6977d03cbfeb778eee8f74da8e8e48f2a7b83c

data/lib/inkcite/email.rb

@@ -49,7 +49,14 @@ module Inkcite
       meta_data[key.to_sym]
     end
 
+    # Optimizes this email's images if optimize-images is enabled
+    # in the email configuration.
     def optimize_images
+      optimize_images! if optimize_images?
+    end
+
+    # Optimizes all of the images in this email.
+    def optimize_images!
       Minifier.images(self)
     end
 
@@ -63,23 +70,6 @@ module Inkcite
       File.join(path, optimize_images?? Minifier::IMAGE_CACHE : IMAGES)
     end
 
-    def properties
-
-      opts = {
-        :n => NEW_LINE
-      }
-
-      # Load the project's properties, which may include references to additional
-      # properties in other directories.
-      read_properties opts, 'helpers.tsv'
-
-      # As a convenience pre-populate the month name of the email.
-      mm = opts[:mm].to_i
-      opts[:month] = Date::MONTHNAMES[mm] if mm > 0
-
-      opts
-    end
-
     def project_file file
       File.join(path, file)
     end
@@ -115,12 +105,9 @@ module Inkcite
       raise "Unknown format \"#{format}\" - must be one of #{FORMATS.join(',')}" unless FORMATS.include?(format)
       raise "Unknown version: \"#{version}\" - must be one of #{versions.join(',')}" unless versions.include?(version)
 
-      opt = properties
-      opt.merge!(self.config)
-
       # Instantiate a new view of this email with the desired view and
       # format.
-      View.new(self, environment, format, version, opt)
+      View.new(self, environment, format, version)
 
     end
 
@@ -151,16 +138,6 @@ module Inkcite
     META_FILE_NAME = :'meta-file'
     META_FILE      = '.inkcite'
 
-    COMMENT         = '//'
-    NEW_LINE        = "\n"
-    TAB             = "\t"
-    CARRIAGE_RETURN = "\r"
-
-    # Used for
-    MULTILINE_START = "<<-START"
-    MULTILINE_END = "END->>"
-    TAB_TO_SPACE = '  '
-
     def meta_data
       Util.read_yml(File.join(path, meta_file_name), false)
     end
@@ -169,51 +146,5 @@ module Inkcite
       config[META_FILE_NAME] || META_FILE
     end
 
-    def read_properties into, file
-
-      fp = File.join(path, file)
-      abort("Can't find #{file} in #{path} - are you sure this is an Inkcite project?") unless File.exists?(fp)
-
-      # Consolidate line-breaks for simplicity
-      raw = File.read(fp)
-      raw.gsub!(/[\r\f\n]{1,}/, NEW_LINE)
-
-      # Initial position of the
-      multiline_starts_at = 0
-
-      # Determine if there are any multiline declarations - those that are wrapped with
-      # <<-START and END->> and reduce them to single line declarations.
-      while (multiline_starts_at = raw.index(MULTILINE_START, multiline_starts_at))
-
-        break unless (multiline_ends_at = raw.index(MULTILINE_END, multiline_starts_at))
-
-        declaration = raw[(multiline_starts_at+MULTILINE_START.length)..multiline_ends_at - 1]
-        declaration.strip!
-        declaration.gsub!(/\t/, TAB_TO_SPACE)
-        declaration.gsub!(/\n/, "\r")
-
-        raw[multiline_starts_at..multiline_ends_at+MULTILINE_END.length - 1] = declaration
-
-      end
-
-      raw.split(NEW_LINE).each do |line|
-        next if line.starts_with?(COMMENT)
-
-        line.gsub!(/\r/, NEW_LINE)
-        line.strip!
-
-        key, open, close = line.split(TAB)
-        next if key.blank?
-
-        into[key.to_sym] = open.to_s.freeze
-
-        # Prepend the key with a "/" and populate the closing tag.
-        into["/#{key}".to_sym] = close.to_s.freeze
-
-      end
-
-      true
-    end
-
   end
 end

data/lib/inkcite/version.rb

@@ -1,3 +1,3 @@
 module Inkcite
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/inkcite/view.rb

@@ -38,15 +38,20 @@ module Inkcite
     attr_accessor :css_compressor
     attr_accessor :js_compressor
 
-    def initialize email, environment, format, version, config
+    def initialize email, environment, format, version
       @email = email
       @environment = environment
       @format = format
       @version = version
 
-      # TODO Read this ourselves and run it through Erubis for better
-      # a/b testing capabilities
-      @config = config
+      # Read the helper(s) for this view of the email.  This will load
+      # the default helpers.tsv and any version-specific (e.g. returning-customer.tsv)
+      # helper allowing for overrides.
+      @config = load_helpers
+
+      # Merge in the email's configuration for convience - providing access
+      # to the renderers.
+      @config.merge!(email.config)
 
       # Expose the version, format as a properties so that it can be resolved when
       # processing pathnames and such.  These need to be strings because they are
@@ -468,6 +473,7 @@ module Inkcite
     NEW_LINE        = "\n"
     REGEX_SLASH     = '/'
     SOURCE_ENCODING = :'source-encoding'
+    TAB             = "\t"
     TXT_EXTENSION   = '.txt'
     UTF_8           = 'utf-8'
 
@@ -481,6 +487,21 @@ module Inkcite
     # Used when there is no subject or title for this email.
     UNTITLED_EMAIL = 'Untitled Email'
 
+    # Used to denote the start and end of a multi-line helper entry. e.g.
+    # feature-story <<-START
+    #   I'm a multiline helper where line breaks and indendentation
+    #   can be used to make the helper file more readable, debuggable.
+    # END->>
+    MULTILINE_START = "<<-START"
+    MULTILINE_END = "END->>"
+
+    # Tabs within a multiline helper are converted to spaces.
+    TAB_TO_SPACE = '  '
+
+    # Used to mark a helper.tsv line as a comment.
+    COMMENT = '//'
+
+
     def assert_in_browser msg
       raise msg if email? && !development?
     end
@@ -679,6 +700,78 @@ module Inkcite
       html.join(NEW_LINE)
     end
 
+    def load_helper_file filename, into, abort_on_fail=true
+
+      path = @email.path
+      file = File.join(path, filename)
+      unless File.exists?(file)
+        abort("Can't find #{filename} in #{path} - are you sure this is an Inkcite project?") if abort_on_fail
+        return
+      end
+
+      # Consolidate line-breaks for simplicity
+      raw = File.read(file)
+      raw.gsub!(/[\r\f\n]{1,}/, NEW_LINE)
+
+      # Initial position of the
+      multiline_starts_at = 0
+
+      # Determine if there are any multiline declarations - those that are wrapped with
+      # <<-START and END->> and reduce them to single line declarations.
+      while (multiline_starts_at = raw.index(MULTILINE_START, multiline_starts_at))
+
+        break unless (multiline_ends_at = raw.index(MULTILINE_END, multiline_starts_at))
+
+        declaration = raw[(multiline_starts_at+MULTILINE_START.length)..multiline_ends_at - 1]
+        declaration.strip!
+        declaration.gsub!(/\t/, TAB_TO_SPACE)
+        declaration.gsub!(/\n/, "\r")
+
+        raw[multiline_starts_at..multiline_ends_at+MULTILINE_END.length - 1] = declaration
+
+      end
+
+      raw.split(NEW_LINE).each do |line|
+        next if line.starts_with?(COMMENT)
+
+        line.gsub!(/\r/, NEW_LINE)
+        line.strip!
+
+        key, open, close = line.split(TAB)
+        next if key.blank?
+
+        into[key.to_sym] = open.to_s.freeze
+
+        # Prepend the key with a "/" and populate the closing tag.
+        into["/#{key}".to_sym] = close.to_s.freeze
+
+      end
+
+      true
+    end
+
+    # Reads the helpers.tsv and any version-specific override (e.g. helpers-owners.tsv)
+    def load_helpers
+
+      _helpers = {
+        :n => NEW_LINE
+      }
+
+      # Load the project's properties, which may include references to additional
+      # properties in other directories.
+      load_helper_file 'helpers.tsv', _helpers
+
+      # Look for a version-specific override allowing restyling of an email based
+      # on its version - e.g. difference colors in the "no orders for 30 days" email.
+      load_helper_file "helpers-#{@version}.tsv", _helpers, false
+
+      # As a convenience pre-populate the month name of the email.
+      mm = _helpers[:mm].to_i
+      _helpers[:month] = Date::MONTHNAMES[mm] if mm > 0
+
+      _helpers
+    end
+
     # Retrieves the version-specific meta data for this view.
     def meta_data
       @email.meta version

data/test/email_spec.rb

@@ -8,9 +8,4 @@ describe Inkcite::Email 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/view_spec.rb

@@ -12,4 +12,9 @@ describe Inkcite::View do
     Inkcite::Renderer.fix_illegal_characters('“That’s what she said!”', @view).must_equal('“That’s what she said!”')
   end
 
+  it 'supports multi-line property declarations' do
+    @view[:multiline].must_equal("This\n    is a\n      multiline tag.")
+    @view[:'/multiline'].must_equal("This\n    ends the\n  multiline tag.")
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inkcite
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeffrey D. Hoffman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport