cocos 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed017038dd37ce27a71bb2835900c893dc916643e1f07e3809a18eca3f626265
-  data.tar.gz: 77f8a74da6add1f4af968364c3eecfbae7cb1dfd88bce89bb04490ad3932df44
+  metadata.gz: 38e913cc7ec8d6951edd7bb59ac80626aadf3a3fbd7b13f82ccc123dffc6a7b1
+  data.tar.gz: 8883a9656f7aa48b6c778e9786966f507a80dbd13be670ca69ff9ed5b20656a8
 SHA512:
-  metadata.gz: c74889afd4f26afd75e8bcd306920f916646787cf3a85e3d94e2e67b0aed81bea4747c7e924d0dde40c2aa22661a61eed59c656ca1f57842ffd4d6f9099ae00b
-  data.tar.gz: f25f050d937978cf344530b6f347716f79f137b1e467518be2c5d506a39eedbe7f5bf16163047685cf18d4e34d7cf501cc200db6b1c876e0406b35f4d0968edc
+  metadata.gz: 1b9e85de98ce029a384d0ce1fa2e09905d3d7eeee956d59ab090c0eb9300b1de121ecc1bfeaaacdebdca7dd66227f7a9fefce1ef397d1d97fa5123cac32609c8
+  data.tar.gz: ba6fc944c1dc724c131c0f32390349140c3d658a4db80d876a421704eea1d13ac78ecedc3da6141ba7116367270e836d8aafcb420b12bd664ae604ac557af8a4

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+### 0.3.0
 ### 0.0.1 / 2022-08-01
 
 * Everything is new. First release.

data/Manifest.txt

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

data/lib/cocos/env.rb

@@ -0,0 +1,91 @@
+###
+# simple read_env, load_env machinery
+##   inspired by
+##      dotenv gem -> https://github.com/bkeepers/dotenv
+##      figaro     -> https://github.com/laserlemon/figaro  
+##      and others
+
+
+##  todo/check:
+##    move to its own (standandaloen) envparser gem - why? why not?
+
+module EnvParser
+    # returns a hash
+    #  (compatible structure - works like YAML.load_file)
+    #
+    #   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 }
+        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_-]*)
+                 [ ]*
+                   =
+                 [ ]*
+               (?<value>.+?)    ## non-greedy
+              \z
+             /x
+
+  ## use a parser class - why? why not?
+  def self.parse( text )
+   h = {}
+
+   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?( '#' )
+
+    if m=LINE_RX.match(line)
+      key   = m[:key]
+      value = m[:value]
+      
+      ## todo/check - check/warn about duplicates - why? why not?
+      h[key] = value
+   else 
+      raise ParseError,  "line #{lineno} - unknown line type; cannot parse >#{line}<"
+   end
+  end
+  h
+end   # methdod self.parse
+end  # module EnvParser
+
+  
+
+__END__
+
+# parser regex from dotenv
+
+LINE = /
+(?:^|\A)              # beginning of line
+\s*                   # leading whitespace
+(?:export\s+)?        # optional export
+([\w.]+)              # key
+(?:\s*=\s*?|:\s+?)    # separator
+(                     # optional value begin
+  \s*'(?:\\'|[^'])*'  #   single quoted value
+  |                   #   or
+  \s*"(?:\\"|[^"])*"  #   double quoted value
+  |                   #   or
+  [^\#\r\n]+          #   unquoted value
+)?                    # value end
+\s*                   # trailing whitespace
+(?:\#.*)?             # optional comment
+(?:$|\z)              # end of line
+/x

data/lib/cocos/version.rb

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

data/lib/cocos.rb

@@ -30,7 +30,7 @@ require 'webclient'
 #####################
 # our own code
 require 'cocos/version'   # note: let version always go first
-
+require 'cocos/env'       ## e.g. EnvParser
 
 ###
 ##  read/parse convenience/helper shortcuts
@@ -40,14 +40,35 @@ 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
 ##         add sep options
 def read_csv( path, headers: true )
-   if headers
-      CsvHash.read( path )
+
+   if _download?( path )
+     parse_csv( _wget!( path ).text,
+                headers: headers )
    else
-      Csv.read( path )
-   end
+     if headers
+        CsvHash.read( path )
+     else
+        Csv.read( path )
+     end
+    end
 end
 
 def parse_csv( str, headers: true )
@@ -63,7 +84,11 @@ end
 ##  for alternate shortcut for read_csv / parse_csv w/ headers: false
 ##       returning arrays of strings
 def read_data( path )
-  Csv.read( path )
+  if _download?( path )
+    read_data( _wget!( path ).text )
+  else
+    Csv.read( path )
+  end
 end
 
 def parse_data( str )
@@ -73,7 +98,11 @@ end
 
 
 def read_tab( path )
-   Tab.read( path )
+  if _download?( path )
+    parse_tab( _wget!( path ).text )
+  else
+    Tab.read( path )
+  end
 end
 
 def parse_tab( str )
@@ -83,16 +112,17 @@ end
 
 ## todo:  add symbolize options ???
 def read_json( path )
-   JSON.parse( read_text( path ))
+  JSON.parse( read_text( path ))
 end
 
 def parse_json( str )
   JSON.parse( str )
 end
 
+
 ### todo/check:  use parse_safeyaml or such? (is default anyway?) - why? why not?
 def read_yaml( path )
-  YAML.load( read_text( path ))
+   YAML.load( read_text( path ))
 end
 
 def parse_yaml( str )
@@ -101,7 +131,7 @@ end
 
 
 def read_ini( path )
-  INI.load( read_text( path ))
+   INI.load( read_text( path ))
 end
 
 def parse_ini( str )
@@ -115,22 +145,32 @@ alias_method :parse_conf, :parse_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
 end
 alias_method :read_txt, :read_text
 
 
 def read_blob( path )
-  blob =  File.open( path, 'rb' ) do |f|
-                  f.read
-          end
-  blob
+  if _download?( path )
+    _wget!( path ).blob
+  else
+    blob =  File.open( path, 'rb' ) do |f|
+                   f.read
+            end
+    blob
+  end
 end
 alias_method :read_binary, :read_blob
 alias_method :read_bin,    :read_blob
@@ -140,12 +180,42 @@ alias_method :read_bin,    :read_blob
 
 ## todo/check: remove \n (or\r or \r\n) from line
 ##   ruby (by default) keeps the newline - follow tradition? why? why not?
+##   add/offer chomp: true/false option or such - why? why not?
+##    see String.lines in rdoc
 ##
 def read_lines( path )
-    lines = File.open( path, 'r:utf-8' ) do |f|
-               f.readlines
-            end
-    lines
+  read_text( path ).lines
+end
+
+def parse_lines( str )
+  str.lines
+end
+
+
+
+def read_env( path )
+   EnvParser.load( read_text( path ))
+end
+
+def parse_env( str )
+   EnvParser.load( str )
+end
+
+
+##
+##  todo/check - change path to *paths=['./.env']
+##                   and support more files - why? why not?
+def load_env( path='./.env' )
+  if File.exist?( path )
+     puts "==> loading .env settings..."
+     env = read_env( path )
+     puts "    applying .env settings... (merging into ENV)"
+     pp env
+     ## note: will only add .env setting if NOT present in ENV!!!
+     env.each do |k,v|
+         ENV[k] ||= v
+     end
+  end
 end
 
 
@@ -163,7 +233,7 @@ 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|
+  File.open( path, 'w:utf-8' ) do |f|
      f.write( JSON.pretty_generate( data ))
   end
 end
@@ -177,7 +247,7 @@ def write_blob( path, blob )
   dirname = File.dirname( path )
   FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
 
-  File.open( path, "wb" ) do |f|
+  File.open( path, 'wb' ) do |f|
     f.write( blob )
   end
 end
@@ -193,7 +263,7 @@ 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|
+  File.open( path, 'w:utf-8' ) do |f|
     f.write( text )
   end
 end
@@ -211,6 +281,17 @@ end
 
 
 
+## private helper - make public -why? why not?
+def _wget!( url, **kwargs )
+  res = Webclient.get( url, **kwargs )
+
+  ##  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?
+
+  res
+end
+
+
 end # module Kernel
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocos
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2023-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csvreader
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '4.0'
 description: cocos (code commons) - auto-include quick-starter prelude & prolog
 email: opensport@googlegroups.com
 executables: []
@@ -116,6 +116,7 @@ files:
 - README.md
 - Rakefile
 - lib/cocos.rb
+- lib/cocos/env.rb
 - lib/cocos/version.rb
 homepage: https://github.com/rubycocos/cocos
 licenses:
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: cocos (code commons) - auto-include quick-starter prelude & prolog