malvolio 0.1.0

data/lib/malvolio/compiler.rb

@@ -0,0 +1,85 @@
+require "yaml"
+require "inky"
+require "sass/plugin"
+require "premailer"
+
+module Malvolio
+	class Compiler
+		def initialize(path = nil, no_warnings = false)
+			@path = File.expand_path(path || ".")
+			@config = YAML.load_file(File.join(@path, "config.yaml"))
+			@compiler = Sass::Plugin::Compiler.new
+			@compiler.on_compilation_error do |error, template, _css|
+				raise Malvolio::CompilationError, compilation_error(error, template)
+			end
+			@no_warnings = no_warnings
+		end
+
+		def run!
+			convert_html			
+			compile_sass_to_css
+			inline_styles
+			clean_tmp_folder
+			print_colorized("New HTML email build was a success!", 32)
+		end
+
+		private
+
+		attr_reader :path, :config, :compiler, :no_warnings
+
+		def convert_html
+			src_path = File.join(path, "src", "index.html")
+			dest_path = File.join(path, "tmp", "index.html")
+			if config["inky"]
+				html_string = File.read(src_path)
+				html_output = Inky::Core.new.release_the_kraken(html_string)
+				File.write(dest_path, html_output)
+			else
+				FileUtils.cp(src_path, dest_path)
+			end
+		end
+
+		def compile_sass_to_css
+			src_path = File.join(path, "src", "scss", "index.scss")
+			dest_path = File.join(path, "tmp", "index.css")
+			compiler.update_stylesheets([[src_path, dest_path]])
+		end
+
+		def inline_styles
+			src_path = File.join(path, "tmp", "index.html")
+			dist_path = File.join(path, "dist", "index.html")
+			warn_level = no_warnings ? Premailer::Warnings::NONE : Premailer::Warnings::SAFE
+			premailer = Premailer.new(src_path, warn_level: warn_level)
+			File.open(dist_path, "w") do |file|
+				file.puts premailer.to_inline_css
+			end
+			premailer.warnings.each do |warning|
+				print_premailer_warning(warning)
+			end
+		end
+
+		def clean_tmp_folder
+			remove_path = Dir[File.join(path, "tmp", "*")]
+			FileUtils.rm_rf(remove_path)
+		end
+
+		def compilation_error(error, template)
+			"Sass failed to compile. Error found in #{template}\n#{error}"
+		end
+
+		def print_colorized(string, code)
+			puts "\e[#{code}m#{string}\e[0m"
+		end
+
+		def print_premailer_warning(warning)
+			message = "(#{warning[:level]}) #{warning[:message]} may not render properly "\
+				"in the following clients:\n\t#{warning[:clients]}"
+			code = premailer_risk_color_codes[warning[:level]]
+			print_colorized(message, code)
+		end
+
+		def premailer_risk_color_codes
+			{"SAFE" => 32, "NONE" => 32, "POOR" => 33, "RISKY" => 31}
+		end
+	end
+end

data/lib/malvolio/version.rb

@@ -0,0 +1,3 @@
+module Malvolio
+  VERSION = "0.1.0"
+end

data/malvolio.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "malvolio/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "malvolio"
+  spec.version       = Malvolio::VERSION
+  spec.authors       = ["Josh Reinhardt"]
+  spec.email         = ["jereinhardt415@gmail.com"]
+
+  spec.summary       = %q{A command line tool for building HTML emails.}
+  spec.description   = %q{A command line tool for building HTML emails.}
+  spec.homepage      = "https://github.com/jereinhardt/malvolio"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/jereinhardt/malvolio"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ["malvolio"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "inky-rb"
+  spec.add_dependency "premailer"
+  spec.add_dependency "filewatcher"
+  spec.add_dependency "compass"
+  spec.add_dependency "sass"
+
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: malvolio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Reinhardt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inky-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: premailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A command line tool for building HTML emails.
+email:
+- jereinhardt415@gmail.com
+executables:
+- malvolio
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/malvolio
+- bin/setup
+- lib/generators/malvolio/create_generator.rb
+- lib/generators/malvolio/create_with_inky_generator.rb
+- lib/generators/malvolio/templates/base/config.yaml
+- lib/generators/malvolio/templates/base/index.html
+- lib/generators/malvolio/templates/base/index.scss
+- lib/generators/malvolio/templates/base_with_inky/config.yaml
+- lib/generators/malvolio/templates/base_with_inky/index.html
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/_foundation_emails.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/_global.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_alignment.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_button.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_callout.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_code.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_media-query.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_menu.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_normalize.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_outlook-first.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_thumbnail.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_typography.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/components/_visibility.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/grid/_block-grid.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/grid/_grid.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/settings/_settings.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/foundation_emails/util/_util.scss
+- lib/generators/malvolio/templates/base_with_inky/scss/index.scss
+- lib/malvolio.rb
+- lib/malvolio/cli.rb
+- lib/malvolio/compiler.rb
+- lib/malvolio/version.rb
+- malvolio.gemspec
+homepage: https://github.com/jereinhardt/malvolio
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jereinhardt/malvolio
+  source_code_uri: https://github.com/jereinhardt/malvolio
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A command line tool for building HTML emails.
+test_files: []