separated_values 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf22f4626ef0b7c1a99f0e1342ea118deca30cf3
+  data.tar.gz: 00e0bc67b4dddcd8498ab799f6f4cea54860e610
+SHA512:
+  metadata.gz: f6704f9b8a63421586c40c9f8bb8252dc182e57e8078b03589f5217e9c364872388ba1b57c1ad4ff2fc8ac3ce086ca98486003cb80c0497cbf24bb60395094ae
+  data.tar.gz: 111fdcbded392511da6ad88f459a5fd5347191ee05a2de360d53c694347e84a3938608ee792e5f77e5d1ecc4b78c48ba13a50b189b4c258561ce3a25c313c912

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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 separated_values.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    separated_values (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  separated_values!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emric
+
+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,63 @@
+# SeparatedValues
+
+This is a gem for easily parsing primitive data sheet files.
+It supports file types like CSV and TSV to name a few.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'separated_values'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install separated_values
+
+## Usage
+
+Parsing a file:
+```ruby
+document = SeparatedValues.parse('my_file.csv')
+```
+
+As you might guess the `document` file contains the contents
+of the file. You can access the cell values as a two dimensional array.
+```ruby
+document[0][0] = 'foo'
+```
+
+The parser will default to parseCSV files.
+If you want to parse a custom format you can use the `:separator` option.
+```ruby
+document = SeparatedValues.parse('my_file.tsv', separator: '\t')
+```
+
+The parser also comes with the handy `:schema` option.
+By providing this option you can convert the document to an array of hashes:
+```ruby
+document = SeparatedValues.parse('my_file.csv', schema: [:first_name, :last_name])
+document.to_hash_array = [
+    { first_name: 'Luke', last_name: 'Skywalker' },
+    { first_name: 'Han', last_name: 'Solo' }
+]
+```
+
+## 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/istanful/separated_values.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "separated_values"
+
+# 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/separated_values/document.rb

@@ -0,0 +1,20 @@
+module SeparatedValues
+  class Document
+    attr_reader :rows, :options
+
+    def initialize(rows, options = DEFAULT_OPTIONS)
+      @rows = rows
+      @options = options
+    end
+
+    def [](index)
+      rows[index]
+    end
+
+    def to_hash_array
+      rows.map do |row|
+        row.to_h(options[:schema])
+      end
+    end
+  end
+end

data/lib/separated_values/parser.rb

@@ -0,0 +1,25 @@
+require 'separated_values/document'
+require 'separated_values/row_parser'
+
+module SeparatedValues
+  class Parser
+    attr_reader :file_path, :options
+
+    def initialize(file_path, options = DEFAULT_OPTIONS)
+      @file_path = file_path
+      @options = options
+    end
+
+    def parse
+      Document.new(rows, options)
+    end
+
+    private
+
+    def rows
+      File.readlines(file_path).map do |line|
+        RowParser.new(line, options).parse
+      end
+    end
+  end
+end

data/lib/separated_values/row.rb

@@ -0,0 +1,20 @@
+module SeparatedValues
+  class Row
+    attr_reader :options
+
+    def initialize(values, options = DEFAULT_OPTIONS)
+      @values = values
+      @options = options
+    end
+
+    def [](index)
+      @values[index]
+    end
+
+    def to_h(schema = options[:schema])
+      schema.each_with_object({}).with_index do |(key, hash), i|
+        hash[key] = @values[i]
+      end
+    end
+  end
+end

data/lib/separated_values/row_parser.rb

@@ -0,0 +1,22 @@
+require 'separated_values/row'
+
+module SeparatedValues
+  class RowParser
+    attr_reader :source_data, :options
+
+    def initialize(source_data, options = DEFAULT_OPTIONS)
+      @source_data = source_data
+      @options = options
+    end
+
+    def parse
+      Row.new(source_data_to_array)
+    end
+
+    private
+
+    def source_data_to_array
+      source_data.split(options[:separator])
+    end
+  end
+end

data/lib/separated_values/version.rb

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

data/lib/separated_values.rb

@@ -0,0 +1,10 @@
+require 'separated_values/version'
+require 'separated_values/parser'
+
+module SeparatedValues
+  DEFAULT_OPTIONS = { separator: ';' }
+
+  def self.parse(file_path, options = DEFAULT_OPTIONS)
+    Parser.new(file_path, options).parse
+  end
+end

data/separated_values.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "separated_values/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "separated_values"
+  spec.version       = SeparatedValues::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["w.e.w@live.se"]
+
+  spec.summary       = 'Gem for parsing separated values documents'
+  spec.homepage      = 'https://www.github.com/istanful/separated-values'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://www.rubygems.org'
+  end
+
+  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.16"
+  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: separated_values
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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:
+- w.e.w@live.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/separated_values.rb
+- lib/separated_values/document.rb
+- lib/separated_values/parser.rb
+- lib/separated_values/row.rb
+- lib/separated_values/row_parser.rb
+- lib/separated_values/version.rb
+- separated_values.gemspec
+homepage: https://www.github.com/istanful/separated-values
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://www.rubygems.org
+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: Gem for parsing separated values documents
+test_files: []