html_email_creator 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in html_email_creator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    html_email_creator (0.0.1)
+      commander (>= 4.0.6)
+      inline-style (>= 0.5.0)
+      kramdown (>= 0.13.3)
+      liquid (>= 2.3.0)
+      nokogiri (>= 1.5.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    commander (4.0.6)
+      highline (~> 1.5.0)
+    css_parser (1.2.5)
+      addressable
+    diff-lcs (1.1.3)
+    facets (2.9.2)
+    ffi (1.0.10)
+    highline (1.5.2)
+    inline-style (0.5.0)
+      css_parser
+      facets
+      maca-fork-csspool
+      nokogiri
+    kramdown (0.13.3)
+    liquid (2.3.0)
+    maca-fork-csspool (2.0.2)
+      ffi
+    nokogiri (1.5.0)
+    rake (0.9.2.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  html_email_creator!
+  rake (>= 0.9.2)
+  rspec

data/README.markdown

@@ -0,0 +1,5 @@
+# HTML Email Creator
+
+## Writing Emails
+
+http://kramdown.rubyforge.org/syntax.html

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/html_email_creator

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'html_email_creator'
+require 'html_email_creator/version'
+require 'html_email_creator/information'
+
+# :name is optional, otherwise uses the basename of this executable
+program :name, 'HTML Email Creator'
+program :version, HtmlEmailCreator::VERSION
+program :description, HtmlEmailCreator::DESCRIPTION
+
+command :create do |c|
+  c.syntax = 'html_email_creator create <email or directory>'
+  c.description = 'Creates a single email or all emails from the directory'
+  c.option '--recursive', 'If creating directory, find from sub directories too.'
+  c.action do |args, options|
+    # TODO implement me
+    recursive = options.recursive ? true : false
+    full_path = File.expand_path(args.first)
+    # run in this directory
+    Dir.chdir(File.dirname(full_path))
+    results = HtmlEmailCreator::EmailCreator.new.save_emails(full_path, recursive)
+    say "Creation completed!\n\n"
+    results.each_pair do |file, format|
+      say "#{file}:"
+      say "  Output:"
+      format.values.each do |output|
+
+        say "    #{output}"
+      end
+    end
+    say "\nHave a nice day :)"
+  end
+end

data/html_email_creator.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'html_email_creator/version'
+require 'html_email_creator/information'
+
+Gem::Specification.new do |s|
+  s.platform           = Gem::Platform::RUBY
+  s.name               = "html_email_creator"
+  s.version            = HtmlEmailCreator::VERSION
+  s.summary            = HtmlEmailCreator::SUMMARY
+  s.description        = HtmlEmailCreator::DESCRIPTION
+  s.default_executable = "html_email_creator"
+
+  s.required_ruby_version = '>= 1.9.2'
+  s.rubygems_version      = ">= 1.3.6"
+  s.rubyforge_project     = "html_email_creator"
+  
+  s.author   = 'Pekka Mattila'
+  s.email    = 'pekka.mattila@gmail.com'
+  s.homepage = 'https://github.com/pekkaj/HTML-Email-Creator'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # Runtime Dependencies
+
+  s.add_runtime_dependency "commander", ">= 4.0.6"
+  s.add_runtime_dependency "kramdown", ">= 0.13.3"
+  s.add_runtime_dependency "liquid", ">= 2.3.0"
+  s.add_runtime_dependency "nokogiri", ">= 1.5.0"
+  s.add_runtime_dependency "inline-style", ">= 0.5.0"
+  
+  # Development Dependencies
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake", ">= 0.9.2"
+end

data/lib/html_email_creator/email.rb

@@ -0,0 +1,93 @@
+require "liquid"
+
+module HtmlEmailCreator
+  class Email
+    attr_reader :settings
+    
+    def self.find_emails(file_or_directory, recursively = false)
+      if File.directory?(file_or_directory)
+        if recursively
+          Dir.glob(File.join(file_or_directory, "**", "*.yaml"))
+        else
+          Dir.glob(File.join(file_or_directory, "*.yaml"))
+        end
+      else
+        return [] unless File.extname(file_or_directory) == ".yaml"
+        [file_or_directory]
+      end
+    end
+
+    def initialize(configuration, settings = HtmlEmailCreator.settings)
+      @settings = settings
+      @configuration = create_configuration(configuration)
+    end
+
+    # Renders emails using configuration. Returns Hash[format, EmailVersion].
+    def render_all
+      # render only once
+      return @versions if @versions
+
+      @versions = {}
+      output_formats.each do |format|
+        @versions[format] = render_only(format)
+      end
+      @versions
+    end
+    
+    # Renders email in a specific format
+    def render_only(format)
+      formatter = HtmlEmailCreator::Formatter.new(rendered_email, @settings).find(format)
+      HtmlEmailCreator::EmailVersion.new(formatter, output_basename, @settings)
+    end
+    
+    # Convenience method for rendering HTML email.
+    def render_html_email
+      render_only(HtmlEmailCreator::Formatters::HtmlEmail.id)
+    end
+    
+    # Convenience method for rendering plain text email.
+    def render_plain_text_email
+      render_only(HtmlEmailCreator::Formatters::PlainTextEmail.id)
+    end
+    
+    private
+
+    def rendered_email
+      @email ||= HtmlEmailCreator::Layout.new(fill_blanks(IO.read(layout_path)), settings.extension_data).to_html
+    end
+
+    def output_formats
+      @configuration["output_formats"]
+    end
+
+    def create_configuration(configuration)
+      config_hash = if configuration.kind_of?(String)
+        YAML.load_file(configuration)
+      else
+        configuration
+      end
+      
+      defaults = {
+        "output_formats" => ["plain_text_email", "html_email"]
+      }
+      
+      config_hash.merge(defaults)
+    end
+    
+    def output_basename
+      @configuration["config"]["output"]
+    end
+    
+    def layout_path
+      File.join(@settings.layouts_path, @configuration["config"]["layout"])
+    end
+    
+    def fill_blanks(layout)
+      filled_layout = layout.dup
+      @configuration["config"]["data"].each_pair do |key, value|
+        filled_layout.gsub!(/\{\{\s*#{key}\s*\}\}/, value)
+      end
+      filled_layout
+    end
+  end
+end

data/lib/html_email_creator/email_creator.rb

@@ -0,0 +1,45 @@
+module HtmlEmailCreator
+  class EmailCreator
+    def create_email(file_or_configuration, format)
+      email(file_or_configuration).render_only(format)
+    end
+
+    def create_html_email(file_or_configuration)
+      email(file_or_configuration).render_html_email
+    end
+
+    def create_plain_text_email(file_or_configuration)
+      email(file_or_configuration).render_plain_text_email
+    end
+
+    def create_all_email_versions(file_or_configuration)
+      email(file_or_configuration).render_all
+    end
+
+    def save_email(file_or_configuration)
+      formats_and_paths = {}
+      create_all_email_versions(file_or_configuration).each_value do |version|
+        formats_and_paths[version.id] = version.save
+      end
+      formats_and_paths
+    end
+
+    def save_emails(file_or_directory, recursively = false)
+      files = {}
+      HtmlEmailCreator::Email.find_emails(file_or_directory, recursively).each do |file|
+        files[file] = save_email(file)
+      end
+      files
+    end
+    
+    private
+    
+    def email(file_or_configuration)
+      if file_or_configuration.kind_of?(String)
+        # Is file so update settings before creating email (makes sure that we have the latest settings file)
+        HtmlEmailCreator.update_settings(File.dirname(file_or_configuration))
+      end
+      Email.new(file_or_configuration, HtmlEmailCreator.settings)
+    end
+  end
+end

data/lib/html_email_creator/email_version.rb

@@ -0,0 +1,26 @@
+module HtmlEmailCreator
+  class EmailVersion    
+    def initialize(formatter, output_basename, settings)
+      @formatter = formatter
+      @output_basename = output_basename
+      @settings = settings
+    end
+
+    def get
+      @formatter.format
+    end
+    
+    def id
+      @formatter.id
+    end
+
+    def save
+      FileUtils.mkdir_p(@settings.output_path) unless File.exists?(@settings.output_path)
+      file = File.join(@settings.output_path, "#{@output_basename}.#{@formatter.extension}")
+      File.open(file, "w") do |file|
+        file.write(get)
+      end
+      file
+    end
+  end
+end

data/lib/html_email_creator/extensions.rb

@@ -0,0 +1,46 @@
+require 'kramdown'
+
+module HtmlEmailCreator
+  class Extensions
+    @@EXTENSIONS = {
+      'aweber' => {
+        'email' => '{!email}',
+        'subscription_date' => '{!signdate long}',
+        'unsubscribe_url' => '{!remove_web}',
+        'full_name' => '{!name_fix}',
+        'first_name' => '{!firstname_fix}',
+        'last_name' => '{!lastname_fix}',
+        'company_signature' => '{!signature}',
+        'company_address' => '{!contact_address}',
+        'tomorrow' => '{!date dayname+1}',
+        'after_2_days' => '{!date dayname+2}',
+        'after_3_days' => '{!date dayname+3}',
+        'after_4_days' => '{!date dayname+4}',
+        'after_5_days' => '{!date dayname+5}',
+        'after_6_days' => '{!date dayname+6}',
+        'after_7_days' => '{!date dayname+7}'
+      }
+    }
+    
+    def initialize(settings = HtmlEmailCreator.settings)
+      @settings = settings
+    end
+    
+    def built_in(*extensions)
+      new_data = {}
+      extensions.flatten.each do |extension|
+        data = @@EXTENSIONS[extension]
+        new_data.merge!(data.dup) if data
+      end
+      new_data
+    end
+    
+    def custom(data = {}, extensions)
+      new_data = {}
+      extensions.each_pair do |key, value|
+        new_data[key] = value
+      end
+      new_data
+    end
+  end
+end

data/lib/html_email_creator/filters.rb

@@ -0,0 +1,9 @@
+require "liquid"
+
+module HtmlEmailCreator
+  module Filters
+    def photo(input, alt)
+      "<img src=\"#{HtmlEmailCreator.settings.cdn_url}/#{input}\" alt=\"#{alt}\" border=\"0\" />"
+    end
+  end
+end

data/lib/html_email_creator/formatter.rb

@@ -0,0 +1,30 @@
+require "liquid"
+
+module HtmlEmailCreator
+  class Formatter
+    @@DEFAULT = HtmlEmailCreator::Formatters::UnknownFormatter
+    @@CONFIG = {}
+
+    [
+      HtmlEmailCreator::Formatters::Markdown,
+      HtmlEmailCreator::Formatters::PlainTextEmail,
+      HtmlEmailCreator::Formatters::HtmlEmail
+    ].each do |klass|
+      @@CONFIG[klass.id] = klass
+    end
+    
+    def initialize(text, settings = HtmlEmailCreator.settings)
+      @text = text
+      @settings = settings
+    end
+    
+    def find(format)
+      klass = @@CONFIG[format.to_sym] || @@DEFAULT
+      klass.send(:new, @text, @settings)
+    end
+        
+    def find_by_filename(filename)
+      find(File.extname(filename).split(".").last)
+    end
+  end
+end

data/lib/html_email_creator/formatters/formatter.rb

@@ -0,0 +1,31 @@
+module HtmlEmailCreator
+  module Formatters
+    class Formatter      
+      def self.id
+        raise "id needs to be defined"
+      end
+
+      def self.extension
+        raise "extension needs to be defined"
+      end
+      
+      def initialize(text, settings)
+        @text = text
+        @settings = settings
+      end
+      
+      # override to implement a correct formatter
+      def format
+        @text
+      end
+      
+      def id
+        self.class.id
+      end
+      
+      def extension
+        self.class.extension
+      end
+    end
+  end
+end