table_print 1.5.2 → 1.5.7

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTViMjhhZmQ0MTQ4MjAzOWE2YjY3YmQzYzMyMjNkMmNiYzI5MzFhZg==
-  data.tar.gz: !binary |-
-    M2U2ZGI4ZjA1OTUyOWY1YTY1OGVhY2Q4OWE5NWY3YWJhMWFiNTdkOQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NWRlZGRjZmY5ZWY1OWU0YzYxODdhNmJkMzAwZjdhOGU3MGY2MjhiY2UxZmY3
-    M2Q3OTVmZGMyZDI3MTE0NDJiZjNkZjkxNzM4MjFhMmIzNWIxYWE0NWYwZGY4
-    OGM3ZmU5MzliYmI1M2I2MTg1Y2YxMTcxOTk4ZmY3OTk4NjAxYzQ=
-  data.tar.gz: !binary |-
-    Y2QzYTFiOWQ2ZmQyMTJjZDE3OWQ5ZDQyNzFhOTc2MjI1MjNkZmQ1ZGJhMGMx
-    ZTViYWRlNTI4MTNmMDYzMmYyMDU4OTE5ODQ2ZDRmMzM1Y2NjZDc5NTJiNzI0
-    NzU4OGE2MGQwYTM0ZjRlYjhlODBlYWIyZTU0OTFmYzNkZjdlZWM=
+SHA256:
+  metadata.gz: 4d550bded70ef9a5ae903bdf98d2436d282ef8d89bf760dd65c0a90476131bb4
+  data.tar.gz: 858aee5efcc4d4ce91c0834cf215cb29e4899964d4bc4d3c624c49c9902b592d
+SHA512:
+  metadata.gz: f7980699dada79051fdfbb5611815377eebc3200745c814401ee24955daa7d6d1d2838a72da1f942e9eca64d926974d2d044955067548a3e10b7a1be48c00e4c
+  data.tar.gz: 7f8eb1af627f5efc816d2751be6bc641cdca8ae74aab482e56af936266b83158d6d5eebbadf66cd48a508f974635200c045cfeafc2e8f7ba57dfee20a28cb5ce

data/.travis.yml

@@ -1,12 +1,9 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - ree
 

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec :name => 'table_print'
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Chris Doyle
+Copyright (c) 2012-2016 Chris Doyle
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,6 @@
 = table_print
 
-{<img src="https://travis-ci.org/arches/table_print.png?branch=master" />}[http://travis-ci.org/arches/table_print]
+{<img src="https://travis-ci.org/arches/table_print.svg?branch=master" />}[http://travis-ci.org/arches/table_print]
 {<img src="https://codeclimate.com/github/arches/table_print.png" />}[https://codeclimate.com/github/arches/table_print]
 
 TablePrint shows objects in nicely formatted columns for easy reading. It even lets you nest other tables
@@ -10,13 +10,15 @@ see exactly the data you care about.
 This {three minute screencast}[http://tableprintgem.com] will give you a quick overview of table_print's most
 powerful features and how to use them.
 
+http://arches.io/tp_example.gif
+
 == Installation
 
   # Install as a standalone gem
   $ gem install table_print
 
-  # Install within rails
-  In your Gemfile: gem "table_print", "~> 1.0.0"
+  # Or install within rails
+  In your Gemfile: gem "table_print"
   $ bundle install
 
 == Usage
@@ -36,7 +38,7 @@ You should see something like this:
   AUTHOR            | SUMMARY                         | TITLE
   ------------------|---------------------------------|------------------
   Michael Connelly  | Another book by Michael Con...  | The Fifth Witness
-  Manning Mardale   | From acclaimed historian Ma...  | Malcolm X
+  Manning Marable   | From acclaimed historian Ma...  | Malcolm X
   Tina Fey          | Worth it. -Trees                | Bossypants
 
 TablePrint tries to use sensible defaults to choose the columns to show. If you're inspecting ActiveRecord objects, it
@@ -85,6 +87,8 @@ Available column options:
 * *formatters* - array of objects - each will be called in turn as the cells are printed. Must define a 'format' method. See below.
 * *time_format* - string - passed to strftime[http://www.ruby-doc.org/core-1.9.3/Time.html#method-i-strftime], only affects time columns
 * *width* - integer - how wide you want your column.
+* *display_name* - string - useful if you want spaces in your column name
+* *separator* - string - default is vertical bar for console and markdown, change it to a comma for CSV output
 
 ==== Display method
 
@@ -96,12 +100,16 @@ Columns are named after hash keys. To rename a column, use the name you want as
 
 You can pass a proc as the display_method for a column:
 
-  tp User.all, :email, :monthly_payment, :yearly_payment => lambda{|u| u.monthly_payment * 12}
+  tp User.all, :email, :monthly_payment, yearly_payment: lambda{|u| u.monthly_payment * 12}
 
 Or if you want to pass other options along with the lambda:
 
   tp User.all, :yearly_payment => {:display_method => lambda{|u| u.monthly_payment * 12}, :width => 10}
 
+Make sure to add curly braces if you have more than one column with a lambda or if this column isn't the last one.
+
+  tp User.all, :email, { daily_payment: lambda { |u| u.monthly_payment / 30} }, :monthly_payment, { yearly_payment: lambda { |u| u.monthly_payment * 12} }
+
 ==== Column formatters
 
 Similar to a lambda column, you can use a column formatter to reuse code across prints. Any object with a 'format' method
@@ -115,6 +123,22 @@ can be used to filter a column. This could also be used for coloring output.
 
   tp User.all, :bio => {:formatters => [NoNewlineFormatter.new]} # strip newlines from user bios
 
+=== HTML Output
+
+Currently the best way to show table_print output on an HTML page is using a <pre> tag. You can create a helper
+method to send table_print output directly into your <pre> tag:
+
+  def tp_pre data, options={}
+    content_tag :pre, TablePrint::Printer.new(data, options).table_print
+  end
+
+=== CSV Output
+
+Set the column separator to get an output you can save as a CSV:
+
+  tp.set :separator, ","
+
+Since your CSV viewer probably already handles column widths for you, setting +max_width+ to something very large will help you export your full data set.  Otherwise, this CSV output will still be truncated to the default max_width of 30 characters.
 
 === Config
 
@@ -151,6 +175,15 @@ You can also set global options:
 
   tp.set :max_width, 10 # columns won't exceed 10 characters
   tp.set :time_format, "%Y" # date columns will only show the year
+  tp.set :capitalize_headers, false # don't capitalize column headers
+  
+You can redirect output:
+
+  f = File.open("users.txt", "w")
+  tp.set :io, f
+  tp User.all # written to users.txt instead of STDOUT
+  tp.clear :io
+  tp User.all # writing to STDOUT again
   
 === Multibyte
 

data/features/configuring_output.feature

@@ -13,6 +13,49 @@ Feature: Configuring output
     ------|-----------------------------------------
     post! | Ryan Ryan Ryan Ryan Ryan Ryan Ryan Ry... 
     """
+
+  Scenario: Setting a minimum width for an individual column
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan Ryan'}
+    And table_print Blog, {:include => {:author => {:min_width => 40}}}
+    Then the output should contain
+    """
+    TITLE | AUTHOR
+    ------|-----------------------------------------
+    post! | Ryan Ryan
+    """
+
+  Scenario: Setting a fixed width for an individual column, when data width is greater than fixed width
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan Ryan Ryan Ryan Ryan Ryan Ryan'}
+    And table_print Blog, {:include => {:author => {:fixed_width => 15}}}
+    Then the output should contain
+    """
+    TITLE | AUTHOR
+    ------|----------------
+    post! | Ryan Ryan Ry...
+    """
+
+  Scenario: Setting a fixed width for an individual column, when data width is less than fixed width
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan Ryan'}
+    And table_print Blog, {:include => {:author => {:fixed_width => 15}}}
+    Then the output should contain
+    """
+    TITLE | AUTHOR
+    ------|----------------
+    post! | Ryan Ryan                                
+    """
+
   Scenario: Specifying configuration on a per-object basis
     Given a class named Blog
 
@@ -55,3 +98,33 @@ Feature: Configuring output
     ------
     Ryan
     """
+
+  Scenario: Setting a lowercase column name
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And I configure capitalize_headers with false
+    And table_print Blog, {:author => {:display_name => "Wom Bat"}}
+    Then the output should contain
+    """
+    Wom Bat
+    -------
+    Ryan
+    """
+
+  Scenario: Setting the column separator
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And I configure separator with ','
+    And table_print Blog
+    Then the output should contain
+    """
+    TITLE , AUTHOR
+    ------,-------
+    post! , Ryan
+    """

data/features/support/step_definitions/before.rb

@@ -1,3 +1,5 @@
 Before do
   Sandbox.cleanup!
+  TablePrint::Config.clear(:capitalize_headers)
+  TablePrint::Config.clear(:separator)
 end

data/features/support/step_definitions/steps.rb

@@ -62,6 +62,14 @@ When /^I configure multibyte with (.*)$/ do |value|
   TablePrint::Config.set(:multibyte, [value == "true"])
 end
 
+When /^I configure capitalize_headers with (.*)$/ do |value|
+  TablePrint::Config.set(:capitalize_headers, [value == "true"])
+end
+
+When /^I configure separator with '(.*)'$/ do |value|
+  TablePrint::Config.set(:separator, [value])
+end
+
 When /^configure (.*) with (.*)$/ do |klass, config|
   klass = Sandbox.const_get_from_string(klass)
   TablePrint::Config.set(klass, eval(config))
@@ -79,7 +87,7 @@ When /table_print ([\w\.:]*)$/ do |klass|
 end
 
 Then /^the output should contain$/ do |string|
-  output = @r.lines.to_a
+  output = @r.each_line.to_a
 
   output.zip(string.split("\n")).each do |actual, expected|
     actual.gsub(/\s/m, "").split(//).sort.join.should == expected.gsub(" ", "").split(//).sort.join

data/lib/table_print.rb

@@ -51,7 +51,10 @@ module TablePrint
 
     def message
       return "Printed with config" if configged?
-      Time.now - @start_time
+      (Time.now - @start_time).to_s
+      # the message is used to initiate Returnable
+      # whose argument is regarded in ruby 2.7.1 as string
+      # (ruby 2.7.1 calls ".includes?" method on this argument)
     end
 
     private

data/lib/table_print/column.rb

@@ -1,7 +1,7 @@
 module TablePrint
   class Column
     attr_reader :formatters
-    attr_accessor :name, :data, :time_format, :default_width
+    attr_accessor :name, :data, :time_format, :default_width, :min_width, :fixed_width
 
     def initialize(attr_hash={})
       @formatters = []
@@ -48,7 +48,10 @@ module TablePrint
     end
 
     def width
-      [(default_width || max_width), data_width].min
+      return fixed_width if fixed_width
+
+      width = [(default_width || max_width), data_width].min
+      [(min_width || 0), width].max
     end
 
     private

data/lib/table_print/config.rb

@@ -3,12 +3,16 @@ module TablePrint
 
     DEFAULT_MAX_WIDTH = 30
     DEFAULT_TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
-    DEFAULT_IO = STDOUT
+    DEFAULT_IO = $stdout
+    DEFAULT_CAPITALIZE_HEADERS = true
+    DEFAULT_SEPARATOR = "|"
 
     @@max_width = DEFAULT_MAX_WIDTH
     @@time_format = DEFAULT_TIME_FORMAT
     @@multibyte = false
-    @@io = STDOUT
+    @@io = DEFAULT_IO
+    @@capitalize_headers = true
+    @@separator = DEFAULT_SEPARATOR
 
     @@klasses = {}
 
@@ -57,6 +61,22 @@ module TablePrint
       @@time_format = format
     end
 
+    def self.capitalize_headers
+      @@capitalize_headers
+    end
+
+    def self.capitalize_headers=(caps)
+      @@capitalize_headers = caps
+    end
+
+    def self.separator
+      @@separator
+    end
+
+    def self.separator=(separator)
+      @@separator = separator
+    end
+
     def self.io
       @@io
     end

data/lib/table_print/config_resolver.rb

@@ -73,6 +73,11 @@ module TablePrint
         option[:default_width] = option.delete(:width)
       end
 
+      if option.has_key? :display_name
+        option[:display_method] = option[:name]
+        option[:name] = option.delete(:display_name)
+      end
+
       c = Column.new(option)
       @column_hash[c.name] = c
       c

data/lib/table_print/returnable.rb

@@ -24,6 +24,6 @@ module TablePrint
 
     def inspect
       to_s
-     end
+    end
   end
 end

data/lib/table_print/row_group.rb

@@ -64,7 +64,7 @@ module TablePrint
     def horizontal_separator
       columns.collect do |column|
         '-' * column.width
-      end.join('-|-')
+      end.join("-#{TablePrint::Config.separator}-")
     end
 
     def header
@@ -73,7 +73,10 @@ module TablePrint
         f.format(column.name)
       end
 
-      padded_names.join(" | ").upcase
+      header_string = padded_names.join(" #{TablePrint::Config.separator} ")
+      header_string.upcase! if TablePrint::Config.capitalize_headers
+
+      header_string
     end
 
     def add_formatter(name, formatter)
@@ -174,7 +177,7 @@ module TablePrint
     def format
       column_names = columns.collect(&:name)
 
-      output = [column_names.collect { |name| apply_formatters(name, @cells[name]) }.join(" | ")]
+      output = [column_names.collect { |name| apply_formatters(name, @cells[name]) }.join(" #{TablePrint::Config.separator} ")]
       output.concat @children.collect { |g| g.format }
 
       output.join("\n")
@@ -218,8 +221,8 @@ module TablePrint
       formatters << FixedWidthFormatter.new(column_for(column_name).width)
 
       # successively apply the formatters for a column
-      formatters.inject(value) do |value, formatter|
-        formatter.format(value)
+      formatters.inject(value) do |inner_value, formatter|
+        formatter.format(inner_value)
       end
     end
 

data/lib/table_print/version.rb

@@ -1,4 +1,4 @@
 module TablePrint
-  VERSION = "1.5.2"
+  VERSION = "1.5.7"
 end
 

data/spec/config_resolver_spec.rb

@@ -206,6 +206,14 @@ describe TablePrint::ConfigResolver do
         c.columns.first.formatters.should == [f1, f2]
       end
     end
+    context "display_name" do
+      it "sets the display name on the column" do
+        c = TablePrint::ConfigResolver.new(Object, [], :title => {:display_name => "Ti Tle"})
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'Ti Tle'
+        c.columns.first.display_method.should == "title"
+      end
+    end
   end
 
   describe "#option_to_column" do

data/spec/table_print_spec.rb

@@ -25,8 +25,10 @@ describe TablePrint::Printer do
   end
 
   describe "message" do
-    it "defaults to the time the print took" do
-      Printer.new([]).message.should be_a Numeric
+    it "defaults to the time the print took, but in string" do
+      message = Printer.new([]).message
+      message.should be_a String
+      expect(message.to_f.to_s).to eq(message)
     end
 
     it "shows a warning if the printed objects have config" do

data/table_print.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |gem|
   gem.name                = "table_print"
 
   gem.authors             = ["Chris Doyle"]
-  gem.email               = ["archslide@gmail.com"]
-  gem.email               = "archslide@gmail.com"
+  gem.email               = ["chris@arches.io"]
+  gem.email               = "chris@arches.io"
 
   gem.description         = "TablePrint turns objects into nicely formatted columns for easy reading. Works great in rails console, works on pure ruby objects, autodetects columns, lets you traverse ActiveRecord associations. Simple, powerful."
   gem.summary             = "Turn objects into nicely formatted columns for easy reading"
@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths       = ["lib"]
 
   gem.add_development_dependency 'cat', '~> 0.2.1'
-  gem.add_development_dependency 'cucumber', '~> 1.2.1'
+  gem.add_development_dependency 'cucumber', '~> 2.4.0'
   gem.add_development_dependency 'rspec', '~> 2.11.0'
   gem.add_development_dependency 'rake', '~> 0.9.2'
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: table_print
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.7
 platform: ruby
 authors:
 - Chris Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
 description: TablePrint turns objects into nicely formatted columns for easy reading.
   Works great in rails console, works on pure ruby objects, autodetects columns, lets
   you traverse ActiveRecord associations. Simple, powerful.
-email: archslide@gmail.com
+email: chris@arches.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rspec
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -124,17 +124,16 @@ 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.0.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Turn objects into nicely formatted columns for easy reading