tomlib 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9598af874f419d93b421990cfced654f3787aa1feb30cb73c10bd42088917e9c
-  data.tar.gz: ac5980031b22fc23911e1555ce323fff74e4540071ba26960808325548b5290b
+  metadata.gz: aad6b4a6455bd446b09db888f1fc491a66521e0680594f74eeba9d10314cc8b6
+  data.tar.gz: fe599fd32583ba52c6702d29a9a27d805ba3cb0889e3df4b6612e2cebc6d1c75
 SHA512:
-  metadata.gz: 8eb4fe0b0054e2f3e446a62a212d211678c10a55360ea1523b38de9900e76163ec7811ba2b96a3e46db96818ca4d3c9188fe69f3c5107cead1da8fbef4360b76
-  data.tar.gz: b22db5ff36ebc41ac9a4d39798ed78a510e1793c05ec2e3c74ad91bb61eb8c92e7325902d592ce909e8d5ce289cbc9b6de624a2b471edfbb098b77252db8cf85
+  metadata.gz: a9f44b0a8b4f65b58ebf058646ca69d1fabdb935f352523cf9836f6387a92b5712ee59e233ec4efe92beb5a8feae28dd03af630f7601db236564d0a5afc79b86
+  data.tar.gz: aa654d7e31d34113629798a9336c9ead2e2071eb1935b3c80974f4c44da6333bf9b11719668ed43d148a4d85df6b1032f5fc8a306cde7e7620d9316ad7e9bb9a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.6.0] - 2023-05-05
+
+- Correctly escape special characters
+
 ## [0.5.0] - 2022-08-16
 
 - Add support for Ruby 2.6

data/README.md

@@ -1,7 +1,7 @@
 # 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 a TOML parser and generator for Ruby. It uses native C extension based on
+fast and standards-compliant [tomlc99](https://github.com/cktan/tomlc99) parser.
 
 ## Compliance
 
@@ -118,10 +118,11 @@ Tomlib.dump(hash, indent: false)
 
 ## Performance
 
-`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).
+When parsing documents, `Tomlib` is more than 600x (400x with yjit) faster than `toml-rb`,
+23x (17x with yjit) faster than `Tomlrb` and almost 5x (3.5x with yjit)
+faster than `perfect_toml` (~5KB TOML document size).
 
-Generating TOML document is about 2x faster than `toml-rb`.
+When generating TOML documents, it is about 1.5x (1.7x with yjit) faster than `toml-rb`.
 
 For full comparison take a look at
 [benchmarks](https://github.com/kgiszczak/tomlib/tree/master/benchmarks)

data/ext/tomlib/tomlib.c

@@ -320,7 +320,7 @@ static VALUE tomlib_key_type(VALUE self, VALUE rb_key) {
 
   if (str_len == 0) return sym_escape;
 
-  for(long i = 0; i < str_len; i++) {
+  for (long i = 0; i < str_len; i++) {
     const char c = *(str + i);
 
     if (c == '\n') {

data/lib/tomlib/dumper.rb

@@ -27,6 +27,22 @@ module Tomlib
     # @api private
     NAN = 'nan'.freeze
 
+    # Regex to match escape chars
+    # @api private
+    ESCAPE_CHARS_REGEX = /[\x00-\x1F\x22\x5C\x7F]/.freeze
+
+    # Escape chars mapping
+    # @api private
+    ESCAPE_CHARS = {
+      "\b" => 'b',
+      "\t" => 't',
+      "\n" => 'n',
+      "\f" => 'f',
+      "\r" => 'r',
+      '"' => '"',
+      '\\' => '\\',
+    }.freeze
+
     def initialize(use_indent: true)
       @use_indent = use_indent
     end
@@ -106,7 +122,7 @@ module Tomlib
 
       case key_type(key)
       when :quoted
-        key.inspect
+        escape_string(key)
       when :escape
         key.dump.gsub('\n', '\\\\\n')
       else
@@ -138,7 +154,7 @@ module Tomlib
     def to_toml_value(value)
       case value
       when String
-        value.inspect
+        escape_string(value)
       when Float, BigDecimal
         to_toml_float(value)
       when Time, DateTime
@@ -170,5 +186,26 @@ module Tomlib
 
       value.to_s
     end
+
+    # Escapes TOML special characters
+    #
+    # @param [String] str
+    #
+    # @return [String]
+    #
+    # @api private
+    def escape_string(str)
+      str = str.gsub(ESCAPE_CHARS_REGEX) do |chr|
+        c = ESCAPE_CHARS[chr]
+
+        if c
+          '\\' << c
+        else
+          format('\\u%04X', chr.ord)
+        end
+      end
+
+      '"' << str << '"'.freeze
+    end
   end
 end

data/lib/tomlib/version.rb

@@ -2,5 +2,5 @@
 
 module Tomlib
   # @api private
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomlib
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies: []
 description: Fast TOML parser and generator with native extension.
 email:
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Fast TOML parser and generator with native extension.