honey_format 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 582322cb2da52ea080c388d8112159bf2f7923e3
4
+ data.tar.gz: e6854e04c23c2aa129753bf373c9417df4887627
5
+ SHA512:
6
+ metadata.gz: 324f80c7fb803942428dfd051e55de92e687d83b7c6c5f351330f4eb159260f34fb6fb4a7b695d64c4ccdebd2a8e96aa90acb338f95645dd29b188a61dec09e0
7
+ data.tar.gz: 9d5e5f4724f1aca4f8676f1814d3034709d40c26f5266781d6ab7f62150f0bffaf797961090aebb7f579b950d8f8a25b1fae62526eecc43d73fbc82ba804a17f
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ 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.
4
+
5
+ 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.
6
+
7
+ 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.
8
+
9
+ 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.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ 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 ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in honey_format.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Jacob Burenstam
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # HoneyFormat
2
+
3
+ Convert CSV to object with one command.
4
+
5
+ ```ruby
6
+ csv_string = "Id, Username\n 1, buren"
7
+ csv = HoneyFormat::CSV.new(csv_string)
8
+ csv.header # => ["Id", "Username"]
9
+ user = csv.rows # => [#<struct id="1", username="buren">]
10
+ user.id # => "1"
11
+ user.username # => "buren"
12
+ ```
13
+
14
+ ## Installation
15
+
16
+ Add this line to your application's Gemfile:
17
+
18
+ ```ruby
19
+ gem 'honey-import'
20
+ ```
21
+
22
+ And then execute:
23
+ ```
24
+ $ bundle
25
+ ```
26
+
27
+ Or install it yourself as:
28
+ ```
29
+ $ gem install honey-import
30
+ ```
31
+
32
+ ## Usage
33
+
34
+ By default assumes a header in the CSV file.
35
+
36
+ ```ruby
37
+ csv_string = "Id, Username\n 1, buren"
38
+ csv = HoneyFormat::CSV.new(csv_string)
39
+ csv.header # => ["Id", "Username"]
40
+
41
+ include HoneyFormat
42
+ # If included you can use the HoneyCSV shorthand
43
+ csv = HoneyCSV.new(csv_string)
44
+ user = csv.rows # => [#<struct id="1", username="buren">]
45
+ user.id # => "1"
46
+ user.username # => "buren"
47
+ ```
48
+
49
+ Validate CSV header
50
+ ```ruby
51
+ csv_string = "Id, Username\n 1, buren"
52
+ # Invalid
53
+ HoneyCSV.new(csv_string, valid_columns: [:something, :username])
54
+ # => #<HoneyFormat::CSVHeaderColumnError: key :id ("Id") not in [:something, :username]>
55
+ # Valid
56
+ csv = HoneyCSV.new(csv_string, valid_columns: [:id, :username])
57
+ csv.rows.first.username # => "buren"
58
+ ```
59
+
60
+ Define header
61
+ ```ruby
62
+ csv_string = "1, buren"
63
+ csv = HoneyCSV.new(csv_string, header: ['Id', 'Username'])
64
+ csv.rows.first.username # => "buren"
65
+ ```
66
+
67
+ _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.
68
+
69
+ ## Development
70
+
71
+ 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.
72
+
73
+ 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).
74
+
75
+ ## Contributing
76
+
77
+ 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.
78
+
79
+
80
+ ## License
81
+
82
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'honey_format'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'honey_format/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'honey_format'
8
+ spec.version = HoneyFormat::VERSION
9
+ spec.authors = ['Jacob Burenstam']
10
+ spec.email = ['burenstam@gmail.com']
11
+
12
+ spec.summary = 'Convert CSV to objects.'
13
+ spec.description = 'Convert CSV to object with one command. Automagically makes your column order independent by defining real, named, methods for each column.'
14
+ spec.homepage = 'https://github.com/buren/honey_format'
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ['lib']
20
+
21
+ spec.add_development_dependency 'bundler', '~> 1.10'
22
+ spec.add_development_dependency 'rake', '~> 10.0'
23
+ spec.add_development_dependency 'rspec'
24
+ spec.add_development_dependency 'simplecov'
25
+ end
@@ -0,0 +1,63 @@
1
+ require 'csv'
2
+
3
+ module HoneyFormat
4
+ class MissingCSVHeaderError < StandardError; end
5
+ class CSVHeaderColumnError < StandardError; end
6
+
7
+ class CSV
8
+ attr_reader :header, :columns
9
+
10
+ def initialize(csv, header: nil, valid_columns: :all)
11
+ csv = ::CSV.parse(csv)
12
+ @head = build_header(header || csv.shift)
13
+ @csv_body = csv
14
+ @columns = build_columns(@head, valid_columns)
15
+ @struct_klass = Struct.new(*@columns)
16
+ end
17
+
18
+ def header
19
+ @head
20
+ end
21
+
22
+ def rows
23
+ @rows ||= @csv_body.map { |row| create_object(row) }
24
+ end
25
+
26
+ def row_count
27
+ rows.length
28
+ end
29
+
30
+ private
31
+
32
+ def build_header(head)
33
+ head || fail(MissingCSVHeaderError, 'CSV header must be present.')
34
+ clean_row(head)
35
+ end
36
+
37
+ def build_columns(keys, valid_columns)
38
+ columns = keys.map do |raw_col|
39
+ col = raw_col.downcase.gsub(/ /, '').to_sym
40
+ validate_column!(raw_col, col, valid_columns)
41
+ col
42
+ end
43
+ end
44
+
45
+ def create_object(row)
46
+ @struct_klass.new(*clean_row(row))
47
+ end
48
+
49
+ def clean_row(row)
50
+ row.map { |column| clean(column) }
51
+ end
52
+
53
+ def clean(column)
54
+ column.strip unless column.nil?
55
+ end
56
+
57
+ def validate_column!(c, col, valid_columns)
58
+ unless valid_columns == :all
59
+ valid_columns.include?(col) || fail(CSVHeaderColumnError, "column :#{col} (\"#{c}\") not in #{valid_columns.inspect}")
60
+ end
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,3 @@
1
+ module HoneyFormat
2
+ VERSION = '0.1.0'
3
+ end
@@ -0,0 +1,6 @@
1
+ require 'honey_format/version'
2
+ require 'honey_format/csv'
3
+
4
+ module HoneyFormat
5
+ HoneyCSV = CSV
6
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: honey_format
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jacob Burenstam
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-10-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: simplecov
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Convert CSV to object with one command. Automagically makes your column
70
+ order independent by defining real, named, methods for each column.
71
+ email:
72
+ - burenstam@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".travis.yml"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - LICENSE.txt
83
+ - README.md
84
+ - Rakefile
85
+ - bin/console
86
+ - bin/setup
87
+ - honey_format.gemspec
88
+ - lib/honey_format.rb
89
+ - lib/honey_format/csv.rb
90
+ - lib/honey_format/version.rb
91
+ homepage: https://github.com/buren/honey_format
92
+ licenses:
93
+ - MIT
94
+ metadata: {}
95
+ post_install_message:
96
+ rdoc_options: []
97
+ require_paths:
98
+ - lib
99
+ required_ruby_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ required_rubygems_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ requirements: []
110
+ rubyforge_project:
111
+ rubygems_version: 2.4.7
112
+ signing_key:
113
+ specification_version: 4
114
+ summary: Convert CSV to objects.
115
+ test_files: []