rb_cfg_parser 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9103c8c06f978609933e4ffc3c7aaa4e4af44860e5feb1a8d94f6a76daac847
-  data.tar.gz: 5f893f3b5042113a90de05ba58d6b36f0d98c500fdc71ef6938af471bbf0f6e5
+  metadata.gz: 67671d34a5ab6b2e94b06ca3152ba1b820fb91bbb44a2cd8c75de155eae3da1b
+  data.tar.gz: c98c2337de6184a209f499d29b569f9836350e22c57d09602378cfe76b215382
 SHA512:
-  metadata.gz: ae76c8dc9b3a1ea6bc380c7c94423da7184b603fd36e522daf1d7959ee710bc4c54d0b76be3fc5b62691e2ea825c7f5fc13cab7b6dcf79beb81fcef94af73e31
-  data.tar.gz: 6af35ac2f6dfaab81984c1018de0c4df97edde92770786cb63cf63b744e97139e32ff993cc2054e16dafcdb0d0e0739787269a1940031f387b2b171cf45c823e
+  metadata.gz: 6801e106a59a9df556acb29c253b577befe47014f93f3fb215cec04ad232546b2cd27fcde5031e78ea8cee778c51f3bd2995d3faa2e330595496c959dd83c1ec
+  data.tar.gz: c6120c344a91322f903afb7e9ca4700c997eb09d63e115f90474610332bec605206a30307aa7ed3e221a482bda88dcebab52f1824ad43c9bb5e98625950d01a2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) since 2025: rb-cfg-parser ruby App
+Copyright (c) since 2025: rb-cfg-parser Ruby Gem
 description: ruby gem to parse and load .cfg files
 author:      J. Arrizza   email: cppgent0@gmail.com
 

data/lib/parser/cfg_parser.rb

@@ -9,6 +9,7 @@ class RbCfgParser
   attr_writer :log_cb
 
   ###
+  # constructor
   def initialize
     @rex                 = CfgLexer.new
     @fsm                 = :start
@@ -20,18 +21,22 @@ class RbCfgParser
     @curr_values         = nil
     @curr_section        = nil
     @curr_section_lineno = 0
-    @log_cb              = method(:print_line)
+    @log_cb              = method(:_print_raw_line)
     @verbose             = 0
     @content             = {}
   end
 
   ###
+  # parse the given file
+  # @return the content as a hash
   def parse_file(path)
     file_content = File.read(path)
     parse_str(file_content)
   end
 
   ###
+  # parse the given string
+  # @return the content as a hash
   def parse_str(text)
     text = text.join("\n") if text.is_a?(Array)
     @rex.scan_setup(text)
@@ -42,7 +47,7 @@ class RbCfgParser
 
     loop do
       break if @token.nil?
-      print_dbg(format('fsm:%-17s tok[%d]:%-13s val:%-10s next[%d]=%s', @fsm, @tok_posn, @token[0], @token[1], @next_tok_posn, @next_token))
+      # print_dbg(format('fsm:%-17s tok[%d]:%-13s val:%-10s next[%d]=%s', @fsm, @tok_posn, @token[0], @token[1], @next_tok_posn, @next_token))
 
       if @token[0] == :newline
         @lineno        += 1
@@ -77,6 +82,9 @@ class RbCfgParser
   end
 
   ###
+  # in the start fsm state:
+  #   read and handle the next value
+  # @return None
   def fsm_start
     if @token[0] == :newline
       @lineno        += 1
@@ -99,6 +107,9 @@ class RbCfgParser
   end
 
   ###
+  # in the read_section fsm state:
+  #   read and handle the next value
+  # @return None
   def fsm_read_section
     if @token[0] == :vrbl
       @curr_section = @token[1]
@@ -118,6 +129,9 @@ class RbCfgParser
   end
 
   ###
+  # in the assignments fsm state:
+  #   read and handle the next value
+  # @return None
   def fsm_assignments
     if @token[0] == :newline
       # skip
@@ -141,6 +155,9 @@ class RbCfgParser
   end
 
   ###
+  # in the asgmt_read_values fsm state:
+  #   read and handle the next value
+  # @return None
   def fsm_asgmt_read_values
     if @token[0] == :newline
       # handle empty value
@@ -193,6 +210,8 @@ class RbCfgParser
   end
 
   ###
+  # strip any quotes (single or double) from the given value
+  # @return the updated value
   def strip_quotes(val)
     if (val[0] == "'" && val[-1] == "'") || (val[0] == '"' && val[-1] == '"')
       val[1..-2]
@@ -202,6 +221,8 @@ class RbCfgParser
   end
 
   ###
+  # reset the section info
+  # @return None
   def reset_section
     @curr_section        = nil
     @curr_section_lineno = @lineno
@@ -210,6 +231,8 @@ class RbCfgParser
   end
 
   ###
+  # save the current section that was found
+  # @return None
   def save_curr_section
     if @content.include?(@curr_section)
       raise_err("found duplicate section: \"#{@curr_section}\"")
@@ -219,6 +242,8 @@ class RbCfgParser
   end
 
   ###
+  # save the current assignment that found
+  # @return None
   def save_curr_assignment
     if @content[@curr_section].include?(@curr_vrbl)
       raise_err("found duplicate variable: \"#{@curr_vrbl}\" in section: \"#{@curr_section}\"")
@@ -229,6 +254,8 @@ class RbCfgParser
   end
 
   ###
+  # get the next token from the input stream, set token and tok_posn
+  # @return None
   def get_next_token
     @token         = @next_token
     @tok_posn      = @next_tok_posn
@@ -246,22 +273,41 @@ class RbCfgParser
   end
 
   ###
+  # raise an exception indicating an unexpected token was found
+  # @return does not return
   def raise_unexpected_token
     raise_err("Unexpected token #{@token}")
   end
 
   ###
-  def raise_err(text)
-    raise("\nline: #{@lineno}] in state: #{@fsm}, #{text}")
+  # raise an exception with the given text
+  # @param msg  additional message to print
+  # @return does not return
+  def raise_err(msg)
+    raise("\nline: #{@lineno}] in state: #{@fsm}, #{msg}")
   end
 
   ###
+  # print a debug line
+  # @param msg  line to print
+  # @return None
   def print_dbg(msg)
     @log_cb.call(format('DBG  line: %3d] %s', @lineno, msg)) if @verbose > 1
   end
 
   ###
+  # print a line
+  # @param msg  line to print
+  # @return None
   def print_line(msg)
     @log_cb.call(format(' --> line: %3d] %s', @lineno, msg)) if @verbose.positive?
   end
+
+  ###
+  # default callback to print a simple line to stdout
+  # @param msg  line to print
+  # @return None
+  def _print_raw_line(msg)
+    # skip
+  end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 ## current version
-VERSION = '0.1.1'
+VERSION = '0.1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_cfg_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - J. Arrizza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2025-04-12 00:00:00.000000000 Z
 dependencies: []
 description: ruby gem to parse and load .cfg files
 email: cppgent0@gmail.com