csvh 0.5.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de3ee5b1fa4dbe3dd0a91b897e8476e2fa40f3c
-  data.tar.gz: d3946dba3e4bdfd5dbbf1b68012c7b7666fed29f
+  metadata.gz: a6323cad1ddf79e484199f5830eb10076b61d04f
+  data.tar.gz: 779978ad240f9f0a2b1a46f3e316aad5d460f167
 SHA512:
-  metadata.gz: f452f83e37f35367181c27cf092864a4e91f431295bc39d96b850d513268f36d59a0e78c81725cea6f4df2cc82fb205a5e7ab380713b970416a809d692d275d5
-  data.tar.gz: 08a81b08f521c2bb14adc7fe858b21e4ef05172b9e48277a43efbe4b3607ef43678c22dd8260ef1fe0c0920e75b103c40c8a34641c18fa66576db08442d5e548
+  metadata.gz: 9bc569b2cb0d5008214c42c43fb2f897d67ad44278da745636797cd369bb88ff0e15bc7d60bf5551dead5bd57d5ed414c39cba7d7a1dab35dadd9fed366b05ff
+  data.tar.gz: ea02ecde2fe229c2551654ff898c02128aff2bbed72796f28712de20664eda7247e42ea329255de28a70f2d6074aafaa263519e7837fed8109593ff9d26f9af3

data/lib/csvh/reader.rb

@@ -30,6 +30,38 @@ module CSVH
       # return the header row. Any oadditional options you supply
       # will be added to those defaults or override them.
       #
+      # A [Reader] created using this method will delegate all
+      # of the same IO methods that a `CSV` created using
+      # `CSV#open` does except `close_write`, `flush`, `fsync`,
+      # `sync`, `sync=`, and `truncate`. You may call:
+      #
+      # * binmode()
+      # * binmode?()
+      # * close()
+      # * close_read()
+      # * closed?()
+      # * eof()
+      # * eof?()
+      # * external_encoding()
+      # * fcntl()
+      # * fileno()
+      # * flock()
+      # * flush()
+      # * internal_encoding()
+      # * ioctl()
+      # * isatty()
+      # * path()
+      # * pid()
+      # * pos()
+      # * pos=()
+      # * reopen()
+      # * seek()
+      # * fstat()
+      # * tell()
+      # * to_i()
+      # * to_io()
+      # * tty?()
+      #
       # @param file_path [String] the path of the file to read.
       # @param opts options for `CSV.new`.
       # @yieldparam [Reader] the new reader.
@@ -119,17 +151,60 @@ module CSVH
       end
     end
 
+    # These methods always delegate to CSV, which may or may not
+    # futher delegate them to its underlying file IO object,
+    # depending on how it was created.
+
     def_delegators \
       :@csv,
+      :binmode,
+      :binmode?,
+      :close_read,
       :close,
-      :closed?
+      :closed?,
+      :eof,
+      :eof?,
+      :external_encoding,
+      :fcntl,
+      :fileno,
+      :flock,
+      :flush,
+      :internal_encoding,
+      :ioctl,
+      :isatty,
+      :path,
+      :pid,
+      :pos,
+      :pos=,
+      :reopen,
+      :seek,
+      :fstat,
+      :tell,
+      :to_i,
+      :to_io,
+      :tty?
+
+    # You can use this method to install a `CSV::Converters`
+    # built-in, or provide a block that handles a custom
+    # conversion.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :convert
+
+    # Returns the current list of converters in effect.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :converters
 
-    # When given a block, yields each data row of the data source
-    # in turn as `CSV::Row` instances. When called without a
-    # block, returns an Enumerator over those rows.
+    # When given a block, yields each remaining data row of the
+    # data source in turn as a `CSV::Row` instance. When called
+    # without a block, returns an Enumerator over those rows.
     #
-    # Does not yield the header row, however, the headers are
-    # available via the #headers method of the reader or the row.
+    # Will never yield the header row, however, the headers are
+    # available via the #headers method of either the reader or
+    # the row object.
     #
     # @yieldparam [CSV::Row]
     def each
@@ -141,6 +216,76 @@ module CSVH
       end
     end
 
+    # Returns `true` if all output fields are quoted.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :force_quotes?
+
+    # Identical to #convert, but for header rows.
+    #
+    # Note that this must be called before reading any rows or
+    # calling #headers to have any effect.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :header_convert
+
+    # Returns the current list of converters in effect for
+    # headers.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :header_converters
+
+    # Slurps the remaining data rows and returns a `CSV::Table`.
+    #
+    # This is essentially the same behavior as `CSV#read`, but
+    # ensures that the header info has been fetched first, and the
+    # resulting table will never include the header row.
+    #
+    # Note that the Ruby documentation (at least as of 2.2.2) is
+    # for `CSV#read` is incomplete and simply says that it
+    # returns "an Array of Arrays", but it actually returns a
+    # table if a truthy `:headers` option was used when creating
+    # the `CSV` object.
+    #
+    # @return [CSV::Table] a table of remaining unread rows
+    def read
+      headers
+      @csv.read
+    end
+
+    alias  readlines read
+
+    # A single data row is pulled from the data source, parsed
+    # and returned as a CSV::Row.
+    #
+    # This is essentially the same behavior as `CSV#shift`, but
+    # ensures that the header info has been fetched first, and
+    # #shift will never return the header row.
+    #
+    # @return [CSV::Row] the next previously unread row
+    def shift
+      headers
+      @csv.shift
+    end
+
+    alias  gets      shift
+    alias  readline  shift
+
+    # Returns `true` if blank lines are skipped by the parser.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :skip_blanks?
+
+    # Returns `true` if `unconverted_fields()` to parsed results.
+    #
+    # See the documentation for `CSV` in the Ruby standard
+    # library for more details.
+    def_delegator :@csv, :unconverted_fields?
+
   end
 
 end

data/lib/csvh/version.rb

@@ -1,3 +1,3 @@
 module CSVH
-  VERSION = "0.5.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csvh
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Steve Jorgensen