cocos 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbe9c2c739403b5996adda6684d175a3853afbd76bffe81adf44c8a31cbe0c8d
-  data.tar.gz: 4ba46909cd0722c656aaa1be7145dc5430e681bf5f4722e2b03b3af6928d9de8
+  metadata.gz: 51832aaf3ccd7164304a1c4652108b89d7651d2d7358e80c8f0d24fa46f59f69
+  data.tar.gz: 3236f78ad3ced02d1ac42a047a0ce11eaf60017063b61c2c1480786e3513ddc0
 SHA512:
-  metadata.gz: 5416f8ad167ba3f614cb85483b372bd1b9a8ccf7c60a69fcdbcfac954c1ae3c586f582e1fa3d7abf6dc6cf4c3f95c1da0f8e2bbfaae12b716d77290f90450715
-  data.tar.gz: e7aa4a8514cf702b9b35b526e60011743de51ebdf1cbb2e8e0861e722225b5e3e76b113304dbcb8c58c377be17e340fd0e961a64a8a3a568768d01fe17a6de3e
+  metadata.gz: 11206d11694da8a98bf33b2c444975ec3e195e4c29348f761945fba044fe582d5ab885bb8a5d3057f3ce5589ba288bc14b9d2b456e0003fa74537ac5efa3d0a1
+  data.tar.gz: 8f9e09293599531c4fd4482295fc75e0d7aeea95ffe5de62f7c2bc4d2e84a4e8b643109682accdb98b3295e30e89265f0aa6b36dbcaf70e25adfd8488ea6ba8c

data/CHANGELOG.md

@@ -1,4 +1,5 @@
-### 0.3.1
+### 0.4.1
+### 0.4.0
 ### 0.0.1 / 2022-08-01
 
 * Everything is new. First release.

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/README.md

@@ -87,8 +87,7 @@ And so on.
 
 _Read / parse convenience short-cut helpers_
 
-`read_blob( path )` <br>
-also known as `read_binary` or `read_bin`
+`read_blob( path )`
 
 
 `read_text( path )` <br>
@@ -98,14 +97,14 @@ also known as `read_txt`
 `read_lines( path )`
 
 
-
 `read_json( path )` / `parse_json( str )`
 
 
-`read_yaml( path )` / `parse_yaml( str )`
+`read_yaml( path )` / `parse_yaml( str )` <br>
+also known as `read_yml` / `parse_yml`
 
 
-`read_csv( path, headers: true )` / `parse_csv( str, headers: true )`
+`read_csv( path )` / `parse_csv( str )`
 
 note: comma-separated values (.csv) reading & parsing service
 brought to you by the [**csvreader library / gem »**](https://github.com/rubycocos/csvreader/tree/master/csvreader)
@@ -113,8 +112,7 @@ brought to you by the [**csvreader library / gem »**](https://github.com/rubyco
 
 `read_data( path )` / `parse_data( str )`
 
-note:  alternate shortcut / alias for `read_csv( path, headers: false )` / `parse_csv( str, headers: false )`
-
+note:  alternate csv reader / parser; reads data WITHOUT headers, that is, named columns - returns data array not named hash (table)
 
 
 
@@ -125,7 +123,6 @@ brought to you by the [**tabreader library / gem »**](https://github.com/rubyco
 
 
 
-
 `read_ini( path )` / `parse_ini( str )` <br>
 also known as `read_conf / parse_conf`
 

data/Rakefile

@@ -12,7 +12,7 @@ Hoe.spec 'cocos' do
   self.urls = { home: 'https://github.com/rubycocos/cocos' }
 
   self.author = 'Gerald Bauer'
-  self.email = 'opensport@googlegroups.com'
+  self.email = 'gerald.bauer@gmail.com'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'

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

@@ -1,7 +1,7 @@
 
 module Cocos
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 3
+  MINOR = 4
   PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
@@ -14,8 +14,6 @@ module Cocos
   end
 
   def self.root
-    File.expand_path( File.dirname(File.dirname(__FILE__) ))
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__) )))
   end
-
 end # module Cocos
-

data/lib/cocos.rb

@@ -29,8 +29,12 @@ require 'webclient'
 
 #####################
 # our own code
-require 'cocos/version'   # note: let version always go first
-require 'cocos/env'       ## e.g. EnvParser
+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
@@ -43,138 +47,153 @@ module Kernel
 ################
 #  private helpers - keep along here - why? why not?
 
-##### check if path starts with http:// or https://
-##       if yes, assume it's a download
-DOWNLOAD_RX = %r{^https?://}i
 
-## note: hack - use !! to force nil (no match) to false
-##                         and matchdata to true
-def _download?( path )
-   !! DOWNLOAD_RX.match( path )
-end
+## todo:  add symbolize options a la read_json? - why? why not?
+##         add sep options
 
+def read_csv( path, sep: nil )
+  opts = {}
+  opts[:sep] = sep  if sep
 
+  CsvHash.read( path, **opts )
+end
 
-## todo:  add symbolize options a la read_json
-##         add sep options
-def read_csv( path, headers: true )
-
-   if _download?( path )
-     parse_csv( _wget!( path ).text,
-                headers: headers )
-   else
-     if headers
-        CsvHash.read( path )
-     else
-        Csv.read( path )
-     end
-    end
+def parse_csv( str, sep: nil )
+  opts = {}
+  opts[:sep] = sep  if sep
+
+  CsvHash.parse( str, **opts )
 end
 
-def parse_csv( str, headers: true )
-  if headers
-    CsvHash.parse( str )
-  else
-    Csv.parse( str )
-  end
+
+##  note - use explicit download for now
+##
+def download_csv( url, sep: nil )
+  opts = {}
+  opts[:sep] = sep  if sep
+
+  parse_csv( download_text( url ),
+              **opts )
 end
 
 
+
 ### note: use read_data / parse_data
 ##  for alternate shortcut for read_csv / parse_csv w/ headers: false
 ##       returning arrays of strings
 def read_data( path )
-  if _download?( path )
-    read_data( _wget!( path ).text )
-  else
-    Csv.read( path )
-  end
+  Csv.read( path )
 end
 
 def parse_data( str )
   Csv.parse( str )
 end
 
+def download_data( url )
+  parse_data( download_text( url ))
+end
+
 
 
 def read_tab( path )
-  if _download?( path )
-    parse_tab( _wget!( path ).text )
-  else
-    Tab.read( path )
-  end
+  Tab.read( path )
 end
 
 def parse_tab( str )
   Tab.parse( str )
 end
 
+def download_tab( url )
+  parse_tab( download_text( url ))
+end
+
+
 
 ## todo:  add symbolize options ???
 def read_json( path )
-  JSON.parse( read_text( path ))
+  parse_json( read_text( path ))
 end
 
 def parse_json( str )
   JSON.parse( str )
 end
 
+def download_json( url )
+  parse_json( download_text( url ))
+end
+
 
 ### todo/check:  use parse_safeyaml or such? (is default anyway?) - why? why not?
 def read_yaml( path )
-   YAML.load( read_text( path ))
+   parse_yaml( read_text( path ))
 end
 
 def parse_yaml( str )
   YAML.load( str )
 end
 
+def download_yaml( url )
+   parse_yaml( download_text( url ))
+end
+
+## keep yml alias - why? why not?
+alias_method :read_yml,     :read_yaml
+alias_method :parse_yml,    :parse_yaml
+alias_method :download_yml, :download_yaml
+
 
 def read_ini( path )
-   INI.load( read_text( path ))
+   parse_ini( read_text( path ))
 end
 
 def parse_ini( str )
   INI.load( str )
 end
 
-alias_method :read_conf, :read_ini
-alias_method :parse_conf, :parse_ini
+def download_ini( url )
+   parse_ini( download_text( url ))
+end
+
+alias_method :read_conf,     :read_ini
+alias_method :parse_conf,    :parse_ini
+alias_method :download_conf, :download_ini
 
 
 
 
 def read_text( path )
-  if _download?( path )
-    _wget!( path ).text
-  else
    ## todo/check: add universal newline mode or such?
    ##  e.g. will always convert all
    ##    newline variants (\n|\r|\n\r) to "universal" \n only
    ##
    ##  add r:bom  - why? why not?
-    txt = File.open( path, 'r:utf-8' ) do |f|
-                f.read
-          end
-    txt
-  end
+    File.open( path, 'r:utf-8' ) do |f|
+        f.read
+    end
 end
-alias_method :read_txt, :read_text
+
+def download_text( url )
+  wget!( url ).text
+end
+
+alias_method :read_txt,     :read_text
+alias_method :download_txt, :download_text
+
 
 
 def read_blob( path )
-  if _download?( path )
-    _wget!( path ).blob
-  else
-    blob =  File.open( path, 'rb' ) do |f|
-                   f.read
-            end
-    blob
-  end
+    File.open( path, 'rb' ) do |f|
+        f.read
+    end
 end
-alias_method :read_binary, :read_blob
-alias_method :read_bin,    :read_blob
+## alias_method :read_binary, :read_blob
+## alias_method :read_bin,    :read_blob
 
+def download_blob( url )
+   wget!( url ).blob
+end
+## alias_method :download_binary, :download_blob
+## alias_method :download_bin,    :download_blob
 
 
 
@@ -191,10 +210,14 @@ def parse_lines( str )
   str.lines
 end
 
+def download_lines( url )
+  parse_lines( download_text( url ))
+end
+
 
 
 def read_env( path )
-   EnvParser.load( read_text( path ))
+   parse_env( read_text( path ))
 end
 
 def parse_env( str )
@@ -202,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)"
@@ -251,8 +280,8 @@ def write_blob( path, blob )
     f.write( blob )
   end
 end
-alias_method :write_binary, :write_blob
-alias_method :write_bin,    :write_blob
+# alias_method :write_binary, :write_blob
+# alias_method :write_bin,    :write_blob
 
 
 def write_text( path, text )
@@ -271,54 +300,90 @@ alias_method :write_txt,  :write_text
 
 
 
-#
+
 # note:
 #  for now write_csv expects array of string arrays
-#     does NOT support array of hashes for now 
+#     does NOT support array of hashes for now
 
 def write_csv( path, recs, headers: nil )
   dirname = File.dirname( path )
   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  
+    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 )
       f.write( "\n" )
-    end 
+    end
   end
 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
 
-def wget( url, **kwargs )
-  Webclient.get( url, **kwargs )
+def wget( url, **opts )
+  Webclient.get( url, **opts )
 end
 ##  add alias www_get or web_get - why? why not?
 
-
-
-## private helper - make public -why? why not?
-def _wget!( url, **kwargs )
-  res = Webclient.get( url, **kwargs )
+def wget!( url, **opts )
+  res = Webclient.get( url, **opts )
 
   ##  check/todo - use a different exception/error - keep RuntimeError - why? why not?
   raise RuntimeError, "HTTP #{res.status.code} - #{res.status.message}"   if res.status.nok?
@@ -339,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.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csvreader
@@ -92,16 +92,16 @@ 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: opensport@googlegroups.com
+email: gerald.bauer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -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