html_email_creator 1.0.10 → 1.0.13

data/lib/html_email_creator/callbacks.rb

@@ -0,0 +1,16 @@
+module HtmlEmailCreator
+  
+  # Mail creation consists of many steps. This is a place where you coordinate additional steps.
+  # In the future you may even register callbacks to your plugins if that feture is needed.
+  class Callbacks
+    
+    def initialize(settings = HtmlEmailCreator.settings)
+      @settings = settings
+    end
+    
+    def html_created(html)
+      HtmlEmailCreator::Extensions.new.process_html(html, *@settings.built_in_extensions)
+    end
+    
+  end
+end

data/lib/html_email_creator/extensions.rb

@@ -27,11 +27,12 @@ module HtmlEmailCreator
         'unsubscribe_url' => '*|UNSUBSCRIBE|*'
       }
     }
-    
-    def initialize(settings = HtmlEmailCreator.settings)
-      @settings = settings
+
+    # This is a mechanism for handling HTML email for certain extension
+
+    def initialize()
     end
-    
+
     def built_in(*extensions)
       new_data = {}
       extensions.flatten.each do |extension|
@@ -40,7 +41,7 @@ module HtmlEmailCreator
       end
       new_data
     end
-    
+
     def custom(data = {}, extensions)
       new_data = {}
       extensions.each_pair do |key, value|
@@ -48,5 +49,30 @@ module HtmlEmailCreator
       end
       new_data
     end
+
+    # HTML callback after the HTML is created.
+    def process_html(html, *extensions)
+      processed_html = html.dup
+
+      extensions.each do |extension|
+        method_name = "process_html_for_#{extension}".to_sym
+
+        if self.respond_to?(method_name)
+          processed_html = self.send(method_name, html)
+        end
+      end
+
+      processed_html
+    end
+
+    protected
+
+    def process_html_for_aweber(html)
+      html.gsub(/%7B/, '{').gsub(/%7D/, '}').gsub(/!global%20/, '!global ')
+    end
+
+    def process_html_for_mailchimp(html)
+      html.gsub(/\*%7C/, '*|').gsub(/%7C\*/, '|*')
+    end
   end
 end

data/lib/html_email_creator/processor.rb

@@ -5,7 +5,7 @@ require 'inline-style'
 
 module HtmlEmailCreator
   class Processor
-    def initialize(email_string, settings = HtmlEmailCreator.settings)
+    def initialize(email_string, settings = HtmlEmailCreator::settings)
       @email = email_string
       @settings = settings
     end
@@ -41,14 +41,9 @@ module HtmlEmailCreator
 
       html_email = doc.to_html
       
-      inlined_html_email = InlineStyle.process(html_email)
-      
-      # Then remove escaping of Aweber templates
-      @processed_html_email = if @settings.built_in_extensions.include?("aweber")
-        inlined_html_email.gsub(/%7B/, '{').gsub(/%7D/, '}').gsub(/!global%20/, '!global ')
-      else
-        inlined_html_email
-      end
+      # process and then call callback
+      inlined_html_email = InlineStyle.process(html_email)  
+      HtmlEmailCreator::callbacks(@settings).html_created(inlined_html_email)
     end
     
     def to_plain_text

data/lib/html_email_creator/settings.rb

@@ -43,7 +43,7 @@ module HtmlEmailCreator
 
     def extension_data
       return @extension_data if @extension_data
-      extensions = HtmlEmailCreator::Extensions.new(self)
+      extensions = HtmlEmailCreator::Extensions.new
       built_in_data = extensions.built_in(built_in_extensions)
       # use built in data for creating custom data
       custom_data = extensions.custom(built_in_data, custom_extensions)
@@ -53,7 +53,7 @@ module HtmlEmailCreator
     def built_in_extensions
       (@config["extensions"] || {})["built_in"] || []
     end
-
+    
     private
 
     def custom_extensions

data/lib/html_email_creator/version.rb

@@ -1,3 +1,3 @@
 module HtmlEmailCreator
-  VERSION = "1.0.10" unless defined?(::HtmlEmailCreator::VERSION)
+  VERSION = "1.0.13" unless defined?(::HtmlEmailCreator::VERSION)
 end

data/lib/html_email_creator.rb

@@ -11,6 +11,7 @@ require_all 'html_email_creator/formatters'
 
 module HtmlEmailCreator
   
+  autoload :Callbacks, "html_email_creator/callbacks"
   autoload :Email, "html_email_creator/email"
   autoload :EmailCreator, "html_email_creator/email_creator"
   autoload :EmailVersion, "html_email_creator/email_version"
@@ -32,6 +33,10 @@ module HtmlEmailCreator
       Dir.pwd
     end
     
+    def callbacks(current_settings = settings)
+      Callbacks.new(current_settings)
+    end
+    
     def settings
       @settings ||= read_settings(current_dir)
     end

data/spec/fixtures/with_mailchimp_config/.html_config.yaml

@@ -0,0 +1,11 @@
+layouts_path: "Layouts"
+output_path: "Output"
+emails_path: "Emails"
+includes_path: "Includes"
+cdn_url: "http://cdn.example.com"
+extensions:
+  built_in:
+    - "mailchimp"
+  custom:
+    foobar: "Hi, this is foobar."
+    great: "Hi, this is **great**"

data/spec/fixtures/with_mailchimp_config/Emails/first_email.yaml

@@ -0,0 +1,7 @@
+config:
+  output: "first"
+  layout: "simple.liquid"
+  data:
+    first_content: "{% include 'Emails/foobar.md' %}"
+    second_content: "{% include 'Emails/barfoo.md' %}"
+    third_content: "{{ 'foo/bar' | photo: 'alt text' }}"

data/spec/fixtures/with_mailchimp_config/Includes/Emails/barfoo.md

@@ -0,0 +1 @@
+bar foo

data/spec/fixtures/with_mailchimp_config/Includes/Emails/foobar.md

@@ -0,0 +1 @@
+foo bar

data/spec/fixtures/with_mailchimp_config/Includes/Quotes/henry_ford.txt

@@ -0,0 +1 @@
+A bore is a person who opens his {{ what }} and puts his feats in it.

data/spec/fixtures/with_mailchimp_config/Layouts/simple.liquid

@@ -0,0 +1,7 @@
+This is simple template.
+
+{{ first_content }}
+
+{{ second_content }}
+
+{{ third_content }}

data/spec/html_email_creator/processor_spec.rb

@@ -90,22 +90,31 @@ eos
     end
   end
 
-  describe "aweber escaping" do
-    it "should not escape aweber markup if using aweber extension" do
-      html = <<-eos
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<body>
-<p>{!date dayname+7}</p>
-</body>
-</html>
-eos
-
+  describe "Character unescaping" do
+    html = <<-eos
+    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+    <html>
+    <body>
+    <p>%7B!date dayname+7%7D *%7CFNAME%7C*</p>
+    </body>
+    </html>
+    eos
+
+    it "should unescape Aweber markup if using Aweber extension" do
       run_in_fixture_dir("with_config") do
         processor = HtmlEmailCreator::Processor.new(html)
-        processor.to_html.should include("<p>{!date dayname+7}</p>")
-        processor.to_plain_text.should include("{!date dayname+7}")
+        processor.to_html.should include("<p>{!date dayname+7} *%7CFNAME%7C*</p>")
+        processor.to_plain_text.should include("{!date dayname+7} *%7CFNAME%7C*")
+      end
+    end
+
+    it "should unescape Mailchimp markup if using Mailchimp extension" do
+      run_in_fixture_dir("with_mailchimp_config") do
+        processor = HtmlEmailCreator::Processor.new(html)
+        processor.to_html.should include("<p>%7B!date dayname+7%7D *|FNAME|*</p>")
+        processor.to_plain_text.should include("%7B!date dayname+7%7D *|FNAME|*")
       end
     end
+
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 10
-  version: 1.0.10
+  - 13
+  version: 1.0.13
 platform: ruby
 authors: 
 - Pekka Mattila
@@ -137,6 +137,7 @@ files:
 - bin/html_email_creator
 - html_email_creator.gemspec
 - lib/html_email_creator.rb
+- lib/html_email_creator/callbacks.rb
 - lib/html_email_creator/email.rb
 - lib/html_email_creator/email_creator.rb
 - lib/html_email_creator/email_version.rb
@@ -175,6 +176,14 @@ files:
 - spec/fixtures/with_config/Layouts/.keep
 - spec/fixtures/with_config/Layouts/simple.liquid
 - spec/fixtures/with_config/Output/.keep
+- spec/fixtures/with_mailchimp_config/.html_config.yaml
+- spec/fixtures/with_mailchimp_config/Emails/first_email.yaml
+- spec/fixtures/with_mailchimp_config/Includes/Emails/barfoo.md
+- spec/fixtures/with_mailchimp_config/Includes/Emails/foobar.md
+- spec/fixtures/with_mailchimp_config/Includes/Quotes/henry_ford.txt
+- spec/fixtures/with_mailchimp_config/Layouts/.keep
+- spec/fixtures/with_mailchimp_config/Layouts/simple.liquid
+- spec/fixtures/with_mailchimp_config/Output/.keep
 - spec/html_email_creator/email_creator_spec.rb
 - spec/html_email_creator/email_spec.rb
 - spec/html_email_creator/formatter_spec.rb
@@ -238,6 +247,14 @@ test_files:
 - spec/fixtures/with_config/Layouts/.keep
 - spec/fixtures/with_config/Layouts/simple.liquid
 - spec/fixtures/with_config/Output/.keep
+- spec/fixtures/with_mailchimp_config/.html_config.yaml
+- spec/fixtures/with_mailchimp_config/Emails/first_email.yaml
+- spec/fixtures/with_mailchimp_config/Includes/Emails/barfoo.md
+- spec/fixtures/with_mailchimp_config/Includes/Emails/foobar.md
+- spec/fixtures/with_mailchimp_config/Includes/Quotes/henry_ford.txt
+- spec/fixtures/with_mailchimp_config/Layouts/.keep
+- spec/fixtures/with_mailchimp_config/Layouts/simple.liquid
+- spec/fixtures/with_mailchimp_config/Output/.keep
 - spec/html_email_creator/email_creator_spec.rb
 - spec/html_email_creator/email_spec.rb
 - spec/html_email_creator/formatter_spec.rb