typedcsv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50d01bbde2f4dc34fe2d698b490c2d786b8a5549
+  data.tar.gz: 54f8597c317508902b6709c308ba14eb45aa48da
+SHA512:
+  metadata.gz: 51e70f6b102ff7e8b91fd36899a4ac06960564444ebbabb5925533901f5de39abf804c28ced2af41d662eef2d21a703fe0eb631ad8d29874a4d27fa0548eead0
+  data.tar.gz: 6a844258d5e748328b87787e901c36d8c6e3a7daf43ad18d3f02c703942f31187ab936c7498040e7f139a98b94da80ed0ff370c39ba879fa8fd448cb7ed65bf6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at seamus@abshere.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in typedcsv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Seamus Abshere
+
+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,62 @@
+# Typedcsv
+
+Here's your standard untyped CSV:
+
+```
+name,income,created_at,tags
+Seamus,12301.2,2012-02-21,red;blue
+```
+
+Now, you and I know that `12301.2` is a number and `2012-02-21` is a date and `red;blue` is a list... so let's just write that into the headers:
+
+```
+name,income:number,created_at:date,tags:list
+Seamus,12301.2,2012-02-21,red;blue
+```
+
+Now let's parse it:
+
+```
+Typedcsv.foreach('file.csv', headers: true) do |row|
+  row['income']     # will be a Float
+  row['created_at'] # will be a Date
+  row['tags']       # will be an Array
+end
+```
+
+This gem provides `Typedcsv.foreach()`, which takes exactly the same arguments as [ruby stdlib `CSV.foreach`](https://ruby-doc.org/stdlib-2.4.1/libdoc/csv/rdoc/CSV.html#method-c-foreach).
+
+## Types
+
+* text (default)
+* number
+* list (must be semicolon-separated)
+* date (must be ISO8601)
+* time (must be ISO8601)
+
+## Benchmarks
+
+It's about 10x slower than ruby's stdlib `CSV.foreach`:
+
+```
+cd benchmark && ruby benchmark.rb
+[...]
+CSV.foreach - array mode
+                          2.503  (± 0.0%) i/s -     13.000  in   5.197588s
+Typedcsv.foreach - array mode
+                          0.253  (± 0.0%) i/s -      2.000  in   7.892107s
+CSV.foreach - hash mode
+                          1.830  (± 0.0%) i/s -     10.000  in   5.466998s
+Typedcsv.foreach - hash mode
+                          0.226  (± 0.0%) i/s -      2.000  in   8.867616s
+```
+
+## Sponsor
+
+<p><a href="https://www.faraday.io"><img src="https://s3.amazonaws.com/faraday-assets/files/img/logo.svg" alt="Faraday logo"/></a></p>
+
+We use [`typedcsv`](https://github.com/faradayio/typedcsv) for [B2C customer intelligence at Faraday](https://www.faraday.io).
+
+## Copyright
+
+Copyright 2017 Faraday

data/Rakefile

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

data/benchmark/.gitignore

@@ -0,0 +1 @@
+example.csv

data/benchmark/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'typedcsv', path: File.expand_path('../../', __FILE__)
+gem 'benchmark-ips'
+gem 'faker'

data/benchmark/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: /Users/seamus/code/typedcsv
+  specs:
+    typedcsv (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.7.2)
+    faker (1.8.4)
+      i18n (~> 0.5)
+    i18n (0.8.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  faker
+  typedcsv!
+
+BUNDLED WITH
+   1.15.4

data/benchmark/benchmark.rb

@@ -0,0 +1,64 @@
+require 'csv'
+
+require 'bundler/setup'
+require 'benchmark/ips'
+require 'typedcsv'
+require 'faker'
+require 'securerandom'
+
+PATH = 'example.csv'
+
+if File.exist?(PATH)
+  $stderr.puts "using existing #{PATH.inspect}"
+else
+  $stderr.puts "generating new #{PATH.inspect}"
+  File.open(PATH, 'w') do |f|
+    f.puts %w{
+      name
+      income:number
+      created_at:date
+      zipcode:text
+      list:list
+      uuid
+      quote
+    }.to_csv
+    (2**15).times do
+      f.puts [
+        Faker::Name.name,
+        rand(2**16) + rand(),
+        Faker::Date.backward(900),
+        Faker::Address.zip_code,
+        rand(5).times.map { Faker::TwinPeaks.location }.to_csv(col_sep: ';').chomp,
+        SecureRandom.uuid,
+        Faker::TwinPeaks.quote
+      ].to_csv
+    end
+  end
+end
+
+Benchmark.ips do |x|
+  x.report("CSV.foreach - array mode") do
+    count = 0
+    CSV.foreach(PATH) do |row|
+      count += 1
+    end
+  end
+  x.report("Typedcsv.foreach - array mode") do
+    count = 0
+    Typedcsv.foreach(PATH) do |row|
+      count += 1
+    end
+  end
+  x.report("CSV.foreach - hash mode") do
+    count = 0
+    CSV.foreach(PATH, headers: true) do |row|
+      count += 1
+    end
+  end
+  x.report("Typedcsv.foreach - hash mode") do
+    count = 0
+    Typedcsv.foreach(PATH, headers: true) do |row|
+      count += 1
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "typedcsv"
+
+# 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(__FILE__)

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/lib/typedcsv/version.rb

@@ -0,0 +1,3 @@
+class Typedcsv
+  VERSION = "0.1.0"
+end

data/lib/typedcsv.rb

@@ -0,0 +1,92 @@
+require 'typedcsv/version'
+
+require 'csv'
+require 'date'
+require 'time'
+
+class Typedcsv
+  def Typedcsv.foreach(*args, &blk)
+    typedcsv = new(*args, &blk)
+    if args.last.is_a?(Hash) and args.last[:headers]
+      typedcsv.foreach_hash
+    else
+      typedcsv.foreach_array
+    end
+  end
+
+  attr_reader :args
+  attr_reader :blk
+
+  def initialize(*args, &blk)
+    @args = args
+    @blk = blk
+  end
+
+  def foreach_hash
+    headers = nil
+    CSV.foreach(*args) do |row|
+      unless headers
+        headers = Headers.new(row.headers)
+      end
+      blk.call headers.parse_hash(row)
+    end
+  end
+
+  def foreach_array
+    headers = nil
+    CSV.foreach(*args) do |row|
+      unless headers
+        headers = Headers.new(row)
+        next
+      end
+      blk.call headers.parse_array(row)
+    end
+  end
+
+  class Headers
+    attr_reader :raw
+    def initialize(raw)
+      @raw = raw
+    end
+    def types
+      @types ||= raw.each_with_index.map do |raw_k, i|
+        k, type = raw_k.split(':', 2)
+        if type
+          [k, type, "#{k}:#{type}", i]
+        else
+          [k, 'text', k, i]
+        end
+      end
+    end
+    def parse_array(row)
+      types.map do |k, type, _, i|
+        convert type, row[i]
+      end
+    end
+    def parse_hash(row)
+      types.inject({}) do |memo, (k, type, orig_k, _)|
+        v = row.fetch orig_k
+        memo[k] = convert(type, v)
+        memo
+      end
+    end
+    private
+    def convert(type, v)
+      case type
+      when 'text'
+        # defaults to no parsing
+        v
+      when 'list'
+        CSV.parse_line(v, col_sep: ';')
+      when 'date'
+        Time.parse(v).to_date
+      when 'time'
+        Time.parse(v).to_date
+      when 'number'
+        v.to_f
+      else
+        v
+      end
+    end
+  end
+end

data/typedcsv.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "typedcsv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "typedcsv"
+  spec.version       = Typedcsv::VERSION
+  spec.authors       = ["Seamus Abshere"]
+  spec.email         = ["seamus@abshere.net"]
+
+  spec.summary       = %q{Thin wrapper around Ruby's stdlib CSV parser that adds typed csv support.}
+  spec.homepage      = "https://github.com/faradayio/typedcsv-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: typedcsv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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:
+- seamus@abshere.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/.gitignore
+- benchmark/Gemfile
+- benchmark/Gemfile.lock
+- benchmark/benchmark.rb
+- benchmark/generate.rb
+- bin/console
+- bin/setup
+- lib/typedcsv.rb
+- lib/typedcsv/version.rb
+- typedcsv.gemspec
+homepage: https://github.com/faradayio/typedcsv-ruby
+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.8
+signing_key: 
+specification_version: 4
+summary: Thin wrapper around Ruby's stdlib CSV parser that adds typed csv support.
+test_files: []