tabulo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ac51b57ff0b2dc5ce13ea28612183fe2691ed88
+  data.tar.gz: f004eedf9ec5fa112a289aba3f8411805d88a9fb
+SHA512:
+  metadata.gz: 5aa026d70495b3a06a6d364ef2f58bfdb007911f0f43f770dd7fc66bdc6b7c55321234cfe938d1869661d6f5e5526b1b0eea4bf0c31348ccab4a901151c7347a
+  data.tar.gz: e05b95a3ee28396e71b4771ddaf2f3803715935c391cfce31e1488c8dbdbb3d5c9e5fc641c7fb8a61ffb24ea241979a637f285b24cabf6c49d54fbd24842b8c1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**/.*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Matthew Harvey
+
+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,114 @@
+# Tabulo
+
+## Overview
+
+Tabulo generates ASCII tables for displaying in a terminal or as preformatted text.
+
+A `Tabulo::Table` can be printed:
+
+```
+> puts table
++----------+----------+
+|     N    |  Doubled |
++----------+----------+
+|        1 |        2 |
+|        2 |        4 |
+| 50000000 | 10000000 |
+```
+
+But it is also `Enumerable`, so you can process it one row at a time:
+
+```ruby
+table.each do |row|
+  puts row
+  # do some other thing that you want to do for each row
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tabulo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tabulo
+
+## Usage
+
+Require the gem:
+
+```ruby
+require 'tabulo'
+```
+
+Instantiate a `Tabulo::Table` by passing it an underlying `Enumerable` and then telling it
+the columns you want to generate.
+
+A simple case involves initializing columns from symbols corresponding to methods on members of the
+`Enumerable`. In this case the symbol also provides the header for each column:
+
+```ruby
+table = Tabulo::Table.new([1, 2, 5]) do |t|
+  t.add_column(:itself)
+  t.add_column(:even?)
+  t.add_column(:odd?)
+end
+
+# > puts table
+# +----------+----------+----------+
+# |  itself  |   even?  |   odd?   |
+# +----------+----------+----------+
+# |        1 |   false  |   true   |
+# |        2 |   true   |   false  |
+# |        5 |   false  |   true   |
+```
+
+Columns can also be initialized using blocks or procs that are called on each object. In this case
+the first argument provides the column header:
+
+```ruby
+table = Tabulo::Table.new([1, 2, 5]) do |t|
+  t.add_column("N", &:itself)
+  t.add_column("Doubled") { |n| n * 2 }
+end
+
+# > puts table
+# +----------+----------+
+# |     N    |  Doubled |
+# +----------+----------+
+# |        1 |        2 |
+# |        2 |        4 |
+# |        5 |       10 |
+```
+
+TODO: Finish this...
+
+
+## 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/matt-harvey/tabulo.
+
+## 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 "tabulo"
+
+# 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,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/tabulo.rb

@@ -0,0 +1,8 @@
+require "tabulo/version"
+require "tabulo/table"
+require "tabulo/row"
+require "tabulo/column"
+
+# TODO Tidy the code.
+# TODO Handle newline in output.
+# TODO Allow the option of a horizontal rule between rows.

data/lib/tabulo/column.rb

@@ -0,0 +1,66 @@
+module Tabulo
+
+  class Column
+
+    attr_reader :label, :truncate, :width
+
+    def initialize(options)
+      @label, @header = options[:label], options[:header]
+      @truncate = options[:truncate]
+      @align_header, @align_body = options[:align_header], options[:align_body]
+      @extractor, @formatter = options[:extractor], options[:formatter]
+      @width = options[:width]
+      @horizontal_rule_character = options[:horizontal_rule_character]
+    end
+
+    def header_cell
+      align_cell_content(@header, @align_header)
+    end
+
+    def horizontal_rule
+      @horizontal_rule_character * @width
+    end
+
+    def body_cell(source)
+      cell_datum = body_cell_value(source)
+      formatted_cell_content = @formatter.call(cell_datum)
+      real_alignment = @align_body || infer_alignment(cell_datum)
+      align_cell_content(formatted_cell_content, real_alignment)
+    end
+
+    def body_cell_value(source)
+      @extractor.call(source)
+    end
+
+    private
+
+    def align_cell_content(content, real_alignment)
+      padding = [@width - content.length, 0].max
+      left_padding, right_padding =
+        case real_alignment
+        when :center
+          half_padding = padding / 2
+          [padding - half_padding, half_padding]
+        when :left
+          [0, padding]
+        when :right
+          [padding, 0]
+        else
+          raise "Unrecognized alignment: #{real_alignment}"
+        end
+
+      "#{' ' * left_padding}#{content}#{' ' * right_padding}"
+    end
+
+    def infer_alignment(cell_datum)
+      case cell_datum
+      when Numeric
+        :right
+      when TrueClass, FalseClass
+        :center
+      else
+        :left
+      end
+    end
+  end
+end

data/lib/tabulo/row.rb

@@ -0,0 +1,26 @@
+module Tabulo
+
+  class Row
+    include Enumerable
+
+    def initialize(table, source, options = { with_header: true })
+      @table = table
+      @source = source
+      @with_header = options[:with_header]
+    end
+
+    def each
+      @table.columns.each do |column|
+        yield column.body_cell_value(@source)
+      end
+    end
+
+    def to_s
+      @table.formatted_body_row(@source, with_header: @with_header)
+    end
+
+    def to_h
+      @table.columns.map(&:label).zip(to_a).to_h
+    end
+  end
+end

data/lib/tabulo/table.rb

@@ -0,0 +1,123 @@
+module Tabulo
+
+  class Table
+    include Enumerable
+
+    attr_reader :columns
+
+    def initialize(sources, options = { })
+      opts = {
+        header_frequency: :start,
+
+        # nil to wrap to no max, 1 to wrap to 1 row then truncate, etc..
+        wrap_header_cells_to: nil,
+        wrap_cells_to: nil
+
+      }.merge(options)
+
+      @header_frequency = opts[:header_frequency]
+      @wrap_header_cells_to = opts[:wrap_header_cells_to]
+      @wrap_cells_to = opts[:wrap_cells_to]
+      @sources = sources
+      @joiner = "|"
+      @corner_character = "+"
+      @horizontal_rule_character = "-"
+      @truncation_indicator = "~"
+      @padding_character = " "
+      @columns = []
+      @default_column_width = 8
+      yield self if block_given?
+    end
+
+    def add_column(label, options = {}, &extractor)
+      @columns << Column.new({
+        label: label.to_sym,
+        header: label.to_s,
+        truncate: true,
+        align_header: :center,
+        align_body: nil,
+        horizontal_rule_character: @horizontal_rule_character,
+        width: @default_column_width,
+        extractor: extractor || (label.respond_to?(:to_proc) ? label.to_proc : proc { nil }),
+        formatter: :to_s.to_proc
+
+      }.merge(options))
+    end
+
+    def to_s
+      join_lines(map(&:to_s))
+    end
+
+    def each
+      @sources.each_with_index do |source, index|
+        include_header =
+          case @header_frequency
+          when :start
+            index == 0
+          when Fixnum
+            index % @header_frequency == 0
+          else
+            @header_frequency
+          end
+        yield body_row(source, with_header: include_header)
+      end
+    end
+
+    def header_row
+      format_row(true, &:header_cell)
+    end
+
+    def horizontal_rule
+      format_row(false, @horizontal_rule_character, @corner_character, &:horizontal_rule)
+    end
+
+    def formatted_body_row(source, options = { with_header: false })
+      inner = format_row { |column| column.body_cell(source) }
+      if options[:with_header]
+        join_lines([horizontal_rule, header_row, horizontal_rule, inner])
+      else
+        inner
+      end
+    end
+
+    private
+
+    def body_row(source, options = { with_header: false })
+      Row.new(self, source, options)
+    end
+
+    def format_row(header = false, padder = @padding_character, joiner = @joiner)
+      cell_stacks = @columns.map do |column|
+        raw = yield column
+        wrap = (header ? @wrap_header_cells_to : @wrap_cells_to)
+        truncate = (column.truncate && wrap)
+        column_width = column.width
+        cell_body_length = (truncate ? column_width * wrap : raw.length)
+        truncated = (cell_body_length < raw.length)
+        cell_body = raw[0...cell_body_length]
+        num_subcells = (cell_body_length.to_f / column_width).ceil
+        (0...num_subcells).map do |i|
+          s = cell_body.slice(i * column_width, column_width)
+          right_padder = ((truncated && i == num_subcells - 1) ? @truncation_indicator : padder)
+          "#{padder}#{s}#{padder * (column_width - s.length)}#{right_padder}"
+        end
+      end
+
+      subrows = (0...cell_stacks.map(&:size).max).map do |subrow_index|
+        cell_stacks.map.with_index do |cell_stack, column_index|
+          if subrow_index < cell_stack.size
+            cell_stack[subrow_index]
+          else
+            "#{padder}#{' ' * @columns[column_index].width}#{padder}"
+          end
+        end
+      end
+
+      join_lines(subrows.map { |subrow| "#{joiner}#{subrow.join(joiner)}#{joiner}" })
+    end
+
+    def join_lines(lines)
+      lines.join($/)  # join strings with cross-platform newline
+    end
+  end
+end

data/lib/tabulo/version.rb

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

data/tabulo.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tabulo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tabulo"
+  spec.version       = Tabulo::VERSION
+  spec.authors       = ["Matthew Harvey"]
+  spec.email         = ["software@matthewharvey.net"]
+
+  spec.summary       = "Enumerable ASCII table"
+  spec.description   = "Enumerable ASCII table"
+  spec.homepage      = "https://github.com/matt-harvey/tabulo"
+  spec.license       = "MIT"
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tabulo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Harvey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: Enumerable ASCII table
+email:
+- software@matthewharvey.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tabulo.rb
+- lib/tabulo/column.rb
+- lib/tabulo/row.rb
+- lib/tabulo/table.rb
+- lib/tabulo/version.rb
+- tabulo.gemspec
+homepage: https://github.com/matt-harvey/tabulo
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Enumerable ASCII table
+test_files: []