cocos 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51832aaf3ccd7164304a1c4652108b89d7651d2d7358e80c8f0d24fa46f59f69
-  data.tar.gz: 3236f78ad3ced02d1ac42a047a0ce11eaf60017063b61c2c1480786e3513ddc0
+  metadata.gz: 8bef9f661e35af9a5b936f7e37a27e73d0554e361e4d5f3a722305db037b6dc9
+  data.tar.gz: c347765ba3ce339a52541c801bb10fb6ce39800facd619773a6072bddffd16c2
 SHA512:
-  metadata.gz: 11206d11694da8a98bf33b2c444975ec3e195e4c29348f761945fba044fe582d5ab885bb8a5d3057f3ce5589ba288bc14b9d2b456e0003fa74537ac5efa3d0a1
-  data.tar.gz: 8f9e09293599531c4fd4482295fc75e0d7aeea95ffe5de62f7c2bc4d2e84a4e8b643109682accdb98b3295e30e89265f0aa6b36dbcaf70e25adfd8488ea6ba8c
+  metadata.gz: 8f6d70adfcfd0eb010daf8b7a23e8ae402a6186f7242d097e8a1fb99ad6187105567727077c033760b724c9863b6da64efe4a960ac8dd6c9ff961a6b485a9b89
+  data.tar.gz: d0b49d70ac8a369ed7d1f1d51b793edcffd468575592a1cb229c09494d16f7ff63b5479e385858d621190981c92e14c307cb7ebab66c62669fc12e94b69ce09b

data/CHANGELOG.md

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

data/Manifest.txt

@@ -7,3 +7,4 @@ lib/cocos.rb
 lib/cocos/env.rb
 lib/cocos/find_file.rb
 lib/cocos/version.rb
+lib/cocos/words.rb

data/README.md

@@ -50,7 +50,7 @@ txt = File.read( "history.txt" )
 # (e.g. on microsoft windows it is ISO Code Page (CP-1252
 # or something - depending on your locale/culture/language)
 
-txt = File.open( "history.txt", "r:utf-8" ) do |f|
+txt = File.open( "history.txt", "r:bom|utf-8" ) do |f|
              f.read
          end
 ```
@@ -61,7 +61,7 @@ and always repeating the same open / read and code block dance
 again and again e.g.:
 
 ``` ruby
-txt  = File.open( "history.json", "r:utf-8" ) do |f|
+txt  = File.open( "history.json", "r:bom|utf-8" ) do |f|
              f.read
          end
 data = JSON.parse( txt )
@@ -94,7 +94,7 @@ _Read / parse convenience short-cut helpers_
 also known as `read_txt`
 
 
-`read_lines( path )`
+`read_lines( path, chomp: true|false )`
 
 
 `read_json( path )` / `parse_json( str )`
@@ -138,5 +138,4 @@ That's it for now.
 ## License
 
 The `cocos` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
-
+Use as you please with no restrictions whatsoever.

data/Rakefile

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

data/lib/cocos/env.rb

@@ -13,9 +13,9 @@ module EnvParser
     # returns a hash
     #  (compatible structure - works like YAML.load_file)
     #
-    #   change to .read(path) and parse( text) - why? why not?
+    #   change to .read(path) and parse(text) - why? why not?
     def self.load_file( path )
-        text = File.open( path, 'r:utf-8' ) { |f| f.read }
+        text = File.open( path, 'r:bom|utf-8', newline: :lf) { |f| f.read }
         parse( text )
     end
     def self.load( text )   parse( text ); end
@@ -32,7 +32,7 @@ module EnvParser
     ##  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_RE = /\A
+LINE_RE =  %r{\A
                  [ ]*
              (?<key> [A-Za-z][A-Za-z0-9_-]*)
                  [ ]*
@@ -41,7 +41,7 @@ LINE_RE = /\A
                (?<value>.+?)    ## non-greedy
                  [ ]*
               \z
-             /x
+             }x
 
 ## use a parser class - why? why not?
 def self.parse( text )

data/lib/cocos/find_file.rb

@@ -1,3 +1,5 @@
+module Cocos
+  module  Find
 
 
 ##
@@ -13,11 +15,9 @@
 ##     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?
+    raise Errno::ENOENT, "file #{name.inspect} not found; looking in path #{path.inspect}"   if filepath.nil?
     filepath
 end
 
@@ -25,16 +25,25 @@ 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 ?
 
+##
+##  note - always expand path for now and return absolute path!
+##
+##  note - do NOT search path if name passed in is absolute!!!
 def find_file( name, path: )
-    return name    if File.file?( name )
+    filepath = File.expand_path( name )
+    return filepath   if File.file?( filepath )
 
-    path.each do |dir|
-        filepath = File.join( dir, name )
+##  note - if name starts with root / or c:\
+##          assume it's absolute - handle by Pathname lib for now
+##    do NOT search!!!
+    return nil    if Pathname.new(name).absolute?
+
+    path.each do |basedir|
+        filepath = File.expand_path( name, basedir )
         return filepath   if File.file?( filepath )
     end
 
@@ -42,4 +51,33 @@ def find_file( name, path: )
 end
 
 
-end  # module Kernel
+
+def find_dir( name, path: [] )
+    dirpath = File.expand_path( name )
+    return dirpath   if Dir.exist?( dirpath )
+
+##  note - if name starts with / or \ assume it's absolute!!
+##    do NOT search!!!
+##     note - search still works for
+##               ./austria  or ../austria or such
+##
+##  todo/check/fix-fix-fix
+##     is there a File.absolute? or such method for reuse??
+##
+##  todo/fix-fix-fix add absolute check upstream to find_file too!!!
+   ## return nil    if name.start_with?( %r{[/\\]} )
+   ##  note - Pathname#absolute? is basically !Pathname#relative? !!!
+      return nil    if Pathname.new(name).absolute?
+
+    path.each do |basedir|
+        ## todo/check -  always make sure basedir is an absolute/expanded path - why? why not?
+        dirpath = File.expand_path( name, basedir )
+        return dirpath   if Dir.exist?( dirpath )
+    end
+
+    nil   ## return nil if not found
+end
+
+
+end  ## module  Find
+end  ## module Cocos

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 = 1
+  PATCH = 3
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/cocos/words.rb

@@ -0,0 +1,86 @@
+
+###
+##
+##   try  new style with Cocos::FileUtils or Cocos::IO module
+##           and include module into Kernel (instead of directly)
+
+
+module Cocos
+module  FileUtils
+
+
+
+## "words" or "word array.
+##
+##  follows  %w[] rules
+##    splits on whitespace (space or newline)
+##    BUT include support for inline comments!!!!
+##
+##    %w[apple banana cherry]
+##        => ["apple", "banana", "cherry"]
+##      note - allows more than one word on a line!!!!
+##
+##    %w[
+##        ruby
+##        python
+##        javascript
+##        go
+##     ]
+##      => ["ruby", "python", "javascript", "go"]
+##
+##  %w[] is a shorthand syntax (known as a percent literal)
+##    used to create an array of strings.
+##   It allows you to write an array of words without typing
+##    repetitive quotation marks and commas.
+##   Instead, you separate each item using whitespace (spaces or newlines).
+##   note - You CANNOT use standard # comments inside %w[].
+##    Ruby treats the # character as part of a literal string, which will ruin your array.
+##
+##
+##  todo/check:
+##   Option 1: The "Strict Space" Rule (Simplest & Safest)
+##   In most text/config files, a comment is separated by a space
+##    (e.g., key = value # comment).
+##   If a # is glued to a word without a space, it is usually part of the data
+##    (like a hex color #ffffff or a tag #important).
+##     You can modify your code to only remove # if it is preceded by whitespace
+##         color#ff0000     # red
+##         color = #ff0000  # red
+##   check - if this is how # is handled in yaml?
+##      - Inline Comments: A # can be placed at the end of a line of data,
+##                          but it must be preceded by a space.
+##     e.g.  port: 8080# This will break or fail to parse correctly
+##
+##  e.g. use
+##        line.sub( ??, '' ).strip
+
+def parse_words( txt )
+   words = []     ## array of strings
+   txt.each_line( chomp: true ) do |line|
+
+      line = line.strip
+
+      next  if line.empty? || line.start_with?('#')
+
+      ##  strip (inline) end-of-line comments (from line) too - keep why? why not?
+      ##    ## (eat-up) REQUIRED leading (preceding) space(s) too - why? why not?
+      line = line.sub( /[ \t]+#.*/, '' )
+
+      ##  support __END__ marker for inline comments
+      break  if line == '__END__'
+
+      words += line.split( /[ \t]+/ )
+   end
+
+   words
+end
+
+alias_method :parse_wordarray, :parse_words
+
+
+## todo - add (missing) read_words/wordarray too - why? why not?
+
+
+
+end  # module FileUtils
+end  # module Cocos

data/lib/cocos.rb

@@ -8,6 +8,8 @@ require 'json'
 require 'yaml'
 require 'base64'    ## e.g. Base64.decode64,Base64.encode64,...
 require 'fileutils'
+require 'pathname'  ## used by find_file/find_dir to check for absolute? etc.
+
 
 require 'uri'
 require 'net/http'
@@ -40,9 +42,8 @@ require_relative 'cocos/find_file'
 ##  read/parse convenience/helper shortcuts
 
 
-module Kernel
-
 
+module Kernel
 
 ################
 #  private helpers - keep along here - why? why not?
@@ -51,6 +52,20 @@ module Kernel
 ## todo:  add symbolize options a la read_json? - why? why not?
 ##         add sep options
 
+  ##
+  ##  todo - add upstream
+  ##            to CsvHash.read
+  ##                    newline option on read/write and
+  ##                     bom    option on read
+  ## note:
+  ##  (i) :newline => :lf option
+  #      Reads text natively; normalizes all incoming newlines to strict LF (\n)
+  ##  (ii) 'bom|' flag
+  ##   The 'bom|' flag instructs Ruby to drop the BOM bytes if they exist
+  ##  File.open( path, 'r:bom|utf-8', newline: :lf) do |f|
+
+
+
 def read_csv( path, sep: nil )
   opts = {}
   opts[:sep] = sep  if sep
@@ -108,6 +123,10 @@ def download_tab( url )
 end
 
 
+##  fix-fix-fix
+##    for json  add new strict: true|false option (default is false!)
+##       add   option for allowing trailing_commas and comments!!!
+##         see JSON.parse  for more
 
 ## todo:  add symbolize options ???
 def read_json( path )
@@ -160,14 +179,13 @@ alias_method :download_conf, :download_ini
 
 
 
-
 def read_text( path )
-   ## 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?
-    File.open( path, 'r:utf-8' ) do |f|
+  ## note:
+  ##  (i) :newline => :lf option
+  #      Reads text natively; normalizes all incoming newlines to strict LF (\n)
+  ##  (ii) 'bom|' flag
+  ##   The 'bom|' flag instructs Ruby to drop the BOM bytes if they exist
+    File.open( path, 'r:bom|utf-8', newline: :lf) do |f|
         f.read
     end
 end
@@ -202,20 +220,25 @@ end
 ##   add/offer chomp: true/false option or such - why? why not?
 ##    see String.lines in rdoc
 ##
-def read_lines( path )
-  read_text( path ).lines
+##
+##  yes, add chomp: true|false option
+##     note - default is chomp: false (keeping the trailing newline)
+
+def read_lines( path, chomp: false )
+  read_text( path ).lines( chomp: chomp )
 end
 
-def parse_lines( str )
-  str.lines
+def parse_lines( str, chomp: false )
+  str.lines( chomp: chomp )
 end
 
-def download_lines( url )
-  parse_lines( download_text( url ))
+def download_lines( url, chomp: false )
+  parse_lines( download_text( url ), chomp: chomp )
 end
 
 
 
+
 def read_env( path )
    parse_env( read_text( path ))
 end
@@ -250,6 +273,7 @@ end
 
 
 
+
 ######
 #  add writers
 
@@ -262,7 +286,9 @@ def write_json( path, data )
   FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
 
   ## note: pretty print/reformat json
-  File.open( path, 'w:utf-8' ) do |f|
+  ## note: on windows ruby translates \n to \r\n
+  ##          use newline option to use \n everywhere!!
+  File.open( path, 'w:utf-8', newline: :lf) do |f|
      f.write( JSON.pretty_generate( data ))
   end
 end
@@ -292,7 +318,9 @@ def write_text( path, text )
   dirname = File.dirname( path )
   FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
 
-  File.open( path, 'w:utf-8' ) do |f|
+  ## note: on windows ruby translates \n to \r\n
+  ##          use newline option to use \n everywhere!!
+  File.open( path, 'w:utf-8', newline: :lf) do |f|
     f.write( text )
   end
 end
@@ -309,7 +337,9 @@ 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|
+  ## note: on windows ruby translates \n to \r\n
+  ##          use newline option to use \n everywhere!!
+  File.open( path, 'w:utf-8', newline: :lf) do |f|
     if headers     ## e.g. Date,Team 1,FT,HT,Team 2
       f.write( headers.map do |header|
                   _escape_csv( header )
@@ -341,8 +371,10 @@ end
 ##  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?
+  ##  or use value.to_str - why? why not?
   value = value.to_s
 
    ## note - double double quotes (") for now only
@@ -377,6 +409,12 @@ end
 ######
 #   world wide web (www) support
 
+##
+##  keep wget/wget! support - why? why not?
+##    check if used outside anywhere
+##    add deprecated warning - why? why not?
+
+
 def wget( url, **opts )
   Webclient.get( url, **opts )
 end
@@ -397,6 +435,19 @@ end # module Kernel
 
 
 
+require_relative 'cocos/words'    ## pulls in parse_words/wordarray
+
+###
+##   try add kernel global methods via module
+module Kernel
+  include Cocos::FileUtils
+  include Cocos::Find        # e.g. find_file, find_dir, etc.
+end  ## module Kernel
+
+
+
+
+
 
 ####
 #  convenience alias  (use plural or singual)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocos
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-09 00:00:00.000000000 Z
+date: 2026-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csvreader
@@ -119,6 +119,7 @@ files:
 - lib/cocos/env.rb
 - lib/cocos/find_file.rb
 - lib/cocos/version.rb
+- lib/cocos/words.rb
 homepage: https://github.com/rubycocos/cocos
 licenses:
 - Public Domain