csvyaml 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c07f82dfd13c43d0246141a6c79d36d42222d00a
-  data.tar.gz: 45ac0671f99a0d44b7ffd782c6ab3462f1304ba3
+  metadata.gz: 8b34d6995287396390a637e0a66a02128789a6d3
+  data.tar.gz: 205cf03a3a1ba3e5fc9936b29b94b899bebf7d8a
 SHA512:
-  metadata.gz: 0fae80b8706cf2def97794fc32f0aaae92efd3bc403dd9904e7be1370b05b84c4670ba25d4b64ca3aeb3af3135a83ae4c60577904d724678c8b8d48bfed2c593
-  data.tar.gz: 996746983caeeef7ce305533c5d564e375656cbd4787a8e9698d56fc5f2ba71cb6703fb93e33b672bb0f489ae75bc6269a5cd28d8921d0d758ff4699c8c22cb5
+  metadata.gz: '021907b520885283562bce2f14b891ab5e980bdb558dcb7bc0f7a7c79966d8deb87f06e3f191c78bf12ac00163c2e7d4eb96ba4b1f764cd81231c94b460dfcb2'
+  data.tar.gz: 6d13ca8c2373c6f67b59b32303d5ced7e365663a2321396d18e8dd0ce5c95606e0972e0c8f6aa4efc00a889f3462aa058e63367348924ebf30254f00b37d5a20

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,12 +1,13 @@
 HISTORY.md
+LICENSE.md
 Manifest.txt
 README.md
 Rakefile
+datasets/hello.yaml.csv
+datasets/hello11.yaml.csv
 lib/csvyaml.rb
 lib/csvyaml/parser.rb
 lib/csvyaml/version.rb
-test/data/hello.yaml.csv
-test/data/hello11.yaml.csv
 test/helper.rb
 test/test_parser.rb
 test/test_parser_misc.rb

data/README.md

@@ -9,10 +9,135 @@ csvyaml library / gem - read tabular data in the CSV <3 YAML format, that is, co
 * forum :: [wwwmake](http://groups.google.com/group/wwwmake)
 
 
+## What's CSV <3 YAML?
+
+CSV <3 YAML is a Comma-Separated Values (CSV)
+variant / format / dialect
+where the line-by-line records follow the
+YAML Ain't Markup Language (YAML) encoding rules.
+It's a modern (simple) tabular data format that
+includes arrays, numbers, booleans, nulls, nested structures, comments and more.
+Example:
+
+
+```
+# "Vanilla" CSV <3 YAML
+
+1,John,12 Totem Rd. Aspen,true
+2,Bob,null,false
+3,Sue,"Bigsby, 345 Carnival, WA 23009",false
+```
+
+or
+
+```
+# CSV <3 YAML with array values
+
+1,directions,[north,south,east,west]
+2,colors,[red,green,blue]
+3,drinks,[soda,water,tea,coffe]
+4,spells,[]
+```
+
+For more see the [official CSV <3 YAML Format documentation »](https://github.com/csvspecs/csv-yaml)
+
+
 
 ## Usage
 
-to be done
+``` ruby
+txt <<=TXT
+# "Vanilla" CSV <3 YAML
+
+1,John,12 Totem Rd. Aspen,true
+2,Bob,null,false
+3,Sue,"Bigsby, 345 Carnival, WA 23009",false
+TXT
+
+records = CsvYaml.parse( txt )     ## or CSV_YAML.parse or CSVYAML.parse
+pp records
+# =>  [[1,"John","12 Totem Rd. Aspen",true],
+#      [2,"Bob",nil,false],
+#      [3,"Sue","Bigsby, 345 Carnival, WA 23009",false]]
+
+# -or-
+
+records = CsvYaml.read( "values.yaml.csv" )   ## or CSV_YAML.read or CSVYAML.read
+pp records
+# =>  [[1,"John","12 Totem Rd. Aspen",true],
+#      [2,"Bob",nil,false],
+#      [3,"Sue","Bigsby, 345 Carnival, WA 23009",false]]
+
+# -or-
+
+CsvYaml.foreach( "values.yaml.csv" ) do |rec|   ## or CSV_YAML.foreach or CSVYAML.foreach
+  pp rec
+end
+# => [1,"John","12 Totem Rd. Aspen",true]
+# => [2,"Bob",nil,false]
+# => [3,"Sue","Bigsby, 345 Carnival, WA 23009",false]
+```
+
+
+
+### What about Enumerable?
+
+Yes, the reader / parser includes `Enumerable` and runs on `each`.
+Use `new` or `open` without a block
+to get the enumerator (iterator).
+Example:
+
+
+``` ruby
+csv = CsvYaml.new( "1,2,3" )   ## or CSV_YAML.new or CSVYAML.new
+it  = csv.to_enum
+pp it.next  
+# => [1,2,3]
+
+# -or-
+
+csv = CsvYaml.open( "values.yaml.csv" )  ## or CSV_YAML.open or CSVYAML.open
+it  = csv.to_enum
+pp it.next
+# => [1,"John","12 Totem Rd. Aspen",true]
+pp it.next
+# => [2,"Bob",nil,false]
+```
+
+
+
+### What about headers?
+
+Yes, you can. Use the `CsvHash`
+from the csvreader library / gem
+if the first line is a header (or if missing pass in the headers
+as an array) and you want your records as hashes instead of arrays of strings.
+Example:
+
+``` ruby
+txt <<=TXT
+id,name,address,regular
+1,John,"12 Totem Rd., Aspen",true
+2,Bob,null,false
+3,Sue,"\"Bigsby\", 345 Carnival, WA 23009",false
+TXT
+
+records = CsvHash.yaml.parse( txt )
+pp records
+
+# => [{"id":      1,
+#      "name":    "John",
+#      "address": "12 Totem Rd. Aspen",
+#      "regular": true},
+#     {"id":      2,
+#      "name":    "Bob",
+#      "address": null,
+#      "regular": false},
+#    ... ]
+```
+
+For more see the [official CsvHash documentation in the csvreader library / gem »](https://github.com/csvreader/csvreader)
+
 
 
 ## License

data/lib/csvyaml.rb

@@ -17,5 +17,5 @@ CSVY     = CsvYaml
 CsvY     = CsvYaml
 
 
-
-puts CsvYaml.banner
+# say hello
+puts CsvYaml.banner     if $DEBUG || (defined?($RUBYCOCO_DEBUG) && $RUBYCOCO_DEBUG)

data/lib/csvyaml/version.rb

@@ -3,8 +3,8 @@
 
 class CsvYaml
 
-  MAJOR = 0
-  MINOR = 1
+  MAJOR = 1
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/helper.rb

@@ -12,7 +12,7 @@ require 'csvyaml'
 ## add test_data_dir helper
 class CsvYaml
   def self.test_data_dir
-    "#{root}/test/data"
+    "#{root}/datasets"
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csvyaml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -46,18 +46,20 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - HISTORY.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 files:
 - HISTORY.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile
+- datasets/hello.yaml.csv
+- datasets/hello11.yaml.csv
 - lib/csvyaml.rb
 - lib/csvyaml/parser.rb
 - lib/csvyaml/version.rb
-- test/data/hello.yaml.csv
-- test/data/hello11.yaml.csv
 - test/helper.rb
 - test/test_parser.rb
 - test/test_parser_misc.rb