console_table 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d6584806bd70be8c861b3f31cab09d40dd7aaea
+  data.tar.gz: b14fa23bff85071edfb100410e7058935837aec5
+SHA512:
+  metadata.gz: 4b325157fe823b192c90a2f55966e79f3540a446bc903776221fea12a201d10abe2f72ced458be2f4ec92f1ba7f82cb61afa2f073b9db9ee1c1e77322b797b8d
+  data.tar.gz: 533d3190d9c667094541be8a7dd3bf1092253932491da7c382ed0b02c86452bf08d4a2bd7be68e256a2c5fb87730b68219dcdf5903003313fb9e9fc53980dd3a

data/.gitignore

@@ -0,0 +1,26 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rod Hilton
+
+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,29 @@
+# ConsoleTable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'console_table'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install console_table
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/console_table/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 new Pull Request

data/Rakefile

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

data/console_table.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'console_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "console_table"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Rod Hilton"]
+  spec.email         = ["consoletable@rodhilton.com"]
+  spec.summary       = %q{Simplifies printing tables of information to commandline consoles}
+  spec.description   = %q{Allows developers to define tables with specifically-sized columns, which can then have entries printed to them that are automatically formatted, truncated, and padded to fit in the console window.}
+  spec.homepage      = "https://github.com/rodhilton/console_table"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'rake', '~> 0'
+
+  spec.add_runtime_dependency 'colorize', '~> 0.7'
+end

data/lib/console_table.rb

@@ -0,0 +1,228 @@
+class ConsoleTable
+  
+  def self.define(layout, options, &block)
+    table = ConsoleTable.new(layout, options)
+    table.print_header()
+    block.call(table)
+    table.print_footer()
+  end
+
+  def initialize(column_layout, options={})
+    @original_column_layout = column_layout
+    @left_margin = options[:left_margin] || 0
+    @right_margin = options[:right_margin] || 0
+
+    @count = 0
+
+    @title = options[:title]
+
+    @footer_lines = []
+
+    calc_column_widths()
+    @headings_printed = false
+
+    Signal.trap('SIGWINCH', proc { calc_column_widths() })
+  end
+
+  def print_header()
+    $stdout.print " " * @left_margin
+    $stdout.print "=" * @working_width
+    $stdout.print "\n"
+
+    if not @title.nil? and @title.length <= @working_width
+      $stdout.print " "*@left_margin
+      left_side = (@working_width - @title.uncolorize.length)/2
+      right_side = (@working_width - @title.uncolorize.length) - left_side
+      $stdout.print " "*left_side
+      $stdout.print @title
+      $stdout.print " "*right_side
+      $stdout.print "\n"
+    end
+  end
+
+  def print_headings()
+    @headings_printed = true
+    $stdout.print " "*@left_margin
+
+    @column_widths.each_with_index do |column, i|
+      justify = column[:justify] || :left
+      title = column[:title].strip
+      $stdout.print format(column[:size], title, false, justify).bold
+      $stdout.print " " if i < @column_widths.size-1
+    end
+    $stdout.print "\n"
+
+    $stdout.print " " * @left_margin
+    $stdout.print "-" * @working_width
+    $stdout.print "\n"
+  end
+
+  def add_footer(line)
+    lines = line.split("\n")
+    lines.each do |l|
+      @footer_lines << l.strip unless l.nil? or l.uncolorize.strip.blank?
+    end
+  end
+
+  def print_footer()
+    should_print_footer = @footer_lines.length > 0 && @footer_lines.any?{|l| l.uncolorize.length <= @working_width}
+
+    if(should_print_footer)
+      $stdout.print " " * @left_margin
+      $stdout.print "-" * @working_width
+      $stdout.print "\n"
+    end
+
+    @footer_lines.each do |line|
+      if line.uncolorize.length <= @working_width
+        $stdout.print " " * @left_margin
+        $stdout.print " " * (@working_width - line.uncolorize.length)
+        $stdout.print line
+        $stdout.print "\n"
+      end
+    end
+
+    $stdout.print " " * @left_margin
+    $stdout.print "=" * @working_width
+    $stdout.print "\n"
+  end
+
+  def print_plain(to_print)
+    $stdout.print " "*@left_margin
+
+    if to_print.is_a? String
+      $stdout.print format(@working_width, normalize(to_print))
+    elsif to_print.is_a? Hash
+      color = to_print[:color] || :default
+      background = to_print[:background] || :default
+      text = normalize(to_print[:text]) || ""
+      ellipsize = to_print[:ellipsize] || false
+      justify = to_print[:justify] || :left
+      mode = to_print[:mode] || :default
+
+      formatted=format(@working_width, text, ellipsize, justify).colorize(:color=>color, :background=>background, :mode=>mode)
+      $stdout.print formatted
+    end
+
+    $stdout.print "\n"
+  end
+
+  def print(options)
+    print_headings unless @headings_printed
+
+    $stdout.print " "*@left_margin
+    #column order is set, so go through each column and look up values in the incoming options
+    @column_widths.each_with_index do |column, i|
+      to_print = options[column[:key]] || ""
+      justify = column[:justify] || :left
+      if to_print.is_a? String
+        $stdout.print format(column[:size], normalize(to_print), false, justify)
+      elsif to_print.is_a? Hash
+        color = to_print[:color] || :default
+        background = to_print[:background] || :default
+        text = normalize(to_print[:text]) || ""
+        ellipsize = to_print[:ellipsize] || false
+        highlight = to_print[:highlight]
+        justify = to_print[:justify] || justify #can override
+        mode = to_print[:mode] || :default
+
+        formatted=format(column[:size], text, ellipsize, justify).colorize(:color=>color, :background=>background, :mode=>mode)
+
+        unless(to_print[:highlight].nil?)
+          highlight_regex = to_print[:highlight][:regex] || /wontbefoundbecauseit'sgobbledygookblahblahblahbah/
+          highlight_color = to_print[:highlight][:color] || :blue
+          highlight_background = to_print[:highlight][:background] || :default
+
+          formatted = formatted.gsub(highlight_regex, '\0'.colorize(:color=>highlight_color, :background=>highlight_background))
+        end
+
+        $stdout.print formatted
+      else
+        $stdout.print format(column[:size], normalize(to_print.to_s))
+      end
+
+      $stdout.print " " if i < @column_widths.size-1
+    end
+    $stdout.print "\n"
+
+    @count = @count + 1
+  end
+
+  private
+  def normalize(string)
+    if (string.nil?)
+      nil
+    else
+      string.to_s.gsub(/\s+/, " ").strip #Primarily to remove any tabs or newlines
+    end
+  end
+
+  def calc_column_widths()
+    @column_widths = []
+
+    begin
+      total_width = TermInfo.screen_columns
+    rescue => ex
+      total_width = ENV["COLUMNS"].to_i || 150
+    end
+
+    num_spacers = @original_column_layout.length - 1
+    set_sizes = @original_column_layout.collect{|x| x[:size]}.find_all{|x| x.is_a? Integer}
+    used_up = set_sizes.inject(:+) || 0
+    available = total_width - used_up - @left_margin - @right_margin - num_spacers
+
+    if(available <= 0)
+      $stderr.puts "ConsoleTable configuration invalid, current window is too small to display required sizes"
+      Kernel.exit(-1)
+    end
+
+    percentages = @original_column_layout.collect{|x| x[:size]}.find_all{|x| x.is_a? Float}
+    percent_used = percentages.inject(:+) || 0
+
+    if(percent_used > 1.0)
+      $stderr.puts "ConsoleTable configuration invalid, percentages total value greater than 100%"
+      Kernel.exit(-1)
+    end
+
+    percent_available = 1 - percent_used
+    stars = @original_column_layout.collect{|x| x[:size]}.find_all{|x| x.is_a? String}
+    num_stars = stars.length || 1
+    percent_for_stars = percent_available / num_stars
+
+    @original_column_layout.each do |column_config|
+      if column_config[:size].is_a? Integer
+        @column_widths << column_config #As-is when integer
+      elsif column_config[:size].is_a? Float
+        @column_widths << column_config.merge({:size=> (column_config[:size]*available).floor })
+      elsif column_config[:size].is_a?(String) && column_config[:size] == "*"
+        @column_widths << column_config.merge({:size=> (percent_for_stars*available).floor })
+      else
+        $stderr.puts "ConsoleTable configuration invalid, '#{column_config[:size]}' is not a valid size"
+        Kernel.exit(-1)
+      end
+    end
+
+    @working_width = (@column_widths.inject(0) {|res, c| res+c[:size]}) + @column_widths.length - 1
+  end
+
+  def format(length, text, ellipsize=false, justify=:left)
+    if text.length > length
+      if(ellipsize)
+        text[0, length-3] + '...'
+      else
+        text[0, length]
+      end
+    else
+      if justify == :right
+        (" "*(length-text.length)) + text
+      elsif justify == :center
+        space = length-text.length
+        left_side = space/2
+        right_side = space - left_side
+        (" " * left_side) + text + (" "*right_side)
+      else #assume left
+        text + (" "*(length-text.length))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: console_table
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Rod Hilton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Allows developers to define tables with specifically-sized columns, which
+  can then have entries printed to them that are automatically formatted, truncated,
+  and padded to fit in the console window.
+email:
+- consoletable@rodhilton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- console_table.gemspec
+- lib/console_table.rb
+homepage: https://github.com/rodhilton/console_table
+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: Simplifies printing tables of information to commandline consoles
+test_files: []