troml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f320382cdbd2c0ce7e6589ac9b66fa5d00ba931e389233e86d90e04377cf6efb
+  data.tar.gz: d9841b093be23a74449c135d22275d251367be6a407dd9eaecef8f4ce8d94e5f
+SHA512:
+  metadata.gz: 283988c931b5725754f5bdb6ccea0e4826abe2b207223bdf8ebd0d597793379e19e573cc954d0762ceafda61e65ed66ad738d8ecef82d99c5d58e27347cb3ffb
+  data.tar.gz: d6bba4efe1109bcb0724641a3db5aa88fe0458e59c30836b7cbcacfb20c7fc779a1b8ad5a1e67b252ef504602d2a0de0f4f9e2fae04284bc19139c24b247b202

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at git@pawandubey.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "troml"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+rutie = "0.8.4"
+toml = "0.5.9"
+
+[lib]
+name = "troml"
+crate-type = ["cdylib"]

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in troml.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    troml (0.1.0)
+      rutie
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    gem-release (2.2.2)
+    minitest (5.16.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    rutie (0.0.4)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  gem-release
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  troml!
+  yard
+
+BUNDLED WITH
+   2.3.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Pawan Dubey
+
+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,80 @@
+<!--
+# @markup markdown
+-->
+
+# Troml
+
+> ⚠ Alpha quality software. Consider it a side project and read the [gotchas](#current-gotchas) and [contribution guidelines](#contributing).
+
+Blazing fast [TOML](https://toml.io) parsing, with the power of Rust ⚡
+
+Troml utilizes [rutie](https://github.com/danielpclark/rutie) to parse TOML by delegating the actual parsing to Rust-land. The Rust code uses the canonical [toml](https://github.com/alexcrichton/toml-rs) package that's also used by Cargo.
+
+As of June 2022, Troml is approximately **30 thousand times** faster than the `toml` ruby gem at parsing the `test/data/spec.toml` file in this repository, as measured on a Thinkpad T470 with Intel Core i7-7500U @ 4x 3.5GHz and 12GB of RAM running KDE Neon 20.04 with Rust 1.57.0 and Ruby 3.1.2.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add troml
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install troml
+
+## Usage
+
+```ruby
+# Parse TOML strings with Troml.parse
+Troml.parse("foo='bar'")
+# => {"foo"=>"bar"}
+
+# Read and parse the contents of a file with
+Troml.parse_file("path/to/file.toml")
+```
+
+## Current Gotchas
+- Troml only deserializes TOML documents, it does not generate them.
+- Troml uses `rutie`, which at this time has a bug where [it leaks memory when it tries to raise in Ruby from Rust](https://github.com/danielpclark/rutie/issues/159). Troml raises on parse failures currently. This means that if you are encountering a lot of parse failures, your program will end up consuming a lot of memory. I have a fix for this in mind and will implement it soon.
+- Troml packaging depends on the Cargo extension builder toolchain in Rubygems. As that is a recently-shipped feature, there might be bugs in the packaging of this gem.
+
+## Performance
+
+The benchmark is located in `bin/benchmark`. Here is a sample benchmark run from my laptop:
+
+```
+★ 𝞴 date
+Wed 22 Jun 2022 12:56:22 AM EDT
+ pawan  : [ruby-3.1.2] : [troml] on main *%
+★ 𝞴 bin/benchmark
+Warming up --------------------------------------
+             jm/toml     5.666B i/100ms
+               troml     1.091T i/100ms
+Calculating -------------------------------------
+             jm/toml    233.632B (±26.6%) i/s -      1.065T in   5.008150s
+               troml      9.958Q (±18.5%) i/s -     46.181Q in   4.967881s
+
+Comparison:
+               troml: 9957828005865654.0 i/s
+             jm/toml: 233631820362.5 i/s - 42621.88x  (± 0.00) slower
+```
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Please note that this is a side project. That means that I can and will only dedicate time to it when I have the will to. I guarantee no SLOs for support, looking at issues or merging PRs. I will pay attention to security vulnerabilities where necessary. Please bear this in mind when evaluating this gem for production use.
+
+That being said, bug reports and pull requests are welcome on GitHub at https://github.com/pawandubey/troml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pawandubey/troml/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Troml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pawandubey/troml/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/troml

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "troml"
+require "json"
+
+def tag(val)
+  case val
+  when String
+    {type: "string", value: val}
+  when Integer
+    {type: "integer", value: val}
+  when Float
+    {type: "float", value: val}
+  when TrueClass, FalseClass
+    {type: "bool", value: val}
+  when Array
+    val.map { |e| tag(e) }
+  when Hash
+    val.transform_values { |v| tag(v) }
+  end
+end
+
+raw_toml = ARGF.read
+
+parsed_toml = Troml.parse(raw_toml)
+
+tagged_hash = tag(parsed_toml)
+
+puts tagged_hash.to_json

data/lib/troml/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Troml
+  VERSION = "0.1.0"
+end

data/lib/troml.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "troml/version"
+require "rutie"
+require "date"
+
+module Troml
+  # Class to encapsulate external functions defined in Rust
+  # Must be defined before the call to Rutie#init as the Rust
+  # library depends on its existence.
+  #
+  # @private
+  class TromlExt; end
+
+  class Error < StandardError; end
+
+  class ExtParseError < Error; end
+
+  # Initialize external library
+  Rutie.new(:troml).init "Init_troml", __dir__
+
+  # Returns a hash representation of the TOML string passed.
+  # Raises on parse failure.
+  #
+  # @param raw_toml [String] The raw TOML as a string.
+  #
+  # @return [Hash] The hash representation of the TOML document, if valid.
+  # @raise [Troml::ExtParseError] Raises if parsing fails.
+  def self.parse(raw_toml)
+    TromlExt.parse(raw_toml)
+  end
+
+  # Returns a hash representation of the TOML stored in the file
+  # at the provided path.
+  # Raises on parse failure or if the file is not present.
+  #
+  # @param file_path [String] Path to the file to be read.
+  #
+  # @return [Hash] The hash representation of the file's TOML content.
+  # @raise [Troml::ExtParseError] Raises if parsing fails.
+  def self.parse_file(file_path)
+    TromlExt.parse(File.read(file_path))
+  end
+
+  private_constant :TromlExt
+end

data/sig/troml.rbs

@@ -0,0 +1,4 @@
+module Troml
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/src/lib.rs

@@ -0,0 +1,134 @@
+use rutie::{
+    class, methods, AnyException, AnyObject, Array, Boolean, Class, Exception, Float, Hash,
+    Integer, Object, RString, VM, Module,
+};
+use toml::Value;
+
+class!(TromlExt);
+
+methods!(
+    TromlExt,
+    _rtself,
+    fn troml_ext_parse_toml_str(input: RString) -> Hash {
+        let raw_toml = input.map_err(|e| VM::raise_ex(e)).unwrap();
+
+        let parsed_toml = raw_toml
+            .to_string()
+            .parse::<Value>()
+            .map_err(|e| {
+                let msg = format!("{}", e);
+                VM::raise_ex(AnyException::new("Troml::ExtParseError", Some(&msg)))
+            })
+            .unwrap();
+
+        let mut hash = Hash::new();
+
+        let _rutie_toml = toml_to_toml_value(parsed_toml, &mut hash);
+
+        hash
+    }
+);
+
+enum TomlValue {
+    String(RString),
+    Integer(Integer),
+    Float(Float),
+    Boolean(Boolean),
+    Array(Array),
+    Table(Hash),
+    Datetime(AnyObject),
+}
+
+fn toml_to_toml_value(toml_value: Value, hash: &mut Hash) -> TomlValue {
+    match toml_value {
+        Value::String(s) => TomlValue::String(RString::new_utf8(&s)),
+        Value::Integer(i) => TomlValue::Integer(Integer::new(i)),
+        Value::Float(f) => TomlValue::Float(Float::new(f)),
+        Value::Boolean(b) => TomlValue::Boolean(Boolean::new(b)),
+        Value::Array(a) => {
+            let mut rutie_arr = Array::new();
+            for item in a.into_iter() {
+                let rutie_val = toml_to_toml_value(item, hash);
+                match rutie_val {
+                    TomlValue::String(s) => rutie_arr.push(s),
+                    TomlValue::Integer(i) => rutie_arr.push(i),
+                    TomlValue::Float(f) => rutie_arr.push(f),
+                    TomlValue::Boolean(b) => rutie_arr.push(b),
+                    TomlValue::Array(a) => rutie_arr.push(a),
+                    TomlValue::Table(t) => rutie_arr.push(t),
+                    TomlValue::Datetime(d) => rutie_arr.push(d),
+                };
+            }
+            TomlValue::Array(rutie_arr)
+        }
+        Value::Table(t) => {
+            for (key, val) in t.into_iter() {
+                let rutie_key = RString::new_utf8(&key);
+                let mut nested_hash = Hash::new();
+                let rutie_val = toml_to_toml_value(val, &mut nested_hash);
+
+                match rutie_val {
+                    TomlValue::String(s) => hash.store(rutie_key, s),
+                    TomlValue::Integer(i) => hash.store(rutie_key, i),
+                    TomlValue::Float(f) => hash.store(rutie_key, f),
+                    TomlValue::Boolean(b) => hash.store(rutie_key, b),
+                    TomlValue::Array(a) => hash.store(rutie_key, a),
+                    TomlValue::Table(t) => hash.store(rutie_key, t),
+                    TomlValue::Datetime(d) => hash.store(rutie_key, d),
+                };
+            }
+            TomlValue::Table(hash.to_owned())
+        }
+        Value::Datetime(d) => {
+            let args = [RString::new_utf8(&d.to_string()).to_any_object()];
+            let ruby_datetime = unsafe { Class::from_existing("DateTime").send("iso8601", &args) };
+            TomlValue::Datetime(ruby_datetime)
+        }
+    }
+}
+
+#[allow(non_snake_case)]
+#[no_mangle]
+pub extern "C" fn Init_troml() {
+    Module::from_existing("Troml").get_nested_class("TromlExt").define(|klass| {
+        klass.def_self("parse", troml_ext_parse_toml_str);
+    });
+}
+
+#[cfg(test)]
+mod test {
+    use rutie::{Hash, Array, RString, Integer as Int, VM, Object};
+    use toml::Value;
+
+    #[test]
+    fn test_toml_parse() {
+        let toml = "
+simple='value'
+[nested]
+nested_key='nested_val'
+nested_array=['first_element', 2]
+";
+
+        VM::init();
+        let mut expected = Hash::new();
+        let mut nested_hash = Hash::new();
+        let mut nested_array = Array::new();
+
+        nested_array.push(RString::new_utf8("first_element"));
+        nested_array.push(Int::new(2));
+
+        nested_hash.store(RString::new_utf8("nested_key"), RString::new_utf8("nested_val"));
+        nested_hash.store(RString::new_utf8("nested_array"), nested_array);
+
+        expected.store(RString::new_utf8("simple"), RString::new_utf8("value"));
+        expected.store(RString::new_utf8("nested"), nested_hash);
+
+        let mut actual = Hash::new();
+
+        let toml_value = toml.parse::<Value>().unwrap();
+
+        let _ = crate::toml_to_toml_value(toml_value, &mut actual);
+
+        assert!(actual.equals(&expected), "expected {:?} to be equal to {:?}", actual, expected)
+    }
+}

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: troml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pawan Dubey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rutie
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: TOML parser
+email:
+- git@pawandubey.com
+executables:
+- troml
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Cargo.toml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/troml
+- lib/troml.rb
+- lib/troml/version.rb
+- sig/troml.rbs
+- src/lib.rs
+homepage: https://github.com/pawandubey/troml
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pawandubey/troml
+  source_code_uri: https://github.com/pawandubey/troml
+  changelog_uri: https://github.com/pawandubey/troml/tree/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.16
+signing_key: 
+specification_version: 4
+summary: TOML parser
+test_files: []