MRML Ruby
Ruby wrapper for MRML, the MJML markup language implementation in Rust. Rust must be available on your system to install this gem if you use a version below v1.4.2.
Installation
Add this line to your application's Gemfile:
gem 'mrml'And then execute:
$ bundle install
Or install it yourself as:
$ gem install mrml
Usage
require 'mrml'
mjml = <<-HTML
<mjml>
<mj-head>
<mj-title>Newsletter Title</mj-title>
<mj-preview>Newsletter Preview</mj-preview>
</mj-head>
<mj-body>
<mj-section>
<mj-column>
<mj-text font-size="20px" color="#F45E43" font-family="helvetica">Hello World</mj-text>
</mj-column>
</mj-section>
</mj-body>
</mjml>
HTML
# Using module methods
MRML.to_html(mjml) # Generate html from mjml
MRML.to_json(mjml) # Generate json from mjml
MRML.to_hash(mjml) # Generate hash from mjml
# Using Template class
template = MRML::Template.new(mjml)
template.title # Get template title
template.preview # Get template preview
template.to_html # Render as html
template.to_mjml # Render as mjml
template.to_json # Render as json
template.to_hash # Render as hashrequire 'mrml'
json = <<-JSON
{
"type": "mjml",
"children": [{
"type": "mj-head",
"children": [{
"type": "mj-title",
"children": "Newsletter Title"
}, {
"type": "mj-preview",
"children": "Newsletter Preview"
}]
}, {
"type": "mj-body",
"children": [{
"type": "mj-section",
"children": [{
"type": "mj-column",
"children": [{
"type": "mj-text",
"attributes": {
"font-size": "20px",
"color": "#F45E43",
"font-family": "helvetica"
},
"children": ["Hello World"]
}]
}]
}]
}]
}
JSON
# Create Template from JSON
template = MRML::Template.from_json(json)
template.to_html # Render as html
template.to_mjml # Render as mjml
template.to_json # Render as json
template.to_hash # Render as hashBenchmark
Warming up --------------------------------------
mrml 3.071k i/100ms
mjml 1.000 i/100ms
Calculating -------------------------------------
mrml 40.927k (±14.2%) i/s ( 24.43 μs/i) - 199.615k in 5.058805s
mjml 1.774 (± 0.0%) i/s (563.81 ms/i) - 9.000 in 5.085477s
Comparison:
mrml: 40927.2 i/s
mjml: 1.8 i/s - 23075.08x slower
Calculating -------------------------------------
mrml 3.109k memsize ( 0.000 retained)
2.000 objects ( 0.000 retained)
1.000 strings ( 0.000 retained)
mjml 24.183k memsize ( 40.000 retained)
110.000 objects ( 1.000 retained)
28.000 strings ( 1.000 retained)
Comparison:
mrml: 3109 allocated
mjml: 24183 allocated - 7.78x more
Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/mrml-ruby.
License
The gem is available as open source under the terms of the MIT License.