termtable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 581a5dfb715ea7eaa47ae23d6da376276673c819
+  data.tar.gz: f1af2c524a24227dac39693ff4075221fc7d7324
+SHA512:
+  metadata.gz: 2b97cb4bf4fc1b4eed5e8f562d0bd884466e316f149801b0afbc5689cca51358ddd8a7e089ec7f08f941fc868d2c5e47ab9b8644ba1a0ba0aa8444e836f7fb6c
+  data.tar.gz: e9de018cf87eb659e1afb57b81e474d5bfceccb7f9631e96d88199a3f35217289bb9be6028ccb6771353983d868f564a038e7f605e8a593b53924ba11642c274

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rubocop'
+end
+
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# Termtable
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'termtable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install termtable
+
+## Usage
+
+A table instance can take a 2 dimensional array for the rows. 
+
+```ruby
+table = Termtable::Table.new [[1, 2, 3], [4, 5, 6]]
+```
+
+This can also be given as a hash with a rows key.
+
+```ruby
+table = Termtable::Table.new rows: [[1, 2, 3], [4, 5, 6]]
+
+puts table.render
+
++--+--+--+
+|1 |2 |3 |
+|4 |5 |6 |
++--+--+--+
+```
+
+### Headers
+
+Headers can be given as the first array
+
+```ruby
+Termtable::Table.new ['Header A', 'Header B'], [['a1', 'a2'], ['b1', 'b2']]
+```
+
+Also as a headers key
+
+```ruby
+Termtable::Table.new headers: ['Header A', 'Header B'], rows: [['a1', 'a2'], ['b1', 'b2']]
+
++---------+---------+
+|Header A |Header B |
++---------+---------+
+|a1       |a2       |
+|b1       |b2       |
++---------+---------+
+```
+
+### Padding
+
+It is possible to pass a padding argument to the render method
+
+```ruby
+table = Termtable::Table.new rows: [['a1', 'a2'], ['b1', 12345]]
+puts table.render(padding: 3)
+
++-----+--------+
+|a1   |a2      |
+|b1   |12345   |
++-----+--------+
+```
+
+### Alignment
+
+It is possible to pass an alignment argument to render
+
+```ruby
+table = Termtable::Table.new rows: [['a1', 'a2'], ['b1', 123456]]
+puts table.render(alignment: 'center')
+
++----+--------+
+| a1 |   a2   |
+| b1 | 123456 |
++----+--------+
+```
+
+## Development
+
+To run the tests
+
+    $ rake
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nikkypx/termtable.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'termtable'
+require 'pry'
+
+Pry.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/termtable.rb

@@ -0,0 +1,13 @@
+require 'termtable/border'
+require 'termtable/cell'
+require 'termtable/core_ext/array'
+require 'termtable/error'
+require 'termtable/header'
+require 'termtable/render'
+require 'termtable/row'
+require 'termtable/table'
+require 'termtable/version'
+
+module Termtable
+  Array.include(CoreExt::Array)
+end

data/lib/termtable/border.rb

@@ -0,0 +1,13 @@
+module Termtable
+  class Border
+    def initialize(**opts)
+      @columns = opts.delete(:columns)
+      @style   = opts.delete(:style) || '-'
+      @corner  = opts.delete(:corners) || '+'
+    end
+
+    def render
+      @corner + @columns.map { |col| @style * col }.join(@corner) << @corner
+    end
+  end
+end

data/lib/termtable/cell.rb

@@ -0,0 +1,51 @@
+module Termtable
+  class Cell
+    attr_reader :value
+    attr_accessor :max_column_size,
+                  :padding,
+                  :alignment,
+                  :total_padding
+
+    def initialize(value)
+      @value = value.to_s
+    end
+
+    def expand?
+      max_column_size != value.to_s.size + total_padding
+    end
+
+    def left_padding
+      count = case alignment
+              when 'right'
+                expand? ? max_column_size - value.to_s.size : padding
+              when 'center'
+                expand? ? (max_column_size - value.to_s.size) / 2 : padding
+              else
+                0
+              end
+      ' ' * count
+    end
+
+    def right_padding
+      count = case alignment
+              when 'right'
+                0
+              when 'center'
+                if expand? && max_column_size.even?
+                  (max_column_size - value.to_s.size) / 2
+                elsif expand? && max_column_size.odd?
+                  (max_column_size - value.to_s.size) / 2 + 1
+                else
+                  padding
+                end
+              else
+                expand? ? max_column_size - value.to_s.size : padding
+              end
+      ' ' * count
+    end
+
+    def render
+      "#{left_padding}#{value}#{right_padding}"
+    end
+  end
+end

data/lib/termtable/core_ext/array.rb

@@ -0,0 +1,14 @@
+module Termtable
+  module CoreExt
+    module Array
+      def depth
+        __depth__(self)
+      end
+
+      def __depth__(array)
+        return 0 if array == array.flatten
+        1 + __depth__(array.flatten(1))
+      end
+    end
+  end
+end

data/lib/termtable/error.rb

@@ -0,0 +1,5 @@
+module Termtable
+  class Error < StandardError
+    InitializationError = Class.new(self)
+  end
+end

data/lib/termtable/header.rb

@@ -0,0 +1,13 @@
+module Termtable
+  class Header
+    attr_reader :cells
+
+    def initialize(header)
+      @cells = header.map { |value| Cell.new(value) }
+    end
+
+    def render
+      '|' + cells.map(&:render).join('|') << '|'
+    end
+  end
+end

data/lib/termtable/render.rb

@@ -0,0 +1,53 @@
+module Termtable
+  class Render
+    DEFAULT_PADDING = 1
+    DEFAULT_ALIGNMENT = 'left'.freeze
+
+    def initialize(rows, opts)
+      @rows           = rows
+      @padding        = opts.delete(:padding) || DEFAULT_PADDING
+      @alignment      = opts.delete(:alignment) || DEFAULT_ALIGNMENT
+      @border_options = opts.delete(:border)
+      @column_lengths = column_widths(rows)
+    end
+
+    def set_metadata!
+      @rows.each do |row|
+        row.cells.each_with_index do |cell, idx|
+          cell.max_column_size = @column_lengths[idx]
+          cell.padding         = @padding
+          cell.alignment       = @alignment
+          cell.total_padding   = total_padding
+        end
+      end
+    end
+
+    def set_borders!
+      @rows.unshift(Termtable::Border.new(columns: @column_lengths))
+      @rows.push(Termtable::Border.new(columns: @column_lengths))
+    end
+
+    def set_headers_border!
+      @rows.insert(2, Termtable::Border.new(columns: @column_lengths)) if @rows[1].is_a?(Termtable::Header)
+    end
+
+    def total_padding
+      @alignment == 'center' ? @padding * 2 : @padding
+    end
+
+    def column_widths(rows)
+      column_values = rows.map { |r| r.cells.map(&:value) }.transpose
+      column_values.map do |col|
+        col.max_by(&:length).size + total_padding
+      end
+    end
+
+    def exec
+      set_metadata!
+      set_borders!
+      set_headers_border!
+
+      @rows.map(&:render).join("\n")
+    end
+  end
+end

data/lib/termtable/row.rb

@@ -0,0 +1,13 @@
+module Termtable
+  class Row
+    attr_reader :cells
+
+    def initialize(row)
+      @cells = row.map { |value| Cell.new(value) }
+    end
+
+    def render
+      '|' + cells.map(&:render).join('|') << '|'
+    end
+  end
+end

data/lib/termtable/table.rb

@@ -0,0 +1,46 @@
+module Termtable
+  class Table
+    def initialize(*args)
+      if args.first.is_a?(Array) && args.depth == 1
+        raise Termtable::Error::InitializationError, '2d array required for initialization'
+      end
+
+      if args.empty?
+        @rows = []
+
+        yield(self) if block_given?
+      else
+        if args.first.is_a?(Hash)
+          headers = args.first.delete(:headers)
+          @rows = args.first.delete(:rows)
+        elsif args.size == 2
+          headers, @rows = args
+        else
+          @rows = args.first
+        end
+
+        buffer_jagged_array!
+
+        @rows = @rows.map { |row| Row.new(row) }
+        @rows.unshift(Header.new(headers)) unless headers.nil?
+      end
+    end
+
+    def buffer_jagged_array!
+      max = @rows.map(&:size).max
+      @rows.map { |row| (max - row.size).times { row << ' ' } }
+    end
+
+    def row_count
+      @rows.size
+    end
+
+    def <<(row)
+      @rows << Row.new(row)
+    end
+
+    def render(**opts)
+      Render.new(@rows, opts).exec
+    end
+  end
+end

data/lib/termtable/version.rb

@@ -0,0 +1,3 @@
+module Termtable
+  VERSION = '0.1.0'.freeze
+end

data/termtable.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'termtable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'termtable'
+  spec.version       = Termtable::VERSION
+  spec.authors       = ['Nicholas Palaniuk']
+  spec.email         = ['npalaniuk+github@gmail.com']
+  spec.summary       = 'Table generator for the terminal'
+  spec.description   = 'Table generator for the terminal'
+  spec.homepage      = 'https://github.com/nikkypx/termtable'
+
+  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'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: termtable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Palaniuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Table generator for the terminal
+email:
+- npalaniuk+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/termtable.rb
+- lib/termtable/border.rb
+- lib/termtable/cell.rb
+- lib/termtable/core_ext/array.rb
+- lib/termtable/error.rb
+- lib/termtable/header.rb
+- lib/termtable/render.rb
+- lib/termtable/row.rb
+- lib/termtable/table.rb
+- lib/termtable/version.rb
+- termtable.gemspec
+homepage: https://github.com/nikkypx/termtable
+licenses: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Table generator for the terminal
+test_files: []