Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hardpixel/mrml-ruby
Ruby wrapper for MRML, the MJML parser implementation in Rust.
https://github.com/hardpixel/mrml-ruby
mjml native-extension ruby ruby-gem
Last synced: 2 days ago
JSON representation
Ruby wrapper for MRML, the MJML parser implementation in Rust.
- Host: GitHub
- URL: https://github.com/hardpixel/mrml-ruby
- Owner: hardpixel
- License: mit
- Created: 2021-02-01T12:06:38.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T08:09:53.000Z (7 months ago)
- Last Synced: 2025-01-13T13:22:21.026Z (13 days ago)
- Topics: mjml, native-extension, ruby, ruby-gem
- Language: Ruby
- Homepage:
- Size: 103 KB
- Stars: 53
- Watchers: 7
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MRML Ruby
Ruby wrapper for [MRML](https://github.com/jdrouet/mrml), the [MJML](https://mjml.io) 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](https://github.com/hardpixel/mrml-ruby/releases/tag/v1.4.2).
[](https://badge.fury.io/rb/mrml)
[](https://github.com/hardpixel/mrml-ruby/actions/workflows/build.yml)
[](https://codeclimate.com/github/hardpixel/mrml-ruby/maintainability)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'mrml'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install mrml
## Usage
```ruby
require 'mrml'
mjml = <<-HTML
Newsletter Title
Newsletter Preview
Hello World
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 hash
```
```ruby
require '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 hash
```
## Benchmark
```
Warming up --------------------------------------
mrml 3.069k i/100ms
mjml 1.000 i/100ms
Calculating -------------------------------------
mrml 32.537k (±16.1%) i/s - 156.519k in 5.029759s
mjml 1.895 (± 0.0%) i/s - 10.000 in 5.283579s
Comparison:
mrml: 32537.2 i/s
mjml: 1.9 i/s - 17169.16x slower
Calculating -------------------------------------
mrml 3.166k memsize ( 0.000 retained)
2.000 objects ( 0.000 retained)
1.000 strings ( 0.000 retained)
mjml 21.253k memsize ( 1.490k retained)
107.000 objects ( 15.000 retained)
20.000 strings ( 11.000 retained)
Comparison:
mrml: 3166 allocated
mjml: 21253 allocated - 6.71x 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](https://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](https://opensource.org/licenses/MIT).