csvreader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12819f4da3e9fb0121d72d1832103b914983d618
+  data.tar.gz: bc02fabb9e4b5627a3e44dc4f6d00b0f4d0a94e0
+SHA512:
+  metadata.gz: 5abae0494cb1799d312ddf91b1baa73a4e8798510a064513dd4411cbc9e10fd64a31ef3522549810e8c0c0b9bba2b9070438120e3bf7cd504ee57db821634943
+  data.tar.gz: a113bbb46e2faa262f9f7133a083b021a7ba5240a4b8a5afacdaedf1dd82ba5a66831a11283a6ffa62dadd0274422f3ca4fdc46ab63cbb6eb2e8ed38ce531e31

data/HISTORY.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2018-08-15
+
+* Everything is new. First release.

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

@@ -0,0 +1,8 @@
+HISTORY.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+lib/csvreader.rb
+lib/csvreader/reader.rb
+lib/csvreader/version.rb

data/README.md

@@ -0,0 +1,30 @@
+# csvreader - read tabular data in the comma-separated values (csv) format the right way (uses best practices out-of-the-box with zero-configuration)
+
+
+* home  :: [github.com/csv11/csvreader](https://github.com/csv11/csvreader)
+* bugs  :: [github.com/csv11/csvreader/issues](https://github.com/csv11/csvreader/issues)
+* gem   :: [rubygems.org/gems/csvreader](https://rubygems.org/gems/csvreader)
+* rdoc  :: [rubydoc.info/gems/csvreader](http://rubydoc.info/gems/csvreader)
+* forum :: [wwwmake](http://groups.google.com/group/wwwmake)
+
+
+
+## Usage
+
+
+## Alternatives
+
+See the Libraries & Tools section in the [Awesome CSV](https://github.com/csv11/awesome-csv#libraries--tools) page.
+
+
+## License
+
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+The `csvreader` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Send them along to the [wwwmake forum](http://groups.google.com/group/wwwmake).
+Thanks!

data/Rakefile

@@ -0,0 +1,26 @@
+require 'hoe'
+require './lib/csvreader/version.rb'
+
+Hoe.spec 'csvreader' do
+
+  self.version = CsvReader::VERSION
+
+  self.summary = "csvreader - read tabular data in the comma-separated values (csv) format the right way (uses best practices out-of-the-box with zero-configuration)"
+  self.description = summary
+
+  self.urls = ['https://github.com/csv11/csvreader']
+
+  self.author = 'Gerald Bauer'
+  self.email = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   :required_ruby_version => '>= 2.2.2'
+  }
+
+end

data/lib/csvreader.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'csv'
+require 'json'
+require 'pp'
+
+
+###
+# our own code
+require 'csvreader/version' # let version always go first
+require 'csvreader/reader'
+
+
+
+puts CsvReader.banner   # say hello

data/lib/csvreader/reader.rb

@@ -0,0 +1,188 @@
+# encoding: utf-8
+
+
+module Csv    ## check: rename to CsvSettings / CsvPref / CsvGlobals or similar - why? why not???
+
+  ## STD_CSV_ENGINE = CSV   ## to avoid name confusion use longer name - why? why not? find a better name?
+  ## use __CSV__ or similar? or just ::CSV ??
+
+  class Configuration
+
+    puts "CSV::VERSION:"
+    puts CSV::VERSION
+
+    puts "builtin CSV::Converters:"
+    pp CSV::Converters
+
+    puts "CSV::DEFAULT_OPTIONS:"
+    pp CSV::DEFAULT_OPTIONS
+
+    ##  register our own converters
+    ## check if strip gets called for nil values too?
+    CSV::Converters[:strip] = ->(field) { field.strip }
+
+
+    attr_accessor :sep   ## col_sep (column separator)
+
+    def initialize
+      @sep = ','
+      ## note: do NOT add headers as global - should ALWAYS be explicit
+      ##   headers (true/false) - changes resultset and requires different processing!!!
+
+      self  ## return self for chaining
+    end
+
+    def blank?( line )
+      ## note:  blank line does NOT include "blank" with spaces only!!
+      ##          use BLANK_REGEX in skip_lines to clean-up/skip/remove/ignore
+      ##  see skip_blanks in default_options
+      line.empty?
+    end
+
+    ## lines starting with # (note: only leading spaces allowed)
+    COMMENTS_REGEX = /^\s*#/
+    BLANK_REGEX    = /^\s*$/   ## skip all whitespace lines - note: use "" or , for a blank record!!!
+    SKIP_REGEX = Regexp.union( COMMENTS_REGEX, BLANK_REGEX )
+
+    def skip?( line )
+      ## check if comment line - skip comments
+      ##  see skip_lines in default_options
+      line =~ SKIP_REGEX
+    end
+
+    ## built-in (default) options
+    ##  todo: find a better name?
+    def default_options
+      ## note:
+      ##   do NOT include sep character and
+      ##   do NOT include headers true/false here
+      ##
+      ##  make default sep its own "global" default config
+      ##   e.g. Csv.config.sep =
+
+      ## common options
+      ##   skip comments starting with #
+      ##   skip blank lines
+      ##   strip leading and trailing spaces
+      ##    NOTE/WARN:  leading and trailing spaces NOT allowed/working with double quoted values!!!!
+      defaults = {
+        skip_blanks: true,    ## note: skips lines with no whitespaces only!! (e.g. line with space is NOT blank!!)
+        skip_lines:  SKIP_REGEX,
+        :converters => :strip
+      }
+      defaults
+    end
+  end # class Configuration
+
+
+  ## lets you use
+  ##   Csv.configure do |config|
+  ##      config.sep = ','   ## or "/t"
+  ##   end
+
+  def self.configure
+    yield( config )
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end   # module Csvv
+
+
+
+####
+## use our own wrapper
+
+class CsvReader
+
+  ####################
+  # helper methods
+  def self.unwrap( row_or_array )   ## unwrap row - find a better name? why? why not?
+    ## return row values as array of strings
+    if row_or_array.is_a?( CSV::Row )
+      row = row_or_array
+      row.fields   ## gets array of string of field values
+    else  ## assume "classic" array of strings
+      array = row_or_array
+    end
+  end
+
+
+
+  def self.foreach( path, sep: Csv.config.sep, headers: true )
+    csv_options = Csv.config.default_options.merge(
+                     headers: headers,
+                     col_sep: sep,
+                     external_encoding: 'utf-8'  ## note:  always (auto-)add utf-8 external encoding for now!!!
+    )
+
+    CSV.foreach( path, csv_options ) do |row|
+      yield( row )    ## check/todo: use block.call( row ) ## why? why not?
+    end
+  end
+
+
+  def self.read( path, sep: Csv.config.sep, headers: true )
+    ## note: use our own file.open
+    ##   always use utf-8 for now
+    ##    check/todo: add skip option bom too - why? why not?
+    txt = File.open( path, 'r:utf-8' )
+    parse( txt, sep: sep, headers: headers )
+  end
+
+  def self.parse( txt, sep: Csv.config.sep, headers: true )
+    csv_options = Csv.config.default_options.merge(
+                     headers: headers,
+                     col_sep: sep
+    )
+    ## pp csv_options
+    CSV.parse( txt, csv_options )
+  end
+
+  def self.parse_line( txt, sep: Csv.config.sep )
+    ## note: do NOT include headers option (otherwise single row gets skipped as first header row :-)
+    csv_options = Csv.config.default_options.merge(
+                    headers: false,  ## note: always turn off headers!!!!!!
+                    col_sep: sep
+    )
+    ## pp csv_options
+    CSV.parse_line( txt, csv_options )
+  end
+
+
+
+  def self.header( path, sep: Csv.config.sep )   ## use header or headers - or use both (with alias)?
+      # read first lines (only)
+      #  and parse with csv to get header from csv library itself
+      #
+      #  check - if there's an easier or built-in way for the csv library
+
+      ## readlines until
+      ##  - NOT a comments line or
+      ##  - NOT a blank line
+
+      lines = ''
+      File.open( path, 'r:utf-8' ) do |f|
+
+        ## todo/fix: how to handle empty files or files without headers?!
+
+        ## todo/check if readline includes \n\r too??
+        ## yes! - line include \n e.g.
+        ##   "Brewery,City,Name,Abv\n" or
+        ##   "#######\n#  try with some comments\n#   and blank lines even before header\n\nBrewery,City,Name,Abv\n"
+        loop do
+          line = f.readline
+          lines << line
+          break unless  Csv.config.skip?( line ) || Csv.config.blank?( line )
+        end
+      end
+
+      ## puts "lines:"
+      ## pp lines
+
+      ## note: do NOT use headers: true to get "plain" data array (no hash records)
+      ##   hash record does NOT work for single line/row
+      parse_line( lines, sep: sep )
+    end  # method self.header
+end # class CsvReader

data/lib/csvreader/version.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+
+class CsvReader   ## note: uses a class for now - change to module - why? why not?
+
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "csvreader/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # class CsvReader

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: csvreader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: csvreader - read tabular data in the comma-separated values (csv) format
+  the right way (uses best practices out-of-the-box with zero-configuration)
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+files:
+- HISTORY.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/csvreader.rb
+- lib/csvreader/reader.rb
+- lib/csvreader/version.rb
+homepage: https://github.com/csv11/csvreader
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: csvreader - read tabular data in the comma-separated values (csv) format
+  the right way (uses best practices out-of-the-box with zero-configuration)
+test_files: []