mrml 1.5.1-aarch64-linux-musl

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48930121b1177677907b9a3981ebe9c81d37299606dd4e0626a636b2c998d4ee
+  data.tar.gz: 3281c57bfd3548e2c729c29c18dec76d432ea1ebc8ccaa2deea78c7c98e75fbb
+SHA512:
+  metadata.gz: b45ca44f2034f049a65cc8c2922d9b24d17db072281cd345c4719d655cb2d0773a89e12a5c24cfe75b3b4bec1b13479b92c1659faed1ee4da55a7bf37afb2cea
+  data.tar.gz: 57f8778c7d81e0fd59db11954b2803164c199dd51e65054d96c5a4b461ca6ab525c753a63808f1db69747112f251352401f7fe749c2dbf7c6ee5eb0d9522a4ed

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Code of Conduct
+
+All participants of this project are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with this project.
+
+## The Pledge
+
+In the interest of fostering an open and welcoming environment, we pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## The Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Referring to people by their preferred pronouns and using gender-neutral pronouns when uncertain
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Dismissing or attacking inclusion-oriented requests
+
+## Enforcement
+
+Violations of the Code of Conduct may be reported by sending an email to info@hardpixel.eu. All reports will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Further details of specific enforcement policies may be posted separately.
+
+We hold the right and responsibility to remove comments or other contributions that are not aligned to this Code of Conduct, or to suspend temporarily or permanently any members for other behaviors that are inappropriate, threatening, offensive, or harmful.
+
+## Attribution
+
+This Code of Conduct is adapted from [dev.to](https://dev.to/code-of-conduct).

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 jonian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# 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).
+
+[![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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e307214d3c2e4d2056d/maintainability)](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
+<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 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).

data/lib/mrml/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MRML
+  class Error < StandardError
+  end
+end

data/lib/mrml/template.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module MRML
+  # Template object implemented in Rust that can parse MJML templates.
+  class Template
+    class << self
+      # @!method from_json(json)
+      # A new instance of Template from JSON.
+      # @!scope class
+      # @param json [String]
+      # @return [Template]
+      # @raise [Error] if json has invalid format
+
+      # A new instance of Template from Hash.
+      # @param hash [Hash]
+      # @return [Template]
+      # @raise [Error] if hash has invalid format
+
+      def from_hash(hash)
+        from_json(JSON.generate(hash))
+      end
+    end
+
+    # @!method initialize(mjml)
+    # A new instance of Template.
+    # @param mjml [String]
+    # @return [Template]
+    # @raise [Error] if mjml is not a valid template
+
+    # @!attribute [r] title
+    # Gets mj-title tag value.
+    # @return [String]
+
+    # @!attribute [r] preview
+    # Gets mj-preview tag value.
+    # @return [String]
+
+    # @!method to_mjml
+    # MJML representation of the template.
+    # @return [String]
+
+    # @!method to_json
+    # JSON representation of the template.
+    # @return [String]
+
+    # @!method to_html
+    # HTML representation of the template.
+    # @return [String]
+
+    # Hash representation of the template.
+    # @return [Hash]
+
+    def to_hash
+      JSON.parse(to_json)
+    end
+  end
+end

data/lib/mrml/version.rb

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

data/lib/mrml.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "mrml/#{$1}/mrml"
+rescue LoadError
+  require 'mrml/mrml'
+end
+
+require 'mrml/error'
+require 'mrml/template'
+require 'mrml/version'
+
+# Module that renders MJML templates into HTML/JSON using MRML,
+# a reimplementation of the MJML markup language in Rust.
+module MRML
+  class << self
+    # Render template as HTML.
+    # @param mjml [String]
+    # @return (see Template#to_html)
+    # @raise (see Template#initialize)
+
+    def to_html(mjml)
+      return if mjml.nil?
+
+      template = Template.new(mjml)
+      template.to_html
+    end
+
+    # Render template as JSON.
+    # @param mjml [String]
+    # @return (see Template#to_json)
+    # @raise (see Template#initialize)
+
+    def to_json(mjml)
+      return if mjml.nil?
+
+      template = Template.new(mjml)
+      template.to_json
+    end
+
+    # Render template as Hash.
+    # @param mjml [String]
+    # @return (see Template#to_hash)
+    # @raise (see Template#initialize)
+
+    def to_hash(mjml)
+      return if mjml.nil?
+
+      template = Template.new(mjml)
+      template.to_hash
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: mrml
+version: !ruby/object:Gem::Version
+  version: 1.5.1
+platform: aarch64-linux-musl
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Ruby wrapper for MRML, the MJML parser implementation in Rust.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/mrml.rb
+- lib/mrml/2.6/mrml.so
+- lib/mrml/2.7/mrml.so
+- lib/mrml/3.1/mrml.so
+- lib/mrml/3.2/mrml.so
+- lib/mrml/3.3/mrml.so
+- lib/mrml/error.rb
+- lib/mrml/template.rb
+- lib/mrml/version.rb
+homepage: https://github.com/hardpixel/mrml-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.4.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for MRML Rust
+test_files: []