Skip to content

Commit

Permalink
Add mention about compliance and passed tests in README
Browse files Browse the repository at this point in the history
  • Loading branch information
kgiszczak committed Aug 3, 2022
1 parent 3cccc8c commit 409538d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 13 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## [0.2.0] - [unreleased]

- 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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions lib/tomlib.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# frozen_string_literal: true

require 'date'

require_relative 'tomlib/dumper'
require_relative 'tomlib/tomlib'
require_relative 'tomlib/version'
Expand Down
23 changes: 11 additions & 12 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# frozen_string_literal: true

require 'simplecov'
require 'tomlib'

if GC.respond_to?(:verify_compaction_references)
# This method was added in Ruby 3.0.0. Calling it this way asks the GC to
# move objects around, helping to find object movement bugs.
begin
GC.verify_compaction_references(double_heap: true, toward: :empty)
rescue NotImplementedError
# Some platforms don't support compaction
end
end

SimpleCov.start do
add_filter '/spec/'
Expand Down Expand Up @@ -106,15 +117,3 @@
Kernel.srand config.seed
=end
end

require 'tomlib'

if GC.respond_to?(:verify_compaction_references)
# This method was added in Ruby 3.0.0. Calling it this way asks the GC to
# move objects around, helping to find object movement bugs.
begin
GC.verify_compaction_references(double_heap: true, toward: :empty)
rescue NotImplementedError
# Some platforms don't support compaction
end
end

0 comments on commit 409538d

Please sign in to comment.