atv 0.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTQxMzBkNjk2OGE2NzFlOWNjMjhiOGM5MTNiZjI4MzcwNWJkY2QwOQ==
+  data.tar.gz: !binary |-
+    ZDljZWRkNGM5Mjc5MzY3ZWJjNDE4NGM0NDNiNzkzODIzMTA5YTVhZA==
+SHA512:
+  metadata.gz: !binary |-
+    OWQ0NjZiYmY5MzE2MWQwNTU3MTJlMzM1MzU1MGUzZDBhNTNiOTY3OWFiNWEw
+    NTQ5ZjgzODk2ZmViMGVlYmM3MmJiN2YzNjUyNDg2YTIwNWI0ODczN2ZlMWM0
+    NmJlNmNiM2YwZTBkZGE2NzdmZTg1NjJkODZlOWY4OWFhYzgwNGE=
+  data.tar.gz: !binary |-
+    YmJkZWZkZTc1ZTUzY2JhNmNiMDkwYWJjYjIzMmZiNzNiNWQ1NjdhYWM2MWRl
+    MzE0ZWE5MTMwZTkyZmI5MDdlM2M4MzVjNzBkYzU4ZGU0ODFlYTQ5NDg2NDYy
+    ZmNhMjVhY2FlZjNkMmFmNjUyYWRmMDJlNDQxMGUzNTRlYmY0YjA=

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kelly Felkins
+
+MIT License
+
+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,86 @@
+# ATV: Ascii Table Values
+
+ATV is a reader for data in ascii table format.
+It allows you to read data formatted like this:
+
+<pre>
+|------------------+--------------------|
+| name             | dob                |
+|------------------+--------------------|
+| Malcolm Reynolds | September 20, 2468 |
+|------------------+--------------------|
+| Zoe Washburne    | February 15, 2484  |
+|------------------+--------------------|
+</pre>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'atv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atv
+
+## Usage
+
+Rows are returned or yielded as [CSV::Row][1] objects.
+
+<pre>
+|-----------------------+------------------------------+-----------------------------------|
+| **Ascii Table Value** | **Returned Value**           | **Notes**                         |
+|-----------------------+------------------------------+-----------------------------------|
+| Malcolm Reynolds      | "Malcolm Reynolds"           | Most values returned as string    |
+|-----------------------+------------------------------+-----------------------------------|
+| 123                   | "123"                        | including numbers                 |
+|-----------------------+------------------------------+-----------------------------------|
+| wrapped strings are   | "wrapped strings are folded" | Similar to yaml, wrapped          |
+| folded                |                              | strings are folded with a single  |
+|                       |                              | space replacing the new line      |
+|-----------------------+------------------------------+-----------------------------------|
+|                       | not available                | The CSV::Row object will not      |
+|                       |                              | include columns with blank values |
+|-----------------------+------------------------------+-----------------------------------|
+| null                  | nil                          | null, true, and false are         |
+|                       |                              | special values                    |
+|-----------------------+------------------------------+-----------------------------------|
+| true                  | true                         |                                   |
+|-----------------------+------------------------------+-----------------------------------|
+| false                 | false                        |                                   |
+|-----------------------+------------------------------+-----------------------------------|
+</pre>
+
+**Reading a String**
+
+```ruby
+atv = ATV.from_string(string)
+atv.each do |row|
+  # use row here...
+end
+```
+
+**Reading from am IO object**
+
+```ruby
+atv = ATV.new(io)
+atv.each do |row|
+  # use row here...
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/IndieKelly/atv/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[1]: http://www.ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV/Row.html

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/atv.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "atv"
+  spec.version       = Atv::VERSION
+  spec.authors       = ["Kelly Felkins"]
+  spec.email         = ["kelly@indiegogo.com"]
+  spec.summary       = "Read Ascii Table Values"
+  spec.description   = "Read data from an ascii table. Inspired by Ruby's CSV library."
+  spec.homepage      = "https://github.com/IndieKelly/atv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/atv/version.rb

@@ -0,0 +1,3 @@
+module Atv
+  VERSION = "0.0.6"
+end

data/lib/atv.rb

@@ -0,0 +1,50 @@
+require "atv/version"
+require 'csv'
+
+class ATV
+  include Enumerable
+
+  SUBSTITUTIONS = {
+    'true' => true,
+    'false' => false,
+    'null' => nil
+  }
+
+  attr_reader(:headers)
+  
+  def initialize(io)
+    @io = io
+    @io.readline
+    @headers = split_table_line(@io.readline.chomp)
+    @io.readline
+  end
+
+  def each
+    line_data = []
+    @io.each_line do |line|
+      line.chomp!
+      if line =~ /^\|\-/
+        csv_row = CSV::Row.new(@headers, line_data.
+          transpose.
+          map { |tokens| tokens.reject(&:empty?).join(' ') }.
+          map { |token| SUBSTITUTIONS.has_key?(token) ? SUBSTITUTIONS[token] : token }
+        ).delete_if {|k, v| v == ''}
+        yield csv_row if csv_row.size > 0
+        line_data = []
+        next
+      end
+      line_data << split_table_line(line)
+    end
+  end
+
+  def self.from_string(string)
+    self.new(StringIO.new(string))
+  end
+
+  protected
+
+  def split_table_line(line)
+    return [] if line.empty?
+    line[1..-1].split('|').map(&:strip)
+  end
+end

data/test/atv_test.rb

@@ -0,0 +1,69 @@
+require 'minitest/autorun'
+require_relative '../lib/atv'
+
+describe ATV do
+  DATA_AS_TABLE = <<-TEXT
+|-----------+--------------------+--------------|
+| name      | dob                | predictable? |
+|-----------+--------------------+--------------|
+| Malcolm   | September 20, 2468 | false        |
+| Reynolds  |                    |              |
+|-----------+--------------------+--------------|
+| Zoe       | February 15, 2484  |              |
+| Washburne |                    |              |
+|-----------+--------------------+--------------|
+| Derrial   | null               | true         |
+| Book      |                    |              |
+|-----------+--------------------+--------------|
+
+  TEXT
+
+  EXPECTED = [
+    ['Malcolm Reynolds', 'September 20, 2468', false],
+    ['Zoe Washburne', 'February 15, 2484'],
+    ['Derrial Book', nil, true]
+  ]
+
+  describe '#each' do
+    before do
+      @atv = ATV.new(StringIO.new(DATA_AS_TABLE))
+    end
+
+    it 'with a block it yields rows of data as CSV rows' do
+      i = 0
+
+      @atv.each do |row|
+        row.fields.must_equal(EXPECTED[i])
+        row[0].must_equal(EXPECTED[i][0])
+        row['name'].must_equal(EXPECTED[i][0])
+        row[1].must_equal(EXPECTED[i][1])
+        row['dob'].must_equal(EXPECTED[i][1])
+        row[2].must_equal(EXPECTED[i][2])
+        row['predictable?'].must_equal(EXPECTED[i][2])
+        i += 1
+      end
+      i.must_equal(3)
+    end
+
+    it 'without a block it returns an enumerator of data as CSV rows' do
+      enum = @atv.enum_for
+      enum.map(&:fields).must_equal(EXPECTED)
+    end
+  end
+
+  describe "#headers" do
+    it 'returns all the headers' do
+      ATV.new(StringIO.new(DATA_AS_TABLE)).headers.must_equal(%w|name dob predictable?|)
+    end
+  end
+
+  describe ".from_string(string)" do
+    it 'initializes ATV with an IO object' do
+      fussy = -> (io) { io.must_be_kind_of StringIO }
+
+      ATV.stub :new, fussy do
+        ATV.from_string(DATA_AS_TABLE)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: atv
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Kelly Felkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Read data from an ascii table. Inspired by Ruby's CSV library.
+email:
+- kelly@indiegogo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atv.gemspec
+- lib/atv.rb
+- lib/atv/version.rb
+- test/atv_test.rb
+homepage: https://github.com/IndieKelly/atv
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Read Ascii Table Values
+test_files:
+- test/atv_test.rb