malvolio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55726811584affa39e9f7deb07a63a141f624a53bce6b398cdb2545d23d50be4
+  data.tar.gz: 5a82a6203e013b3331ad4d84aa862c147994b817ed317a897777c15ff174201d
+SHA512:
+  metadata.gz: 690329ae5c8fb4b4a1ea315683e6e14622dee384ced8d90f349f55e765e02bdf8d6c6ce2bfa40bb361c5df790810feba62a90c06f448aeb4791c6c5c4998a682
+  data.tar.gz: 78d1f42adf7d14b1084e7e78ae14b1b554b4d25e3cb9168b4a64642b9d2fe9df2e6c6df720b572bd068f7077d19780e648ab4545680b26e22d690a637ee81ded

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# ignore gem builds
+/*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in malvolio.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,184 @@
+PATH
+  remote: .
+  specs:
+    malvolio (0.1.0)
+      compass
+      filewatcher
+      inky-rb
+      premailer
+      sass
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    arel (9.0.0)
+    builder (3.2.3)
+    chunky_png (1.3.10)
+    compass (1.0.3)
+      chunky_png (~> 1.2)
+      compass-core (~> 1.0.2)
+      compass-import-once (~> 1.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      sass (>= 3.3.13, < 3.5)
+    compass-core (1.0.3)
+      multi_json (~> 1.0)
+      sass (>= 3.3.0, < 3.5)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    css_parser (1.6.0)
+      addressable
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    ffi (1.9.25)
+    filewatcher (1.1.1)
+      optimist (~> 3.0)
+    foundation_emails (2.2.1.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    htmlentities (4.3.4)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    inky-rb (1.3.7.3)
+      foundation_emails (~> 2)
+      nokogiri
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    nio4r (2.3.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    optimist (3.0.0)
+    premailer (1.11.1)
+      addressable
+      css_parser (>= 1.6.0)
+      htmlentities (>= 4.0.0)
+    public_suffix (3.0.3)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sass (3.4.25)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  malvolio!
+  rails
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Josh Reinhardt
+
+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/README.md

@@ -0,0 +1,61 @@
+# Malvolio
+
+Malvolio is a CLI tool that creates an easy workflow when developing HTML emails.
+
+## Installation
+
+In your terminal, install the gem from Rubygems.
+
+```
+gem install malvolio
+```
+
+## Usage
+
+To create a new project, run the command
+
+```
+malvolio new <project-name> [--inky]
+```
+
+the `--inky` option will create a project that allows you to use The [Zurb Foundation's Inky Templating Language](https://foundation.zurb.com/emails/docs/inky.html) and comes bundled with their (Foundation Email CSS Framework)[https://foundation.zurb.com/emails.html].
+
+The `new` command will generate a new project with the following structure:
+
+```
+/project-name
+  ├──tmp/
+  ├──dist/
+  └──src/
+      ├──index.html
+      └──scss/
+          └──index.scss
+```
+
+Once you've done some work in the `src/` directory and are ready to build, you can run
+
+```
+malvolio build [PROJECT PATH] [--no-warnings]
+```
+
+Or, if you would like for your project to build automatically as you go, you can run
+
+```
+malvolio watch [PROJECT PATH] [--no-warnings]
+```
+
+Running either of these commands will output your final HTML email file to `dist/index.html`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jereinhardt/malvolio.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "malvolio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/malvolio

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "malvolio"
+
+Malvolio::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/malvolio/create_generator.rb

@@ -0,0 +1,27 @@
+require "rails/generators"
+
+module Malvolio
+	module Generators
+		class CreateGenerator < Rails::Generators::Base
+			source_root File.join(File.dirname(__FILE__), "templates", "base")
+			argument :project_name, type: :string
+
+			def create_html_file
+				template "index.html", File.join(project_name, "src", "index.html")
+			end
+
+			def create_css_file 
+				template "index.scss", File.join(project_name, "src", "scss", "index.scss")
+			end
+
+			def create_config_file
+				template "config.yaml", File.join(project_name, "config.yaml")
+			end
+
+			def create_dist_and_tmp_dirs
+				Dir.mkdir File.join(project_name, "dist")
+				Dir.mkdir File.join(project_name, "tmp")
+			end
+		end
+	end
+end

data/lib/generators/malvolio/create_with_inky_generator.rb

@@ -0,0 +1,27 @@
+require "rails/generators"
+
+module Malvolio
+	module Generators
+		class CreateWithInkyGenerator < ::Rails::Generators::Base
+			source_root File.join(File.dirname(__FILE__), "templates", "base_with_inky")
+			argument :project_name, type: :string
+
+			def create_html_file
+				template "index.html", File.join(project_name, "src", "index.html")
+			end
+
+			def create_css_file
+				directory "scss", File.join(project_name, "src", "scss")
+			end
+
+			def create_config_file
+				template "config.yaml", File.join(project_name, "config.yaml")
+			end
+
+			def create_dist_and_tmp_dirs
+				Dir.mkdir File.join(project_name, "dist")
+				Dir.mkdir File.join(project_name, "tmp")
+			end
+		end
+	end
+end

data/lib/generators/malvolio/templates/base/config.yaml

@@ -0,0 +1 @@
+inky: false

data/lib/generators/malvolio/templates/base/index.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html xmlsn="http://www.w3.org/1999/xhtml">
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+		<meta name="viewport" content="width=device-width">
+		<link rel="stylesheet" type="text/css" href="index.css">
+		<!--[if mso]>
+			<style type="text/css">
+				body, table, td { font-family: Tahoma, "Helvetica", sans-serif;  }
+			</style>
+		<![endif]-->
+	</head>
+	<body>
+		
+	</body>
+</html>

data/lib/generators/malvolio/templates/base_with_inky/config.yaml

@@ -0,0 +1 @@
+inky: true

data/lib/generators/malvolio/templates/base_with_inky/index.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html xmlsn="http://www.w3.org/1999/xhtml">
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+		<meta name="viewport" content="width=device-width">
+		<link rel="stylesheet" type="text/css" href="index.css">
+		<!--[if mso]>
+			<style type="text/css">
+				body, table, td { font-family: Tahoma, "Helvetica", sans-serif;  }
+			</style>
+		<![endif]-->
+	</head>
+	<body>
+		<table class="body">
+			<tr>
+				<td>
+					<!-- Your awesome email content here -->
+				</td>
+			</tr>
+		</table>
+	</body>
+</html>