honey_format 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 582322cb2da52ea080c388d8112159bf2f7923e3
+  data.tar.gz: e6854e04c23c2aa129753bf373c9417df4887627
+SHA512:
+  metadata.gz: 324f80c7fb803942428dfd051e55de92e687d83b7c6c5f351330f4eb159260f34fb6fb4a7b695d64c4ccdebd2a8e96aa90acb338f95645dd29b188a61dec09e0
+  data.tar.gz: 9d5e5f4724f1aca4f8676f1814d3034709d40c26f5266781d6ab7f62150f0bffaf797961090aebb7f579b950d8f8a25b1fae62526eecc43d73fbc82ba804a17f

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.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jacob Burenstam
+
+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,82 @@
+# HoneyFormat
+
+Convert CSV to object with one command.
+
+```ruby
+csv_string = "Id, Username\n 1, buren"
+csv = HoneyFormat::CSV.new(csv_string)
+csv.header      # => ["Id", "Username"]
+user = csv.rows # => [#<struct id="1", username="buren">]
+user.id         # => "1"
+user.username   # => "buren"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'honey-import'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install honey-import
+```
+
+## Usage
+
+By default assumes a header in the CSV file.
+
+```ruby
+csv_string = "Id, Username\n 1, buren"
+csv = HoneyFormat::CSV.new(csv_string)
+csv.header # => ["Id", "Username"]
+
+include HoneyFormat
+# If included you can use the HoneyCSV shorthand
+csv = HoneyCSV.new(csv_string)
+user = csv.rows # => [#<struct id="1", username="buren">]
+user.id         # => "1"
+user.username   # => "buren"
+```
+
+Validate CSV header
+```ruby
+csv_string = "Id, Username\n 1, buren"
+# Invalid
+HoneyCSV.new(csv_string, valid_columns: [:something, :username])
+# => #<HoneyFormat::CSVHeaderColumnError: key :id ("Id") not in [:something, :username]>
+# Valid
+csv = HoneyCSV.new(csv_string, valid_columns: [:id, :username])
+csv.rows.first.username # => "buren"
+```
+
+Define header
+```ruby
+csv_string = "1, buren"
+csv = HoneyCSV.new(csv_string, header: ['Id', 'Username'])
+csv.rows.first.username # => "buren"
+```
+
+_Note_: This gem, as you can imagine, adds some overhead to parsing a CSV string. Make sure to benchmark before using this for something performance sensitive.
+
+## 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/buren/honey-import. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'honey_format'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/honey_format.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'honey_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'honey_format'
+  spec.version       = HoneyFormat::VERSION
+  spec.authors       = ['Jacob Burenstam']
+  spec.email         = ['burenstam@gmail.com']
+
+  spec.summary       = 'Convert CSV to objects.'
+  spec.description   = 'Convert CSV to object with one command. Automagically makes your column order independent by defining real, named, methods for each column.'
+  spec.homepage      = 'https://github.com/buren/honey_format'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/honey_format/csv.rb

@@ -0,0 +1,63 @@
+require 'csv'
+
+module HoneyFormat
+  class MissingCSVHeaderError < StandardError; end
+  class CSVHeaderColumnError < StandardError; end
+
+  class CSV
+    attr_reader :header, :columns
+
+    def initialize(csv, header: nil, valid_columns: :all)
+      csv = ::CSV.parse(csv)
+      @head = build_header(header || csv.shift)
+      @csv_body = csv
+      @columns = build_columns(@head, valid_columns)
+      @struct_klass = Struct.new(*@columns)
+    end
+
+    def header
+      @head
+    end
+
+    def rows
+      @rows ||= @csv_body.map { |row| create_object(row) }
+    end
+
+    def row_count
+      rows.length
+    end
+
+    private
+
+    def build_header(head)
+      head || fail(MissingCSVHeaderError, 'CSV header must be present.')
+      clean_row(head)
+    end
+
+    def build_columns(keys, valid_columns)
+      columns = keys.map do |raw_col|
+        col = raw_col.downcase.gsub(/ /, '').to_sym
+        validate_column!(raw_col, col, valid_columns)
+        col
+      end
+    end
+
+    def create_object(row)
+      @struct_klass.new(*clean_row(row))
+    end
+
+    def clean_row(row)
+      row.map { |column| clean(column) }
+    end
+
+    def clean(column)
+      column.strip unless column.nil?
+    end
+
+    def validate_column!(c, col, valid_columns)
+      unless valid_columns == :all
+        valid_columns.include?(col) || fail(CSVHeaderColumnError, "column :#{col} (\"#{c}\") not in #{valid_columns.inspect}")
+      end
+    end
+  end
+end

data/lib/honey_format/version.rb

@@ -0,0 +1,3 @@
+module HoneyFormat
+  VERSION = '0.1.0'
+end

data/lib/honey_format.rb

@@ -0,0 +1,6 @@
+require 'honey_format/version'
+require 'honey_format/csv'
+
+module HoneyFormat
+  HoneyCSV = CSV
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: honey_format
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Burenstam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Convert CSV to object with one command. Automagically makes your column
+  order independent by defining real, named, methods for each column.
+email:
+- burenstam@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
+- honey_format.gemspec
+- lib/honey_format.rb
+- lib/honey_format/csv.rb
+- lib/honey_format/version.rb
+homepage: https://github.com/buren/honey_format
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Convert CSV to objects.
+test_files: []