toml-rb README

The project's README from github.com/emancu/toml-rb. As one markdown file: README.md.

TOML Logo

toml-rb

Gem Version Build Status Code Climate RubyGem

A pure Ruby TOML parser and dumper with no runtime dependencies.

toml-rb implements TOML 1.1.0 and passes all toml-test v2.2.0 decoder tests for that version.

Installation

$ gem install toml-rb

Or add this line to your Gemfile:

gem "toml-rb", "~> 6.0"

Parser Usage

require 'toml-rb'

# From a file!
path = File.join(File.dirname(__FILE__), 'path', 'to', 'file')
TomlRB.load_file(path)

# From a stream!
stream = <<-EOS
  title = "wow!"

  [awesome]
    you    = true
    others = false
EOS
TomlRB.parse(stream)
# => {"title"=>"wow!", "awesome"=>{"you"=>true, "others"=>false}}

# You want symbols as your keys? No problem!
TomlRB.load_file(path, symbolize_keys: true) 
# Works the same for TomlRB.parse

# Local datetimes, dates and times are subclasses of Time. Offset datetimes are Time.
times = <<-EOS
  odt = 1979-05-27T07:32:00Z
  ldt = 1979-05-27T07:32:00
  ld  = 1979-05-27
  lt  = 07:32:00
EOS
TomlRB.parse(times).transform_values(&:class)
# => {"odt"=>Time, "ldt"=>TomlRB::LocalDateTime, "ld"=>TomlRB::LocalDate, "lt"=>TomlRB::LocalTime}

Dumper Usage

require 'toml-rb'

# Simple example
TomlRB.dump( simple: true)
# => "simple = true\n"


# Complex example
hash = { 
    "title"=>"wow!", 
    "awesome"=> {
        "you"=>true, 
        "others"=>false
    }
}

TomlRB.dump(hash)
# => "title = \"wow!\"\n[awesome]\nothers = false\nyou = true\n"

Conformance

toml-rb is exercised against the official toml-test conformance suite for both TOML 1.0.0 and TOML 1.1.0. The harness lives in:

The TOML 1.1.0 skip-list is empty. The TOML 1.0.0 skip-list has 9 tests with documents that TOML 1.0.0 forbids and TOML 1.1.0 allows. toml-rb accepts TOML 1.1.0 syntax and has no option to select the spec version, so these tests fail. CI runs toml-test with -skip-must-err, so the run fails when a skipped test passes.

Contributing

  1. Fork it
  2. Create your feature branch git checkout -b my-new-feature
  3. Add tests and commit your changes git commit -am 'Add some feature'
  4. Run tests $ rake
  5. Push the branch git push origin my-new-feature
  6. Create new Pull Request

License

MIT License

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.

toml-rb (emancu/toml-rb)

Searching Database…

124 ·GitHub
Toml-rb
Что это?toml-rb — библиотека для Ruby, которая разбирает и сериализует конфигурационные файлы TOML, построенная поверх библиотеки парсинга Citrus.
Это библиотека или отдельный инструмент?Это библиотека для Ruby, которую вы добавляете в проект; ни CLI, ни GUI нет — только API парсера и дампера.
Как добавить её в проект?Установите её через 'gem install toml-rb' или добавьте 'gem "toml-rb", "~> 6.0"' в свой Gemfile.
Нужны ли другие гемы или зависимости времени выполнения?Нет, у неё нет зависимостей времени выполнения помимо самого Ruby (движок парсинга Citrus включён внутрь).
Какую версию спецификации TOML она поддерживает?Она реализует TOML 1.1.0 и проходит все декодерные тесты toml-test v2.2.0 для этой версии, но у неё нет опции переключиться на поведение TOML 1.0.0, поэтому она принимает некоторый синтаксис, который 1.0.0 отверг бы.
Насколько тщательно проверяется соответствие?Она прогоняется против официального набора тестов соответствия toml-test как для TOML 1.0.0, так и для TOML 1.1.0, с матрицами CI и документированными списками пропусков для каждой версии спецификации.
Почему у TOML 1.0.0 есть пропущенные тесты?Список пропусков для 1.0.0 содержит 9 тестов, покрывающих документы, которые TOML 1.0.0 запрещает, но TOML 1.1.0 разрешает, и поскольку toml-rb реализует только поведение 1.1.0, эти конкретные тесты падают.
На какой движок парсинга она опирается внутри?Она использует библиотеку парсинга Citrus для реализации грамматики TOML на Ruby.
What are similar projects?cli, REDox, toml, codex-astra-luna-orchestrator, viper, html-webpack-plugin, marked, cheerio
Which topics is it in?toml, config, parser, ruby, library, mit, open-source
Creator
emancu
Size
0.5 MB
Stars
124
Updated
CommitOct 09Releasev6.0.0Sep 28
Age
13y
Commits · 90 Days