mjml-rails 4.10.0 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e787307cfcd482f30208f9e38c0ec246b1670ef56bd36fd158d1c84f9b05430a
-  data.tar.gz: 7cc87eadbc13039cf2348cc3e5dc08313a751bf6360c403bfa4b545d628864c7
+  metadata.gz: 37fc78307ca3c1e85b631b150aed387a37db392786125cea2336d9696cd9669f
+  data.tar.gz: 98c17ccd57b004df6d0a03bdeae92de3e4de73f2242335f0f85f84ce006918f2
 SHA512:
-  metadata.gz: 38927fca73bc05d06f51a749176b1d8a93e9f08d30ebecd7b1a904f10093111d8239f368cd4ae0c428a15aaad4412f09442767bb60c621b6508917620f3c2d3a
-  data.tar.gz: 05cf3a1528c6375c7dd526d1952b589625af2b1a9c974d35a067f64a54bab3bd8eb3f9cbb8ae0bee17411a53e9c0efc83d08999e7c28f0d8dd3807ec3e149543
+  metadata.gz: 357492e9fd6db87e71e4151f36b55b24407e40c6d91462bd2d471c2bd084d3fdca096f4413b02754f7292522f7f8529b6ea202bdef150c6777d5a35d26960da1
+  data.tar.gz: 1ccac9f8f3270d7eb1746e711583b73feb1ae0a97f2bf092d5826cfc4f6eb2f5d3d61d371ab6f7aa6d98726fb3035c4650c57a25c2ea1bb2418dcc2e30a40462

data/README.md

@@ -151,6 +151,11 @@ MJML-Rails has the following settings with defaults:
 
 - `use_mrml: false`
   Enabling this will allow you to use Rust implementation of MJML via the `mrml` gem. It comes with prebuilt binaries instead of having to install MJML along with Node. When enabled the options `mjml_binary_version_supported`, `mjml_binary`, `minify`, `beautify` and `validation_level` are ignored.
+  
+- `fonts`
+  By default, MJML-Rails uses MJML default fonts, but enables you to override it. 
+  Example : `config.fonts = { Raleway: 'https://fonts.googleapis.com/css?family=Raleway }`
+
 
 ```ruby
 # config/initializers/mjml.rb
@@ -174,6 +179,9 @@ Mjml.setup do |config|
   # Use custom MJML binary with custom version
   config.mjml_binary = "/path/to/custom/mjml"
   config.mjml_binary_version_supported = "3.3.5"
+
+  # Use default system fonts instead of google fonts
+  config.fonts = {}
 end
 ```
 

data/lib/mjml/parser.rb

@@ -23,7 +23,7 @@ module Mjml
         file.write(input)
         file # return tempfile from block so #unlink works later
       end
-      run(in_tmp_file.path, Mjml.beautify, Mjml.minify, Mjml.validation_level)
+      run(in_tmp_file.path)
     rescue StandardError
       raise if Mjml.raise_render_exception
 
@@ -35,12 +35,9 @@ module Mjml
     # Exec mjml command
     #
     # @return [String] The result as string
-    # rubocop:disable Style/OptionalBooleanParameter: Fixing this offense would imply a change in the public API.
-    def run(in_tmp_file, beautify = true, minify = false, validation_level = 'strict')
+    def run(in_tmp_file)
       Tempfile.create(['out', '.html']) do |out_tmp_file|
-        command = "-r #{in_tmp_file} -o #{out_tmp_file.path} " \
-                  "--config.beautify #{beautify} --config.minify #{minify} --config.validationLevel #{validation_level}"
-        _, stderr, status = Mjml.run_mjml(command)
+        _, stderr, status = Mjml.run_mjml(build_command(in_tmp_file, out_tmp_file))
 
         unless status.success?
           # The process status ist quite helpful in case of dying processes without STDERR output.
@@ -52,6 +49,17 @@ module Mjml
         out_tmp_file.read
       end
     end
-    # rubocop:enable Style/OptionalBooleanParameter
+
+    # Build command string from config variables
+    #
+    # @return [String] Command string
+    def build_command(in_file, out_file)
+      command = "-r #{in_file} -o #{out_file.path} " \
+                "--config.beautify #{Mjml.beautify} " \
+                "--config.minify #{Mjml.minify} " \
+                "--config.validationLevel #{Mjml.validation_level}"
+      command += " --config.fonts '#{Mjml.fonts.to_json}'" unless Mjml.fonts.nil?
+      command
+    end
   end
 end

data/lib/mjml/version.rb

@@ -2,5 +2,5 @@
 
 module Mjml
   # Version number no longer matches MJML.io version
-  VERSION = '4.10.0'
+  VERSION = '4.11.0'
 end

data/lib/mjml.rb

@@ -12,6 +12,7 @@ module Mjml
   mattr_accessor \
     :beautify,
     :minify,
+    :fonts,
     :mjml_binary,
     :mjml_binary_error_string,
     :mjml_binary_version_supported,
@@ -31,6 +32,7 @@ module Mjml
   self.minify = false
   self.validation_level = 'strict'
   self.use_mrml = false
+  self.fonts = nil
 
   def self.check_version(bin)
     stdout, _, status = run_mjml('--version', mjml_bin: bin)
@@ -48,7 +50,8 @@ module Mjml
                              check_for_custom_mjml_binary ||
                              check_for_yarn_mjml_binary ||
                              check_for_npm_mjml_binary ||
-                             check_for_global_mjml_binary
+                             check_for_global_mjml_binary ||
+                             check_for_mrml_binary
 
     return @@valid_mjml_binary if @@valid_mjml_binary
 
@@ -102,6 +105,13 @@ module Mjml
     return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
   end
 
+  def self.check_for_mrml_binary
+    MRML.present?
+  rescue NameError
+    Mjml.mjml_binary_error_string = 'Couldn\'t find MRML - did you add \'mrml\' to your Gemfile?'
+    false
+  end
+
   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.')

data/test/mjml_test.rb

@@ -119,11 +119,13 @@ describe Mjml do
     before do
       Mjml.mjml_binary = nil
       Mjml.valid_mjml_binary = nil
+      Mjml.use_mrml = nil
     end
 
     after do
       Mjml.mjml_binary = nil
       Mjml.valid_mjml_binary = nil
+      Mjml.use_mrml = nil
     end
 
     it 'can be set to a custom value with mjml_binary if version is correct' do
@@ -156,5 +158,19 @@ describe Mjml do
       assert(err.message.start_with?("MJML.mjml_binary is set to 'set by mjml_binary' " \
                                      'but MJML-Rails could not validate that it is a valid MJML binary'))
     end
+
+    it 'can use MRML and check for a valid binary' do
+      Mjml.use_mrml = true
+      Mjml.stubs(:check_for_custom_mjml_binary).returns(false)
+      Mjml.stubs(:check_for_yarn_mjml_binary).returns(false)
+      Mjml.stubs(:check_for_npm_mjml_binary).returns(false)
+      Mjml.stubs(:check_for_global_mjml_binary).returns(false)
+      expect(Mjml.valid_mjml_binary).must_equal(true)
+
+      Mjml.valid_mjml_binary = nil
+      MRML.stubs(:present?).raises(NameError)
+      assert_nil(Mjml.valid_mjml_binary)
+      expect(Mjml.mjml_binary_error_string).must_equal 'Couldn\'t find MRML - did you add \'mrml\' to your Gemfile?'
+    end
   end
 end

data/test/parser_test.rb

@@ -37,11 +37,12 @@ describe Mjml::Parser do
       end
     end
 
-    describe 'can read beautify, minify, and validation_level configs' do
+    describe 'can read beautify, minify, fonts and validation_level configs' do
       it 'uses defaults if no config is set' do
         expect(Mjml.beautify).must_equal(true)
         expect(Mjml.minify).must_equal(false)
         expect(Mjml.validation_level).must_equal('strict')
+        expect(Mjml.fonts).must_equal(nil)
       end
 
       it 'uses setup config' do
@@ -49,16 +50,19 @@ describe Mjml::Parser do
           config.beautify = false
           config.minify = true
           config.validation_level = 'soft'
+          config.fonts = { Mononoki: 'https://cdn.jsdelivr.net/npm/@xz/fonts@1/serve/mononoki.min.css' }
         end
 
         expect(Mjml.beautify).must_equal(false)
         expect(Mjml.minify).must_equal(true)
         expect(Mjml.validation_level).must_equal('soft')
+        expect(Mjml.fonts).must_equal({ Mononoki: 'https://cdn.jsdelivr.net/npm/@xz/fonts@1/serve/mononoki.min.css' })
 
         Mjml.setup do |config|
           config.beautify = true
           config.minify = false
           config.validation_level = 'strict'
+          config.fonts = nil
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.10.0
+  version: 4.11.0
 platform: ruby
 authors:
 - Simon Loffler
@@ -36,7 +36,7 @@ cert_chain:
   RhdbGYd5Hku1QRVeQ+tN2OYG1/vZeRTqZ4MGLdl6r4iO5XGtWWoR2alg8kKc6yLx
   P5J+9tLKId50fAv4voQg//wRwePPNiWIXsLUa1LPYWTAznKTvi3dAQ==
   -----END CERTIFICATE-----
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: MJML + ERb templates