cocos 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34f86372be24c8d19abde781cc66b5d9c6b323e09c7620221f30b9e115b786d
-  data.tar.gz: d025bedc0c96372e74339bd4a0ae7fcd56857d23a1678b35c1b2a8aef2b1be12
+  metadata.gz: 51832aaf3ccd7164304a1c4652108b89d7651d2d7358e80c8f0d24fa46f59f69
+  data.tar.gz: 3236f78ad3ced02d1ac42a047a0ce11eaf60017063b61c2c1480786e3513ddc0
 SHA512:
-  metadata.gz: 50b9cc405bb2d5e16900958a55c11fcf02b5854a4410c072cbab51d585c3a656f9a9a8bb4246b51fc7b46d0200d7fefa98ea3bd4d0e95bb455c8e60dc92c6e10
-  data.tar.gz: fc797f93f3f73644b5b6ee6695564ffd4f4f7308aa8412d5d62785baa9301e5cd740ceb017215d7a3417884edcc057044e15c938bea1310c4c217cbb310d188b
+  metadata.gz: 11206d11694da8a98bf33b2c444975ec3e195e4c29348f761945fba044fe582d5ab885bb8a5d3057f3ce5589ba288bc14b9d2b456e0003fa74537ac5efa3d0a1
+  data.tar.gz: 8f9e09293599531c4fd4482295fc75e0d7aeea95ffe5de62f7c2bc4d2e84a4e8b643109682accdb98b3295e30e89265f0aa6b36dbcaf70e25adfd8488ea6ba8c

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+### 0.4.1
 ### 0.4.0
 ### 0.0.1 / 2022-08-01
 

data/Manifest.txt

@@ -5,4 +5,5 @@ README.md
 Rakefile
 lib/cocos.rb
 lib/cocos/env.rb
+lib/cocos/find_file.rb
 lib/cocos/version.rb

data/lib/cocos/env.rb

@@ -2,7 +2,7 @@
 # simple read_env, load_env machinery
 ##   inspired by
 ##      dotenv gem -> https://github.com/bkeepers/dotenv
-##      figaro     -> https://github.com/laserlemon/figaro  
+##      figaro     -> https://github.com/laserlemon/figaro
 ##      and others
 
 
@@ -19,54 +19,59 @@ module EnvParser
         parse( text )
     end
     def self.load( text )   parse( text ); end
- 
-    
+
+
     class Error < StandardError; end
-  
+
     ## todo/check - what is JSON and YAML returning Parser/ParseError something else?
     ##  YAML uses ParseError  and JSON uses ParserError
     class ParseError < Error; end
-  
+
 
     ## todo/check - if support for empty values e.g. abc=  is required/possible???
     ##  todo/ addd support for quoted values - why? why not?
     ##  add support for "inline" end of line comments - why? why not?
     ##  add support for escapes and multi-line values - why? why not?
-LINE_RX = /\A(?<key>[A-Za-z][A-Za-z0-9_-]*)
+LINE_RE = /\A
+                 [ ]*
+             (?<key> [A-Za-z][A-Za-z0-9_-]*)
                  [ ]*
                    =
                  [ ]*
                (?<value>.+?)    ## non-greedy
+                 [ ]*
               \z
              /x
 
-  ## use a parser class - why? why not?
-  def self.parse( text )
-   h = {}
+## use a parser class - why? why not?
+def self.parse( text )
+  h = {}
 
-   lineno = 0   
+  lineno = 0
   text.each_line do |line|
     lineno += 1    ## track line numbers for (parse) error reporting
-
     line = line.strip   ## check: use strip (or be more strict) - why? why not?
+
     ## skip empty and comment lines
-    next if line.empty? || line.start_with?( '#' )
+    next   if line.empty? || line.start_with?( '#' )
+    ##  support __END__ marker for inline comments
+    break  if line == '__END__'
 
-    if m=LINE_RX.match(line)
+    if m=LINE_RE.match(line)
       key   = m[:key]
       value = m[:value]
-      
+
       ## todo/check - check/warn about duplicates - why? why not?
       h[key] = value
-   else 
+    else
       raise ParseError,  "line #{lineno} - unknown line type; cannot parse >#{line}<"
-   end
+    end
   end
   h
 end   # methdod self.parse
 end  # module EnvParser
 
-  
+
 
 __END__
 

data/lib/cocos/find_file.rb

@@ -0,0 +1,45 @@
+
+
+##
+## note - use File.file? instead of File.exist?
+##            (checks if file exists AND file is a file NOT a directory)
+##
+##
+##   add  option - raise_on_error: false  - why? why not?
+##     def find_file!  - find_file(  raise_on_error: false )
+##
+##  todo/check
+##    golang  lookup_path or such
+##     always return absolute (expanded) path - why? why not?
+
+
+module Kernel
+
+def find_file!( name, path: )
+    filepath = find_file( name, path: path )
+    raise Errorno::ENOENT, "file <#{name}> not found; looking in path #{path.inspect}"   if filepath.nil?
+    filepath
+end
+
+##
+##  note - find_file will NOT find directories!!!
+##                          File.file? will only check if a file (not directory) exits!!
+
+
+##
+## todo/check - expand path and use File.realpath too?
+##           or keep "simple" File.join ?
+
+def find_file( name, path: )
+    return name    if File.file?( name )
+
+    path.each do |dir|
+        filepath = File.join( dir, name )
+        return filepath   if File.file?( filepath )
+    end
+
+    nil   ## return nil if not found
+end
+
+
+end  # module Kernel

data/lib/cocos/version.rb

@@ -2,7 +2,7 @@
 module Cocos
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
   MINOR = 4
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/cocos.rb

@@ -33,6 +33,9 @@ require_relative 'cocos/version'   # note: let version always go first
 require_relative 'cocos/env'       ## e.g. EnvParser
 
 
+require_relative 'cocos/find_file'
+
+
 ###
 ##  read/parse convenience/helper shortcuts
 
@@ -151,8 +154,8 @@ def download_ini( url )
    parse_ini( download_text( url ))
 end
 
-alias_method :read_conf, :read_ini
-alias_method :parse_conf, :parse_ini
+alias_method :read_conf,     :read_ini
+alias_method :parse_conf,    :parse_ini
 alias_method :download_conf, :download_ini
 
 
@@ -222,11 +225,17 @@ def parse_env( str )
 end
 
 
+
+
 ##
 ##  todo/check - change path to *paths=['./.env']
 ##                   and support more files - why? why not?
+##
+##  note - use File.file? instead of File.exist?
+##              will avoid matching directories!
+
 def load_env( path='./.env' )
-  if File.exist?( path )
+  if File.file?( path )
      puts "==> loading .env settings..."
      env = read_env( path )
      puts "    applying .env settings... (merging into ENV)"
@@ -291,7 +300,7 @@ alias_method :write_txt,  :write_text
 
 
 
-#
+
 # note:
 #  for now write_csv expects array of string arrays
 #     does NOT support array of hashes for now
@@ -301,21 +310,16 @@ def write_csv( path, recs, headers: nil )
   FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
 
   File.open( path, 'w:utf-8' ) do |f|
-    if headers
-      f.write( headers.join(','))   ## e.g. Date,Team 1,FT,HT,Team 2
+    if headers     ## e.g. Date,Team 1,FT,HT,Team 2
+      f.write( headers.map do |header|
+                  _escape_csv( header )
+                end.join(',') )
       f.write( "\n" )
     end
 
     recs.each do |values|
-      ## quote values that incl. a comma
-      ##  todo/fix - add more escape/quote checks - why? why not?
-      ##   check how other csv libs handle value generation
       buf =  values.map do |value|
-               if value.index(',')
-                  %Q{"#{value}"}
-               else
-                  value
-               end
+               _escape_csv( value )
              end.join( ',' )
 
       f.write( buf )
@@ -326,6 +330,50 @@ end
 
 
 
+## quote values that incl. a comma
+##  todo/fix - add more escape/quote checks - why? why not?
+##   check how other csv libs handle value generation
+##
+## If a field contains
+## - a comma  (,)
+## - a double quote (")
+## - a newline  (\r\n)
+##  then wrap the field in quotes
+##  Inside quoted fields, double every double quote (" → "")
+
+def _escape_csv(value)
+  ## auto-convert to string or let code fail on nil or such?
+  value = value.to_s
+
+   ## note - double double quotes (") for now only
+   ##  check
+   ##    -  escape newline (lf) as \n or keep it literal - why? why not?
+   ##            what about  \r carriage return (cr)
+   ##
+   ##  add value.match?(/\A\s|\s\z/) ||
+   ##    to preserve leading/trailing spaces in value ???
+   ##    e.g.   _a_ becomes "_a_" written out
+   ##
+   ##  quote empty strings or keep them empty
+   ##   what about nil - for now empty string too
+   ##    add nil_value option e.g. 'n/a' or such
+   ##     and quote_empty true|false - why? why not?
+  if value.include?(',')  ||
+     value.include?('"')  ||
+     value.include?("\n") ||
+     value.include?("\r")
+    '"' + value.gsub('"', '""') + '"'
+  else
+    value
+  end
+end
+
+
+
+
+
+
+
 ######
 #   world wide web (www) support
 
@@ -356,4 +404,3 @@ Coco = Cocos
 
 
 puts Cocos.banner   ## say hello
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocos
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csvreader
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 description: cocos (code commons) - auto-include quick-starter prelude & prolog
 email: gerald.bauer@gmail.com
 executables: []
@@ -117,6 +117,7 @@ files:
 - Rakefile
 - lib/cocos.rb
 - lib/cocos/env.rb
+- lib/cocos/find_file.rb
 - lib/cocos/version.rb
 homepage: https://github.com/rubycocos/cocos
 licenses:
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: cocos (code commons) - auto-include quick-starter prelude & prolog