table_pal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b1c3f5234498b916d764d00cc8e9d6a050fd91cac4bc803791b015934494e86
+  data.tar.gz: 42e49d8eee541a96e21090e467f3abdd87bd96545b0a6dacb12e67cacda061d2
+SHA512:
+  metadata.gz: 7f7cb22a2a031b3d48bad82329d3d76393d855491b78be17e218b7b235db23b06b0a47c6a54a5725d4d9ea178b761b51039635fa81c605a59d46ce844d8677a0
+  data.tar.gz: 8dfea9dfe91bc61d63f03ad30aced9bfafbf756c07e0b3aa0027b6eda44123d93e14592c1fee490454f34cf397a7f27cf9646ab6a39f304f3ca223a49eccc3f0

data/.rubocop.yml

@@ -0,0 +1,108 @@
+AllCops:
+  TargetRubyVersion: 2.6.4
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Lint/UnusedMethodArgument:
+  AutoCorrect: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/StabbyLambdaParentheses:
+  EnforcedStyle: require_no_parentheses
+
+# Layout/AlignArray:
+# Layout/AlignHash:
+# Layout/AlignParameters:
+# Layout/EmptyLineBetweenDefs:
+# Layout/EmptyLinesAroundClassBody:
+# Layout/EmptyLinesAroundExceptionHandlingKeywords:
+# Layout/EmptyLinesAroundModuleBody:
+# Layout/ExtraSpacing:
+# Layout/LeadingBlankLines:
+# Layout/SpaceAroundOperators:
+# Layout/SpaceBeforeFirstArg:
+# Layout/SpaceInLambdaLiteral:
+# Lint/AmbiguousOperator:
+# Lint/AmbiguousRegexpLiteral:
+# Lint/HandleExceptions:
+# Lint/IneffectiveAccessModifier:
+# Lint/ToJSON:
+# Lint/UnderscorePrefixedVariableName:
+# Lint/UnneededSplatExpansion:
+# Lint/UnreachableCode:
+# Lint/UselessAccessModifier:
+# Lint/UselessAssignment:
+# Lint/Void:
+# Metrics/AbcSize:
+# Metrics/BlockLength:
+# Metrics/ClassLength:
+# Metrics/CyclomaticComplexity:
+# Metrics/LineLength:
+# Metrics/MethodLength:
+# Metrics/ModuleLength:
+# Metrics/ParameterLists:
+# Metrics/PerceivedComplexity:
+# Naming/ClassAndModuleCamelCase:
+# Naming/RescuedExceptionsVariableName:
+# Naming/UncommunicativeMethodParamName:
+# Naming/VariableNumber:
+# Security/MarshalLoad:
+# Style/ClassVars:
+# Style/Documentation:
+# Style/EmptyMethod:
+# Style/FormatStringToken:
+# Style/IfUnlessModifier:
+# Style/MixinUsage:
+# Style/MutableConstant:
+# Style/NumericLiterals:
+# Style/NumericPredicate:
+# Style/SingleLineMethods:
+# Style/StringLiterals:
+# Style/TernaryParentheses:

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    table_pal (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    interesting_methods (0.1.2)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (13.0.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  interesting_methods (~> 0.1)
+  minitest (~> 5.12)
+  pry (~> 0.12)
+  rake (~> 13.0)
+  rubocop (~> 0.71)
+  table_pal!
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,5 @@
+# Table Pal
+
+This gem lets you print tables with ease.
+
+It's mainly used by myself and isn't necessarily meant for widespread public comsumption just yet.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.pattern = 'tests/*_test.rb'
+end
+
+task default: 'test'

data/lib/cell.rb

@@ -0,0 +1,52 @@
+module TablePal
+  class Cell
+
+    using Colours
+
+    attr_reader :row, :column, :content, :formatter, :justification, :colour
+
+    def initialize(row:, column:, content: '', formatter: nil, justification: nil, colour: nil)
+      @row           = row
+      @column        = column
+      @content       = content
+      @formatter     = formatter || row.formatter || NoFormatting
+      @justification = justification || row.justification || column.justification
+      @colour        = colour || row.colour || column.colour || :itself
+    end
+
+    def formatted(justified: false, coloured: false)
+      result = format(content)
+      result = justify(result) if justified
+      result = colourize(result) if coloured
+
+      result
+    end
+
+    def format(result)
+      return '' if result == ''
+
+      formatter.call(result).to_s
+    end
+
+    def justify(result)
+      result.send(justification_to_method, column.width)
+    end
+
+    def colourize(result)
+      result.send(colour)
+    end
+
+    def width
+      formatted.length
+    end
+
+    def justification_to_method
+      {
+        left:   :ljust,
+        right:  :rjust,
+        center: :center
+      }[justification]
+    end
+
+  end
+end

data/lib/colours.rb

@@ -0,0 +1,286 @@
+module Colours
+  refine String do
+    def reset
+      ansi(0)
+    end
+
+    # FORMATTING
+
+    def bold
+      style 1
+    end
+
+    def faint
+      style 2
+    end
+
+    def italic
+      style 3
+    end
+
+    def underline
+      style 4
+    end
+
+    # FOREGROUND COLOURS
+
+    def black
+      style 30
+    end
+
+    def blue
+      style 34
+    end
+
+    def cyan
+      style 36
+    end
+
+    def green
+      style 32
+    end
+
+    def magenta
+      style 35
+    end
+
+    # TODO: wrong number
+    def purple
+      style 35
+    end
+
+    def red
+      style 31
+    end
+
+    def white
+      style 37
+    end
+
+    def yellow
+      style 33
+    end
+
+    def bright_black
+      style 90
+    end
+
+    def bright_blue
+      style 94
+    end
+
+    def bright_cyan
+      style 96
+    end
+
+    def bright_green
+      style 92
+    end
+
+    def bright_magenta
+      style 95
+    end
+
+    def bright_red
+      style 91
+    end
+
+    def bright_white
+      style 97
+    end
+
+    def bright_yellow
+      style 93
+    end
+
+    # BACKGROUND COLOURS
+
+    def bg_black
+      style 40
+    end
+
+    def bg_blue
+      style 44
+    end
+
+    def bg_cyan
+      style 46
+    end
+
+    def bg_green
+      style 42
+    end
+
+    def bg_magenta
+      style 45
+    end
+
+    def bg_red
+      style 41
+    end
+
+    def bg_white
+      style 47
+    end
+
+    def bg_yellow
+      style 43
+    end
+
+    # ANSI 256 COLOURS
+
+    def bg(code)
+      style "48;5;#{code}"
+    end
+
+    def fg(code)
+      style "38;5;#{code}"
+    end
+
+    # MISC
+
+    def backticks
+      backtick + self + backtick
+    end
+
+    def near_black
+      bg(240)
+    end
+
+    private
+
+    def ansi(code)
+      "\e[#{code}m"
+    end
+
+    def backtick
+      '`'.yellow
+    end
+
+    def style(code)
+      ansi(code) + self + reset
+    end
+  end
+
+  class Demo
+
+    class << self
+
+      using Colours
+
+      def all_ansi_256
+        puts
+        display_all_ansi_256('bg')
+        puts
+        puts
+        display_all_ansi_256('fg')
+        puts
+        puts
+        display_all(styles)
+        puts
+        puts
+        display_all(fg_colours)
+        puts
+        puts
+        display_all(bright_colours)
+        puts
+        puts
+        display_all(bg_colours)
+        puts
+        puts
+      end
+
+      private
+
+      def display_all(formats)
+        codes_displayed = 1
+
+        formats.each do |method, complementary_method|
+          print ".#{method}".ljust(col_width).send(method).send(complementary_method)
+
+          codes_displayed += 1
+
+          if codes_displayed * col_width > screen_width
+            puts
+            codes_displayed = 1
+          end
+        end
+      end
+
+      def styles
+        {
+          bold:      :white,
+          faint:     :white,
+          italic:    :white,
+          underline: :white
+        }
+      end
+
+      def fg_colours
+        {
+          black:   :near_black,
+          blue:    :bg_black,
+          cyan:    :bg_black,
+          green:   :bg_black,
+          magenta: :bg_black,
+          red:     :bg_black,
+          white:   :bg_black,
+          yellow:  :bg_black
+        }
+      end
+
+      def bright_colours
+        {
+          bright_black:   :bg_black,
+          bright_blue:    :bg_black,
+          bright_cyan:    :bg_black,
+          bright_green:   :bg_black,
+          bright_magenta: :bg_black,
+          bright_red:     :bg_black,
+          bright_white:   :bg_black,
+          bright_yellow:  :bg_black
+        }
+      end
+
+      def bg_colours
+        {
+          bg_black:   :white,
+          bg_blue:    :black,
+          bg_cyan:    :black,
+          bg_green:   :black,
+          bg_magenta: :black,
+          bg_red:     :black,
+          bg_white:   :black,
+          bg_yellow:  :black
+        }
+      end
+
+      def display_all_ansi_256(method)
+        # Use `Colours::Demo.all_ansi_256` to see colours available
+
+        codes_displayed = 1
+
+        256.times do |code|
+          print ".#{method}(#{code})".ljust(col_width).send(method, code).fg(89)
+
+          codes_displayed += 1
+
+          if codes_displayed * col_width + 2 > screen_width
+            puts
+            codes_displayed = 1
+          end
+        end
+      end
+
+      def col_width
+        @col_width ||= '.bright_magenta  '.length
+      end
+
+      def screen_width
+        @screen_width ||= `tput cols`.to_i
+      end
+
+    end
+
+  end
+end

data/lib/column.rb

@@ -0,0 +1,29 @@
+module TablePal
+  class Column
+
+    attr_reader :table, :left_padding, :right_padding, :left_border, :right_border, :justification, :colour
+
+    def initialize(table:, left_padding: ' ', right_padding: ' ', left_border: '', right_border: '|', justification: :left, colour: nil)
+      @table         = table
+      @left_padding  = left_padding
+      @right_padding = right_padding
+      @left_border   = left_border
+      @right_border  = right_border
+      @justification = justification
+      @colour        = colour
+    end
+
+    def width
+      table.select_cells(column: self).max_by(&:width).width
+    end
+
+    def left_padding_char(char)
+      char * left_padding.length
+    end
+
+    def right_padding_char(char)
+      char * right_padding.length
+    end
+
+  end
+end

data/lib/csv_formatted.rb

@@ -0,0 +1,11 @@
+module TablePal
+  class CSVFormatted
+
+    def initialize(table:)
+      table.rows.each do |row|
+        puts row.cells_including_empty.map(&:formatted).join(',')
+      end
+    end
+
+  end
+end

data/lib/csv_unformatted.rb

@@ -0,0 +1,11 @@
+module TablePal
+  class CSVUnformatted
+
+    def initialize(table:)
+      table.rows.each do |row|
+        puts row.cells_including_empty.map(&:content).join(',')
+      end
+    end
+
+  end
+end

data/lib/formatters.rb

@@ -0,0 +1,7 @@
+module TablePal
+  Dollar             = -> content { format('$%.2f', content) }
+  FourFractionDigits = -> content { format('%.4f', content) }
+  NoFormatting       = -> content { content }
+  Titleize           = -> content { content.titleize }
+  Upper              = -> content { content.upcase }
+end

data/lib/plain_text.rb

@@ -0,0 +1,67 @@
+module TablePal
+  class PlainText
+
+    attr_reader :table
+
+    def initialize(table:)
+      @table = table
+
+      table.rows.each do |row|
+        print_row(row)
+      end
+    end
+
+    private
+
+    def print_row(row)
+      row.cells_including_empty.each do |cell|
+        print_cell(cell)
+      end
+
+      puts
+
+      if row.heading
+        underline
+        empty
+      elsif row.subheading
+        empty
+      end
+    end
+
+    def print_cell(cell)
+      print cell.column.left_border
+      print cell.column.left_padding
+      print cell.formatted(justified: true)
+      print cell.column.right_padding
+      print cell.column.right_border
+    end
+
+    def underline
+      table.columns.map do |column|
+        char = '-'
+        print column.left_border
+        print column.left_padding_char(char)
+        print char * column.width
+        print column.right_padding_char(char)
+        print column.right_border
+      end
+
+      puts
+    end
+
+    def empty
+      row = table.create_row
+
+      row.empty_cells.each do |cell|
+        print cell.column.left_border
+        print cell.column.left_padding
+        print cell.formatted(justified: true)
+        print cell.column.right_padding
+        print cell.column.right_border
+      end
+
+      puts
+    end
+
+  end
+end

data/lib/plain_text_coloured.rb

@@ -0,0 +1,61 @@
+module TablePal
+  class PlainTextColoured
+
+    attr_reader :table
+
+    def initialize(table:)
+      @table = table
+
+      table.rows.each do |row|
+        print_row(row)
+      end
+    end
+
+    private
+
+    def print_row(row)
+      row.cells_including_empty.each do |cell|
+        print_cell(cell)
+      end
+
+      puts
+
+      if row.heading
+        underline
+        empty
+      elsif row.subheading
+        empty
+      end
+    end
+
+    def print_cell(cell)
+      print cell.column.left_border
+      print cell.column.left_padding
+      print cell.formatted(justified: true, coloured: true)
+      print cell.column.right_padding
+      print cell.column.right_border
+    end
+
+    def underline
+      table.columns.map do |column|
+        char = '-'
+        print column.left_border
+        print column.left_padding_char(char)
+        print char * column.width
+        print column.right_padding_char(char)
+        print column.right_border
+      end
+
+      puts
+    end
+
+    def empty
+      table.create_row.empty_cells.each do |cell|
+        print_cell(cell)
+      end
+
+      puts
+    end
+
+  end
+end

data/lib/requires.rb

@@ -0,0 +1,11 @@
+require_relative 'colours'
+require_relative 'table_pal'
+require_relative 'cell'
+require_relative 'column'
+require_relative 'csv_formatted'
+require_relative 'csv_unformatted'
+require_relative 'formatters'
+require_relative 'plain_text'
+require_relative 'plain_text_coloured'
+require_relative 'row'
+require_relative 'table'

data/lib/row.rb

@@ -0,0 +1,44 @@
+module TablePal
+  class Row
+
+    attr_reader :table, :formatter, :heading, :subheading, :justification, :colour
+
+    def initialize(table:, formatter: nil, heading: false, subheading: false, justification: nil, colour: nil)
+      @table         = table
+      @formatter     = formatter
+      @heading       = heading
+      @subheading    = subheading
+      @justification = justification
+      @colour        = colour
+    end
+
+    def cells_including_empty
+      table.columns.map do |column|
+        find_cell(column) || create_cell(column)
+      end
+    end
+
+    def underline_cells
+      table.columns.map do |column|
+        table.create_cell(row: self, column: column, content: '-' * column.width)
+      end
+    end
+
+    def empty_cells
+      table.columns.map do |column|
+        table.create_cell(row: self, column: column)
+      end
+    end
+
+    private
+
+    def find_cell(column)
+      table.find_cell(row: self, column: column)
+    end
+
+    def create_cell(column)
+      table.create_cell(row: self, column: column)
+    end
+
+  end
+end

data/lib/table.rb

@@ -0,0 +1,43 @@
+module TablePal
+  class Table
+
+    attr_reader :rows, :columns, :cells
+
+    def initialize
+      @rows    = []
+      @columns = []
+      @cells   = []
+    end
+
+    def create_row(options = {})
+      Row.new(options.merge(table: self)).tap do |row|
+        @rows << row
+      end
+    end
+
+    def create_underline
+      Row.new(table: self).cells_as_underline
+    end
+
+    def create_column(options = {})
+      Column.new(options.merge(table: self)).tap do |column|
+        @columns << column
+      end
+    end
+
+    def create_cell(options = {})
+      Cell.new(options).tap do |cell|
+        @cells << cell
+      end
+    end
+
+    def find_cell(row:, column:)
+      cells.find { |cell| cell.row == row && cell.column == column }
+    end
+
+    def select_cells(column:)
+      cells.select { |cell| cell.column == column }
+    end
+
+  end
+end

data/lib/table_pal.rb

@@ -0,0 +1,2 @@
+module TablePal
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module TablePal
+  VERSION = '0.1.0'
+end

data/table_pal.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'table_pal'
+  spec.version       = TablePal::VERSION
+  spec.authors       = ['Sean Lerner']
+  spec.email         = ['sean@@smallcity.ca']
+  spec.summary       = 'Aids creating tables'
+  spec.homepage      = 'https://github.com/seanlerner/table_pal'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split.reject { |f| f.match('test') }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'interesting_methods', '~> 0.1'
+  spec.add_development_dependency 'minitest',            '~> 5.12'
+  spec.add_development_dependency 'pry',                 '~> 0.12'
+  spec.add_development_dependency 'rake',                '~> 13.0'
+  spec.add_development_dependency 'rubocop',             '~> 0.71'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: table_pal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Lerner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interesting_methods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+description: 
+email:
+- sean@@smallcity.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/cell.rb
+- lib/colours.rb
+- lib/column.rb
+- lib/csv_formatted.rb
+- lib/csv_unformatted.rb
+- lib/formatters.rb
+- lib/plain_text.rb
+- lib/plain_text_coloured.rb
+- lib/requires.rb
+- lib/row.rb
+- lib/table.rb
+- lib/table_pal.rb
+- lib/version.rb
+- table_pal.gemspec
+homepage: https://github.com/seanlerner/table_pal
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Aids creating tables
+test_files: []