antwort 0.0.12

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,21 @@
+# bundler and gems config
+*.gem
+*.rbc
+.bundle
+Gemfile.lock
+
+# Packaged gem
+pkg
+
+# Environment variables
+.env
+
+# Mac Finder file
+.DS_Store
+
+# build directory
+/build
+
+# Temp files and cache
+*.sass-cache
+/tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Include:
+    - '*.gemspec'
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+    - tmp/**/*
+
+SymbolArray:
+  Enabled: true
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 16
+
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/CHANGELOG.md

@@ -0,0 +1,249 @@
+# Change Log
+
+## 0.0.12
+
+Released: 14 March 2016
+
+__Fixed__
+
+* Preserve multiline partials
+* Fixed typo in image tag markup. It should be `style=""`.
+
+__Updated__
+
+* Sending a test email now uses the email's `<title>` as the subject line, prefixed by "[test] "
+* Change CSS output style short flag to -c, more logical than -o
+* Our `include.scss` is now added after `<title>` instead of just before `</head>`, so we do not accidentlly override email specific included CSS.
+* `data-roadie-` attributes are removed after inlining.
+* Updated some templates used when initializing a new project
+
+
+## 0.0.11
+
+Released: 2 December 2015
+
+In this release, Partial Inlining was updated, not just to add and fix missing logic, but more importantly to establish syntax patterns.
+
+__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} %}
+* 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
+
+__Fixed__
+
+* Inlining partials no longer results in extra `<p>` tags. They were added by Nokogiri to create complete DOM trees should be addressed.
+* Fixed edge cases where conditionals using a less than `<` operator resulted in large chunks of missing code. Nokogiri, interpreted it as the start of an HTML tag, often chopping off parts until it found the next orphaned `>`, often in another conditional.
+* Antwort now always sends the correct email by matching `email_id`s exactly (#45).
+
+__Updated__
+
+* Closing logic tags are now simply `{% end %}`, deviating from Twig's `{% endif %}` and `{% endfor %}`, which cannot reliably be captured using regular expressions. We're choosing consistency and reliability over strict adherence to Twig syntax.
+* Updated some specs to test conversion of ERB logic to Twig-style logic.
+
+## 0.0.10
+
+Released: 15 November 2015
+
+__Added__
+
+* New Feature: `--css-style` or `-o` flag for [Sass output style](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style). Possible values: `expanded, `nested`, `compact`, or `compressed`.
+* Building partials now also builds the emails
+
+__Fixed__
+
+* Adding and removing emails now also adds and removes respective `data/[email_id].yml` data file.
+
+__Updated__
+
+* `symbolize_keys` helper is now a generic antwort helper.
+
+## 0.0.9
+
+Released: 20 Oct 2015
+
+__Added__
+* Preserve more logic for partials, including:
+  - conditionals
+  - variables
+  - varibles in lines
+  - non brekaing spaces
+  - code comments
+  - assignments including `||=` asssignments
+* add Yahoo table `align="center"` workaround to inline css.
+
+__Breaking Changes__
+
+* Stylesheets have been renamed to more accurately reflect how they are integrated into the email.
+  - `styles.scss` is now `inline.scss`, because it will be inlined.
+  - `responsive.scss` is now `include.scss`, because it will be included in the `<head>`, not all of which are responsive styles. Some are just CSS resets.
+* Meta data variables are now set directly as instance variables and can be accessed directly. For example, use `@title` instead of `@metadata[:title]`
+
+__Fixed__
+* Create `./build` directory if it doesn't exist (#30)
+* Build email before send if not already built and inlined (#31)
+* Restore variables inside links (#32)
+* Make default server layout responsive (#29)
+* [`Sinatra::ContentFor`](http://www.sinatrarb.com/contrib/content_for.html) helper now works
+
+__Updated__
+* Cleaned up existing and added more specs
+* Update `.env.sample` defaults and add missing `SEND_FROM`
+
+
+## 0.0.8
+
+Released: 12 Jan 2015
+
+__Added__
+
+* Added `SEND_FROM` environment variable to use as sender address, in case it differs from SMTP username
+* Refactored Builder to generate both templates and partials
+* Preserve ERB code in partials by changing to [Twig](http://twig.sensiolabs.org/) syntax, which is ignored by our inliner.
+
+__Fixed__
+
+* Make sure partials always have `.html` file extension, in case file is named `_partial.erb`
+* Default buttons now work in Outlook (missing border property)
+* Default email now also responsive (missing media query)
+* Prevent double slashes in image asset URLs when building templates without an `ASSET_SERVER` environment variable
+* Only creates a build subfolder if it exists
+* Preserves `&nbsp;` in code
+
+__Updated__
+
+* Various code cleanup
+* Updated project templates
+  * Added default font styles
+  * Updated meta tags in layout to support media queries on Windows Phone  
+  * Added more getting started text in demo email
+  * Added sample placeholder image for `image_tag` example
+  * Added `button` helper examples
+  * Added examples using partials
+  * Updated sample .ruby-version to use latest version of ruby
+  * Removed deprecated button defualts via `config.yml`. Use CSS instead
+
+
+## 0.0.7
+
+Released: 13 Nov 2014
+
+__Added__
+
+* Added `data/config.yml` to store global defaults, e.g. button colors. Updated new project templates to reflect this.
+
+__Updated__
+
+* Changed button markup to use Litmus Bulletproof strategy
+* Updated CSS organization; use underscore prefixes for included styles
+* Only parses data YAML if we have it; fixes errors from `symbolize_keys!` on `false`
+
+__Removed__
+
+* Removed Rake tasks remnants, including `Rakefile`
+* Removed `Sinatra::ConfigFile`
+
+
+## 0.0.6
+
+Released: 6 Nov 2014
+
+__Added__
+
+* Added `$antwort remove [EMAIL_ID]` command to remove emails, incl. css and image assets
+* Allows upload of shared images directory via `$antwort upload shared`
+* New emails get a blank title
+* Add username password to new project `init`
+
+__Fixed__
+
+* Defaults border color to background color if no border color is defined
+* Always render 404 with content_type `text/html`
+
+
+## 0.0.5
+
+Released: 15 Oct 2014
+
+__Added__
+
+* Added `$ antwort send [EMAIL_ID]` command to send emails
+* Added `$ antwort list` command to list all emails
+
+__Fixed__
+
+* Respect port number option when running server
+
+__Removed__
+
+* Removed `send.rake`
+* Removed duplicate dotenv load in `upload.rb`
+
+
+## 0.0.4
+
+Released: 13 Oct 2014
+
+__Added__
+
+* Added `$ antwort build` command to build emails
+* Added `$ antwort prune` command to empty `./build` directory
+* Added `$ antwort version` to output version, with `--version` option on executable
+* Made `bundle` and `git init` optional when initializing new antwort project
+* Various CLI output improvements
+* Various new project template improvements
+
+__Removed__
+
+* Removed `build.rake` tasks after integrating them into antwort executable
+
+
+## 0.0.3
+
+Released: 7 Oct 2014
+
+__Added__
+
+* Added `$ antwort server` command
+* Styled server pages
+
+    - Lists all templates by title
+    - If no templates, shows message to add one
+    - Styled 404 template not found page
+* Refactored Builder
+
+    - Builder now uses regex to remove rack live reload code
+    - Cleaned up CSS markup required for inlining css. Removed `roadie` references from project templates.
+    - Templates now use just `styles.scss` (inlined) and `responsive.scss` (outputed to `<head>`)
+* Individual email metadata via YAML frontmatter
+* Custom layouts per email via metadata
+* Adjusted templates included in project initializer based on code changes
+* Added some specs for Antwort::Server
+
+
+__Fixed__
+
+* Fixed port number, should be 9292 instead of 9494.
+* Include `lib/cli/upload` too
+* `image_tag` now respects absolute URLs starting with `http:` or `https:`
+* `image_tag` only prefxes template directory to path if image src does *not* start with `/`
+  
+
+## 0.0.2
+
+Released: 8 Sept 2014
+
+__Added__
+
+* Gemified antwort generator
+* Added `antwort` CLI
+  *   `$ antwort init MY_PROJECT` initializes the project 
+  * `$ antwort new FOO_LETTER` sets up a new email 
+  * `$ antwort upload FOO_LETTER` uploads the assets to Amazon S3
+
+__Fixed__
+
+* Create `./build` directory if it does not exist

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec', results_file: File.expand_path('tmp/rspec_guard_result') do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,108 @@
+# Antwort E-Mail Generator
+
+Author: Julie Ng  
+Version 0.0.12 (14 March 2016)
+
+
+### Speed up your email design and development workflow:
+
+- design in code with **live preview** of markup using Antwort's local development server
+- **build html** and **inline css** from multiple templates
+- **upload images** to content server (S3 only)
+- **send email** test via SMTP
+- includes **useful helpers**, e.g. `image_tag` that automatically includes email specific markup.
+
+See [CHANGELOG.md](https://github.com/jng5/antwort-generator/blob/master/CHANGELOG.md) for full functionality list.
+
+## Setup
+
+### Requirements
+
+- [Bundler](http://bundler.io/)
+- Ruby 2.0+
+- AWS S3 Account, for email upload (optional)
+- SMTP credentials, for sending test emails (optional)
+
+### Environment 
+
+In the project root, create a `.env` file with the following attributes
+
+
+    ASSET_SERVER:           https://example.s3.amazonaws.com
+    AWS_ACCESS_KEY_ID:      {{aws_access_key_id}}
+    AWS_SECRET_ACCESS_KEY:  {{aws_secret_access_key}}  
+    AWS_BUCKET:             example
+    FOG_REGION:             eu-west-1
+                            
+    SMTP_SERVER:            smtp.mandrillapp.com
+    SMTP_PORT:              587
+    SMTP_USERNAME:          {{username}}
+    SMTP_PASSWORD:          {{password}}
+    SMTP_DOMAIN:            {{domain}}
+    SEND_TO:                {{default_recipient}}
+    SEND_FROM:              {{default_sender}}
+
+See `.env.sample` for an example.
+
+## Use
+
+### Structure
+
+    .
+    +-- .env
+    +-- build
+    +-- assets
+    |   +-- css
+    |   +-- images
+    +-- emails
+    +-- views
+    +-- tmp
+
+
+To create a new email template, for example `newsletter`, simply run: `bundle exec antwort new newsletter` and all the proper files will be created for you.
+
+
+
+## Commands
+
+
+```
+Commands:
+  antwort build EMAIL_ID               # Builds email markup and inlines CSS from source
+  antwort help [COMMAND]               # Describe available commands or one specific command
+  antwort init PROJECT_NAME            # Initializes a new Antwort Email project
+  antwort list                         # Lists all emails in the ./emails directory by id
+  antwort new EMAIL_ID                 # Creates a new email template
+  antwort prune                        # Removes all files in the ./build directory
+  antwort send EMAIL_ID                # Sends built email via SMTP
+  antwort server                       # Starts http://localhost:9292 server for coding and previewing emails
+  antwort upload EMAIL_ID              # Uploads email assets to AWS S3
+  antwort version                      # ouputs version number
+```
+
+__Notes__ 
+
+- You should run the commands prefixed with `bundle exec` to make sure the correct version of gems are used.
+
+
+## License (MIT)
+
+Copyright (c) 2014-2016 Julie Ng.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+ENV['gem_push'] = 'false'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+desc 'Opens a console with antwort preloaded'
+task :console do
+  require 'pry'
+  require 'antwort'
+  include Antwort
+  Pry.start
+end