mjml-rails 4.12.1 → 4.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01907552b34958af3e345325340d7c93d23fff1ab5510b8a0af948b2f58b66f1'
-  data.tar.gz: 7cf08f76b582345db1a6e445c88bdb347031fa090e4af5aaa155d4fe834b31ef
+  metadata.gz: 9c6559e7522a96885f084a543108e00fc80bf778dd371edbf6a67ffb20c8269a
+  data.tar.gz: e14f43e0de4ad7524c1774784552299fd9689b1643b9504e73f44bed92677c2e
 SHA512:
-  metadata.gz: 562b509f671c502a942e0ba76501441d0cad4670ca73514ae43ad82814f5e9e0bb853a89c8128617f3a7026cd0a7c591b43b999d3cc7bc2aed45b5e975f2ba63
-  data.tar.gz: e57778aadf44939220cce799f9b80eab9e517c6c3d69fecf00fb8f35ddf7ec1a7ef517060ac63804606a23a93c834b7a9a9ca0635cbc9fd994ea266f74c89590
+  metadata.gz: fe6820680ae3e42c303ac19d687b2fd01b7c36eb16f9deb590a34e3fe0eb6fd55774f09f95514a46239d233c2209b73247f0e8c577a2c3902e509596c0f8e7ac
+  data.tar.gz: 79ef029fc1a7cecdc35bb3e7681edb865968e5263e110bf7a0b1a87316a6d403e60d6e8383936fda29d6494e118cbf64b8756599933291b6711a63de08fd0548

data/README.md

@@ -68,6 +68,14 @@ Run the following command to install it:
 bundle install
 ```
 
+After installation, you can generate the MJML initializer file:
+
+```console
+rails generate mjml:install
+```
+
+This will create `config/initializers/mjml.rb` with default configuration options.
+
 Add the MJML parser to your project with your favourite package manager:
 
 ```console
@@ -124,7 +132,7 @@ MJML-Rails has the following settings with defaults:
 
    ERB can be used inside MJML templates by default. Possible values are all template languages that you have installed, e.g. `:haml` or `:slim`.
 
-   **Note:** If you’re using Haml/Slim layouts, please don’t put `<mjml>` in comments in your partial. Read more at [#34](https://github.com/sighmon/mjml-rails/issues/34).
+   **Note:** If you're using Haml/Slim layouts, please don't put `<mjml>` in comments in your partial. Read more at [#34](https://github.com/sighmon/mjml-rails/issues/34).
 
 - `raise_render_exception: true`
 
@@ -155,6 +163,9 @@ 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.
 
+- `cache_mjml: false`
+  By default, MJML-Rails does not cache compiled templates. Setting this to `true` will cache compiled templates in `tmp/mjml_cache` to improve performance for frequently used templates.
+
 - `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 }`
@@ -185,6 +196,9 @@ Mjml.setup do |config|
 
   # Use default system fonts instead of google fonts
   config.fonts = {}
+
+  # Uncomment this to enable template caching
+  # config.cache_mjml = true
 end
 ```
 

data/lib/generators/mjml/install/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Mjml
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      desc 'Creates MJML initializer for your application'
+
+      def copy_initializer
+        template 'mjml.rb', 'config/initializers/mjml.rb'
+      end
+    end
+  end
+end

data/lib/generators/mjml/install/templates/mjml.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# MJML configuration
+Mjml.setup do |config|
+  # Use :erb as a template language
+  config.template_language = :erb
+
+  # Raise exceptions for template errors
+  config.raise_render_exception = true
+
+  # Beautify the output HTML
+  config.beautify = true
+
+  # Minify the output HTML
+  config.minify = false
+
+  # Validation level for MJML templates
+  # Possible values: 'strict', 'soft'
+  config.validation_level = 'strict'
+
+  # Use MRML instead of MJML (requires mrml gem)
+  config.use_mrml = false
+
+  # Cache compiled templates for better performance
+  config.cache_mjml = false
+
+  # Custom fonts configuration
+  # Example: config.fonts = { Raleway: 'https://fonts.googleapis.com/css?family=Raleway' }
+  config.fonts = nil
+
+  # Uncomment this to enable template caching
+  # config.cache_mjml = true
+end

data/lib/mjml/cache.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Mjml
+  class Cache
+    attr_reader :template_path
+
+    def initialize(template_path)
+      @template_path = template_path
+    end
+
+    # @yield [] -> String
+    # @return [String]
+    def cache(&block)
+      return yield if !Mjml.cache_mjml && block
+
+      cached_path = cached_file_path
+      if File.exist?(cached_path)
+        File.read(cached_path)
+      else
+        html_content = yield if block
+        File.write(cached_path, html_content)
+        html_content
+      end
+    end
+
+    private
+
+    def cached_file_path
+      File.join(cache_directory, "#{fingerprint}.html")
+    end
+
+    def fingerprint
+      full_path = File.join(Dir.pwd, 'app', 'views', "#{template_path}.mjml")
+      raise "Template file not found: #{full_path}" unless File.exist?(full_path)
+
+      Digest::SHA256.hexdigest(File.read(full_path))
+    end
+
+    def cache_directory
+      dir = File.join(Dir.pwd, 'tmp', 'mjml_cache')
+      FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+      dir
+    end
+  end
+end

data/lib/mjml/handler.rb

@@ -17,6 +17,7 @@ module Mjml
       compiled_source = compile_source(source, template)
 
       parser_class = Mjml.use_mrml ? 'MrmlParser' : 'Parser'
+      template_path = template.virtual_path
       # Per MJML v4 syntax documentation[0] valid/render'able document MUST start with <mjml> root tag
       # If we get here and template source doesn't start with one it means
       # that we are rendering partial named according to legacy naming convention (partials ending with '.mjml')
@@ -25,7 +26,7 @@ module Mjml
       #
       # [0] - https://github.com/mjmlio/mjml/blob/master/doc/components_1.md#mjml
       if /<mjml.*?>/i.match?(compiled_source)
-        "Mjml::#{parser_class}.new(begin;#{compiled_source};end).render.html_safe"
+        "Mjml::#{parser_class}.new('#{template_path}', begin;#{compiled_source};end).render.html_safe"
       else
         compiled_source
       end

data/lib/mjml/mrml_parser.rb

@@ -2,27 +2,32 @@
 
 module Mjml
   class MrmlParser
-    attr_reader :input
+    attr_reader :template_path, :input
 
     # Create new parser
     #
+    # @param template_path [String] The path to the .mjml file
     # @param input [String] The string to transform in html
-    def initialize(input)
-      @input = input
+    def initialize(template_path, input)
+      @template_path = template_path
+      @input         = input
+      @with_cache    = Cache.new(template_path)
     end
 
     # Render mjml template
     #
     # @return [String]
     def render
-      MRML.to_html(input)
-    rescue NameError
-      Mjml.logger.fatal('MRML is not installed. Please add `gem "mrml"` to your Gemfile.')
-      raise
-    rescue StandardError
-      raise if Mjml.raise_render_exception
+      @with_cache.cache do
+        MRML.to_html(input)
+      rescue NameError
+        Mjml.logger.fatal('MRML is not installed. Please add `gem "mrml"` to your Gemfile.')
+        raise
+      rescue StandardError
+        raise if Mjml.raise_render_exception
 
-      ''
+        ''
+      end
     end
   end
 end

data/lib/mjml/parser.rb

@@ -1,36 +1,46 @@
 # frozen_string_literal: true
 
+require 'digest'
+require_relative 'cache'
+
 module Mjml
   class Parser
     class ParseError < StandardError; end
 
-    attr_reader :input
+    attr_reader :template_path, :input
 
     # Create new parser
     #
-    # @param input [String] The string to transform in html
-    def initialize(input)
+    # @param template_path [String] The path to the .mjml file
+    # @param input [String] The content of the .mjml file
+    def initialize(template_path, input)
       raise Mjml.mjml_binary_error_string unless Mjml.valid_mjml_binary
 
-      @input = input
+      @template_path = template_path
+      @input         = input
+      @with_cache    = Cache.new(template_path)
     end
 
-    # Render mjml template
+    # rubocop:disable Metrics/MethodLength
+    # Render MJML template
     #
     # @return [String]
     def render
-      in_tmp_file = Tempfile.open(['in', '.mjml']) do |file|
-        file.write(input)
-        file # return tempfile from block so #unlink works later
-      end
-      run(in_tmp_file.path)
-    rescue StandardError
-      raise if Mjml.raise_render_exception
+      @with_cache.cache do
+        in_tmp_file = Tempfile.open(['in', '.mjml']) do |file|
+          file.write(input)
+          file # return tempfile from block so #unlink works later
+        end
+        run(in_tmp_file.path)
+      rescue StandardError
+        raise if Mjml.raise_render_exception
 
-      ''
-    ensure
-      in_tmp_file&.unlink
+        ''
+      ensure
+        in_tmp_file&.unlink
+      end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Exec mjml command
     #

data/lib/mjml/version.rb

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

data/lib/mjml.rb

@@ -19,7 +19,8 @@ module Mjml
     :raise_render_exception,
     :template_language,
     :validation_level,
-    :use_mrml
+    :use_mrml,
+    :cache_mjml
 
   mattr_writer :valid_mjml_binary
 
@@ -33,6 +34,7 @@ module Mjml
   self.validation_level = 'strict'
   self.use_mrml = false
   self.fonts = nil
+  self.cache_mjml = false
 
   def self.check_version(bin)
     stdout, _, status = run_mjml('--version', mjml_bin: bin)
@@ -45,12 +47,24 @@ module Mjml
     Open3.capture3("#{mjml_bin} #{args}")
   end
 
+  def self.which(command)
+    if Gem.win_platform?
+      stdout, _, status = Open3.capture3("where #{command}")
+    else
+      stdout, _, status = Open3.capture3("which #{command}")
+    end
+    status.success? ? stdout.chomp : nil
+  rescue Errno::ENOENT
+    nil
+  end
+
   def self.valid_mjml_binary
     self.valid_mjml_binary = @@valid_mjml_binary ||
                              check_for_custom_mjml_binary ||
+                             check_for_mrml_binary ||
+                             check_for_bun_mjml_binary ||
                              check_for_package_mjml_binary ||
-                             check_for_global_mjml_binary ||
-                             check_for_mrml_binary
+                             check_for_global_mjml_binary
 
     return @@valid_mjml_binary if @@valid_mjml_binary
 
@@ -74,10 +88,8 @@ module Mjml
   end
 
   def self.check_for_mjml_package(package_manager, bin_command, binary_path)
-    stdout, _, status = Open3.capture3("which #{package_manager}")
-    return unless status.success?
-
-    pm_bin = stdout.chomp
+    pm_bin = Mjml.which(package_manager)
+    return unless pm_bin
 
     stdout, _, status = Open3.capture3("#{pm_bin} #{bin_command}")
     return unless status.success?
@@ -88,17 +100,24 @@ module Mjml
     nil
   end
 
+  def self.check_for_bun_mjml_binary
+    return unless Mjml.which('bun')
+
+    # HINT: Bun always prioritizes local bins first and falls back to global installations
+    mjml_bin = 'bun run mjml'
+
+    return mjml_bin if check_version(mjml_bin)
+  end
+
   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('npm', 'root', ['.bin', 'mjml']) ||
       check_for_mjml_package('yarn', 'bin mjml', [])
   end
 
   def self.check_for_global_mjml_binary
-    stdout, _, status = Open3.capture3('which mjml')
-    return unless status.success?
+    mjml_bin = Mjml.which('mjml')
+    return unless mjml_bin
 
-    mjml_bin = stdout.chomp
     return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
   end
 

data/test/mjml_test.rb

@@ -162,6 +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_bun_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/mrml_parser_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 describe Mjml::MrmlParser do
-  let(:parser) { Mjml::MrmlParser.new(input) }
+  let(:parser) { Mjml::MrmlParser.new('test_template', input) }
 
   describe '#render' do
     describe 'when input is valid' do

data/test/parser_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 describe Mjml::Parser do
   let(:input) { mock('input') }
-  let(:parser) { Mjml::Parser.new(input) }
+  let(:parser) { Mjml::Parser.new('test_template', input) }
 
   describe '#render' do
     describe 'when exception is raised' do
@@ -42,7 +42,7 @@ describe Mjml::Parser 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)
+        assert_nil(Mjml.fonts)
       end
 
       it 'uses setup config' do

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.12.1
+  version: 4.15.1
 platform: ruby
 authors:
 - Simon Loffler
 - Steven Pickles
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -36,7 +35,7 @@ cert_chain:
   Qqk2dn/fFE9vdcl9OaOw2Zizne/1VFL/jkzXLqnLgbKD/q129mVCBgw2CKYnQfMN
   4RwBjPyqnMxWnSq6Ycn7HdFEkgyf2cAxFfH5QtDsjEuca+/LAJMeAQ==
   -----END CERTIFICATE-----
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -158,11 +157,14 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- lib/generators/mjml/install/install_generator.rb
+- lib/generators/mjml/install/templates/mjml.rb
 - lib/generators/mjml/mailer/mailer_generator.rb
 - lib/generators/mjml/mailer/templates/layout.html.mjml
 - lib/generators/mjml/mailer/templates/view.html.erb
 - lib/mjml-rails.rb
 - lib/mjml.rb
+- lib/mjml/cache.rb
 - lib/mjml/handler.rb
 - lib/mjml/mrml_parser.rb
 - lib/mjml/parser.rb
@@ -192,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: MJML + ERb templates
 test_files: