mrml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 698a5cbddf2e1321636928ab0c6bb5edf1e8909173a516de3b9c7d7059122a15
+  data.tar.gz: 13f6b2ae6f0c74c712b66fc481dd13481a4060cf33889fef66b5a277e715eedf
+SHA512:
+  metadata.gz: 1639da3c3ab01afe8ca6930d5f487debff86b67f73469e59611a4198447caa1a2c3771904d5361e8a57dce43ced08aea29fc4bf43bd48e5d6c7a0bbd4fca9933
+  data.tar.gz: 19a0e0f5c8cf10e0c8a10aa73324d5690dc8ddf2c886fc59bd54c2b2acf729206534812b5c0602d2e8ba10e464f756548e3291bd7f990dbcc49c3f9f1c246791

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# Added by cargo
+
+/target
+Cargo.lock
+
+/lib/*.so
+/mkmf.log

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "mrml"
+version = "0.1.0"
+authors = ["Jonian Guveli <jonian@hardpixel.eu>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[dependencies]
+ruru = "0.9.3"
+mrml = "0.4.0"
+
+[lib]
+name = "mrml"
+crate-type = ["cdylib"]

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mrml.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

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,68 @@
+# MRML Ruby
+
+Ruby wrapper for [MRML](https://github.com/jdrouet/mrml), the [MJML](https://mjml.io) parser implementation in Rust. Rust must be available on your system to install this gem.
+
+## 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'
+
+template = <<-HTML
+<mjml>
+  <mj-head>
+    <mj-title>Newsletter Title</mj-title>
+  </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
+
+# Generate the title from mjml
+MRML.to_title(template)
+
+# Generate the preview from mjml
+MRML.to_preview(template)
+
+# Generate the html from mjml
+MRML.to_html(template)
+```
+
+## To Do
+
+Add support for options.
+
+## 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/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "thermite/tasks"
+
+Thermite::Tasks.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mrml'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/Rakefile

@@ -0,0 +1,6 @@
+require "thermite/tasks"
+
+project_dir = File.dirname(File.dirname(__FILE__))
+Thermite::Tasks.new(cargo_project_path: project_dir, ruby_project_path: project_dir)
+
+task default: %w(thermite:build)

data/lib/mrml.rb

@@ -0,0 +1,44 @@
+require 'ffi'
+require 'mrml/version'
+
+module MRML
+  class Error < StandardError
+  end
+
+  class << self
+    extend FFI::Library
+
+    ffi_lib File.expand_path("mrml.#{FFI::Platform::LIBSUFFIX}", __dir__)
+
+    attach_function :__to_title, :to_title, [:string], :string
+    attach_function :__to_preview, :to_preview, [:string], :string
+    attach_function :__to_html, :to_html, [:string], :string
+
+    private :__to_title
+    private :__to_preview
+    private :__to_html
+
+    def to_title(template)
+      call(:__to_title, template)
+    end
+
+    def to_preview(template)
+      call(:__to_preview, template)
+    end
+
+    def to_html(template)
+      call(:__to_html, template)
+    end
+
+    private
+
+    def call(method, template)
+      return if template.nil?
+
+      result = send(method, template)
+      raise Error, result if result.start_with?('Error')
+
+      result
+    end
+  end
+end

data/lib/mrml/version.rb

@@ -0,0 +1,3 @@
+module MRML
+  VERSION = '0.1.0'
+end

data/mrml.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/mrml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mrml'
+  spec.version       = MRML::VERSION
+  spec.authors       = ['Jonian Guveli']
+  spec.email         = ['jonian@hardpixel.eu']
+
+  spec.summary       = %q{Ruby wrapper for MRML Rust}
+  spec.description   = %q{This project is a reimplementation of the nice MJML markup language in Rust.}
+  spec.homepage      = 'https://github.com/hardpixel/mrml-ruby'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.extensions    = ['ext/Rakefile']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ffi'
+  spec.add_runtime_dependency 'thermite'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/src/lib.rs

@@ -0,0 +1,38 @@
+use std::os::raw::c_char;
+use std::ffi::{CStr, CString};
+
+use mrml;
+
+fn to_string(input: *const c_char) -> String {
+  unsafe {
+    CStr::from_ptr(input).to_string_lossy().into_owned()
+  }
+}
+
+fn to_char(str: &str) -> *const c_char {
+  CString::new(str).unwrap().into_raw()
+}
+
+#[no_mangle]
+pub extern "C" fn to_title(input: *const c_char) -> *const c_char {
+  match mrml::to_title(&to_string(input), mrml::Options::default()) {
+    Ok(html) => return to_char(&html),
+    Err(err) => return to_char(&format!("Error: {:?}", err)),
+  }
+}
+
+#[no_mangle]
+pub extern "C" fn to_preview(input: *const c_char) -> *const c_char {
+  match mrml::to_preview(&to_string(input), mrml::Options::default()) {
+    Ok(html) => return to_char(&html),
+    Err(err) => return to_char(&format!("Error: {:?}", err)),
+  }
+}
+
+#[no_mangle]
+pub extern "C" fn to_html(input: *const c_char) -> *const c_char {
+  match mrml::to_html(&to_string(input), mrml::Options::default()) {
+    Ok(html) => return to_char(&html),
+    Err(err) => return to_char(&format!("Error: {:?}", err)),
+  }
+}

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mrml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thermite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: This project is a reimplementation of the nice MJML markup language in
+  Rust.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Cargo.toml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/Rakefile
+- lib/mrml.rb
+- lib/mrml/version.rb
+- mrml.gemspec
+- src/lib.rs
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for MRML Rust
+test_files: []