simple_csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f379384bc15e489a0bbb1a8d7a28026e58162a3
+  data.tar.gz: c239e1ebccf33ed4fe0f9051f7c1a5a65a44f6da
+SHA512:
+  metadata.gz: 1404a5abbf6bbc700ddcc53ad3edc8e3428c1316c547d516d146202a50b98fde7951a853bb4c21449b090512423ce36644e34e44c545b1234466bf089c7bcad3
+  data.tar.gz: 432d6aac54b96f6e2775f869484b4ac61ffc1b39927a30c0e334f2f7e3b87068e9bea1ec9267e9219ade9771666552b2f87a1c03b8cd55f6cacddaddc77a311f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+output.csv
+input.csv

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

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 sidneyliebrand@gmail.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_csv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sidney Liebrand
+
+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,125 @@
+# SimpleCsv
+
+SimpleCsv is a simple gem that allows you to interact with CSV's in a more friendly way.
+See the examples given below for more details :)
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/simple_csv.svg)](http://badge.fury.io/rb/simple_csv)
+[![Build Status](https://travis-ci.org/SidOfc/simple_csv.svg?branch=master)](https://travis-ci.org/SidOfc/simple_csv)
+[![Coverage Status](https://coveralls.io/repos/github/SidOfc/simple_csv/badge.svg?branch=master)](https://coveralls.io/github/SidOfc/simple_csv?branch=master)
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_csv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_csv
+
+## Usage
+
+### Generating a CSV file
+
+The `SimpleCsv#generate` method takes a path and options to use for generating the file.
+By default, a CSV is generated using comma's (`,`) as seperator and all fields are quoted.
+
+When supplying options they will be merged into the existing defaults rather than overwriting them completely.
+
+```ruby
+SimpleCsv.generate(path, options = { seperator: ',', force_quotes: true })
+```
+
+To generate a CSV file we use `SimpleCsv#generate` (using the [faker](https://github.com/stympy/faker) gem to provide fake data)
+
+```ruby
+require 'faker'
+
+# use SimpleCsv.generate('output.csv', seperator: '|') to generate a CSV with a pipe character as seperator
+SimpleCsv.generate('output.csv') do
+  # first define the headers
+  headers :first_name, :last_name, :birth_date, :employed_at
+
+  # loop something
+  100.times do
+    # insert data in each field defined in headers to insert a row.
+    first_name Faker::Name.first_name
+    last_name Faker::Name.last_name
+    birth_date Faker::Date.between(Date.today << 900, Date.today << 200)
+    employed_at [Faker::Company.name, nil].sample
+  end
+end
+```
+
+### Reading a CSV file
+
+The `SimpleCsv#read` method takes a path and options to use for reading the file.
+By default, the expected seperator is a comma (`,`), `:headers` is set to `true` so that `CSV` parses the file expecting headers.
+The `:converters` option ensures values are converted to a proper type if possible, by default (if this is not set) all values are returned as strings
+
+When supplying options they will be merged into the existing defaults rather than overwriting them completely.
+
+```ruby
+SimpleCsv.read(path, options = { headers: true, seperator: ',',
+                                 converters: [:all, :blank_to_nil, :null_to_nil] })
+```
+
+To read a CSV file we use `SimpleCsv#read`, we will pass it a file path and a block as arguments.
+Within the block we define the headers present in the file, these will be transformed into methods you can call within `SimpleCsv::Reader#each_row` to get that property's current value
+
+```ruby
+SimpleCsv.read('input.csv') do
+  # first define the headers in the file manually
+  headers :first_name, :last_name, :birth_date, :employed_at
+
+  each_row do
+    # print each field defined in headers (that is not nil)
+    puts [first_name, last_name, birth_date, employed_at].compact.join ', '
+  end
+end
+```
+
+If we have a large CSV we might want to batch operations (say, if we are inserting this data into a database).
+For this we can use `SimpleCsv::Reader#in_groups_of` and pass the size of the group.
+Within that we call `SimpleCsv::Reader#each_row` as usual
+
+```ruby
+SimpleCsv.read('input.csv') do
+  # first define the headers in the file manually
+  headers :first_name, :last_name, :birth_date, :employed_at
+
+  in_groups_of(100) do
+    each_row do
+      # print each field defined in headers (that is not nil)
+      puts [first_name, last_name, birth_date, employed_at].compact.join ', '
+    end
+    # execute after every 100 rows
+    sleep 2
+  end
+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]/simple_csv. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,31 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pry'
+require 'faker'
+require 'simple_csv'
+
+# CSV generation test
+SimpleCsv.generate('spec/files/output.csv') do
+  headers :first_name, :last_name, :birth_date, :employed_at
+
+  100.times do
+    first_name Faker::Name.first_name
+    last_name Faker::Name.last_name
+    birth_date Faker::Date.between(Date.today << 1000, Date.today << 200)
+    employed_at [Faker::Company.name, nil].sample
+  end
+end
+
+# CSV read test
+SimpleCsv.read('spec/files/output.csv') do
+  headers :first_name, :last_name, :birth_date, :employed_at
+
+  in_groups_of(10) do
+    each_row :with_index do
+      puts [index, first_name, last_name,
+            birth_date, employed_at].compact.join ', '
+    end
+    sleep 1
+  end
+end

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/simple_csv/base.rb

@@ -0,0 +1,29 @@
+module SimpleCsv
+  class Base
+    attr_reader :index
+
+    COMMON_DELIMITERS = %w(, ; |)
+    DEFAULTS = { headers: true, col_sep: ',', seperator: ',',
+                 converters: [:all, :blank_to_nil, :null_to_nil] }.freeze
+
+    private
+
+    def settings(**opts)
+      @settings ||= DEFAULTS.dup
+      @settings = @settings.merge opts[:merge] if opts[:merge]
+
+      @settings[:col_sep] = @settings.delete :seperator if @settings[:seperator]
+
+      @settings
+    end
+
+    def headers(*column_names)
+      return @headers if column_names.empty?
+      @headers = column_names.map(&:to_s)
+    end
+
+    def respond_to_missing?(mtd, include_private = false)
+      @headers.include?(mtd) || super
+    end
+  end
+end

data/lib/simple_csv/reader.rb

@@ -0,0 +1,63 @@
+module SimpleCsv
+  class Reader < Base
+    attr_reader :index
+
+    def initialize(path, **opts, &block)
+      settings merge: opts
+
+      unless opts[:seperator]
+        settings merge: { seperator: detect_delimiter(path) }
+      end
+
+      headers(*find_headers(path)) if settings[:headers]
+
+      @csv = @original = CSV.open File.expand_path(path), settings
+      instance_eval(&block)
+    end
+
+    def in_groups_of(size, &block)
+      @original.each_slice(size) do |group|
+        @csv = group
+        instance_eval(&block)
+      end
+      @index = nil
+      @csv = @original
+    end
+
+    def each_row(*arr_opts, &block)
+      @index ||= 0 if arr_opts.include?(:with_index)
+
+      @csv.each do |record|
+        @record = record
+        instance_eval(&block)
+        @index += 1 if @index
+      end
+    end
+
+    def respond_to_missing?(mtd, include_private = false)
+      super
+    end
+
+    def method_missing(mtd, *args, &block)
+      @headers.include?(mtd.to_s) ? @record[mtd.to_s] : super
+    end
+
+    private
+
+    def find_headers(csv_path)
+      sep = detect_delimiter(csv_path)
+      first_line(csv_path).split(sep).map { |h| h.gsub(/^"*|"*$/, '') }
+    end
+
+    def detect_delimiter(csv_path)
+      line = first_line(csv_path)
+      @delimiters = COMMON_DELIMITERS.map { |sep| [sep, line.scan(sep).length] }
+                                     .sort { |a, b| b[1] <=> a[1] }
+      @delimiter ||= @delimiters[0][0]
+    end
+
+    def first_line(csv_path)
+      @first_line ||= File.open(File.expand_path(csv_path), &:readline)
+    end
+  end
+end

data/lib/simple_csv/version.rb

@@ -0,0 +1,3 @@
+module SimpleCsv
+  VERSION = "0.1.0"
+end

data/lib/simple_csv/writer.rb

@@ -0,0 +1,34 @@
+module SimpleCsv
+  class Writer < Base
+    DEFAULTS = { force_quotes: true }.freeze
+
+    def initialize(path, **opts, &block)
+      settings merge: DEFAULTS.merge(opts)
+      CSV.open(File.expand_path(path), 'w', @settings) do |csv|
+        @csv = csv
+        @current_row = []
+        instance_eval(&block)
+      end
+    end
+
+    private
+
+    def respond_to_missing?(mtd, include_private = false)
+      super
+    end
+
+    def method_missing(mtd, *args, &block)
+      super unless @headers.include? mtd.to_s
+
+      @current_row << args[0]
+      row_complete = @current_row.count == @headers.count
+      (@csv << @current_row) && @current_row = [] if row_complete
+    end
+
+    def headers(*column_names)
+      super
+      @csv << @headers if @csv
+      @headers
+    end
+  end
+end

data/lib/simple_csv.rb

@@ -0,0 +1,30 @@
+require 'csv'
+
+require 'simple_csv/version'
+require 'simple_csv/base'
+require 'simple_csv/reader'
+require 'simple_csv/writer'
+
+module SimpleCsv
+  @converters_initialized = false
+
+  def self.read(path, **options, &block)
+    initialize_converters unless converters_initialized
+    Reader.new path, options, &block
+  end
+
+  def self.generate(path, **options, &block)
+    initialize_converters unless converters_initialized
+    Writer.new path, options, &block
+  end
+
+  def self.initialize_converters
+    CSV::Converters[:blank_to_nil] = ->(f) { f && f.empty? ? nil : f }
+    CSV::Converters[:null_to_nil] = ->(f) { f && f == 'NULL' ? nil : f }
+    @converters_initialized = true
+  end
+
+  def self.converters_initialized
+    @converters_initialized
+  end
+end

data/simple_csv.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_csv'
+  spec.version       = SimpleCsv::VERSION
+  spec.authors       = ['Sidney Liebrand']
+  spec.email         = ['sidneyliebrand@gmail.com']
+
+  spec.summary       = 'CSV DSL'
+  spec.description   = 'A simple DSL for reading and generating CSV files'
+  spec.homepage      = 'https://github.com/sidofc/simple_csv'
+  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.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: simple_csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sidney Liebrand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple DSL for reading and generating CSV files
+email:
+- sidneyliebrand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_csv.rb
+- lib/simple_csv/base.rb
+- lib/simple_csv/reader.rb
+- lib/simple_csv/version.rb
+- lib/simple_csv/writer.rb
+- simple_csv.gemspec
+homepage: https://github.com/sidofc/simple_csv
+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: CSV DSL
+test_files: []