table_puts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39cd50a5295a935701a614576d76a68c0190df8f
+  data.tar.gz: 82837ec0ae6cf45a7262ae47c7022084a02ae97e
+SHA512:
+  metadata.gz: 7a48a404a9e4cdbc03997648bb92b59591b172761cdce18b767fcdefb7237012dca804238732333dab93d8cdebf2bf812eaa1f7dec4a484a9419c0e690c619db
+  data.tar.gz: c085e01e392e6eb961b5379bfd6deb4ed3d37f44b92c4968d141b7b2b4869e30b34e515f6a04840ebd685caa4cece60471fe0ad9805a092a118354a87fa9c316

data/lib/helpers/configuration.rb

@@ -0,0 +1,28 @@
+# from https://www.viget.com/articles/easy-gem-configuration-variables-with-defaults
+
+module Configuration
+
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/table_puts.rb

@@ -0,0 +1,35 @@
+module TablePuts
+  require 'helpers/configuration'
+  require 'table_puts/printer'
+  require 'csv'
+  extend Configuration
+
+  # Set defaults for column width
+  #
+  # Can be changed by doing:
+  # TablePuts.configuration do |config|
+  #   config.min_column_width = 10
+  # end
+  define_setting(:min_column_width, 0)
+  define_setting(:max_column_width, 20)
+
+  # Takes in data in the form of an array of hashes all with the same keys
+  # and prints a nice looking table
+  def self.call(data, min_width: self.min_column_width, max_width: self.max_column_width)
+    Printer.new(data, min_width, max_width).call
+  end
+
+  # Takes in the file path of a CSV and prints a nice looking table
+  def self.csv(path, min_width: self.min_column_width, max_width: self.max_column_width)
+    Printer.new(read_csv(path), min_width, max_width).call
+  end
+
+  private
+
+  # Transforms CSV into an array of hashes
+  def self.read_csv(path)
+    csv_data = CSV.open(path).read
+    keys = csv_data.shift
+    csv_data.map { |items| items.map.with_index { |item, i| [keys[i], item] }.to_h }
+  end
+end

data/lib/table_puts/printer.rb

@@ -0,0 +1,97 @@
+class TablePuts::Printer
+  attr_reader :data, :transposed, :min_width, :max_width
+
+  def initialize(data, min_width, max_width)
+    @data = data
+    @transposed = transpose_data
+    @min_width = min_width
+    @max_width = max_width
+    check_widths(min_width, max_width)
+  end
+
+  def call
+    puts break_string
+    puts header
+    puts break_string
+    puts rows
+    puts break_string
+  end
+
+  # Transforms data into a single hash with each value containing an array of
+  # the values from each hash - for example:
+  #
+  # [ { x: 1, y: 2 }, { x: 3 }, { y: 4 } ]
+  # becomes
+  # { x: [1, 3], y: [2, 4] }
+  #
+  def transpose_data
+    transposed_data = {}
+    data.first.keys.map { |key| transposed_data[key] = [] }
+
+    data.each do |hash|
+      hash.each do |key,value|
+        transposed_data[key] << value
+      end
+    end
+    transposed_data
+  end
+
+  def header
+    transposed.keys.map.with_index do |key, i|
+      key_string = abbreviate(key.to_s).ljust(column_widths[i])
+
+      "| #{ key_string } "
+    end.join + "|"
+  end
+
+  def rows
+    justification = calculate_column_justification
+    data.map do |row|
+      row.map.with_index do |(key, value), i|
+        justify = "#{ justification[i] }just".to_sym
+        value_string = abbreviate(value.to_s).send(justify, (column_widths[i]))
+
+        "| #{ value_string } "
+      end.join + "|"
+    end
+  end
+
+  def break_string
+    @break_string ||= column_widths.map { |size| "+-#{ '-'*size }-" }.join + "+"
+  end
+
+  # An array of how many characters wide each column should be
+  #
+  # You can set a minimum and maximum width for all columns
+  # by passing in min_width and max_width
+  def column_widths
+    @column_widths ||= transposed.map do |value_array|
+      largest_width_in_column = value_array.flatten.map { |entry| entry.to_s.length }.max
+      [[largest_width_in_column, max_width].min, min_width].max
+    end
+  end
+
+  # Computes how we should justify the values in each column
+  #
+  # If all values in a column contain a number or are nil, then we right justify
+  # Otherwise, left justify
+  #
+  # Returns an array of 'r's and 'l's for each column
+  def calculate_column_justification
+    transposed.map do |(key, values)|
+      values.all? { |entry| entry.to_s.match(/\d/) || entry.nil? } ? 'r' : 'l'
+    end
+  end
+
+  def abbreviate(string)
+    string == string[0...max_width] ? string : string[0...max_width-3] + "..."
+  end
+
+  def check_widths(min, max)
+    if min > max
+      puts "WARNING: max_width is greater than min_width"
+      puts "         This may cause unexpected output"
+      puts "         min_width: #{ min_width }\tmax_width: #{ max_width }"
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: table_puts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Fauver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-15 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: ryan.fauver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/helpers/configuration.rb
+- lib/table_puts.rb
+- lib/table_puts/printer.rb
+homepage: https://github.com/rfauver/TablePuts
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Print nice tables in a ruby console
+test_files: []