Module: Mjml
- Defined in:
- lib/mjml.rb,
lib/mjml/parser.rb,
lib/mjml/handler.rb,
lib/mjml/railtie.rb,
lib/mjml/version.rb,
lib/generators/mjml/mailer/mailer_generator.rb
Defined Under Namespace
Modules: Generators
Classes: Handler, Parser, Railtie
Constant Summary
collapse
- VERSION =
Version number no longer matches MJML.io version
'4.9.0'
Class Attribute Summary collapse
Class Method Summary
collapse
Class Attribute Details
.logger ⇒ Object
115
116
117
118
119
|
# File 'lib/mjml.rb', line 115
def logger
@logger ||= Logger.new($stdout).tap do |log|
log.progname = name
end
end
|
Class Method Details
.check_for_custom_mjml_binary ⇒ Object
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# File 'lib/mjml.rb', line 56
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
return if mjml_binary.blank?
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
|
.check_for_global_mjml_binary ⇒ Object
98
99
100
101
|
# File 'lib/mjml.rb', line 98
def self.check_for_global_mjml_binary
mjml_bin = `which mjml`.chomp
return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
end
|
.check_for_npm_mjml_binary ⇒ Object
85
86
87
88
89
90
91
92
93
94
95
96
|
# File 'lib/mjml.rb', line 85
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
nil
end
|
.check_for_yarn_mjml_binary ⇒ Object
72
73
74
75
76
77
78
79
80
81
82
83
|
# File 'lib/mjml.rb', line 72
def self.check_for_yarn_mjml_binary
yarn_bin = `which yarn`.chomp
return if yarn_bin.blank?
stdout, _, status = Open3.capture3("#{yarn_bin} bin mjml")
return unless status.success?
mjml_bin = stdout.chomp
return mjml_bin if check_version(mjml_bin)
rescue Errno::ENOENT
nil
end
|
.check_version(bin) ⇒ Object
33
34
35
36
37
38
|
# File 'lib/mjml.rb', line 33
def self.check_version(bin)
stdout, _, status = run_mjml('--version', mjml_bin: bin)
status.success? && stdout.include?("mjml-core: #{Mjml.mjml_binary_version_supported}")
rescue StandardError
false
end
|
.discover_mjml_bin ⇒ Object
103
104
105
106
|
# File 'lib/mjml.rb', line 103
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
|
.run_mjml(args, mjml_bin: valid_mjml_binary) ⇒ Object
40
41
42
|
# File 'lib/mjml.rb', line 40
def self.run_mjml(args, mjml_bin: valid_mjml_binary)
Open3.capture3("#{mjml_bin} #{args}")
end
|
.setup {|_self| ... } ⇒ Object
108
109
110
|
# File 'lib/mjml.rb', line 108
def self.setup
yield self if block_given?
end
|
.valid_mjml_binary ⇒ Object
44
45
46
47
48
49
50
51
52
53
54
|
# File 'lib/mjml.rb', line 44
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_global_mjml_binary
return @@valid_mjml_binary if @@valid_mjml_binary
puts Mjml.mjml_binary_error_string
end
|