csvh 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5528c84de3fd89a37fc7cb37c4ef7c26988aa9a3
+  data.tar.gz: b5f9b26106d34f09565700704fe34ef9484ded97
+SHA512:
+  metadata.gz: 93a1a100cf34d6d20c4acc048830550110a43bc59eb3e5702fa1d39169fbf47a0cf77533ced3757c8c91874b80be6b2d4274acf8fb0cefb97b83e41d0cb06db6
+  data.tar.gz: ff2397bde3839c9c10b27417dfe3b56f14f31301734d907073ad981aec895118bf91f3e9e776d78163f46ab431cb6e0f4a3760b9ea245996938fcc013b80fe4e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csvh.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steve Jorgensen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# CSVH
+
+The csvh gem provides convenient augmentations to handling of CSV
+files with header rows in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csvh'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csvh
+
+## Usage
+
+This gem provides a `CSVH::Reader` class that lazily reads from
+CSV-formatted data that has a header row. Allows accessing
+headers before reading any subsequent data rows and/or when no
+additional data rows are present in the data.
+
+The `CSVH::Reader` class is primarily intended to be used in one
+of the following ways:
+
+    # Read from a file, and close the file automatically.
+    CSVH::Reader.from_file 'the-path-to/my-data.csv' do |reader|
+      # reader.headers is an array of header strings.
+      puts "Headers: " + reader.headers.inspect
+
+      reader.each do |row|
+        # row is a standard Ruby CSV::Row object.
+        puts row.to_h.inspect
+      end
+    end
+
+    # Read from an IO stream.
+    reader = CSVH::Reader.from_string_or_io(an_io_stream)
+
+    # reader.headers is an array of header strings.
+    puts "Headers: " + reader.headers.inspect
+
+    reader.each do |row|
+      # row is a standard Ruby CSV::Row object.
+      puts row.to_h.inspect
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow
+you to experiment.
+
+To install this gem onto your local machine, run `bundle exec
+rake install`. To release a new version, update the version
+number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and
+tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/csvh.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csvh"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/csvh.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csvh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csvh"
+  spec.version       = CSVH::VERSION
+  spec.authors       = ["Steve Jorgensen"]
+  spec.email         = ["stevej@stevej.name"]
+
+  spec.summary       = "Convenient augmentations to handling of CSV files with header rows in Ruby"
+  spec.homepage      = "https://github.com/stevecj/csvh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/csvh/reader.rb

@@ -0,0 +1,146 @@
+require 'delegate'
+
+module CSVH
+
+  # Sequantially and lazily reads from CSV-formatted data that
+  # has a header row. Allows accessing headers before reading
+  # any subsequent data rows and/or when no additional data rows
+  # are present in the data.
+  class Reader
+    extend Forwardable
+
+    DEFAULT_CSV_OPTS = {
+      headers: :first_row,
+      return_headers: true
+    }.freeze
+
+    class << self
+
+      # When called without a block argument, returns an open
+      # reader for data from the file at the given file_path.
+      #
+      # When called with a block argument, passes an open reader
+      # for data from the file to the given block, closes the
+      # reader (and its underlying file IO channel) before
+      # returning, and then returns the value that was returned
+      # by the block.
+      #
+      # By default, the underlying CSV object is initialized
+      # with default options for data with a header row and to
+      # return the header row. Any oadditional options you supply
+      # will be added to those defaults or override them.
+      #
+      # @param file_path [String] the path of the file to read.
+      # @param opts options for `CSV.new`.
+      # @yieldparam [Reader] the new reader.
+      # @return [Reader,object]
+      #   the new reader or the value returned from the given
+      #   block.
+      def from_file(file_path, **opts)
+        opts = default_csv_opts.merge(opts)
+        io = File.open(file_path, 'r')
+        csv = CSV.new(io, **opts)
+        instance = new(csv)
+
+        if block_given?
+          begin
+            yield instance
+          ensure
+            instance.close unless instance.closed?
+          end
+        else
+          instance
+        end
+      end
+
+      # Returns an open reader for data from given string or
+      # readable IO stream.
+      #
+      # @param data [String, IO] the source of the data to read.
+      # @param opts options for `CSV.new`.
+      # @return [Reader] the new reader.
+      def from_string_or_io(data, **opts)
+        opts = default_csv_opts.merge(opts)
+        csv = CSV.new(data, **opts)
+        new(csv)
+      end
+
+      alias  foreach  from_file
+      alias  parse    from_string_or_io
+
+      private
+
+      def default_csv_opts
+        DEFAULT_CSV_OPTS
+      end
+    end
+
+    # Returns a new reader based on the given CSV object. The CSV
+    # object must be configured to return a header row (a
+    # `CSV::ROW` that returns true from its `#header?` method
+    # as its first item. The header item must also not have been
+    # read yet.
+    # @param csv [CSV] A Ruby `::CSV` object.
+    def initialize(csv)
+      unless csv.return_headers?
+        raise \
+          InappropreateCsvInstanceError,
+           "%{self.class} requires a CSV instance that returns headers." \
+          " It needs to have been initialized with non-false/nil values" \
+          " for :headers and :return_headers options."
+      end
+      @csv = csv
+    end
+
+    # @return [Reader] the target of the method call.
+    def to_csvh_reader
+      self
+    end
+
+    # Returns the list of column header values from the CSV data.
+    #
+    # If any rows have already been read, then the result is
+    # immediately returned, having been recorded when the header
+    # row was initially encountered.
+    #
+    # If no rows have been read yet, then the first row is read
+    # from the data in order to return the result.
+    #
+    # @return [Array<String>] the column header names.
+    def headers
+      @headers ||= begin
+        row = @csv.readline
+        unless row.header_row?
+          raise \
+            CsvPrematurelyShiftedError,
+            "the header row was prematurely read from the underlying CSV object."
+        end
+        row.headers
+      end
+    end
+
+    def_delegators \
+      :@csv,
+      :close,
+      :closed?
+
+    # 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.
+    #
+    # Does not yield the header row, however, the headers are
+    # available via the #headers method of the reader or the row.
+    #
+    # @yieldparam [CSV::Row]
+    def each
+      headers
+      if block_given?
+        @csv.each { |row| yield row }
+      else
+        @csv.each
+      end
+    end
+
+  end
+
+end

data/lib/csvh/version.rb

@@ -0,0 +1,3 @@
+module CSVH
+  VERSION = "0.5.0"
+end

data/lib/csvh.rb

@@ -0,0 +1,9 @@
+require 'csv'
+
+require "csvh/version"
+require "csvh/reader"
+
+module CSVH
+  class InappropreateCsvInstanceError < ArgumentError ; end
+  class CsvPrematurelyShiftedError < StandardError ; end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: csvh
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Steve Jorgensen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- stevej@stevej.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csvh.gemspec
+- lib/csvh.rb
+- lib/csvh/reader.rb
+- lib/csvh/version.rb
+homepage: https://github.com/stevecj/csvh
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Convenient augmentations to handling of CSV files with header rows in Ruby
+test_files: []