html_email_creator 1.0.0

data/lib/html_email_creator/formatters/html_email.rb

@@ -0,0 +1,24 @@
+require 'kramdown'
+
+module HtmlEmailCreator
+  module Formatters
+    class HtmlEmail < Formatter
+      def self.extension
+        "html"
+      end
+      
+      def self.id
+        :html_email
+      end  
+      
+      def initialize(html, settings)
+        super
+        @processor = HtmlEmailCreator::Processor.new(html, settings)
+      end
+  
+      def format
+        @output ||= @processor.to_html
+      end
+    end
+  end
+end

data/lib/html_email_creator/formatters/markdown.rb

@@ -0,0 +1,24 @@
+require 'kramdown'
+
+module HtmlEmailCreator
+  module Formatters
+    class Markdown < Formatter
+      def self.extension
+        "md"
+      end
+      
+      def self.id
+        :md
+      end
+
+      def initialize(text, settings)
+        super
+        @document = Kramdown::Document.new(text)
+      end
+  
+      def format
+        @output ||= @document.to_html.strip
+      end
+    end
+  end
+end

data/lib/html_email_creator/formatters/plain_text_email.rb

@@ -0,0 +1,22 @@
+module HtmlEmailCreator
+  module Formatters
+    class PlainTextEmail < Formatter
+      def self.extension
+        "txt"
+      end
+
+      def self.id
+        :plain_text_email
+      end
+      
+      def initialize(html, settings)
+        super
+        @processor = HtmlEmailCreator::Processor.new(html, settings)
+      end
+  
+      def format
+        @output ||= @processor.to_plain_text
+      end
+    end
+  end
+end

data/lib/html_email_creator/formatters/unknown_formatter.rb

@@ -0,0 +1,17 @@
+module HtmlEmailCreator
+  module Formatters
+    class UnknownFormatter < Formatter
+      def self.extension
+        "txt"
+      end
+
+      def self.id
+        :unknown
+      end
+      
+      def initialize(text, settings = HtmlEmailCreator.settings)
+        super
+      end
+    end
+  end
+end

data/lib/html_email_creator/helper.rb

@@ -0,0 +1,25 @@
+module HtmlEmailCreator
+  
+  module Helper
+    
+    class << self
+      
+      # Find recursively starting from start_from_dir and continues towards a root.
+      def find_recursively(start_from_dir, dir_or_file, default_if_not_found = nil)
+        current_file = File.join(start_from_dir, dir_or_file)
+        if File.exists?(current_file)
+          current_file
+        else
+          next_file = File.dirname(start_from_dir)
+          if start_from_dir == next_file
+            return default_if_not_found
+          end
+        
+          # continue searching
+          find_recursively(next_file, dir_or_file, default_if_not_found)
+        end
+      end
+      
+    end    
+  end
+end

data/lib/html_email_creator/information.rb

@@ -0,0 +1,4 @@
+module HtmlEmailCreator
+  SUMMARY = "An easy way to create HTML and plain text emails!"
+  DESCRIPTION = "An easy way to create HTML and plain text emails using Markdown markup and Liquid layouts." unless defined?(::HtmlEmailCreator::DESCRIPTION)
+end

data/lib/html_email_creator/layout.rb

@@ -0,0 +1,15 @@
+require "liquid"
+
+module HtmlEmailCreator
+  class Layout
+    def initialize(text, default_data = HtmlEmailCreator.settings.extension_data)
+      @text = text
+      @template = Liquid::Template.parse(text)
+      @default_data = default_data
+    end
+        
+    def to_html(data = {}, *filters)
+      @template.render(@default_data.merge(data), :filters => [HtmlEmailCreator::Filters] + filters)
+    end
+  end
+end

data/lib/html_email_creator/processor.rb

@@ -0,0 +1,125 @@
+require 'nokogiri'
+require 'inline-style'
+
+module HtmlEmailCreator
+  class Processor
+    def initialize(email_string, settings = HtmlEmailCreator.settings)
+      @email = email_string
+      @settings = settings
+    end
+    
+    def original_email
+      @email
+    end
+
+    def to_html
+      return @processed_html_email if @processed_html_email
+      
+      doc = Nokogiri::HTML(@email)
+      headers = ["h1", "h2", "h3", "h4", "h5"]
+
+      # wrap headers with div
+
+      headers.each do |hx|
+        nodes = doc.css hx
+        nodes.wrap("<div class='#{hx}'></div>")
+      end
+
+      # replace headers with divs
+
+      headers.each do |hx|
+        doc.css(hx).each { |h| h.name = "div" }
+      end
+
+      # replace paragraphs with divs
+
+      #doc.css("p").each { |p| p.name = "div" }
+
+      # store file
+
+      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
+    end
+    
+    def to_plain_text
+      return @processed_plain_text_email if @processed_plain_text_email
+      
+      doc = Nokogiri::HTML(to_html)
+      doc.css('style').each { |node| node.remove }
+      doc.css('title').each { |node| node.remove }
+      doc.css('script').each { |node| node.remove }
+      doc.css('link').each { |node| node.remove }
+      doc.css('a').each do |node|
+        img = node.at_css('img')
+        node.content = if img
+          "#{img['alt']} (#{node['href']})"
+        else
+          "#{node.content} (#{node['href']})"
+        end
+      end
+      doc.css('img').each do |node|
+        node.content = "#{node['alt']} (#{node['src']})"
+      end
+      doc.css('strong').each do |node| 
+        node.content = "*#{node.content}*"
+      end
+      doc.css('li').each { |node| node.content = "- #{node.content.strip}" }
+
+      # format all content that must have an empty line on top of them
+
+      doc.css('div.h1 div').each do |node| 
+        node.content = "\n#{'=' * 77}\n#{node.content}"
+      end
+      doc.css('div.h2 div').each do |node| 
+        node.content = "\n#{'-' * 77}\n#{node.content}"
+      end
+      doc.css('div.h3 div').each do |node| 
+        node.content = "\n#{'- ' * 39}\n#{node.content}"
+      end
+      doc.css('div.h4 div').each do |node| 
+        node.content = "\n#{node.content}"
+      end
+      doc.css('p').each do |node| 
+        node.content = "\n#{node.content}"
+      end 
+
+      doc.css('table.inline').each do |table|
+        content = []
+        table.css('tr').each do |row|
+          # each_index method is missing
+          i = 0
+          row.css('td').each do |column|
+            empty_column = column.content.strip.gsub(/^\p{Space}+|\p{Space}+$/, "").empty?
+            if content[i]
+              content[i] = content[i] + "\n* #{column.content}" unless empty_column
+            else
+              content[i] = "\n#{column.content}" unless empty_column
+            end
+            i = i + 1
+          end
+        end
+
+        table.content = "#{content.join("\n")}\n"
+      end
+
+      # remove unnecessary whitespaces and empty lines
+      previous = ""
+      @processed_plain_text_email = doc.css('body').text.split("\n").map do |line|
+        # Nokogiri uses UTF-8 whitespace character for &nbsp and strip doesn't support those
+        res = line.gsub(/^\p{Space}+|\p{Space}+$/, "")
+        new_previous = res
+        res = nil if res.empty? && previous.empty?
+        previous = new_previous
+        res
+      end.compact.join("\n")
+    end
+  end
+end

data/lib/html_email_creator/settings.rb

@@ -0,0 +1,95 @@
+module HtmlEmailCreator
+  class Settings
+
+    # Create settings configuration file.
+    # 
+    # If the root is not set, the configuration is not searched from the file system
+    # but instead the defaults are used.
+    def initialize(root = nil)
+      @root = root
+      @root ||= File.expand_path('~')
+      @config = create_configuration      
+    end
+
+    def layouts_path
+      @config["layouts_path"]
+    end
+
+    def output_path
+      @config["output_path"]
+    end
+
+    def emails_path
+      @config["emails_path"]
+    end
+    
+    def includes_path
+      @config["includes_path"]
+    end
+
+    def cdn_url
+      @config["cdn_url"]
+    end
+
+    def extension_data
+      return @extension_data if @extension_data
+      extensions = HtmlEmailCreator::Extensions.new(self)
+      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)
+      @extension_data = built_in_data.merge(custom_data)
+    end
+
+    def built_in_extensions
+      (@config["extensions"] || {})["built_in"] || []
+    end
+    
+    private
+
+    def custom_extensions
+      (@config["extensions"] || {})["custom"] || {}
+    end
+
+    def create_configuration
+      config_file = find_config_file
+      if config_file
+        config_root_dir = File.dirname(config_file)
+        loaded_config = YAML.load_file(config_file)
+        # fill missing values with defaults if missing
+        default_config.each_pair do |key, value|          
+          loaded_config[key] = value unless loaded_config[key]
+        end
+        
+        # make absolute paths if is relative for all _path ending keys
+        loaded_config.each_pair do |key, value|
+          if key.match(/_path$/) && !value.match(/^\//)
+            loaded_config[key] = File.join(config_root_dir, value)
+          end
+        end
+        
+        loaded_config
+      else
+        default_config
+      end
+    end
+    
+    def default_config
+      {
+        "layouts_path" => find_dir("Layouts"),
+        "output_path" => find_dir("Output"),
+        "emails_path" => find_dir("Emails"),
+        "includes_path" => find_dir("Includes"),
+        "cdn_url" => "",
+        "extensions" => {}
+      }
+    end
+    
+    def find_dir(dir)
+      HtmlEmailCreator::Helper.find_recursively(@root, dir, File.join(@root, dir))
+    end
+              
+    def find_config_file
+      HtmlEmailCreator::Helper.find_recursively(@root, ".html_config.yaml")
+    end
+  end
+end

data/lib/html_email_creator/tags/include_tag.rb

@@ -0,0 +1,71 @@
+require 'liquid'
+
+module HtmlEmailCreator
+
+  class IncludeTag < Liquid::Tag
+    Syntax = /(#{Liquid::QuotedFragment}+)(\s+(?:with|for)\s+(#{Liquid::QuotedFragment}+))?/
+
+    def initialize(tag_name, markup, tokens)
+      if markup =~ Syntax
+
+        @template_name = $1
+        @variable_name = $3
+        @attributes    = {}
+
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          @attributes[key] = value
+        end
+
+      else
+        raise SyntaxError.new("Error in tag 'include' - Valid syntax: include '[template]' (with|for) [object|collection]")
+      end
+
+      super
+    end
+
+    def parse(tokens)
+    end
+
+    def render(context)
+      settings = find_settings(context)
+      source = read_template_from_file_system(context, settings)
+      partial = Liquid::Template.parse(source)
+      variable = context[@variable_name || @template_name[1..-2]]
+
+      context.stack do
+        @attributes.each do |key, value|
+          context[key] = context[value]
+        end
+
+        if variable.is_a?(Array)
+          variable.collect do |variable|
+            context[@template_name[1..-2]] = variable
+            partial.render(context)
+          end
+        else
+          context[@template_name[1..-2]] = variable
+          partial.render(context)
+        end
+      end
+    end
+
+    private
+
+    def find_settings(context)
+      (context.registers[:settings] || HtmlEmailCreator.settings)
+    end
+
+    def read_template_from_file_system(context, settings)
+      template = File.join(settings.includes_path, context[@template_name])
+      if File.exists?(template)
+        # run through a formatter
+        formatter = HtmlEmailCreator::Formatter.new(IO.read(template), settings)
+        formatter.find_by_filename(template).format
+      else
+        "Included file '#{template}' not found."
+      end
+    end
+  end
+
+  Liquid::Template.register_tag('include', IncludeTag)
+end

data/lib/html_email_creator/version.rb

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

data/lib/html_email_creator.rb

@@ -0,0 +1,46 @@
+def require_all(path)
+  glob = File.join(File.dirname(__FILE__), path, '*.rb')
+  Dir[glob].each do |f|
+    require f
+  end
+end
+
+require_all 'html_email_creator/tags'
+require_all 'html_email_creator/formatters'
+
+module HtmlEmailCreator
+  
+  autoload :Email, "html_email_creator/email"
+  autoload :EmailCreator, "html_email_creator/email_creator"
+  autoload :EmailVersion, "html_email_creator/email_version"
+  autoload :Extensions, "html_email_creator/extensions"
+  autoload :Filters, 'html_email_creator/filters'
+  autoload :Formatter, 'html_email_creator/formatter'
+  autoload :Helper, 'html_email_creator/helper'
+  autoload :Layout, 'html_email_creator/layout'
+  autoload :Markdown, 'html_email_creator/markdown'
+  autoload :Processor, 'html_email_creator/processor'
+  autoload :Renderer, 'html_email_creator/renderer'
+  autoload :Settings, 'html_email_creator/settings'
+  autoload :Version, 'html_email_creator/version'
+
+  class << self
+    attr_writer :settings    
+        
+    def current_dir
+      Dir.pwd
+    end
+    
+    def settings
+      @settings ||= read_settings(current_dir)
+    end
+    
+    def update_settings(from_email_dir = current_dir)
+      @settings = read_settings(from_email_dir)
+    end
+    
+    def read_settings(dir)
+      Settings.new(dir)
+    end
+  end
+end