RBON

• VERSION 0.2.221217
• github
• rubygems

$ gem install rbon

RBON is not JSON!

Use RBON to store your configration "Items", if by "Items" you mean that: Key = (Symbol=~/^\w+[?!]?$/) and Item = (Key | String | Integer | Float | nil | bool) and Items = (Item | Array[Items] | Hash[Key, Items]).

require 'rbon'

ITEMS = {
  author: "CarlosJHR64",
  year: 2021,
  Key_List: [
    :yes!,
    :wut?,
    :no
  ],
}

# RBON::Dump.new(String tab:'  ')
dumper = RBON::Dump.new

# Key   = (Symbol=~/^\w+[?!]?$/)
# Item  = (Key | String | Integer | Float | nil | bool)
# Items = (Item | Array[Items] | Hash[Key, Items])
# RBON#dump(Items item, IO io: StringIO.new) => String?
dump = dumper.dump ITEMS

dump.class #=> String
dump       #~> ^\{\s*author: "CarlosJHR64"

# The dump is just a very restricted strict ruby code for Items:
unsafe = eval dump
ITEMS == unsafe #=> true

# But don't eval an untrusted RBON dump, load it in RBON instead:
# RBON::Load.new
loader = RBON::Load.new

# RBON::Load#load((IO | String) io) => Items
safe = loader.load dump
ITEMS == safe #=> true

# For simple Items<=>String conversion, just use:
dump = RBON.dump ITEMS
ITEMS == RBON.load(dump) #=> true

Copyright 2023 CarlosJHR64

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.