antwort 0.0.12

data/antwort.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'antwort/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'antwort'
+  s.version     = Antwort::VERSION
+  s.summary     = 'Antwort Generator'
+  s.description = 'E-Mail development, build and test system.'
+  s.authors     = ['Julie Ng']
+  s.email       = 'hello@antwort.co'
+  s.homepage    = 'https://antwort.co'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.required_ruby_version = '~> 2.0'
+
+  s.add_runtime_dependency 'rake'
+  s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'sinatra'
+  s.add_runtime_dependency 'sinatra-contrib'
+  s.add_runtime_dependency 'sinatra-partial'
+  s.add_runtime_dependency 'dotenv'
+  s.add_runtime_dependency 'htmlentities'
+  s.add_runtime_dependency 'mail'
+  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'roadie', '>= 3.0.0'
+
+  s.add_runtime_dependency 'sass'
+  s.add_runtime_dependency 'sprockets', '~> 3.0'
+
+  s.add_runtime_dependency 'thin'
+  s.add_runtime_dependency 'rack-livereload'
+  s.add_runtime_dependency 'guard-livereload'
+  s.add_runtime_dependency 'fog'
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'guard-rspec'
+end

data/bin/antwort

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/antwort'
+
+Antwort::CLI.start

data/lib/antwort.rb

@@ -0,0 +1,13 @@
+require 'thor'
+require 'dotenv'
+Dotenv.load
+
+# Namespace
+module Antwort
+end
+
+require 'antwort/helpers'
+require 'antwort/cli'
+require 'antwort/builder'
+require 'antwort/server'
+require 'antwort/version'

data/lib/antwort/builder.rb

@@ -0,0 +1,8 @@
+require 'antwort/builder/helpers/logic'
+require 'antwort/builder/helpers/sanitizers'
+require 'antwort/builder/builder'
+require 'antwort/builder/email'
+require 'antwort/builder/partial'
+require 'antwort/builder/flattener'
+require 'antwort/builder/style'
+require 'antwort/cli/helpers'

data/lib/antwort/builder/builder.rb

@@ -0,0 +1,104 @@
+require 'fileutils'
+require 'tilt'
+require 'roadie'
+require 'thor/shell'
+
+module Antwort
+  class Builder
+    include Thor::Shell
+    include Antwort::Helpers
+    include Antwort::CLIHelpers
+    include Antwort::LogicHelpers
+    include Antwort::MarkupSanitizers
+
+    attr_reader :template_name, :build_id, :build_dir, :markup_dir, :source_dir, :scss_dir, :asset_server, :css, :css_style
+
+    def initialize(attrs = {})
+      attrs = symbolize_keys!(attrs)
+      @template_name = attrs[:email]
+      @build_id      = attrs[:id]
+      @build_dir     = "./build/#{template_name}-#{build_id}"
+      @markup_dir    = "#{build_dir}/source"
+      @source_dir    = "./emails/#{template_name}"
+      @scss_dir      = "./assets/css/#{template_name}"
+      @css_style     = attrs[:'css-style'].to_sym
+      @asset_server  = ENV['ASSET_SERVER'] || '/assets'
+      post_initialize(attrs)
+    end
+
+    def post_initialize(*)
+      nil
+    end
+
+    def create_build_directories
+      return if Dir.exist? build_dir
+      Dir.mkdir "build" unless Dir.exist? "./build"
+      Dir.mkdir(build_dir)
+      Dir.mkdir("#{build_dir}/source")
+    end
+
+    def build
+    end
+
+    def load_css
+      css_file = "#{markup_dir}/inline.css"
+      build_css unless File.file? css_file
+      css = File.read(css_file)
+      css
+    end
+
+    def build_css
+      compile_scss(source: "#{scss_dir}/inline.scss", destination: "#{markup_dir}/inline.css")
+      compile_scss(source: "#{scss_dir}/include.scss", destination: "#{markup_dir}/include.css")
+      @css = load_css
+    end
+
+    def compile_scss(attrs = {})
+      source_file      = attrs[:source]
+      destination_file = attrs[:destination]
+
+      if File.file? source_file
+        content = Tilt::ScssTemplate.new(source_file, style: @css_style).render
+        create_file(content: content, path: destination_file)
+      else
+        say 'Build failed. ', :red
+        say "#{source_file}.scss for #{template_name} not found."
+      end
+    end
+
+    def create_file(attrs)
+      content = attrs[:content]
+      path    = attrs[:path]
+
+      file = File.new(path, 'w')
+      file.write(content)
+      file.close
+      say '    create  ', :green
+      say path.gsub(/\A.\//, '')
+      file
+    end
+
+    def use_asset_server(markup = '')
+      replaced = "#{asset_server}/"
+      output = markup.gsub('/assets/', replaced)
+      output
+    end
+
+    def flatten_inlined_css(markup)
+      copy = ''
+
+      # loop through lines so we have the line number
+      markup.lines.each_with_index do |line, i|
+        f = Flattener.new(line).flatten
+        if f.flattened?
+          say " flattened  CSS #{f.flattened_keys} ", :yellow
+          say "#{i}: #{f.source.strip}"
+          copy << f.flattened
+        else
+          copy << f.source
+        end
+      end
+      copy
+    end
+  end
+end

data/lib/antwort/builder/email.rb

@@ -0,0 +1,61 @@
+module Antwort
+  class EmailBuilder < Builder
+    attr_accessor :html_markup
+
+    def post_initialize(*)
+      app     ||= Antwort::Server.new
+      mock    ||= Rack::MockRequest.new(app)
+
+      request = mock.get("/template/#{template_name}")
+      if request.status == 200
+        create_build_directories
+        @html_markup  = remove_livereload(request.body)
+        @inlined_file = "#{build_dir}/#{template_name}.html"
+      else
+        say 'Error: ', :red
+        say "Template '#{template_name}' not found."
+      end
+    end
+
+    def build
+      unless html_markup.nil?
+        build_css
+        build_html
+        inline_css
+      end
+
+      until File.exist?(@inlined_file)
+        sleep 1
+      end
+      return true
+    end
+
+    def build_html
+      markup = html_markup
+      markup = markup.gsub("/assets/#{template_name}/inline.css", 'inline.css')
+                     .gsub("/assets/#{template_name}/include.css", 'include.css')
+      create_file(content: markup, path: "#{markup_dir}/#{template_name}.html")
+    end
+
+    def inline_css
+      markup   = preserve_nbsps(html_markup)
+      document = Roadie::Document.new(markup)
+
+      document.asset_providers << Roadie::NullProvider.new
+      document.add_css(css)
+
+      inlined = restore_nbsps(document.transform)
+      inlined = cleanup_markup(inlined)
+      lnlined = remove_roadie_flags(inlined)
+      inlined = remove_excessive_newlines(inlined)
+      inlined = flatten_inlined_css(inlined)
+      create_file(content: inlined, path: @inlined_file)
+    end
+
+    def cleanup_markup(markup)
+      content = use_asset_server(markup)
+      content = add_included_css(content)
+      content
+    end
+  end
+end

data/lib/antwort/builder/flattener.rb

@@ -0,0 +1,37 @@
+module Antwort
+  class Flattener
+
+    attr_reader :source, :styles, :flattened, :flattened_keys
+
+    def initialize(source='')
+      @source = source
+      @styles = find_styles
+      @flattened_keys = []
+      self
+    end
+
+    def flatten
+      copy = String.new(@source)
+      @styles.each do |m|
+        style = Antwort::Style.new(m)
+        @flattened_keys.concat(style.duplicate_keys) if style.duplicates?
+        copy.sub!(m, style.flattened_str) # flattened_str removes extra spaces and trailing semicolons
+      end
+
+      @flattened = copy
+      self
+    end
+
+    def flattened?
+      @flattened_keys.length > 0
+    end
+
+    private
+
+      def find_styles
+        a = []
+        @source.scan(/style="(.+?)"/).each { |match| a.push(match.first) } # first is regex group `(.+?)`
+        a
+      end
+  end
+end

data/lib/antwort/builder/helpers/logic.rb

@@ -0,0 +1,82 @@
+module Antwort
+  module LogicHelpers
+
+    def preserve_nbsps(html = '')
+      html.gsub(/ /, '%nbspace%')
+    end
+
+    def restore_nbsps(html = '')
+      html.gsub(/%nbspace%/, ' ')
+    end
+
+    def preserve_logic(html = '')
+      html = preserve_comments(html)
+      html = preserve_conditionals(html) # conditionals before loops, in case we have them inside loops
+      html = preserve_loops(html)
+      html = preserve_variables(html)
+      html = preserve_assignments(html)
+      html = convert_partials_to_includes(html)
+      html = convert_helper_wrappers(html)
+      html = preserve_leftover_statements(html) # must be last
+      html
+    end
+
+    def preserve_conditionals(html = '')
+      html.gsub(%r{<%\s*if (.*?)%>}, '{% if \1 %}')         # if
+          .gsub(%r{<%\s*unless (.*?)%>}, '{% if !( \1) %}') # unless
+          .gsub(%r{<%\s*elsif(.*?)%>}, '{% elseif\1%}')     # elsif
+          .gsub(%r{<%\s*else\s*%>}, '{% else %}')           # else
+          .gsub(%r{<%\s*end\s*%>}, '{% end %}')             # end
+          .gsub(/[ \t]{2,}%}/, ' %}')                       # remove extra white space, e.g. {% else    %}
+    end
+
+    def preserve_loops(html = '')
+      html.gsub(%r{<%\s+(.*)(\.each\s+do\s+\|)\s*(\S+)\s*(\|\s+)%>}, '{% for \3 in \1 %}')
+          .gsub(%r{<%\s+(.*)(\.each_with_index\s+do\s+\|)\s*(\S+)\s*,\s*(\S+)\s*(\|\s+)%>}, '{% for \3 in \1 with: {@index: \4} %}')
+          .gsub(%r{<%\s*end\s*%>}, '{% end %}')
+    end
+
+    def preserve_comments(html = '')
+      html.gsub(%r{<%[ \t]*#(.*)%>},'{#\1#}')
+          .gsub(/{#([^=\s])/, '{# \1')      # {#foo #} ->{# foo #}
+    end
+
+    def preserve_variables(html = '')
+      html.gsub(/\[:(.*?)\]/, '.\1')        # a[:b][:c] -> a.b.c
+          .gsub(/\['(.*?)'\]/, '.\1')       # a['b'] -> a.b
+          .gsub(/\["(.*?)"\]/, '.\1')       # a["b"] -> a.b
+          .gsub(%r{<%=(.*?)%>}, '{{\1}}')   # assume leftover erb output are variables
+    end
+
+    def preserve_assignments(html = '')
+      html.gsub(%r{<%\s+([A-Za-z0-9_]+)\s*(\|\|=)\s*(.*)\s+%>}, '{% set \1 = \1 || \3 %}')
+          .gsub(%r{<%\s+([A-Za-z0-9_]+)\s*(=)\s*(.*)\s+%>}, '{% set \1 = \3 %}')
+    end
+
+    def preserve_leftover_statements(html = '')
+      html.gsub(%r{<%\s*(.*?)?%>}, '{% \1%}') # no trailing space because group captures it
+    end
+
+    def restore_variables_in_links(html = '')
+      html.gsub('%7B%7B%20','{{ ')
+          .gsub('%20%7D%7D',' }}')
+    end
+
+    def convert_partials_to_includes(html = '')
+      html.gsub(%r{{{ partial :(.+?) }}}, '{% include \1 %}')
+          .gsub(%r{{% include (.+),\s+locals:(.+?)%}}, '{% include \1 with:\2%}')
+          .gsub(%r{(<%=\s+?partial\s+?:)(.+?),(.+?)(locals:)((.|\n)+?)(%>)}, '{% include \2 with:\5%}') # multiline partials not caught in presumably leftover variable
+    end
+
+    def convert_helper_wrappers(html = '')
+      html.gsub(%r{{{ button(.+?)}}}, '{% button\1%}')
+          .gsub(%r{{{ image_tag(.+?)}}}, '{% image_tag\1%}')
+    end
+
+    def cleanup_logic(html = '')
+      html.gsub(%r{({%|{{)(.*?)(&lt;)(.*?)(}}|%})}, '\1\2<\4\5') # <
+          .gsub(%r{({%|{{)(.*?)(&gt;)(.*?)(}}|%})}, '\1\2>\4\5') # >
+          .gsub(/&amp;&amp;/, '&&')
+    end
+  end
+end

data/lib/antwort/builder/helpers/sanitizers.rb

@@ -0,0 +1,29 @@
+module Antwort
+  module MarkupSanitizers
+
+    def remove_livereload(markup = '')
+      markup.gsub(/<script.*?>(\s|\S)*<\/script>/i, '')
+            .gsub(/(<head.*?>\n)(\s*\n)*/i, '\1')
+    end
+
+    def add_included_css(markup = '')
+      css = File.read("#{markup_dir}/include.css")
+      css_markup = "</title>\n<style type=\"text/css\">\n" + css + "</style>\n"
+      markup.gsub(%r{</title>}i, css_markup)
+    end
+
+    def remove_roadie_flags(markup = '')
+      markup.gsub(' data-roadie-ignore', '')
+    end
+
+    def remove_excessive_newlines(markup = '')
+      markup.gsub(/^([ \t]*\n){3,}/m, "\n\n")
+    end
+
+    def remove_extra_dom(html = '')
+      html.gsub(/\<!(.*)\<body.*?\>/im, '')
+          .gsub(%r{</body>.*?</html>}im, '')
+    end
+
+  end
+end

data/lib/antwort/builder/partial.rb

@@ -0,0 +1,80 @@
+module Antwort
+  class PartialBuilder < Builder
+    attr_reader :templates
+
+    def post_initialize(*)
+      @templates = list_partials(source_dir).push('index.html.erb')
+      if templates.length < 1
+        say 'Error: ', :red
+        puts "No partials found in #{template_name} folder."
+        return
+      else
+        create_build_directories
+      end
+    end
+
+    def build
+      @css = load_css
+      templates.each { |t| build_html t }
+    end
+
+    def build_html(partial_name)
+      source_file = "#{source_dir}/#{partial_name}"
+      source      = File.read(source_file)
+      markup      = preserve_logic(source)
+      markup      = preserve_nbsps(markup)
+      markup      = preserve_operators_from_nokogiri(markup)
+      inlined     = inline(markup)
+      inlined     = restore_nbsps(inlined)
+      inlined     = flatten_inlined_css(inlined)
+      filename    = adjust_filename(partial_name)
+      create_file(content: inlined, path: "#{build_dir}/#{filename}")
+    end
+
+    def inline(markup)
+      # Force a complete DOM tree before inlining for nokogiri
+      # Otherwise we have random <p> at beginning of document
+      html = add_nokogiri_wrapper(markup)
+
+      document = Roadie::Document.new html
+      document.add_css(css)
+      inlined  = document.transform
+      inlined  = cleanup(inlined)
+
+      remove_nokogiri_wrapper(inlined)
+    end
+
+    def adjust_filename(filename)
+      filename = @template_name if filename == 'index.html.erb'
+
+      name = filename.gsub('.erb', '')
+      name << '.html' unless name[-5, 5] == '.html'
+      name = '_' << name unless name[0] == '_'
+      name
+    end
+
+    def cleanup(html = '')
+      code = remove_extra_dom(html)
+      code = cleanup_logic(code)
+      code = restore_variables_in_links(code)
+      code
+    end
+
+    private
+
+    def add_nokogiri_wrapper(html = '')
+      html = '<div id="valid-dom-tree">' + html + '</div><!--/#valid-dom-tree-->'
+      html
+    end
+
+    def remove_nokogiri_wrapper(html = '')
+      html.gsub('<div id="valid-dom-tree">', '')
+          .gsub(%r{</div>(\s*)<!--/#valid-dom-tree-->}, '')
+    end
+
+    def preserve_operators_from_nokogiri(html = '')
+      html.gsub(%r{{%\s*if(.*?)<(.*?)%}}, '{%\1&lt;\2%}')
+          .gsub(%r{{%\s*if(.*?)>(.*?)%}}, '{%\1&gt;\2%}')
+    end
+  end
+end