getinline 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a02e79e72792bc59b5a1f2ce8fac01f2ab49e8b4
-  data.tar.gz: c37596ccbd34fc3a1da68f5eeb52fa739e8d7f06
+  metadata.gz: 52b2a9ad2702d5c0b7affe50fd0269698d22a6d9
+  data.tar.gz: 12c9c09a501dc65a98f346cc870e51177c639728
 SHA512:
-  metadata.gz: 5884a60805ecdec97665505d8cfa1af06c816150c6ce28ab84afc0dd27ab5697cb3c9988eb0353dcff84ea16a7c7be1b60e0bd47f078529ed4e9ab4fbbf077a4
-  data.tar.gz: 0365058cdfb46720933437cd27a358c42625f6632fbd34422a6ea1a6d0f5bc12112aca649f6729ca9414e9495bfbdc4e62fb01ca83e08df43ddabcbd25440cf3
+  metadata.gz: 4c238eca8ebe86d34dd442f300b9fecca172f4e66afada078b8155a66c36ac8f20da69e8b5c3d68d85b8b24dc8a26f11b8c8f198f8b71aec16025b1acd994ff8
+  data.tar.gz: f7e7c11ae032ecf5a609226d44c3c26861c9fbc78b9ea660480a378fa7203878144285f43e35908eb1efb6c16753db58a739b9753330a94f0caaf6f37f5f1e0a

data/README.md

@@ -1,35 +1,52 @@
 # Getinline
 
-Inlines CSS styles for HTML email development and preserves ERB tags.
+A CSS inliner for Ruby ERB templates.
+
+The motivation for this project is automating the premailer inliner and plain text generator such that ERB template variables are respected.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the Getinline gem from [RubyGems](https://rubygems.org/gems/getinline):
 
-```ruby
-gem 'getinline'
+    $ gem install getinline
+
+or add it to your `Gemfile` and run `bundle`.
+
+## Examples
+
+#### Command Line
+
+`getinline` can be invoked in any of the following ways on the command line:
+
+```shell
+getinline ./public/index.erb --mode txt
+getinline < ./public/index.erb
+cat ./public/index.erb | getinline
 ```
 
-And then execute:
+#### Rake Task
 
-    $ bundle
+```ruby
+require 'getinline'
 
-Or install it yourself as:
+namespace :generate do
+  desc 'Generate inlined and plain text email templates'
+  task emails: :environment do
 
-    $ gem install getinline
+    file = File.read('./public/index.erb')
 
-## Usage
+    html_transformer = Getinline::Transformer.new(file)
+    html_template = html_transformer.transform
 
-`getinline` can be invoked in any of the following ways:
+    text_transformer = Getinline::Transformer.new(file, mode: :txt)
+    text_template = text_transformer.transform
 
-```shell
-getinline file_name
-getinline < file_name
-cat file_name | getinline
+    File.write('./public/inline/index.erb', html_template)
+    File.write('./public/text/index.erb', text_template)
+  end
+end
 ```
 
-Output is printed to stdout.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -40,7 +57,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jellyvision/getinline.
 
-
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/exe/getinline

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'getinline'
 require 'optparse'
 
-options = {
+getinline_options = {
   mode: :html
 }
 premailer_options = {
@@ -14,6 +14,7 @@ premailer_options = {
   remove_classes: false,
   verbose: false,
   line_length: 9001,
+  output_encoding: 'US-ASCII',
   warn_level: Premailer::Warnings::SAFE
 }
 
@@ -30,7 +31,7 @@ option_parser = OptionParser.new do |opts|
   opts.separator 'Options:'
 
   opts.on('--mode MODE', [:html, :txt], 'Output: html or txt') do |v|
-    options[:mode] = v
+    getinline_options[:mode] = v
   end
 
   opts.on('-h', '--help', 'Print usage instructions') do
@@ -69,8 +70,8 @@ option_parser = OptionParser.new do |opts|
     premailer_options[:line_length] = v
   end
 
-  opts.on('-e', '--entities', 'Output HTML entities instead of UTF-8 when using Nokogiri') do
-    premailer_options[:output_encoding] = 'US-ASCII'
+  opts.on('-n', '--no-entities', 'Output UTF-8 instead of HTML entities when using Nokogiri') do
+    premailer_options[:output_encoding] = nil
   end
 
   opts.on('-d', '--io-exceptions', 'Abort on I/O errors') do |v|
@@ -90,13 +91,13 @@ rescue OptionParser::AmbiguousOption => error
   abort "That's an #{error}"
 end
 
-def transform(file_contents, options, premailer_options)
-  transformer = Getinline::Transformer.new(file_contents, options, premailer_options)
+def transform(file_contents, getinline_options, premailer_options)
+  transformer = Getinline::Transformer.new(file_contents, getinline_options, premailer_options)
   puts transformer.transform
 end
 
 if ARGF.filename != '-' || (!STDIN.tty? && !STDIN.closed?)
-  transform(ARGF.read, options, premailer_options)
+  transform(ARGF.read, getinline_options, premailer_options)
 else
   puts option_parser
   exit

data/lib/getinline/transformer.rb

@@ -1,7 +1,7 @@
 require 'premailer'
-require 'nokogiri'
 
 TOKEN = '@TOKEN'
+ERB_TAG = /<%.+?%>/
 TOKENIZED_ERB_FILE_NAME = '/tmp/tokenized.erb'
 
 module Getinline
@@ -13,7 +13,7 @@ module Getinline
     end
 
     def transform
-      matches = @raw_text.scan(/<%.+?%>/)
+      matches = @raw_text.scan(ERB_TAG)
       tokenized_text = @raw_text.dup
       matches.each do |match|
         tokenized_text.sub!(match, TOKEN)
@@ -23,7 +23,7 @@ module Getinline
 
       @premailer = Premailer.new(TOKENIZED_ERB_FILE_NAME, @premailer_options)
       premailed_tokenized_text = @options[:mode] == :txt ?
-        @premailer.to_plain_text : Nokogiri::HTML(@premailer.to_inline_css).to_html(encoding:'US-ASCII')
+        @premailer.to_plain_text : @premailer.to_inline_css
       premailed_text = premailed_tokenized_text.dup
 
       matches.each do |match|

data/lib/getinline/version.rb

@@ -1,3 +1,3 @@
 module Getinline
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getinline
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeremy Kahn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler