tableparser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2fbd2734b958cf74830b745ee5fb3b2aeef2ddf9cdb69a5f6e3fa327a954f69
+  data.tar.gz: 3edf9acb532fe76fa79dd5a0334968293316b49063e2ed709f70ed9fbed09a38
+SHA512:
+  metadata.gz: b71299efb498a81ba9b1114f2ac1cd20cc723298ea0a9a9628f569734f725a512163c8aee930a1807acb9bdf5771be5ccea9cca6840c375426a16a4ae233fe20
+  data.tar.gz: 77d21735bf65ec316dd6964d417e3f4383bf1d94c253e8558c109573b77825aa570f3cc1930682962c3528e16dce1726099656c8c3454cdb7898fd6267542d7a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+## 2019-04-09 `1.0.0`
+
+First release!!!
+
+Adds:
+
+- `Tableparser.parse`
+- `Tableparser.parse_to_struct`
+- `tableparser` executable

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 margolis@squareup.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 tableparser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    tableparser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    yard (0.9.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.8.0)
+  tableparser!
+  yard (~> 0.9.19)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Zach Margolis
+
+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,67 @@
+# Tableparser
+
+A gem for parsing table-like formats like from SQL output such as MySQL (when it's not batch-formatted).
+
+```ruby
+io = StringIO.new <<-EOS
++---------+---------+
+| col1    | col2    |
++---------+---------+
+| val     | val     |
+| val     | val     |
++---------+---------+
+EOS
+Tableparser.parse(io)
+# => [['col1', 'col2'], ['val', 'val'], ['val', 'val']]
+```
+
+It can also parse the content in to instances of a `Struct` class.
+
+```ruby
+MyRow = Struct.new(:col1, :col2)
+Tableparser.parse_to_struct(io, MyRow)
+# => [#<struct MyRow col1="val", col2="val">, #<struct MyRow col1="val", col2="val">]
+```
+
+Also comes with a handy `tableparser` exectuable:
+
+```bash
+$ echo "SELECT 1 AS one, 2 AS two" | mysql --table
++-----+-----+
+| one | two |
++-----+-----+
+|   1 |   2 |
++-----+-----+
+
+$ echo "SELECT 1 AS one, 2 AS two" | mysql --table | tableparser
+one,two
+1,2
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tableparser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tableparser
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zachmargolis/tableparser. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tableparser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zachmargolis/tableparser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tableparser"
+
+# 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/exe/tableparser

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+begin
+  require 'tableparser'
+rescue LoadError
+  lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+  $LOAD_PATH.unshift(lib_dir)
+  require 'tableparser'
+end
+
+if STDIN.tty?
+  abort "Usage: cat RESULTS | #{$PROGRAM_NAME}"
+end
+
+require 'csv'
+
+CSV.instance(STDOUT) do |csv|
+  Tableparser.parse(STDIN) do |row|
+    csv << row
+  end
+end

data/lib/tableparser.rb

@@ -0,0 +1,97 @@
+require "tableparser/version"
+
+# Helpers for table formatted results
+module Tableparser
+  # @overload parse(io)
+  #   @param [String] io io with source data to parse
+  #   @return [Array<Array<String>>] rows
+  # @overload parse(io, &block)
+  #   @param [String] io io with source data to parse
+  #   @yieldparam [Array<String>] row each row
+  #
+  # Parses output from tables (often from SQL queries) to CSV-like array of
+  # rows of strings.
+  #
+  # It expects the contents of +io+ to look something like this, and will
+  # skip over rows that don't match the format.
+  #
+  #     +---------+---------+
+  #     | col1    | col2    |
+  #     +---------+---------+
+  #     | val     | val     |
+  #     | val     | val     |
+  #     +---------+---------+
+  #
+  # @example
+  #   Tableparser.parse(STDIN) # =>
+  #   [['col1', 'col2'], ['val', 'val'], ['val', 'val']]
+  # @example
+  #   Tableparser.parse(STDIN) do |row|
+  #     # ...
+  #   end
+  def self.parse(io)
+    iter = io.each_line
+    pattern = /\|/
+
+    if block_given?
+      iter.grep(pattern) do |line|
+        yield parse_line(line)
+      end
+    else
+      iter.grep(pattern).map { |line| parse_line(line) }
+    end
+  end
+
+  # @overload parse_to_struct(io, struct)
+  #   @param [String] io io with source data to parse
+  #   @param [Class] struct class that rows will be parsed as
+  #   @return [Array<struct>] an array of instances of the +struct+ with fields
+  #     set from the corresponding columns
+  # @overload parse(io, struct, &block)
+  #   @param [String] io io with source data to parse
+  #   @yieldparam [struct] row each row
+  #
+  # Assumes +struct+ was from +Struct.new(:col1, :col2)+. The code sets values on
+  # the struct by name, not by index.
+  #
+  # *Note*: the code will downcase column names when setting.
+  #
+  def self.parse_to_struct(io, struct)
+    cols = nil
+
+    # grap the header row
+    parse(io) do |values|
+      cols = values
+      break
+    end
+
+    if block_given?
+      parse(io) do |values|
+        yield to_struct(values, struct, cols)
+      end
+    else
+      parse(io).map do |values|
+        to_struct(values, struct, cols)
+      end
+    end
+  end
+
+  # @api private
+  # @param [String] line
+  # @return [Array<String>]
+  # @example parse a line
+  #  parse_line("| banklin_card_token           | state       |")
+  #  => ['banklin_card_token', 'state']
+  def self.parse_line(line)
+    line.chomp.split('|').map(&:strip)[1..-1]
+  end
+
+  # @api private
+  def self.to_struct(values, struct, cols)
+    struct.new.tap do |row|
+      cols.zip(values).each do |name, val|
+        row[name.downcase] = val
+      end
+    end
+  end
+end

data/lib/tableparser/version.rb

@@ -0,0 +1,3 @@
+module Tableparser
+  VERSION = "1.0.0"
+end

data/tableparser.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tableparser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tableparser"
+  spec.version       = Tableparser::VERSION
+  spec.authors       = ["Zach Margolis"]
+  spec.email         = ["zbmargolis@gmail.com"]
+
+  spec.summary       = %q{Help parse table-like output}
+  spec.description   = %q{Help parse table-like output such as from raw SQL}
+  spec.homepage      = "https://github.com/zachmargolis/tableparser"
+  spec.license       = "MIT"
+
+  spec.metadata["yard.run"] = "yri"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8.0"
+  spec.add_development_dependency "yard", "~> 0.9.19"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: tableparser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Zach Margolis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.19
+description: Help parse table-like output such as from raw SQL
+email:
+- zbmargolis@gmail.com
+executables:
+- tableparser
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tableparser
+- lib/tableparser.rb
+- lib/tableparser/version.rb
+- tableparser.gemspec
+homepage: https://github.com/zachmargolis/tableparser
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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.7.9
+signing_key: 
+specification_version: 4
+summary: Help parse table-like output
+test_files: []