mjml-rails 4.2.3 → 4.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dac524ffb5e037b010261b15fac79520887dede3e3e1247e7c656ad82fef658a
-  data.tar.gz: cfe736a135609b4fdfba1e6ff43a31e603426d8415ba87912b6fd755249da80b
+  metadata.gz: c9eb1e8e21d779a8ae7196740fa0042a79f152260995977b38cf078cd5eea5f1
+  data.tar.gz: a7158c5b24476fb99808bdfef9b0d001a15801275e9ee9577758077f4c98c151
 SHA512:
-  metadata.gz: a615a1a6831a8ea7328007ce3f08332b31974814c937e26cc672a378a1e034a29a3b11fbd9ec3151377932d67399ee070688a7cb921a2466bf201c49309ad728
-  data.tar.gz: 6e5e25073a7e868b6ba44874b35f3d4daf00a59ce16fdeeb123956999244e8a6e6dde27e109c0f272eae78682581d3a07a6aa6e9448d245c63fa8ec5dda240e7
+  metadata.gz: e0a5b00f83612d1a49539140b94fb0de2490b3dacbe06c5c5256e3f2189866cfba9e3959cf41b2889b3e80eac43b0cf2134854a1dffde9f83ef3a3ecb9b2d1c5
+  data.tar.gz: b6dd71b988f199565ab11f77fc45d6d8cf598c614b88f5f1459b3d4494ad90391f4120b3578c047dc9b6120a8c520f32d51c5d64d600f666b04cb20bc7d64060

data/README.md

@@ -74,25 +74,39 @@ If you're using ```:haml``` or any other Rails template language, create an init
 # config/initializers/mjml.rb
 Mjml.setup do |config|
   config.template_language = :erb # :erb (default), :slim, :haml, or any other you are using
-	# Default is `false` (errors suppressed), set to `true` to enable error raising
-  # config.raise_render_exception = true
-  # config.mjml_binary_version_supported = "4."
 end
-# If you set a different MJML binary version, uncomment next line
-# Mjml::BIN = Mjml.discover_mjml_bin
 ```
 
 **Note:** If you’re using Haml/Slim layouts, please don’t put `<mjml>` in comments in your partial. Read more: [#34](https://github.com/sighmon/mjml-rails/issues/34).
 
-If you'd like to see render errors:
+If there are configurations you'd like change:
+- render errors: defaults to `false` (errors suppressed)
+- minify: defaults to `false` (not minified)
+- beautify: defaults to `true` (beautified)
 
 ```ruby
 Mjml.setup do |config|
-  # Default is `false` (errors suppressed), set to `true` to enable error raising
+  # set to `true` to enable error raising
   config.raise_render_exception = true
+
+  # optimize the size of your email
+  config.beautify = false
+  config.minify = true
+end
+```
+
+If you’d like to specify a different MJML binary to run other than `4.`:
+
+```ruby
+Mjml.setup do |config|
+  config.mjml_binary_version_supported = “3.3.5”
 end
+# If you set a different MJML binary version, you need to re-discover the binary
+Mjml::BIN = Mjml.discover_mjml_bin
 ```
 
+**Note:** If you set a different MJML binary you’ll see warnings in your logs of `already initialized constant Mjml::BIN`. Read more: [#39](https://github.com/sighmon/mjml-rails/issues/39#issuecomment-429151908)
+
 ### MJML v3.x & v4.x support
 
 Version 4.x of this gem brings support for MJML 4.x

data/lib/mjml.rb

@@ -5,12 +5,14 @@ require "mjml/railtie"
 require "rubygems"
 
 module Mjml
-  mattr_accessor :template_language, :raise_render_exception, :mjml_binary_version_supported, :mjml_binary_error_string
+  mattr_accessor :template_language, :raise_render_exception, :mjml_binary_version_supported, :mjml_binary_error_string, :beautify, :minify
 
   @@template_language = :erb
   @@raise_render_exception = false
   @@mjml_binary_version_supported = "4."
   @@mjml_binary_error_string = "Couldn't find the MJML #{Mjml.mjml_binary_version_supported} binary.. have you run $ npm install mjml?"
+  @@beautify = true
+  @@minify = false
 
   def self.check_version(bin)
     IO.popen("#{bin} --version") { |io| io.read.include?("mjml-core: #{Mjml.mjml_binary_version_supported}") }

data/lib/mjml/parser.rb

@@ -22,7 +22,7 @@ module Mjml
         file.write(input)
         file # return tempfile from block so #unlink works later
       end
-      run in_tmp_file.path
+      run(in_tmp_file.path, Mjml.beautify, Mjml.minify)
     rescue
       raise if Mjml.raise_render_exception
       ""
@@ -33,9 +33,9 @@ module Mjml
     # Exec mjml command
     #
     # @return [String] The result as string
-    def run(in_tmp_file)
+    def run(in_tmp_file, beautify=true, minify=false)
       Tempfile.create(["out", ".html"]) do |out_tmp_file|
-        command = "#{mjml_bin} -r #{in_tmp_file} -o #{out_tmp_file.path}"
+        command = "#{mjml_bin} -r #{in_tmp_file} -o #{out_tmp_file.path} --config.beautify #{beautify} --config.minify #{minify}"
         _, _, stderr, _ = Open3.popen3(command)
         raise ParseError.new(stderr.read.chomp) unless stderr.eof?
         out_tmp_file.read

data/lib/mjml/version.rb

@@ -1,4 +1,4 @@
 module Mjml
 	# Version number no longer matches MJML.io version
-  VERSION = "4.2.3"
+  VERSION = "4.2.4"
 end

data/test/parser_test.rb

@@ -37,6 +37,23 @@ describe Mjml::Parser do
         end
       end
     end
+
+    describe 'can read beautify and minify configs' do
+      it 'use defaults if no config is set' do
+        expect(Mjml.beautify).equal?(true);
+        expect(Mjml.minify).equal?(false);
+      end
+
+      it 'use setup config' do
+        Mjml.setup do |config|
+          config.beautify = false
+          config.minify = true
+        end
+
+        expect(Mjml.beautify).equal?(false);
+        expect(Mjml.minify).equal?(true);
+      end
+    end
   end
 
   describe '#run' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.2.4
 platform: ruby
 authors:
 - Simon Loffler
@@ -35,7 +35,7 @@ cert_chain:
   2QfUTBQZBmdkzXtFEAAJQVPa0X6iKxer4Na0dbjQciqf+5FrNBrct94To8eEEgqJ
   Yz5YuMu9yoVoBwOVkHs0NmbAKSv041eBwfQpzmm+reA=
   -----END CERTIFICATE-----
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies: []
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com