uncsv 0.3.1

data/lib/uncsv.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'uncsv/version'
+require 'uncsv/config'
+require 'uncsv/key_normalizer'
+require 'uncsv/header'
+require 'uncsv/row'
+require 'uncsv/rows'
+require 'csv'
+require 'ostruct'
+
+# Parses CSV data and iterates through it
+#
+# Accepts a `String`, `IO`, or file, and outputs CSV rows. The rows can be
+# iterated over with `each`. `Uncsv` is also `Enumerable`, so all of those
+# built-in Ruby methods also work with it, including `map`, `reduce`, `select`,
+# etc.
+class Uncsv
+  include Enumerable
+
+  # Create a new `Uncsv` parser
+  #
+  # @param data [String, IO] The input CSV data to parse
+  # @param opts [Hash] A hash of configuration options.
+  #   See {Config#initialize}.
+  # @yield An optional block for setting configuration options.
+  # @yieldparam config [Config] The configuration object.
+  def initialize(data, opts = {})
+    @config = Config.new(opts)
+    yield @config if block_given?
+    @csv = CSV.new(data, @config.csv_opts)
+  end
+
+  # Create a new `Uncsv` parser from a file
+  #
+  # @param filename [String] The path of the file to open
+  # @param opts (see #initialize)
+  # @yield (see #initialize)
+  # @yieldparam (see #initialize)
+  def self.open(filename, opts = {}, &block)
+    new(File.open(filename, 'rb'), opts, &block)
+  end
+
+  # Iterate over each data row of the CSV
+  #
+  # @yield A block to run for each row
+  # @yieldparam row [Row] A row object
+  # @return [Enumerator] An enumerator over each row
+  def each(&block)
+    rows.each(&block)
+  end
+
+  # Get an array of the headers
+  #
+  # Ordered from left to right
+  #
+  # @return [Array] An array of the header rows
+  def header
+    rows.header
+  end
+
+  private
+
+  # Initialize the internal rows object
+  #
+  # Once initialized, the {Rows} object is cached and reused for
+  # consecutive calls to {#each}.
+  def rows
+    @rows ||= Rows.new(@csv, @config)
+  end
+end

data/uncsv.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uncsv/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'uncsv'
+  spec.version = Uncsv::VERSION
+  spec.authors = ['Justin Howard']
+  spec.email = ['jmhoward0@gmail.com']
+  spec.license = 'Apache-2.0'
+
+  spec.summary = 'A parser for unruly CSVs'
+  spec.homepage = 'https://github.com/machinima/uncsv'
+
+  spec.files = `git ls-files -z`
+    .split("\x0")
+    .reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'fakefs', '~> 0.8'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.61'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'yard', '>= 0.9.11'
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: uncsv
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Justin Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: 
+email:
+- jmhoward0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check-version
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/yard
+- bin/yardoc
+- bin/yri
+- lib/uncsv.rb
+- lib/uncsv/config.rb
+- lib/uncsv/header.rb
+- lib/uncsv/key_normalizer.rb
+- lib/uncsv/row.rb
+- lib/uncsv/rows.rb
+- lib/uncsv/version.rb
+- uncsv.gemspec
+homepage: https://github.com/machinima/uncsv
+licenses:
+- Apache-2.0
+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.7.8
+signing_key: 
+specification_version: 4
+summary: A parser for unruly CSVs
+test_files: []