cocos 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c0c91a32d9421aa68462fe03987ffd9c0e7ec6b8ef56acb4d3ed2b8f148ed6d
-  data.tar.gz: a7fa42e171cd6480f264cadeb196b287f2a9f46af1b0fa4a284295fee030bfdc
+  metadata.gz: ed017038dd37ce27a71bb2835900c893dc916643e1f07e3809a18eca3f626265
+  data.tar.gz: 77f8a74da6add1f4af968364c3eecfbae7cb1dfd88bce89bb04490ad3932df44
 SHA512:
-  metadata.gz: 5aa60909fb45f952871b8a7f0fb1afac09bbf73bda390d3f1a1ca51a4f91454621dffc44cad32552ec5ce3d9f731168b7a659a3529d564650b3902fc57eac07f
-  data.tar.gz: 0ee9fde4d05b4a82101cc023e01833b1a946579fbf5ec321076e6247e1b1387516830e847a0bccc4070f1c34772dd53d47f7e7029e06fd300fcf8a5c9e7c6413
+  metadata.gz: c74889afd4f26afd75e8bcd306920f916646787cf3a85e3d94e2e67b0aed81bea4747c7e924d0dde40c2aa22661a61eed59c656ca1f57842ffd4d6f9099ae00b
+  data.tar.gz: f25f050d937978cf344530b6f347716f79f137b1e467518be2c5d506a39eedbe7f5bf16163047685cf18d4e34d7cf501cc200db6b1c876e0406b35f4d0968edc

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/Manifest.txt

@@ -1,4 +1,5 @@
 CHANGELOG.md
+LICENSE.md
 Manifest.txt
 README.md
 Rakefile

data/README.md

@@ -1,17 +1,140 @@
-# cocos (code commons) - auto-incude quick-starter prelude & prolog
+# cocos (code commons) - auto-include quick-starter prelude & prolog
 
 
-* home  :: [github.com/rubycocos/cococs](https://github.com/rubycocos/cococs)
-* bugs  :: [github.com/rubycocos/cococs/issues](https://github.com/rubycocos/cococs/issues)
+* home  :: [github.com/rubycocos/cocos](https://github.com/rubycocos/cocos)
+* bugs  :: [github.com/rubycocos/cocos/issues](https://github.com/rubycocos/cocos/issues)
 * gem   :: [rubygems.org/gems/cocos](https://rubygems.org/gems/cocos)
 * rdoc  :: [rubydoc.info/gems/cocos](http://rubydoc.info/gems/cocos)
 
 
 
+## Intro - Why?
+
+
+**Reason No. 1**
+
+After starting of too many scripts (hundreds?) with
+adding more and always repeating the same dozen modules with require e.g.:
+
+``` ruby
+require 'pp'
+require 'time'
+require 'date'
+require 'json'
+require 'yaml'
+require 'base64'
+require 'fileutils'
+
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+...
+```
+
+why not use a more "inclusive" prelude & prolog and
+replace the above with a one-liner:
+
+``` ruby
+require 'cocos' # auto-include code commons quick-starter prelude & prolog
+```
+
+
+**Reason No. 2**
+
+After reading too many text files in utf-8 and always repeating the same open / read and code block dance e.g.:
+
+``` ruby
+txt = File.read( "history.txt" )
+# sorry - will NOT guarantee unicode utf8-encoding
+# (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|
+             f.read
+         end
+```
+
+Or after reading and parsing too many json files
+(by default always required utf-8 encoding)
+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|
+             f.read
+         end
+data = JSON.parse( txt )
+```
+
+Why not use read convenience / short-cut helpers such as:
+
+``` ruby
+txt  = read_txt( "history.txt" )
+data = read_json( "history.json" )
+```
+
+
+And so on.
+
+
+
+
+
 ## Usage
 
+###  Read / Parse
+
+_Read / parse convenience short-cut helpers_
+
+`read_blob( path )` <br>
+also known as `read_binary` or `read_bin`
+
+
+`read_text( path )` <br>
+also known as `read_txt`
+
+
+`read_lines( path )`
+
+
+
+`read_json( path )` / `parse_json( str )`
+
+
+`read_yaml( path )` / `parse_yaml( str )`
+
+
+`read_csv( path, headers: true )` / `parse_csv( str, headers: true )`
+
+note: comma-separated values (.csv) reading & parsing service
+brought to you by the [**csvreader library / gem »**](https://github.com/rubycocos/csvreader/tree/master/csvreader)
+
+
+`read_data( path )` / `parse_data( str )`
+
+note:  alternate shortcut / alias for `read_csv( path, headers: false )` / `parse_csv( str, headers: false )`
+
+
+
+
+`read_tab( path )` / `parse_tab( str )`
+
+note: tabulator (`\t`)-separated values (.tab) reading & parsing service
+brought to you by the [**tabreader library / gem »**](https://github.com/rubycocos/csvreader/tree/master/tabreader)
+
+
+
+
+`read_ini( path )` / `parse_ini( str )` <br>
+also known as `read_conf / parse_conf`
+
+note: ini / conf(ig) reading & parsing service
+brought to you by the [**iniparser library / gem »**](https://github.com/rubycocos/core/tree/master/iniparser)
+
+
 
-To be done
+That's it for now.
 
 
 

data/Rakefile

@@ -6,7 +6,7 @@ Hoe.spec 'cocos' do
 
   self.version = Cocos::VERSION
 
-  self.summary = "cocos (code commons) - auto-incude quick-starter prelude & prolog"
+  self.summary = "cocos (code commons) - auto-include quick-starter prelude & prolog"
   self.description = summary
 
   self.urls = { home: 'https://github.com/rubycocos/cocos' }
@@ -20,7 +20,12 @@ Hoe.spec 'cocos' do
 
   self.licenses = ['Public Domain']
 
-  self.extra_deps = []
+  self.extra_deps = [
+    ['csvreader',      '>= 1.2.5'],
+    ['tabreader',      '>= 1.0.1'],
+    ['iniparser',      '>= 1.0.1'],
+    ['webclient',      '>= 0.2.2'],
+  ]
 
   self.spec_extras = {
     required_ruby_version: '>= 2.2.2'

data/lib/cocos/version.rb

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

data/lib/cocos.rb

@@ -6,22 +6,217 @@ require 'time'
 require 'date'
 require 'json'
 require 'yaml'
+require 'base64'    ## e.g. Base64.decode64,Base64.encode64,...
 require 'fileutils'
 
 require 'uri'
 require 'net/http'
 require 'net/https'
-
+require 'cgi'
 
 require 'optparse'    ## used by monofile (built-in test/debug) command line tool
 
 
+###
+# 3rd party gems
+require 'csvreader'
+require 'tabreader'
+require 'iniparser'
+
+require 'webclient'
+
+
 
 #####################
 # our own code
 require 'cocos/version'   # note: let version always go first
 
 
+###
+##  read/parse convenience/helper shortcuts
+
+
+module Kernel
+
+
+
+## todo:  add symbolize options a la read_json
+##         add sep options
+def read_csv( path, headers: true )
+   if headers
+      CsvHash.read( path )
+   else
+      Csv.read( path )
+   end
+end
+
+def parse_csv( str, headers: true )
+  if headers
+    CsvHash.parse( str )
+  else
+    Csv.parse( str )
+  end
+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 )
+  Csv.read( path )
+end
+
+def parse_data( str )
+  Csv.parse( str )
+end
+
+
+
+def read_tab( path )
+   Tab.read( path )
+end
+
+def parse_tab( str )
+  Tab.parse( str )
+end
+
+
+## todo:  add symbolize options ???
+def read_json( 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 ))
+end
+
+def parse_yaml( str )
+  YAML.load( str )
+end
+
+
+def read_ini( path )
+  INI.load( 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 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
+    txt = File.open( path, 'r:utf-8' ) do |f|
+                f.read
+          end
+    txt
+end
+alias_method :read_txt, :read_text
+
+
+def read_blob( path )
+  blob =  File.open( path, 'rb' ) do |f|
+                  f.read
+          end
+  blob
+end
+alias_method :read_binary, :read_blob
+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?
+##
+def read_lines( path )
+    lines = File.open( path, 'r:utf-8' ) do |f|
+               f.readlines
+            end
+    lines
+end
+
+
+
+
+######
+#  add writers
+
+def write_json( path, data )
+  ###
+  ## todo/check:  check if data is Webclient.Response?
+  ##   if yes use res.json  - why? why not?
+
+  dirname = File.dirname( path )
+  FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
+
+  ## note: pretty print/reformat json
+  File.open( path, "w:utf-8" ) do |f|
+     f.write( JSON.pretty_generate( data ))
+  end
+end
+
+
+def write_blob( path, blob )
+  ###
+  ## todo/check:  check if data is Webclient.Response?
+  ##   if yes use res.blob/body  - why? why not?
+
+  dirname = File.dirname( path )
+  FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
+
+  File.open( path, "wb" ) do |f|
+    f.write( blob )
+  end
+end
+alias_method :write_binary, :write_blob
+alias_method :write_bin,    :write_blob
+
+
+def write_text( path, text )
+  ###
+  ## todo/check:  check if data is Webclient.Response?
+  ##   if yes use res.text  - why? why not?
+
+  dirname = File.dirname( path )
+  FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
+
+  File.open( path, "w:utf-8" ) do |f|
+    f.write( text )
+  end
+end
+alias_method :write_txt,  :write_text
+
+
+
+######
+#   world wide web (www) support
+
+def wget( url, **kwargs )
+  Webclient.get( url, **kwargs )
+end
+##  add alias www_get or web_get - why? why not?
+
+
+
+end # module Kernel
+
+
+
+
+
 ####
 #  convenience alias  (use plural or singual)
 Coco = Cocos

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cocos
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csvreader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: tabreader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: iniparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: webclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -44,16 +100,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: cocos (code commons) - auto-incude quick-starter prelude & prolog
+description: cocos (code commons) - auto-include quick-starter prelude & prolog
 email: opensport@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 files:
 - CHANGELOG.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile
@@ -83,5 +141,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: cocos (code commons) - auto-incude quick-starter prelude & prolog
+summary: cocos (code commons) - auto-include quick-starter prelude & prolog
 test_files: []