mrml 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd784db00a3c005e5e1adaf5df181f2c6a9aa1bc28d35a1eed5952dc8f5eba57
-  data.tar.gz: 835836835cd290c5548965f251e9a47fd9418edb6cf5ff064c85744cc3eae0ee
+  metadata.gz: f5082abdee5d6861d22a39241d896fc680f920982801a4ebb6f40dae2cad8995
+  data.tar.gz: 88c08eb3e5fe5ea33c9136b445518e93d25a3ec758809c6268f50ae320c1f9d8
 SHA512:
-  metadata.gz: 042a8847470a0de9e4d1fcf47456de8578407d7cc7b281fd7c36720e0a284adc02fc52af0025be56146061508662470639e3692b764cea567e837e5e8a1c9db6
-  data.tar.gz: af605ddf56d3fc9e07b921589b29f4d36e563e1a8fd754279e59cd923086141348cd5def5a181ce114a5651f5d99508f3cde4e26d846e55996d5c0544197470b
+  metadata.gz: 1f2f72040b78f5afbc378ced982c4c8b5744b11d9fea05b7d0560f6645534f2ef36bbfef9593a4c2acc12c81b242d81fb8d16471dd74cf376955f5ca1b1efc1c
+  data.tar.gz: 5f51220afa5ad2b600b166739657da060bc962d6a707ee22dd5d786455e3a943fdfe528cab4d1cf20c301276708bd2cdc366698b746f899a9f2a9cdc152ab338

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+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).
 
 [![Gem Version](https://badge.fury.io/rb/mrml.svg)](https://badge.fury.io/rb/mrml)
 [![Build](https://github.com/hardpixel/mrml-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/hardpixel/mrml-ruby/actions/workflows/build.yml)
@@ -105,6 +105,33 @@ 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.

data/ext/mrml/Cargo.toml

@@ -5,7 +5,7 @@ authors = ["Jonian Guveli <jonian@hardpixel.eu>"]
 edition = "2018"
 
 [dependencies]
-mrml = "1.2"
+mrml = "3.0"
 magnus = "0.5"
 
 [dependencies.serde]

data/ext/mrml/src/lib.rs

@@ -4,9 +4,9 @@ use magnus::{
   Error, ExceptionClass, RModule
 };
 
-use mrml::mjml::MJML;
+use mrml::mjml::Mjml;
 use mrml::prelude::print::Print;
-use mrml::prelude::render::Options;
+use mrml::prelude::render::RenderOptions;
 
 fn mrml_error() -> ExceptionClass {
   *memoize!(ExceptionClass: {
@@ -16,23 +16,29 @@ fn mrml_error() -> ExceptionClass {
   })
 }
 
+macro_rules! error {
+  ($ex:ident) => {
+    Error::new(mrml_error(), $ex.to_string())
+  };
+}
+
 #[magnus::wrap(class = "MRML::Template", free_immediately, size)]
 struct Template {
-  res: MJML
+  res: Mjml
 }
 
 impl Template {
   fn new(input: String) -> Result<Self, Error> {
     match mrml::parse(&input) {
       Ok(res) => Ok(Self { res }),
-      Err(ex) => Err(Error::new(mrml_error(), ex.to_string()))
+      Err(ex) => Err(error!(ex))
     }
   }
 
   fn from_json(input: String) -> Result<Self, Error> {
-    match serde_json::from_str::<MJML>(&input) {
+    match serde_json::from_str::<Mjml>(&input) {
       Ok(res) => Ok(Self { res }),
-      Err(ex) => Err(Error::new(mrml_error(), ex.to_string()))
+      Err(ex) => Err(error!(ex))
     }
   }
 
@@ -51,14 +57,14 @@ impl Template {
   fn to_json(&self) -> Result<String, Error> {
     match serde_json::to_string(&self.res) {
       Ok(res) => Ok(res),
-      Err(ex) => Err(Error::new(mrml_error(), ex.to_string()))
+      Err(ex) => Err(error!(ex))
     }
   }
 
   fn to_html(&self) -> Result<String, Error> {
-    match self.res.render(&Options::default()) {
+    match self.res.render(&RenderOptions::default()) {
       Ok(res) => Ok(res),
-      Err(ex) => Err(Error::new(mrml_error(), ex.to_string()))
+      Err(ex) => Err(error!(ex))
     }
   }
 }

data/lib/mrml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MRML
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrml
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Jonian Guveli
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for MRML Rust