tomlib 0.1.0 → 0.2.0

checksums.yaml

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

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [0.2.0] - 2022-08-04
+
+- Refactor Tomlib::Dumper to be a littel faster and generate squashed nested tables
+  ```
+  e.g. instead of this:
+  [a]
+  [a.b]
+  [a.b.c]
+
+  the output will be this:
+  [a.b.c]
+  ```
+- Add mention about compliance and passed tests in README.
+- Declare global variables with `rb_global_variable`.
+It may prevent VM from crashing in some cases.
+
 ## [0.1.0] - 2022-08-02
 
-Initial release
+- Initial release

data/README.md

@@ -3,7 +3,11 @@
 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.
 
+## Compliance
+
 Tomlib is TOML v1.0 compliant.
+It passes both [BurntSushi/toml-test](https://github.com/BurntSushi/toml-test) and
+[iarna/toml-spec-tests](https://github.com/iarna/toml-spec-tests).
 
 ## Installation
 
@@ -34,12 +38,7 @@ To parse a TOML document use:
 ```ruby
 require 'tomlib'
 
-Tomlib.parse(<<~TOML)
-firstName = "John"
-lastName = "Doe"
-hobbies = [ "Singing", "Dancing" ]
-
-[address]
+Tomlib.load(<<~TOML)
 firstName = "John"
 lastName = "Doe"
 hobbies = [ "Singing", "Dancing" ]
@@ -119,10 +118,10 @@ Tomlib.dump(hash, indent: false)
 
 ## Performance
 
-`Tomlib` parsing is ~300x faster than `toml-rb` and ~15x faster than `Tomlrb`
-for usual use case (~5KB TOML document size).
+`Tomlib` parsing is ~300x faster than `toml-rb`, ~15x faster than `Tomlrb`
+and ~3x faster than `perfect_toml` for usual use case (~5KB TOML document size).
 
-Generating TOML document is about 1.7x faster than `toml-rb`.
+Generating TOML document is about 2x faster than `toml-rb`.
 
 For full comparison take a look at
 [benchmarks](https://github.com/kgiszczak/tomlib/tree/master/benchmarks)

data/lib/tomlib/dumper.rb

@@ -27,17 +27,37 @@ module Tomlib
     # @api private
     NAN = 'nan'.freeze
 
+    def initialize(use_indent: true)
+      @use_indent = use_indent
+    end
+
+    # Generate TOML string from ruby Hash
+    #
+    # @param [Hash] hash
+    #
+    # @return [String]
+    #
+    # @api private
+    def dump(hash)
+      result = dump_hash(hash)
+
+      result[0] = '' if result[0] == "\n"
+
+      result
+    end
+
+    private
+
     # Generate TOML string from ruby Hash
     #
     # @param [Hash] hash
     # @param [String, nil] base_key
-    # @param [String] indent
-    # @param [true, false] use_indent
+    # @param [Integer] indent_level
     #
     # @return [String]
     #
     # @api private
-    def dump(hash, base_key = nil, indent = '', use_indent: true)
+    def dump_hash(hash, base_key = nil, indent_level = 0)
       header = ''
       footer = ''
 
@@ -45,34 +65,36 @@ module Tomlib
         toml_key = to_toml_key(key)
 
         if value.is_a?(Hash)
+          skip = !value.empty? && value.values.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
 
-          footer << "\n".freeze << next_indent << '['.freeze << compound_key << "]\n".freeze
-          footer << dump(value, compound_key, next_indent, use_indent: use_indent)
+          unless skip
+            indent = @use_indent ? INDENT * indent_level : ''.freeze
+            footer << "\n".freeze << indent << '['.freeze << compound_key << "]\n".freeze
+          end
+
+          footer << dump_hash(value, compound_key, skip ? indent_level : indent_level + 1)
         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
+          indent = @use_indent ? INDENT * indent_level : ''.freeze
 
           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)
+            footer << "\n".freeze << indent << '[['.freeze << compound_key << "]]\n".freeze
+            footer << dump_hash(el, compound_key, indent_level + 1)
           end
         else
+          indent_length = indent_level > 0 ? indent_level - 1 : 0
+          indent = @use_indent ? INDENT * indent_length : ''.freeze
           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]
     #

data/lib/tomlib/version.rb

@@ -2,5 +2,5 @@
 
 module Tomlib
   # @api private
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/tomlib.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'date'
+
 require_relative 'tomlib/dumper'
 require_relative 'tomlib/tomlib'
 require_relative 'tomlib/version'
@@ -40,6 +42,6 @@ module Tomlib
   #
   # @api public
   def self.dump(hash, indent: true)
-    Dumper.new.dump(hash, use_indent: indent)
+    Dumper.new(use_indent: indent).dump(hash)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomlib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies: []
 description: Fast TOML parser and generator with native extension.
 email: