mjml-rails 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 128c814314ffe1c725a9d46d0537c161a45098650f67cf063cf0e27325cd11d2
-  data.tar.gz: b23564a1cf6b824359019f60bf08cb1f97d6d7584f1e58a2220fc672a4dea77c
+  metadata.gz: e001eb3b8f9abfa49b6fbf3e0e10d655fdeb38e68da79f55b348977f4a7082b8
+  data.tar.gz: 7d78f4466486513af5d364c7ca3e5146724a6e9fc785b26cdf66ae5c626138fb
 SHA512:
-  metadata.gz: 9c56d2b1b80bcb2f7ef36cf8e927d135fbdc26fd67f7ac2db52ece28065d1cb98010c89f9abae9176c7861ef3ab65ae099c8cb98ecabf371d06c42cff53f141d
-  data.tar.gz: 1eea404a1e315166fd132ec37b76257d4789f030af4853992067230cda800875861b68fde85a358e803ff283d15cb1d14c88ae778dd49e5f27f01109faf0e787
+  metadata.gz: 534c1c2975ff87a7e5bfed79bcbf19ec0d00ca16cf4a871faac3c9c89a348452aed2afb6197629598f473fd84943d67b64581a75139ca7e608ebcf4878004615
+  data.tar.gz: 6b58532184a1d750fc2d4ae76508a52a3b86578b82fa501a6c4a01c7e9f03856fa2ac48522b0744536e573468233e7f6f54e6a8bd234dff6b58f58e02879ebd5

data/README.md

@@ -1,6 +1,6 @@
 # MJML-Rails
 
-[![Build Status](https://api.travis-ci.org/sighmon/mjml-rails.svg?branch=master)](http://travis-ci.org/sighmon/mjml-rails) [![Gem Version](https://badge.fury.io/rb/mjml-rails.svg)](https://badge.fury.io/rb/mjml-rails)
+[![Build Status](https://github.com/sighmon/mjml-rails/workflows/test/badge.svg?branch=master)](https://github.com/sighmon/mjml-rails/actions?query=workflow%3Atest+branch%3Amaster) [![Gem Version](https://badge.fury.io/rb/mjml-rails.svg)](https://badge.fury.io/rb/mjml-rails)
 
 **MJML-Rails** allows you to render HTML e-mails from an [MJML](https://mjml.io) template.
 
@@ -112,18 +112,23 @@ Mjml.setup do |config|
 end
 ```
 
-If you’d like to specify a different MJML binary to run other than `4.`:
+You can optionally provide a custom MJML binary if MJML-Rails cannot find it:
 
 ```ruby
 # config/initializers/mjml.rb
 Mjml.setup do |config|
-  config.mjml_binary_version_supported = "3.3.5"
+  config.mjml_binary = "/path/to/custom/mjml"
 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)
+If you’d like to specify a different MJML version, set it like this:
+
+```ruby
+# config/initializers/mjml.rb
+Mjml.setup do |config|
+  config.mjml_binary_version_supported = "3.3.5"
+end
+```
 
 ### MJML v3.x & v4.x support
 

data/lib/mjml-rails.rb

@@ -1 +1 @@
-require "mjml"
+require "mjml"

data/lib/mjml.rb

@@ -7,7 +7,17 @@ require "rubygems"
 require "open3"
 
 module Mjml
-  mattr_accessor :template_language, :raise_render_exception, :mjml_binary_version_supported, :mjml_binary_error_string, :beautify, :minify, :validation_level
+  mattr_accessor \
+    :beautify,
+    :minify,
+    :mjml_binary,
+    :mjml_binary_error_string,
+    :mjml_binary_version_supported,
+    :raise_render_exception,
+    :template_language,
+    :validation_level
+
+  mattr_writer :valid_mjml_binary
 
   @@template_language = :erb
   @@raise_render_exception = true
@@ -24,33 +34,55 @@ module Mjml
     false
   end
 
-  def self.run_mjml(args, mjml_bin: nil)
-    mjml_bin ||= BIN
-
+  def self.run_mjml(args, mjml_bin: valid_mjml_binary)
     Open3.capture3("#{mjml_bin} #{args}")
   end
 
-  def self.discover_mjml_bin
-    # Check for local install of MJML with yarn
-    yarn_bin = `which yarn`.chomp
-    if yarn_bin.present?
-      mjml_bin = "#{yarn_bin} run mjml"
-      return mjml_bin if check_version(mjml_bin)
+  def self.valid_mjml_binary
+    @@valid_mjml_binary ||=
+      check_for_custom_mjml_binary ||
+      check_for_yarn_mjml_binary ||
+      check_for_npm_mjml_binary ||
+      check_for_global_mjml_binary
+
+    return @@valid_mjml_binary if @@valid_mjml_binary
+
+    puts Mjml.mjml_binary_error_string
+  end
+
+  def self.check_for_custom_mjml_binary
+    if const_defined?('BIN') && Mjml::BIN.present?
+      logger.warn('Setting `Mjml::BIN` is deprecated and will be removed in a future version! Please use `Mjml.mjml_binary=` instead.')
+      self.mjml_binary = Mjml::BIN
+      remove_const 'BIN'
     end
 
-    # Check for a local install of MJML with npm
+    return unless mjml_binary.present?
+
+    return mjml_binary if check_version(mjml_binary)
+
+    raise "MJML.mjml_binary is set to '#{mjml_binary}' but MJML-Rails could not validate that it is a valid MJML binary. Please check your configuration."
+  end
+
+  def self.check_for_yarn_mjml_binary
+    yarn_bin = `which yarn`.chomp
+    return unless yarn_bin.present?
+
+    mjml_bin = "#{yarn_bin} run mjml"
+    return mjml_bin if check_version(mjml_bin)
+  end
+
+  def self.check_for_npm_mjml_binary
     npm_bin = `which npm`.chomp
-    if npm_bin.present? && (installer_path = bin_path_from(npm_bin)).present?
-      mjml_bin = File.join(installer_path, 'mjml')
-      return mjml_bin if check_version(mjml_bin)
-    end
+    return unless npm_bin.present? && (installer_path = bin_path_from(npm_bin)).present?
+
+    mjml_bin = File.join(installer_path, 'mjml')
+    return mjml_bin if check_version(mjml_bin)
+  end
 
-    # Check for a global install of MJML
+  def self.check_for_global_mjml_binary
     mjml_bin = `which mjml`.chomp
     return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
-
-    puts Mjml.mjml_binary_error_string
-    nil
   end
 
   def self.bin_path_from(package_manager)
@@ -63,7 +95,9 @@ module Mjml
     nil
   end
 
-  BIN = discover_mjml_bin
+  def self.discover_mjml_bin
+    logger.warn('`Mjml.discover_mjml_bin` is deprecated and has no effect anymore! Please use `Mjml.mjml_binary=` to set a custom MJML binary.')
+  end
 
   class Handler
     def template_handler

data/lib/mjml/parser.rb

@@ -8,7 +8,7 @@ module Mjml
     #
     # @param input [String] The string to transform in html
     def initialize input
-      raise Mjml.mjml_binary_error_string unless mjml_bin
+      raise Mjml.mjml_binary_error_string unless Mjml.valid_mjml_binary
       @input = input
     end
 
@@ -40,14 +40,5 @@ module Mjml
         out_tmp_file.read
       end
     end
-
-    private
-
-      # Get mjml bin path
-      #
-      # @return [String]
-      def mjml_bin
-        Mjml::BIN
-      end
   end
 end

data/lib/mjml/railtie.rb

@@ -7,5 +7,10 @@ module Mjml
       ActionView::Template.register_template_handler :mjml, Mjml::Handler.new
       Mime::Type.register_alias "text/html", :mjml
     end
+
+    config.to_prepare do
+      # make sure we have a valid mjml binary
+      Mjml.valid_mjml_binary
+    end
   end
 end

data/lib/mjml/version.rb

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

data/test/mjml_test.rb

@@ -112,3 +112,44 @@ class NotifierMailerTest < ActiveSupport::TestCase
     refute email.body.match(/tracking-code-123/)
   end
 end
+
+describe Mjml do
+  describe '#valid_mjml_binary' do
+    before do
+      Mjml.mjml_binary = nil
+      Mjml.valid_mjml_binary = nil
+    end
+
+    after do
+      Mjml.mjml_binary = nil
+      Mjml.valid_mjml_binary = nil
+    end
+
+    it 'can be set to a custom value with mjml_binary if version is correct' do
+      Mjml.mjml_binary = 'some custom value'
+      Mjml.stub :check_version, true do
+        expect(Mjml.valid_mjml_binary).must_equal 'some custom value'
+      end
+    end
+
+    it 'raises an error if mjml_binary is invalid' do
+      Mjml.mjml_binary = 'some custom value'
+      err = expect { Mjml.valid_mjml_binary }.must_raise(StandardError)
+      expect(err.message).must_match(/MJML\.mjml_binary is set to 'some custom value' but MJML-Rails could not validate that it is a valid MJML binary/)
+    end
+
+    it 'honors old Mjml::BIN way of setting custom binary' do
+      Mjml::BIN = 'set by old way'
+      err = expect { Mjml.valid_mjml_binary }.must_raise(StandardError)
+      expect(err.message).must_match(/MJML\.mjml_binary is set to 'set by old way' but MJML-Rails could not validate that it is a valid MJML binary/)
+    end
+
+    it 'ignores empty Mjml::BIN' do
+      Mjml::BIN = ''
+      Mjml.mjml_binary = 'set by mjml_binary'
+
+      err = expect { Mjml.valid_mjml_binary }.must_raise(StandardError)
+      expect(err.message).must_match(/MJML\.mjml_binary is set to 'set by mjml_binary' but MJML-Rails could not validate that it is a valid MJML binary/)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Simon Loffler