rb_cfg_parser 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53d596560d131b757edbbb6366355fb61abbd23b3f2af43ef2cd340f3dad408d
+  data.tar.gz: aefe4e5a4049d4d27c401cc277d5258c6efd0a4a80d36d4986210ac15a3f0cf0
+SHA512:
+  metadata.gz: f77a2803b3baac5592a660e851dd460c67ed3c113f2c6c8f3dc809d478bad2c7757b7e7c3eae13a2a59c39189ada5d920d767f57e7534e329804675a4552b2bb
+  data.tar.gz: c832cffd945b30329cee4c9ab0b98c5b280dac126d228b500d1c9adea4b8ffdaf79bb4cf25e4030d5171dc9471f3de4ad352b91808ca26b6070d0a90c3fe9b3a

data/LICENSE.txt

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) since 2025: rb-cfg-parser ruby App
+description: ruby gem to parse and load .cfg files
+author:      J. Arrizza   email: cppgent0@gmail.com
+
+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/README.md

@@ -0,0 +1,22 @@
+website: <https://link-here>
+
+## Summary
+
+This project TODO...
+
+* run
+
+```bash
+./doit
+```
+
+Typical output:
+
+```bash
+TODO
+```
+
+## How to use
+
+TODO
+

data/lib/parser/config_parser.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+###
+# Configuration parser
+class RbCfgParser
+  ###
+  # constructor
+  def initialize
+    _reset_all
+  end
+
+  ###
+  # parse the given file
+  #
+  # @param path   the path to the file
+  # @return (hash) the content
+  def parse_file(path)
+    file_content = File.read(path)
+    parse_str(file_content.lines)
+  end
+
+  ###
+  # parse the given array of lines
+  #
+  # @param lines  (array) the lines to parse
+  # @return (hash) the content
+  def parse_str(lines)
+    # uncomment to debug
+    # puts("\nlines: >>>")
+    # lineno = 0
+    # lines.each_line do |line|
+    #   lineno += 1
+    #   line   = line.delete!("\n")
+    #   puts("#{lineno}] '#{line}'")
+    # end
+    # puts("<<< lines: #{lineno}")
+
+    _reset_all
+
+    lineno = 0
+    lines.each do |line|
+      lineno += 1
+      line   = line.strip
+
+      # empty line
+      next if line == ''
+
+      # comment
+      next if %w[; #].include?(line[0])
+
+      if line[0] == '['
+        _parse_section(line)
+      else
+        _parse_single_line(line)
+      end
+    end
+
+    # save previous section
+    @content[@curr_section_name] = @curr_section if @curr_section_name == :unnamed && @curr_section != {}
+
+    @content
+  end
+
+  ###
+  # reset content info
+  #
+  # @return None
+  def _reset_all
+    @content           = {}
+    @curr_param_name   = :unnamed
+    @curr_param        = nil
+    @curr_section_name = :unnamed
+    @curr_section      = {}
+  end
+
+  ###
+  # parse a line containing a section name
+  #
+  # @param line  the line to parse
+  # @return None
+  def _parse_section(line)
+    # save previous section if not already
+    if !@content.key?(@curr_section_name) && (@curr_section_name != :unnamed || @curr_section != {})
+      @content[@curr_section_name] = @curr_section
+    end
+
+    # TODO: check section_name; what chars are allowed?
+    m                            = line.match(/\[\s*(.*)\s*\]/)
+    @curr_section_name           = m[1].strip
+    @curr_section                = {}
+    @content[@curr_section_name] = @curr_section
+    @curr_param                  = nil
+    @curr_param_name             = :unnamed
+  end
+
+  ###
+  # parse the given line.
+  # If it is an id or an assigment it is handled
+  # otherwise it is ignored.
+  #
+  # @param line  the line to parse
+  # @return None
+  def _parse_single_line(line)
+    # TODO: alphanum+; check if line has only alphanum
+    unless line.include?('=')
+      id = _clean_it(line)
+      _parse_raw_id(id)
+      return
+    end
+
+    tokens = line.split('=')
+    if tokens.length == 1
+      _parse_assignment(tokens[0], '')
+    elsif tokens.length == 2
+      _parse_assignment(tokens[0], tokens[1])
+    else
+      # TODO: raise excp?
+      puts("BUG  unknown format, tokens: #{tokens}")
+    end
+  end
+
+  ###
+  # handle an assigment given the name and values found.
+  #
+  # @param name  the name found
+  # @param val   the value found
+  # @return None
+  def _parse_assignment(name, val)
+    @curr_section[@curr_param_name] = @curr_param if @curr_param_name != :unnamed
+
+    @curr_param_name = name.strip
+    @curr_param      = nil
+
+    val = val.strip
+    if val == ''
+      @curr_param                     = val
+      @curr_section[@curr_param_name] = @curr_param
+      return
+    end
+
+    # handle single quoted values
+    m = val.scan(/'([^']*)'/)
+    if m.length == 1
+      _clean_and_parse1(val)
+      return
+    end
+
+    if m.length > 1
+      _clean_and_parse_scan_many(m)
+      return
+    end
+
+    # handle double quoted values
+    m = val.scan(/"([^"]*)"/)
+    if m.length == 1
+      _clean_and_parse1(val)
+      return
+    end
+
+    if m.length > 1
+      _clean_and_parse_scan_many(m)
+      return
+    end
+
+    # handle unquoted values
+    vals = val.split
+    if vals.length == 1
+      _clean_and_parse1(val)
+    else
+      _clean_and_parse_many(vals)
+    end
+  end
+
+  ###
+  # clean quotes etc. and then submit the single value as the current parameter
+  #
+  # @param val   a single value
+  # @return None
+  def _clean_and_parse1(val)
+    id = _clean_it(val)
+    _parse_raw_id(id)
+  end
+
+  ###
+  # clean quotes etc. and then submit the resulting values as the current parameter
+  #
+  # @param vals   a result from a .scan()
+  # @return None
+  def _clean_and_parse_scan_many(vals)
+    results = []
+    vals.each_with_index do |v, i|
+      results[i] = _clean_it(v[0])
+    end
+    @curr_param                     = results
+    @curr_section[@curr_param_name] = @curr_param
+  end
+
+  ###
+  # clean quotes etc. and then submit the resulting values as the current parameter
+  #
+  # @param vals   a multiple value
+  # @return None
+  def _clean_and_parse_many(vals)
+    results = []
+    vals.each do |v|
+      id = _clean_it(v)
+      results.append(id)
+    end
+    @curr_param                     = results
+    @curr_section[@curr_param_name] = @curr_param
+  end
+
+  ###
+  # clean quotes or commas from the given value.
+  #
+  # @param val  (string) the value to clean up
+  # @return None
+  def _clean_it(val)
+    if val[0] == '\''
+      m   = val.match(/'(.*)'/)
+      val = m[1].strip
+    elsif val[0] == '"'
+      m   = val.match(/"(.*)"/)
+      val = m[1].strip
+    elsif val.end_with?(',')
+      val = val.delete_suffix(',')
+    end
+
+    val = '' if val == '[]'
+
+    val
+  end
+
+  ###
+  # check and store the given value
+  #
+  # @param id  the entity to store
+  # @return None
+  def _parse_raw_id(id)
+    if @curr_param.nil?
+      @curr_param = id
+    elsif @curr_param.instance_of?(Array)
+      @curr_param.append(id)
+    elsif @curr_param.instance_of?(String)
+      @curr_param = [@curr_param, id]
+    else
+      # :nocov: coverage: unknown how to cause
+      puts("BUG parse_raw_id: unknown format '#{id}'")
+      # :nocov:
+    end
+    @curr_section[@curr_param_name] = @curr_param
+  end
+end

data/lib/rb_cfg_parser.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'parser/config_parser'

data/lib/version.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+## current version
+VERSION = '0.1.0'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: rb_cfg_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Arrizza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-13 00:00:00.000000000 Z
+dependencies: []
+description: ruby gem to parse and load .cfg files
+email: cppgent@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/parser/config_parser.rb
+- lib/rb_cfg_parser.rb
+- lib/version.rb
+homepage: https://rubygems.org/gems/rb_cfg_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://arrizza.com/rb-cfg-parser
+  source_code_uri: https://bitbucket.org/arrizza-public/rb-cfg-parser/src/master
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: parse a .cfg text file
+test_files: []