antwort 0.0.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e59b19fe569c6bedd6aa867d777da670503f8d6
-  data.tar.gz: 16999bba4fcd7566d0da5000de95b9be271d5faf
+  metadata.gz: bd6a9e87317ec613b9765863c31b6daeef686c17
+  data.tar.gz: 0c1222631e2b670ae9ae6fc6198c727a787720b4
 SHA512:
-  metadata.gz: 670993ca347300e1599aa03c6d7e7cc01b5465fa7b0c7fc6ebeee921d64b3bb64eca82e7e8d30a8ac316d5a9d42e0aa482dd5fa06def7c066a3c7e700a474415
-  data.tar.gz: 38833ee46c6c0c8025776cfa31fb77a371cdcfcfb0593c09620e619ec2e916ea745fb298298072dc2352b8f35afa695ac65a391403fdbcb447c30cde07185776
+  metadata.gz: 43964bd735a1b4e471e75c11c0dbe30e60376863e8c9e1c4f252286af2a84f8093bd8d6f18ca93e0a726d9fffcb630a0ba75889ddb073eea260f16c2e1395911
+  data.tar.gz: c9ca766f6c01f9fffb96edec91dc656cfaad821349a04910df6deb73d35f8830a15a730699a9c7643af83d01fd0d98941fca1f6db92d9b4ad850fcef6692cc30

data/.gitignore

@@ -9,6 +9,7 @@ pkg
 
 # Environment variables
 .env
+.ruby-version
 
 # Mac Finder file
 .DS_Store

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.2
   Include:
     - '*.gemspec'
     - '**/Gemfile'
@@ -17,3 +18,14 @@ Metrics/MethodLength:
 
 Documentation:
   Enabled: false
+
+Lint/Eval:
+  Exclude:
+    - 'spec/support/capture.rb'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/antwort/cli/cli.rb'

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.1

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Change Log
 
+## 1.0.0
+
+Released: 31 October 2016
+
+This release jumped to version 1.0 because it is not compatible with previously generated projects. This update features a great deal of refactoring under the hood:
+
+__Added__
+
+* Send test emails to multiple recipients.
+* Cannot remove 'shared' folder.
+
+__Refactored__
+
+* Extracted code into models: `EmailCollection`, `EmailData`, `EmailTemplate`.
+* Re-organized CLI code to leverage new classes.
+* Re-organized helpers.
+* Cleaned up and removed unused files.
+* Internalized server code, removing it from project code.
+* Added more spces.
+* Added more ruby conventions to method names, esp. `?` and `!` in method names.
+* Ran code through rubocop.
+
+__Fixed__
+
+* various template bugs, e.g. missing/unused variables.
+
+
 ## 0.0.12
 
 Released: 14 March 2016
@@ -28,7 +55,7 @@ __Added__
 
 * New `--all` flag to `build` command, which will build all emails.
 * `each_with_index` loops are also now preserved. Example conversion: `cats.each_with_index do |cat, i|` becomes `{% for cat in cats with: {@index: i} %}`
-* Locals passed to partials are now referenced using a more generic `with` instead of ruby-esqe `locals` like so: {% partial 'foo' with: {size: 1} %}
+* Locals passed to partials are now referenced using a more generic `with` instead of ruby-esqe `locals` like so: `{% partial 'foo' with: {size: 1} %}`
 * ERB's `unless` is  now converted to `if !(condition)` 
 * ERB Statements without output or conditionals are also now preserved. Example: `<% product.merge({featured: false}) %>`
 * `button` and `image_tag` helpers are converted to use statement `{% … %}` syntax, not `{{ … }}` output syntax

data/README.md

@@ -1,7 +1,7 @@
 # Antwort E-Mail Generator
 
 Author: Julie Ng  
-Version 0.0.12 (14 March 2016)
+Version 1.0.0 (31 October 2016)
 
 
 ### Speed up your email design and development workflow:

data/antwort.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |s|
   s.description = 'E-Mail development, build and test system.'
   s.authors     = ['Julie Ng']
   s.email       = 'hello@antwort.co'
-  s.homepage    = 'https://antwort.co'
+  s.homepage    = 'https://antwort.co/gem'
   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.required_ruby_version = '~> 2.2'
 
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'thor'

data/lib/antwort.rb

@@ -1,13 +1,14 @@
 require 'thor'
 require 'dotenv'
-Dotenv.load
+Dotenv.load unless ENV['RACK_ENV'] == 'test'
 
 # Namespace
 module Antwort
 end
 
-require 'antwort/helpers'
+require 'antwort/helpers/helper'
+require 'antwort/helpers/file_helper'
+require 'antwort/core'
 require 'antwort/cli'
-require 'antwort/builder'
-require 'antwort/server'
+require 'antwort/server/server'
 require 'antwort/version'

data/lib/antwort/builder/builder.rb

@@ -7,22 +7,25 @@ module Antwort
   class Builder
     include Thor::Shell
     include Antwort::Helpers
-    include Antwort::CLIHelpers
+    include Antwort::FileHelpers
     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
+    attr_reader :template, :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}"
+
+      @build_id = attrs[:id]
+      @template = EmailTemplate.new(attrs[:email])
+
+      @build_dir     = "./build/#{template.name}-#{build_id}"
       @markup_dir    = "#{build_dir}/source"
-      @source_dir    = "./emails/#{template_name}"
-      @scss_dir      = "./assets/css/#{template_name}"
+      @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
 
@@ -30,9 +33,9 @@ module Antwort
       nil
     end
 
-    def create_build_directories
+    def create_build_directories!
       return if Dir.exist? build_dir
-      Dir.mkdir "build" unless Dir.exist? "./build"
+      Dir.mkdir 'build' unless Dir.exist? './build'
       Dir.mkdir(build_dir)
       Dir.mkdir("#{build_dir}/source")
     end
@@ -47,7 +50,7 @@ module Antwort
       css
     end
 
-    def build_css
+    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
@@ -59,25 +62,13 @@ module Antwort
 
       if File.file? source_file
         content = Tilt::ScssTemplate.new(source_file, style: @css_style).render
-        create_file(content: content, path: destination_file)
+        create_file!(content: content, path: destination_file)
       else
         say 'Build failed. ', :red
-        say "#{source_file}.scss for #{template_name} not found."
+        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)

data/lib/antwort/builder/email.rb

@@ -5,39 +5,36 @@ module Antwort
     def post_initialize(*)
       app     ||= Antwort::Server.new
       mock    ||= Rack::MockRequest.new(app)
+      @request  = mock.get("/template/#{template.name}")
 
-      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"
+      if template_is_valid?
+        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."
+        show_error_message
       end
     end
 
-    def build
+    def build!
       unless html_markup.nil?
-        build_css
-        build_html
-        inline_css
+        build_css!
+        build_html!
+        inline_css!
       end
 
-      until File.exist?(@inlined_file)
-        sleep 1
-      end
-      return true
+      sleep 1 until File.exist?(@inlined_file)
+      true
     end
 
-    def build_html
+    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")
+      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
+    def inline_css!
       markup   = preserve_nbsps(html_markup)
       document = Roadie::Document.new(markup)
 
@@ -46,10 +43,10 @@ module Antwort
 
       inlined = restore_nbsps(document.transform)
       inlined = cleanup_markup(inlined)
-      lnlined = remove_roadie_flags(inlined)
+      inlined = remove_roadie_flags(inlined)
       inlined = remove_excessive_newlines(inlined)
       inlined = flatten_inlined_css(inlined)
-      create_file(content: inlined, path: @inlined_file)
+      create_file!(content: inlined, path: @inlined_file)
     end
 
     def cleanup_markup(markup)
@@ -57,5 +54,33 @@ module Antwort
       content = add_included_css(content)
       content
     end
+
+    private
+
+    def show_error_message
+      msg = if template_not_found?
+              "Template '#{template.name}' not found."
+            elsif template_has_error?
+              "Template '#{template.name}' is not rendering succesfully. Verify with `antwort server` that the template is valid and try again."
+            else
+              "Error building #{template.name}."
+            end
+
+      say 'Error: ', :red
+      say msg
+      exit
+    end
+
+    def template_is_valid?
+      @request.status == 200
+    end
+
+    def template_not_found?
+      @request.status == 404
+    end
+
+    def template_has_error?
+      @request.status == 500
+    end
   end
 end

data/lib/antwort/builder/flattener.rb

@@ -1,9 +1,8 @@
 module Antwort
   class Flattener
-
     attr_reader :source, :styles, :flattened, :flattened_keys
 
-    def initialize(source='')
+    def initialize(source = '')
       @source = source
       @styles = find_styles
       @flattened_keys = []
@@ -15,7 +14,7 @@ module Antwort
       @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
+        copy.sub!(m, style.flattened_str)
       end
 
       @flattened = copy
@@ -23,15 +22,15 @@ module Antwort
     end
 
     def flattened?
-      @flattened_keys.length > 0
+      !@flattened_keys.empty?
     end
 
     private
 
-      def find_styles
-        a = []
-        @source.scan(/style="(.+?)"/).each { |match| a.push(match.first) } # first is regex group `(.+?)`
-        a
-      end
+    def find_styles
+      a = []
+      @source.scan(/style="(.+?)"/).each { |match| a.push(match.first) }
+      a
+    end
   end
 end

data/lib/antwort/builder/partial.rb

@@ -1,21 +1,22 @@
 module Antwort
   class PartialBuilder < Builder
-    attr_reader :templates
+    attr_reader :partials
 
     def post_initialize(*)
-      @templates = list_partials(source_dir).push('index.html.erb')
-      if templates.length < 1
+      @partials = @template.partials.push('index.html.erb')
+
+      if partials.empty?
         say 'Error: ', :red
-        puts "No partials found in #{template_name} folder."
+        puts "No partials found in #{template.name} folder."
         return
       else
-        create_build_directories
+        create_build_directories!
       end
     end
 
-    def build
+    def build!
       @css = load_css
-      templates.each { |t| build_html t }
+      partials.each { |t| build_html t }
     end
 
     def build_html(partial_name)
@@ -28,7 +29,7 @@ module Antwort
       inlined     = restore_nbsps(inlined)
       inlined     = flatten_inlined_css(inlined)
       filename    = adjust_filename(partial_name)
-      create_file(content: inlined, path: "#{build_dir}/#{filename}")
+      create_file!(content: inlined, path: "#{build_dir}/#{filename}")
     end
 
     def inline(markup)
@@ -45,7 +46,7 @@ module Antwort
     end
 
     def adjust_filename(filename)
-      filename = @template_name if filename == 'index.html.erb'
+      filename = @template.name if filename == 'index.html.erb'
 
       name = filename.gsub('.erb', '')
       name << '.html' unless name[-5, 5] == '.html'
@@ -73,8 +74,8 @@ module Antwort
     end
 
     def preserve_operators_from_nokogiri(html = '')
-      html.gsub(%r{{%\s*if(.*?)<(.*?)%}}, '{%\1&lt;\2%}')
-          .gsub(%r{{%\s*if(.*?)>(.*?)%}}, '{%\1&gt;\2%}')
+      html.gsub(/{%\s*if(.*?)<(.*?)%}/, '{%\1&lt;\2%}')
+          .gsub(/{%\s*if(.*?)>(.*?)%}/, '{%\1&gt;\2%}')
     end
   end
 end

data/lib/antwort/builder/style.rb

@@ -3,7 +3,7 @@ module Antwort
     attr_reader :keys, :duplicate_keys, :flattened, :original
 
     def initialize(style = '')
-      @style         = style
+      @style          = style
       @keys           = []
       @duplicate_keys = []
       @flattened      = []
@@ -23,37 +23,36 @@ module Antwort
     end
 
     def duplicates?
-      @duplicate_keys.length > 0
+      !@duplicate_keys.empty?
     end
 
     private
 
-      def convert_to_hash
-        str  = String.new(@style)
-        h    = Hash.new
-        keys = Array.new
-
-        str.split(';').each do |s|
-          key = s.split(':').first.strip
-          val = s.split(':').last.strip
-          h[key] = val
-          @original << { key => val }
-
-          if @keys.include? key
-            @duplicate_keys << key
-          else
-            @keys << key
-          end
+    def convert_to_hash
+      str  = String.new(@style)
+      h    = {}
+
+      str.split(';').each do |s|
+        key = s.split(':').first.strip
+        val = s.split(':').last.strip
+        h[key] = val
+        @original << { key => val }
+
+        if @keys.include? key
+          @duplicate_keys << key
+        else
+          @keys << key
         end
-        @flattened = h
       end
+      @flattened = h
+    end
 
-      # convert our flatted styles hash back into a string
-      def hash_to_str(hash)
-        str = ''
-        hash.each { |k,v| str << "#{k}:#{v};" }
-        str.chop! if str[-1] == ';' # remove trailing ';'
-        str
-      end
+    # convert our flatted styles hash back into a string
+    def hash_to_str(hash)
+      str = ''
+      hash.each { |k, v| str << "#{k}:#{v};" }
+      str.chop! if str[-1] == ';' # remove trailing ';'
+      str
+    end
   end
-end
+end