rbon 0.0.210120

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1da49718259949517ccc8117bed23b712fc28eabcd4a7a61b6fa4fbcc5d5f5e
+  data.tar.gz: 0ff78b0a378228a8d3853fd1c29b0e28196f571ae7cdeb2801e5ec974ac769d8
+SHA512:
+  metadata.gz: c6f1bcffd0bd56eaf7a940f9b785598d04a7e409b9653b554967fe327202558f1a4b689f397eae1a52943e415496f45d6b49eacc9c61bb15f6cbc0439c7f695d
+  data.tar.gz: e2abefd3d9dd734215a64e90e6cb1a9a8e921700ac88759dfb843757eddf99405473dd244ac95c38cac7463ed2428fae07e19bef976591356ba5b8e17bdccac4

data/README.md

@@ -0,0 +1,93 @@
+# RBON
+
+* [VERSION 0.0.210120](https://github.com/carlosjhr64/rbon/releases)
+* [github](https://www.github.com/carlosjhr64/rbon)
+* [rubygems](https://rubygems.org/gems/rbon)
+
+## INSTALL:
+
+```shell
+$ gem install rbon
+```
+
+## DESCRIPTION:
+
+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])`.
+
+## SYNOPSIS:
+
+```ruby
+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
+```
+
+## LICENSE:
+
+Copyright 2021 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.

data/lib/rbon.rb

@@ -0,0 +1,18 @@
+require 'stringio'
+module RBON
+  VERSION = '0.0.210120'
+  require 'rbon/dump'
+  require 'rbon/load'
+
+  # For simple String => Items conversions
+  def self.load(...)
+    Load.new.load(...)
+  end
+
+  # For simple Items => String conversions
+  def self.dump(...)
+    Dump.new.dump(...)
+  end
+end
+# Requires:
+# `ruby`

data/lib/rbon/dump.rb

@@ -0,0 +1,77 @@
+module RBON
+class Dump
+  class Error < StandardError
+  end
+
+  def initialize(tab:'  ')
+    @tab, @io = tab, nil
+  end
+
+  def dump(object, io:StringIO.new)
+    @io = io
+    traverse(object,'')
+    @io.print "\n"
+    @io.respond_to?(:string)? @io.string : nil
+  end
+  alias :pretty_generate :dump
+
+  private
+
+  def traverse(object, indent)
+    case object
+    when Hash
+      hash(object, indent)
+    when Array
+      array(object, indent)
+    when Symbol, String, Integer, Float, NilClass, TrueClass, FalseClass
+      item(object, indent)
+    else
+      raise RBON::Dump::Error, "Unsupported class #{object.class}: #{object.inspect}"
+    end
+  end
+
+  def item(item, indent)
+    case item
+    when String
+      @io.print (item=='')?  '""' : item.lines.map{_1.inspect}.join(" +\n"+indent)
+    else
+      @io.print item.inspect
+    end
+  end
+
+  def array(array, indent)
+    if array.empty?
+      @io.print '[]'
+    else
+      @io.print "[\n"+indent+@tab
+      traverse(array[0], indent+@tab)
+      array[1..-1].each do |object|
+        @io.print ",\n"+indent+@tab
+        traverse(object, indent+@tab)
+      end
+      @io.print "\n"+indent+']'
+    end
+  end
+
+  def hash(hash, indent)
+    if hash.empty?
+      @io.print '{}'
+    else
+      @io.print "{\n"+indent+@tab
+      array = hash.to_a
+      key_object(*array[0], indent+@tab)
+      array[1..-1].each do |key,object|
+        @io.print ",\n"+indent+@tab
+        key_object(key,object, indent+@tab)
+      end
+      @io.print "\n"+indent+'}'
+    end
+  end
+
+  def key_object(key, object, indent)
+    raise RBON::Dump::Error, "Bad Key #{key.class}: #{key.inspect}" unless key.is_a?(Symbol) and key.match?('^\w+[?!]?$')
+    @io.print "#{key}: "
+    traverse(object, indent)
+  end
+end
+end

data/lib/rbon/load.rb

@@ -0,0 +1,151 @@
+module RBON
+class Load
+  class Bug < Exception
+  end
+  class Error < StandardError
+  end
+
+  class CloseArray < Exception
+  end
+  class CloseHash < Exception
+  end
+  class EOL < Exception
+    # End Of List
+  end
+
+  X = '\\'
+  XX = X+X
+  XQ = X+'"'
+  XN = X+'n'
+
+  NILS   = /^nil,?$/
+  FALSES = /^false,?$/
+  TRUES  = /^true,?$/
+
+  INTEGER = /^\d+,?$/
+  FLOAT   = /^\d+\.\d+,?$/
+
+  KEY    = /^\w+[?!]?:/
+  SYMBOL = /^:\w+[?!]?,?$/
+
+  STRING  = /^".*",?$/
+  STRINGS = /^".*"\s*[+]$/
+
+  EMPTY_ARRAY = /^\[\],?$/
+  OPEN_ARRAY  = '['
+  CLOSE_ARRAY = /^\],?$/
+
+  EMPTY_HASH = /^\{\},?$/
+  OPEN_HASH  = '{'
+  CLOSE_HASH = /^\},?$/
+
+  def initialize
+    @opened, @io = 0, nil
+  end
+
+  def load(io)
+    @io = io
+    readlines
+    build
+  end
+
+  private
+
+  def readlines
+    case @io
+    when String
+      @io = @io.lines.map(&:strip)
+    when IO
+      @io = @io.readlines.map(&:strip)
+    else
+      raise TypeError, "RBON#load: Need IO or String, got #{@io.class}."
+    end
+  end
+
+  def build(items=nil)
+    loop do
+      item = get_item
+      case items
+      when NilClass
+        items = item
+      when Array
+        items.push item
+      when Hash
+        items[item[0]]=item[1]
+      else
+        raise RBON::Load::Bug, "Unexpected Error"
+      end
+    end
+    return items
+  rescue CloseArray
+    raise RBON::Load::Error unless items.is_a? Array
+    return items
+  rescue CloseHash
+    raise RBON::Load::Error unless items.is_a? Hash
+    return items
+  rescue EOL
+    raise RBON::Load::Error unless @opened == 0
+    return items
+  end
+
+  def chomp(string)
+    string.chomp(',')[1..-2].gsub(XX,X).gsub(XQ,'"').gsub(XN,"\n")
+  end
+
+  def get_strings
+    strings = ''
+    while @io[0].match? STRINGS
+      string = @io.shift
+      strings << chomp(string.sub(/\s*[+]$/,''))
+    end
+    string = @io.shift
+    raise RBON::Load::Error unless string.match? STRING
+    strings << chomp(string)
+    return strings
+  end
+
+  def get_item
+    line = @io.shift or raise EOL
+    case line
+    when NILS
+      nil
+    when FALSES
+      false
+    when TRUES
+      true
+    when INTEGER
+      line.to_i
+    when FLOAT
+      line.to_f
+    when KEY
+      key, string = line.split(/:\s*/,2)
+      @io.unshift string
+      item = get_item
+      [key.to_sym, item]
+    when SYMBOL
+      then line[1..-1].chomp(',').to_sym
+    when STRING
+      chomp(line)
+    when STRINGS
+      @io.unshift line
+      get_strings
+    when EMPTY_ARRAY then []
+    when OPEN_ARRAY
+      @opened += 1
+      build(Array.new)
+    when CLOSE_ARRAY
+      @opened -= 1
+      raise CloseArray
+    when EMPTY_HASH then {}
+    when OPEN_HASH
+      @opened += 1
+      build(Hash.new)
+    when CLOSE_HASH
+      @opened -= 1
+      raise CloseHash
+    else
+      raise RBON::Load::Error, "Unsupported Item: '#{line}'"
+    end
+  end
+end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: rbon
+version: !ruby/object:Gem::Version
+  version: 0.0.210120
+platform: ruby
+authors:
+- carlosjhr64
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-20 00:00:00.000000000 Z
+dependencies: []
+description: |
+  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])`.
+email: carlosjhr64@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rbon.rb
+- lib/rbon/dump.rb
+- lib/rbon/load.rb
+homepage: https://github.com/carlosjhr64/rbon
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- 'ruby: ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-linux]'
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: RBON is not JSON!
+test_files: []