Module: Mjml

Defined in:

lib/mjml.rb,
lib/mjml/parser.rb,
lib/mjml/railtie.rb,
lib/mjml/version.rb,
lib/mjml/mjmltemplate.rb,
lib/generators/mjml/mailer/mailer_generator.rb

Defined Under Namespace

Modules: Generators Classes: Handler, Mjmltemplate, Parser, Railtie

Constant Summary

BIN =

discover_mjml_bin

VERSION =

Version number no longer matches MJML.io version

"4.3.2"

@@template_language =

:erb

@@raise_render_exception =

true

@@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

@@processing_options =

{}

Class Attribute Summary

• .logger ⇒ Object

Class Method Summary

• .bin_path_from(package_manager) ⇒ Object
• .check_version(bin) ⇒ Object
• .discover_mjml_bin ⇒ Object
• .setup {|_self| ... } ⇒ Object

Class Attribute Details

.logger ⇒ Object

# File 'lib/mjml.rb', line 91

def logger
  @logger ||= Logger.new($stdout).tap do |log|
    log.progname = self.name
  end
end

Class Method Details

.bin_path_from(package_manager) ⇒ Object

# File 'lib/mjml.rb', line 44

def self.bin_path_from(package_manager)
  _, stdout, _, _ = Open3.popen3("#{package_manager} bin")
 stdout.read.chomp
rescue Errno::ENOENT # package manager is not installed
  nil
end

.check_version(bin) ⇒ Object

# File 'lib/mjml.rb', line 19

def self.check_version(bin)
  IO.popen([bin, '--version']) { |io| io.read.include?("mjml-core: #{Mjml.mjml_binary_version_supported}") }
rescue
  false
end

.discover_mjml_bin ⇒ Object

# File 'lib/mjml.rb', line 25

def self.discover_mjml_bin
  # Check for a global install of MJML binary
  mjml_bin = 'mjml'
  return mjml_bin if check_version(mjml_bin)

  # Check for a local install of MJML binary
  installer_path = bin_path_from('npm') || bin_path_from('yarn')
  unless installer_path
    puts Mjml.mjml_binary_error_string
    return nil
  end

  mjml_bin = File.join(installer_path, 'mjml')
  return mjml_bin if check_version(mjml_bin)

  puts Mjml.mjml_binary_error_string
  nil
end

.setup {|_self| ... } ⇒ Object

Yields:

• (_self)

Yield Parameters:

• _self (Mjml) —

  the object that the method was called on

# File 'lib/mjml.rb', line 84

def self.setup
  yield self if block_given?
end