mjml-rails 4.10.1 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 321f6e1eaed15dffa0b3c65283a095a92ac80cae3b3d3df4f395d446fbc4e490
-  data.tar.gz: 96cce85167d65a6c20cc62ad3d5690ed7e4c166af37311190a0729f33b6a315d
+  metadata.gz: 2b6b7aed097a59ac30303aaf45d11b7f736e521d80f861b93fbf1886be6a15a0
+  data.tar.gz: 3d894ce65b6ba9c6f5818acfaf4d34dd57a85b29ed4a071870ff2c4cdc65c9ad
 SHA512:
-  metadata.gz: fc6708c231290dea0a14a04c03d977f58dd34c5d64116c7aba01601191ebbda08642cf0039bc2ab060b7174a5e8f5fa728dae2da14bceeaa3351f8bb4073b721
-  data.tar.gz: 6f32e5c076fac3d45c69c2e8dfcc6880ef8d73dbf32e1c87dfb51442f466b90917d9591c08fa5bbfd7f748845d2672b35befa3ea8210c6edec104f56398dd5b5
+  metadata.gz: d3dd354857e11c5a8864365a1e19c591eaec48a1349d3f675522f6835e5c830d9dd0328957866cbb5e085f1fab6679dec1588f8233841a33626469e9d5eb17a1
+  data.tar.gz: be4f6c9bf8192a20bba52cf2f196e33e96b9d6d7546efccb5c7efec9fb8295fd8caebff39f4131b4e9444dfc254b9c8814e039e529c43bb18fe7714ff0e2acd2

data/README.md

@@ -79,6 +79,9 @@ npm install -g mjml
 
 # with yarn
 yarn add mjml
+
+# with bun
+bun add mjml
 ```
 
 MJML-Rails falls back to a global installation of MJML but it is strongly recommended to add MJML directly to your project.
@@ -152,6 +155,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
 Mjml.setup do |config|
@@ -174,6 +182,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
 ```
 
@@ -203,7 +214,7 @@ npm install -g mjml@3.3.5
 
 ### How to guides
 
-[Hugo Giraudel](https://twitter.com/hugogiraudel) wrote a post on [using MJML in Rails](http://dev.edenspiekermann.com/2016/06/02/using-mjml-in-rails/).
+[Kitty Giraudel](https://twitter.com/KittyGiraudel) wrote a post on [using MJML in Rails](http://dev.edenspiekermann.com/2016/06/02/using-mjml-in-rails/).
 
 ## Using Email Layouts
 

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.1'
+  VERSION = '4.12.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)
@@ -46,8 +48,7 @@ module Mjml
   def self.valid_mjml_binary
     self.valid_mjml_binary = @@valid_mjml_binary ||
                              check_for_custom_mjml_binary ||
-                             check_for_yarn_mjml_binary ||
-                             check_for_npm_mjml_binary ||
+                             check_for_package_mjml_binary ||
                              check_for_global_mjml_binary ||
                              check_for_mrml_binary
 
@@ -72,30 +73,23 @@ module Mjml
           'it is a valid MJML binary. Please check your configuration.'
   end
 
-  def self.check_for_yarn_mjml_binary
-    yarn_bin = `which yarn`.chomp
-    return if yarn_bin.blank?
+  def self.check_for_mjml_package(package_manager, bin_command, binary_path)
+    pm_bin = `which #{package_manager}`.chomp
+    return if pm_bin.blank?
 
-    stdout, _, status = Open3.capture3("#{yarn_bin} bin mjml")
+    stdout, _, status = Open3.capture3("#{pm_bin} #{bin_command}")
     return unless status.success?
 
-    mjml_bin = stdout.chomp
+    mjml_bin = File.join(stdout.chomp, *binary_path)
     return mjml_bin if check_version(mjml_bin)
   rescue Errno::ENOENT # package manager is not installed
     nil
   end
 
-  def self.check_for_npm_mjml_binary
-    npm_bin = `which npm`.chomp
-    return if npm_bin.blank?
-
-    stdout, _, status = Open3.capture3("#{npm_bin} root")
-    return unless status.success?
-
-    mjml_bin = File.join(stdout.chomp, '.bin', 'mjml')
-    return mjml_bin if check_version(mjml_bin)
-  rescue Errno::ENOENT # package manager is not installed
-    nil
+  def self.check_for_package_mjml_binary
+    check_for_mjml_package('bun', 'pm bin', ['mjml']) ||
+      check_for_mjml_package('npm', 'root', ['.bin', 'mjml']) ||
+      check_for_mjml_package('yarn', 'bin mjml', [])
   end
 
   def self.check_for_global_mjml_binary

data/test/mjml_test.rb

@@ -162,8 +162,7 @@ describe Mjml do
     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_package_mjml_binary).returns(false)
       Mjml.stubs(:check_for_global_mjml_binary).returns(false)
       expect(Mjml.valid_mjml_binary).must_equal(true)
 

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.1
+  version: 4.12.0
 platform: ruby
 authors:
 - Simon Loffler
@@ -13,30 +13,30 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIEdDCCAtygAwIBAgIBATANBgkqhkiG9w0BAQsFADBAMRAwDgYDVQQDDAdzaWdo
   bW9uMRcwFQYKCZImiZPyLGQBGRYHc2lnaG1vbjETMBEGCgmSJomT8ixkARkWA2Nv
-  bTAeFw0yMzA1MTIwNzA2MTJaFw0yNDA1MTEwNzA2MTJaMEAxEDAOBgNVBAMMB3Np
+  bTAeFw0yNDA4MjQxMDM4MTNaFw0yNTA4MjQxMDM4MTNaMEAxEDAOBgNVBAMMB3Np
   Z2htb24xFzAVBgoJkiaJk/IsZAEZFgdzaWdobW9uMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAxHOFY9hovaIfd7wX
-  qSZuDoM5hmYVr6NlNl3/BaaAOXY48vSMIFDbLw0XbG7u9yT6LZhK6g8jnFpgXNMP
-  GfJn0wVC3vZn3kQtcpCG5udPUVJnMsRXD/uJV/XSDwJ9FWb6VBvFSW3iQ3B0LfdL
-  RT0kKBfik0bppwCgPGUuIPDsrMlNt0p8Bs1gIWkZm/C1bZDSa91OrJQPcSmBGVda
-  xdxbUzNrn7k9oWEa0g4iGimtargl+OW7mxWm28QrIYCv/DyqgvwB+jce3Yzk/qK/
-  tBFFCHiU3cJ10dOy4QKJn72pw9TiER9yRsfmucAyMFv9KOM3C2L5ZYhr2TgA4p49
-  oFJFOi78UvRkB8v9LQD+vq9yEZifAAUZ3rEh0OAupxhPmgAYkV7H86aV9x4hSEei
-  Hi0SrrKxbjjdE6n+1lFPGoqJVQa8SeZiLdlFSfp5vpUnegg0QNnvS1Ov1GwcwabT
-  Ukfs5RzhEQcabQcL0lequhZFQMliQCTgolTIgsrN7JjCkqXLAgMBAAGjeTB3MAkG
-  A1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBT3ovS4QF/lG/VvSbueQWRi
-  dNVOszAeBgNVHREEFzAVgRNzaWdobW9uQHNpZ2htb24uY29tMB4GA1UdEgQXMBWB
-  E3NpZ2htb25Ac2lnaG1vbi5jb20wDQYJKoZIhvcNAQELBQADggGBAA62EngIqmTY
-  f79wEueZU4P8o10SelwvawXFUkPrOyvDoGx/ZmZ7vpo3STuTN7ywS4h+P3V8t9Zt
-  e8eQ7Slk99lFuRbDoMaX3ARnB3EMjbpNbh3H+8xo5CrzJpklmU5BV6B91Clz3Bou
-  3vdY9D4lZ01s0LgMQsfLwOsKyHeWCEPVwkGdXl4bb/FKpsm0veicKxW3+3F5J+nB
-  zGDjFWsrjpgaq1wYzfO79NEmqrJwZFQM8SoOG89Jwo3iPzJ1mC0UlQx1E+wDakRQ
-  fjE20735cJoU1+WIKO6DLH/mHXDQ+Nrw+9zOWTizoV6at1QSvR1r4cM3u8TQGpIv
-  yjLIXbfSrriclRt4wg6Xlra1F3Jlm3DJMp9w5cRT+knQdTprNEft1lA2cVjczatt
-  RhdbGYd5Hku1QRVeQ+tN2OYG1/vZeRTqZ4MGLdl6r4iO5XGtWWoR2alg8kKc6yLx
-  P5J+9tLKId50fAv4voQg//wRwePPNiWIXsLUa1LPYWTAznKTvi3dAQ==
+  Y29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAuEka244tMe80fy0y
+  YPZ8DXPWGV39QTdTmuTiz3sQ8bSP2ckTzmig/0eT8XKHzYQbkOB00auQX6mwYQpD
+  OphRHPhDcEnPdGRmSIObSXujAFD8tq3ZcVd2bGZ8w8aHHRn5wNDwezLFbTYIhtr2
+  xMdOsSSdcXtslyfxRrLM+am0uVnaGVYWruVGABx+sCTy4qPLzvbF5r+YToV2zl7G
+  y/ZD/YsYnqhrvHWcBt/5tdzvP340UXr3fqoDhfUMD3WrziQLspgYyV65lBA9MMNt
+  dNbXNJDk1nLt8UHuWN9r15GEdnFFs4XryrG0dmsvYAQ+JmVgFvVEFa5dFeTYhntB
+  /h6/1BUgbqtQBDi1e2T0fIi5BxoDd1Asp5OeulyiglDAaAVCIlGdXKGjMKKX1b2N
+  tHZj+9aj1US7cI/sGRsEenlMtoXTjew41x2UwXbHZssaOLsn/ubJr+HP3bLph9it
+  gD4VwPpzem66FPNH/uFfAF17H11961fbTvlPtxcVj39EFMH7AgMBAAGjeTB3MAkG
+  A1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBTo6MDHQYDOj+zwdyTsCljW
+  +zZwszAeBgNVHREEFzAVgRNzaWdobW9uQHNpZ2htb24uY29tMB4GA1UdEgQXMBWB
+  E3NpZ2htb25Ac2lnaG1vbi5jb20wDQYJKoZIhvcNAQELBQADggGBAAj8eUP4oTrt
+  Rnf7qJec8F2EA2mJLUz+PrGrM/eiP0jIVeGGrwfvn9hBtU+3IG6IPj16nb40T+/Q
+  iSNIYxOZHYxj2CZf2CKKIz5slESybSlfuX/3i6WgZ3GP9X+z5jZE43fA1zR9kWIN
+  xVl3McOoST+/UP+skagMdOl8S6qg8THdb9qTZLDT+XJVLNE8k7bcOiTKa6ef/hCR
+  A9C/1rxJJHehHewkQQPLJg5edufj2t+BVY0tnMT24TXVCS7qy9BjZ/f1hC+4jrUA
+  ezb/gRETp2GvGgoIrrZSiTiODKfIuhjifaxy1c+E/XfvN7gtO6awgTKHg+gt6y55
+  ECdz0FTGporEyMBWc+GqSpfIXKKlNUsWyEEo9J3mjDfED/1nP+bePK+B3wwc69sl
+  Qqk2dn/fFE9vdcl9OaOw2Zizne/1VFL/jkzXLqnLgbKD/q129mVCBgw2CKYnQfMN
+  4RwBjPyqnMxWnSq6Ycn7HdFEkgyf2cAxFfH5QtDsjEuca+/LAJMeAQ==
   -----END CERTIFICATE-----
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-08-24 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.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: MJML + ERb templates