tomlib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16903f85ce6caa68598bf97a4e631d2f69312a7019cb0901d668c40fafa24fb6
+  data.tar.gz: 8fc0cf9b86b65dc8e3a455ffdbca94151a1ca74b1252e72600edcb872338de06
+SHA512:
+  metadata.gz: ddd0190b6aa540128cafa6fdf20bcd16b7a7e0d6c4eaa1cbb65f993708388bedea553f0deda33884b26cb93996dd7ddc4825c7bc36b2223eb21eb43fcae6b2aa
+  data.tar.gz: 65e1c88710a7a3f5ca65ca75026e59b64a525d5232c063359c976259ab8e7b10eac503a6aa665d7a2cbe21f7106a8573b9a3faf361b88a121c6a3af46269a744

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2022-08-02
+
+Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kamil Giszczak
+
+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,136 @@
+# Tomlib
+
+Tomlib is a TOML parser and generator for Ruby. It is fast and standards-compliant by relying
+on native [tomlc99](https://github.com/cktan/tomlc99) parser.
+
+Tomlib is TOML v1.0 compliant.
+
+## Installation
+
+Tomlib supports Ruby (MRI) 2.7+
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tomlib'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install tomlib
+```
+
+## Usage
+
+To parse a TOML document use:
+
+```ruby
+require 'tomlib'
+
+Tomlib.parse(<<~TOML)
+firstName = "John"
+lastName = "Doe"
+hobbies = [ "Singing", "Dancing" ]
+
+[address]
+firstName = "John"
+lastName = "Doe"
+hobbies = [ "Singing", "Dancing" ]
+
+[address]
+city = "London"
+zip = "E1 6AN"
+
+[address.street]
+name = "Oxford Street"
+TOML
+
+# =>
+#
+# {
+#   "firstName" => "John",
+#   "lastName" => "Doe",
+#   "hobbies" => ["Singing", "Dancing"],
+#   "address" => {
+#     "city"=>"London",
+#     "zip"=>"E1 6AN",
+#     "street"=>{ "name"=>"Oxford Street" }
+#   }
+# }
+```
+
+To generate a TOML document from Ruby Hash use:
+
+```ruby
+require 'tomlib'
+
+Tomlib.dump({
+  "firstName" => "John",
+  "lastName" => "Doe",
+  "hobbies" => ["Singing", "Dancing"],
+  "address" => {
+    "city"=>"London",
+    "zip"=>"E1 6AN",
+    "street"=>{ "name"=>"Oxford Street" }
+  }
+})
+
+# =>
+#
+# firstName = "John"
+# lastName = "Doe"
+# hobbies = [ "Singing", "Dancing" ]
+#
+# [address]
+# city = "London"
+# zip = "E1 6AN"
+#
+#   [address.street]
+#   name = "Oxford Street"
+```
+
+If you don't need indentation use:
+
+```ruby
+require 'tomlib'
+
+Tomlib.dump(hash, indent: false)
+
+# =>
+#
+# firstName = "John"
+# lastName = "Doe"
+# hobbies = [ "Singing", "Dancing" ]
+#
+# [address]
+# city = "London"
+# zip = "E1 6AN"
+#
+# [address.street]
+# name = "Oxford Street"
+```
+
+## Performance
+
+`Tomlib` parsing is ~300x faster than `toml-rb` and ~15x faster than `Tomlrb`
+for usual use case (~5KB TOML document size).
+
+Generating TOML document is about 1.7x faster than `toml-rb`.
+
+For full comparison take a look at
+[benchmarks](https://github.com/kgiszczak/tomlib/tree/master/benchmarks)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kgiszczak/tomlib.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/ext/tomlib/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+CONFIG['warnflags'].slice!(/ -Wshorten-64-to-32/)
+
+create_makefile('tomlib/tomlib')

data/lib/tomlib/dumper.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: false
+
+require 'bigdecimal'
+require 'date'
+require 'time'
+
+require_relative 'error'
+
+module Tomlib
+  # TOML generator
+  #
+  # @api private
+  class Dumper
+    # Indent characters
+    # @api private
+    INDENT = '  '.freeze
+
+    # Representation of Infinity in TOML
+    # @api private
+    INF_POSITIVE = 'inf'.freeze
+
+    # Representation of negative Infinity in TOML
+    # @api private
+    INF_NEGATIVE = '-inf'.freeze
+
+    # Representation of NaN in TOML
+    # @api private
+    NAN = 'nan'.freeze
+
+    # Generate TOML string from ruby Hash
+    #
+    # @param [Hash] hash
+    # @param [String, nil] base_key
+    # @param [String] indent
+    # @param [true, false] use_indent
+    #
+    # @return [String]
+    #
+    # @api private
+    def dump(hash, base_key = nil, indent = '', use_indent: true)
+      header = ''
+      footer = ''
+
+      hash.each do |key, value|
+        toml_key = to_toml_key(key)
+
+        if value.is_a?(Hash)
+          compound_key = to_toml_compound_key(base_key, toml_key)
+          next_indent = use_indent && base_key ? indent + INDENT : indent
+
+          footer << "\n".freeze << next_indent << '['.freeze << compound_key << "]\n".freeze
+          footer << dump(value, compound_key, next_indent, use_indent: use_indent)
+        elsif value.is_a?(Array) && value.all? { |e| e.is_a?(Hash) }
+          compound_key = to_toml_compound_key(base_key, toml_key)
+          next_indent = use_indent && base_key ? indent + INDENT : indent
+
+          value.each do |el|
+            footer << "\n".freeze << next_indent << '[['.freeze << compound_key << "]]\n".freeze
+            footer << dump(el, compound_key, next_indent, use_indent: use_indent)
+          end
+        else
+          header << indent << toml_key << ' = '.freeze << to_toml_value(value) << "\n".freeze
+        end
+      end
+
+      footer.gsub!(/\A\n/, ''.freeze) if header.empty?
+      header << footer
+    end
+
+    private
+
+    # Generate TOML key from Hash key
+    #
+    # @param [String] key
+    # @param [true, false] use_indent
+    #
+    # @return [String]
+    #
+    # @api private
+    def to_toml_key(key)
+      raise DumpError, "'nil' can't be used as a key" if key.nil?
+
+      key = key.to_s
+
+      case key_type(key)
+      when :quoted
+        key.inspect
+      when :escape
+        key.dump.gsub('\n', '\\\\\n')
+      else
+        key
+      end
+    end
+
+    # Concatenate key with base_key
+    #
+    # @param [String, nil] base_key
+    # @param [String] key
+    #
+    # @return [String]
+    #
+    # @api private
+    def to_toml_compound_key(base, key)
+      return key unless base
+
+      '' << base << '.'.freeze << key
+    end
+
+    # Generate TOML value from Ruby object
+    #
+    # @param [Object] value
+    #
+    # @return [String]
+    #
+    # @api private
+    def to_toml_value(value)
+      case value
+      when String
+        value.inspect
+      when Float, BigDecimal
+        to_toml_float(value)
+      when Time, DateTime
+        value.iso8601(3)
+      when Date
+        value.iso8601
+      when Hash
+        "{ #{value.map { |k, v| "#{to_toml_key(k)} = #{to_toml_value(v)}" }.join(', ')} }"
+      when Array
+        "[ #{value.map { |e| to_toml_value(e) }.join(', ')} ]"
+      when nil
+        '""'.freeze
+      else
+        value.to_s
+      end
+    end
+
+    # Generate TOML float value from Ruby Float or BigDecimal
+    #
+    # @param [Float, BigDecimal] value
+    #
+    # @return [String]
+    #
+    # @api private
+    def to_toml_float(value)
+      return INF_POSITIVE if value.infinite? && value.positive?
+      return INF_NEGATIVE if value.infinite? && value.negative?
+      return NAN if value.nan?
+
+      value.to_s
+    end
+  end
+end

data/lib/tomlib/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: false
+
+module Tomlib
+  # Error during TOML document generation
+  #
+  # @api private
+  class DumpError < StandardError
+  end
+end

data/lib/tomlib/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Tomlib
+  # @api private
+  VERSION = '0.1.0'
+end

data/lib/tomlib.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'tomlib/dumper'
+require_relative 'tomlib/tomlib'
+require_relative 'tomlib/version'
+
+# Main library namespace
+#
+# @example parsing TOML data into Ruby Hash
+#
+#   puts Tomlib.load(<<~TOML)
+#     firstName = "John"
+#     lastName = "Doe"
+#   TOML
+#
+#   # => { 'firstName' => 'John', 'lastName' => 'Doe' }
+#
+# @example generating TOML from Ruby Hash
+#
+#   puts Tomlib.dump({ 'firstName' => 'John', 'lastName' => 'Doe' })
+#
+#   # =>
+#   firstName = "John"
+#   lastName = "Doe"
+#
+# @api public
+module Tomlib
+  # Dump Ruby Hash into TOML format
+  #
+  # @param [Hash] hash
+  # @param [true, false] indent (default: true)
+  #
+  # @return [String]
+  #
+  # @example
+  #   puts Tomlib.dump({ 'firstName' => 'John', 'lastName' => 'Doe' })
+  #   # =>
+  #   firstName = "John"
+  #   lastName = "Doe"
+  #
+  # @api public
+  def self.dump(hash, indent: true)
+    Dumper.new.dump(hash, use_indent: indent)
+  end
+end

data/tomlib.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/tomlib/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'tomlib'
+  spec.version = Tomlib::VERSION
+  spec.authors = ['Kamil Giszczak']
+  spec.email = ['beerkg@gmail.com']
+
+  spec.summary = 'Fast TOML parser and generator with native extension.'
+  spec.description = 'Fast TOML parser and generator with native extension.'
+  spec.homepage = 'https://github.com/kgiszczak/tomlib'
+  spec.license = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/kgiszczak/tomlib'
+  spec.metadata['source_code_uri'] = 'https://github.com/kgiszczak/tomlib'
+  spec.metadata['changelog_uri'] = 'https://github.com/kgiszczak/tomlib/blob/master/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/kgiszczak/tomlib/issues'
+
+  spec.files = Dir['CHANGELOG.md', 'LICENSE.txt', 'README.md', 'tomlib.gemspec', 'lib/**/*']
+  spec.require_paths = ['lib']
+
+  spec.extensions = ['ext/tomlib/extconf.rb']
+
+  spec.required_ruby_version = '>= 2.7.0'
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: tomlib
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kamil Giszczak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-02 00:00:00.000000000 Z
+dependencies: []
+description: Fast TOML parser and generator with native extension.
+email:
+- beerkg@gmail.com
+executables: []
+extensions:
+- ext/tomlib/extconf.rb
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- ext/tomlib/extconf.rb
+- lib/tomlib.rb
+- lib/tomlib/dumper.rb
+- lib/tomlib/error.rb
+- lib/tomlib/tomlib.bundle
+- lib/tomlib/version.rb
+- tomlib.gemspec
+homepage: https://github.com/kgiszczak/tomlib
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kgiszczak/tomlib
+  source_code_uri: https://github.com/kgiszczak/tomlib
+  changelog_uri: https://github.com/kgiszczak/tomlib/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kgiszczak/tomlib/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Fast TOML parser and generator with native extension.
+test_files: []