tablesmith 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e676306e2580d63feec58ebd3c104c7b278f5fae
-  data.tar.gz: 7f2ab47bbdaf6f57bbfec225a82ef9bf9b8263f3
+SHA256:
+  metadata.gz: f7a031da03b4834e3512f66e1ee9541826d6dfdd7992d593dbbf686f9b5029d0
+  data.tar.gz: fcca01f815f5b51e31ff1c148e8137edec52a5405e54588216305e50d5ff1a3f
 SHA512:
-  metadata.gz: 4e597fb0ce8ff13bb8861ad85f5e7e649e5c4c9eece9a815c3f1772db569bf656183b5db31b4aa7e74e507833c076865f341638172ea03cdf80d0882e1931471
-  data.tar.gz: 7948c55b4079002e3c48752cf4fa1ddb0ce3dfb8a925430808738925061898b2e74866eb5f0e35a5c4c5549902e61cb80faa4564fbcff9f417b2abbbb570e94b
+  metadata.gz: 0e1360f9d29e4b9439253b5e6e40279842df875daa2d926f30b265ab32531befe69911dbe3f436cf4c99b0d0adb00188180e9aa5578f7b1f48a121a52149c2f6
+  data.tar.gz: e93c2e664a4c3809c557dc173643d9d38bc51c8913252490bbd46065e1a7c877fe54af44d8140a788e6478c083f93542dcf5fb2abaa8585a98cd44da32840a76

data/.gitignore

@@ -1,4 +1,5 @@
 .bundle/
 .idea/
 bin/
-pkg/
+pkg/
+Gemfile.lock

data/.rubocop.yml

@@ -4,8 +4,118 @@ require:
 AllCops:
   TargetRubyVersion: 2.3
 
-Layout/IndentHeredoc:
+Layout/ClassStructure:
   Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+    association:
+      - has_many
+      - has_one
+      - belongs_to
+      - has_and_belongs_to_many
+    validations:
+      - validate
+      - validates_inclusion_of
+      - validates_presence_of
+    callbacks:
+      - before_initialize
+      - before_validation
+      - before_save
+      - before_create
+      - before_update
+      - before_destroy
+      - after_save
+      - after_create
+      - after_validation
+      - after_initialize
+      - after_update
+      - after_destroy
+    enums:
+      - enum
+    scopes:
+      - scope
+  ExpectedOrder:
+    - association
+    - module_inclusion
+    - validations
+    - constants
+    - enums
+    - callbacks
+    - scopes
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Lint/Void:
+  Exclude:
+    - 'spec/**'
+
+Metrics:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'test/**/*.rb'
+  ExcludedMethods: ['included', 'namespace']
+
+Metrics/ClassLength:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/**/*.rb'
+    - 'test/**/*.rb'
+
+Metrics/LineLength:
+  Enabled: false
+  Max: 120
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes: http, https
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15
+
+Rails/Date:
+  Enabled: true
+  EnforcedStyle: flexible
+
+Rails/RefuteMethods:
+  Enabled: true
+
+Rails/TimeZone:
+  Enabled: true
+  EnforcedStyle: flexible
+
+Style/ClassAndModuleChildren:
+  Enabled: false
 
 Style/Documentation:
-  Enabled: false
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: when_needed
+  Enabled: true
+
+# Technically this performs better, and I got no problem with it.
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/WhenThen:
+  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-2.3.4
+2.6.5

data/.travis.yml

@@ -1 +1,22 @@
 language: ruby
+
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.5
+  - 2.7.0
+
+gemfile:
+  - gemfiles/activerecord_4.gemfile
+  - gemfiles/activerecord_5.1.gemfile
+  - gemfiles/activerecord_5.2.gemfile
+  - gemfiles/activerecord_6.0.gemfile
+
+before_install: gem install bundler -v 2.1.2
+
+jobs:
+  exclude:
+    - rvm: 2.4.6
+      gemfile: gemfiles/activerecord_6.0.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/activerecord_4.gemfile

data/Appraisals

@@ -0,0 +1,19 @@
+appraise 'activerecord-4' do
+  gem 'activerecord', '~> 4.0'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+appraise 'activerecord-5.1' do
+  gem 'activerecord', '~> 5.1.0'
+  gem 'sqlite3', '~> 1.4'
+end
+
+appraise 'activerecord-5.2' do
+  gem 'activerecord', '~> 5.2.0'
+  gem 'sqlite3', '~> 1.4'
+end
+
+appraise 'activerecord-6.0' do
+  gem 'activerecord', '~> 6.0.0'
+  gem 'sqlite3', '~> 1.4'
+end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tablesmith.gemspec

data/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://travis-ci.org/livingsocial/tablesmith.svg?branch=master)](https://travis-ci.org/livingsocial/tablesmith)
+
 # Tablesmith
 
-Drop-in gem for console tables for Hash, Array and ActiveRecord.
+Drop-in gem for console tables for Array, Hash, and ActiveRecord.
 
 ## Installation
 
@@ -18,18 +20,117 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### In irb or pry
+
+```
+require 'tablesmith'
+           
+> [[:foo, :bar], [1,3]].to_table                                                                                                                                                                                         
+=> +-----+-----+
+| foo | bar |
++-----+-----+
+| 1   | 3   |
++-----+-----+
+
+> {a: 1, b: 2}.to_table
+=> +---+---+
+| a | b |
++---+---+
+| 1 | 2 |
++---+---+
+   
+> [{date: '1/1/2020', amt: 35}, {date: '1/2/2020', amt: 80}].to_table
+=> +----------+-----+
+|   date   | amt |
++----------+-----+
+| 1/1/2020 | 35  |
+| 1/2/2020 | 80  |
++----------+-----+
+           
+> p1 = Person.create(first_name: 'chrismo', custom_attributes: { instrument: 'piano', style: 'jazz' })    
+=> #<Person:0x00007fac3eb406a8 id: 1, first_name: "chrismo", last_name: nil, age: nil, custom_attributes: {:instrument=>"piano", :style=>"jazz"}>
+> p2 = Person.create(first_name: 'romer', custom_attributes: { hobby: 'games' })    
+=> #<Person:0x00007fac3ebcbb68 id: 2, first_name: "romer", last_name: nil, age: nil, custom_attributes: {:hobby=>"games"}>
+> batch = [p1, p2].to_table    
+=> +----+------------+-----------+-----+--------+------------+--------+
+|              person               |      custom_attributes       |
++----+------------+-----------+-----+--------+------------+--------+
+| id | first_name | last_name | age | hobby  | instrument | style  |
++----+------------+-----------+-----+--------+------------+--------+
+| 1  | chrismo    |           |     |        | piano      | jazz   |
+| 2  | romer      |           |     | games  |            |        |
++----+------------+-----------+-----+--------+------------+--------+
+```
+
+### In a Script
+
+`puts` won't work because of how Kernel#puts has special case code for Arrays.
+Tablesmith::Table subclasses Array, so it can't cope with puts. Try to remember
+to use `print` instead.
+
+```ruby
+require 'tablesmith'
+
+print [{date: '1/1/2020', amt: 35}, {date: '1/2/2020', amt: 80}].to_table 
+```
+
+### CSV Support
+``` 
+> puts [{date: '1/1/2020', amt: 35}, {date: '1/2/2020', amt: 80}].to_table.to_csv
+date,amt
+1/1/2020,35
+1/2/2020,80
+```
+
+### HTML Support
+```
+> puts [{date: '1/1/2020', amt: 35}, {date: '1/2/2020', amt: 80}].to_table.to_html
+<table>
+    <thead>
+    <tr>
+        <th>date</th>
+        <th>amt</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>1/1/2020</td>
+        <td>35</td>
+    </tr>
+    <tr>
+        <td>1/2/2020</td>
+        <td>80</td>
+    </tr>
+    </tbody>
+</table>
+```
+
+## Troubleshooting
+
+If you ever get a default inspection output in a console for a table, an
+exception has likely occurred and been caught by IRB or Pry. Call
+`.to_table.to_s` to see what the exception is.
+
+```
+[1] pry(main)> [1, [2, 3]].to_table
+=> #<Tablesmith::Table:0x3fc083e14294>
+[2] pry(main)> [1, [2, 3]].to_table.to_s
+IndexError: element size differs (2 should be 1)
+from /Users/chrismo/.bundle/ruby/2.6.0/gems/text-table-1.2.4/lib/text-table/table.rb:157:in `transpose'
+```
 
 ## Why Not #{other_gem}?
 
-Happy to learn about something else already out there, but have struggled to find something
-that doesn't require some sort of setup. I want drop-in ready-to-go table output for Hashes,
-Arrays and ActiveRecord objects.
+Happy to learn about something else already out there, but I have struggled to
+find something that doesn't require some sort of setup. I want drop-in
+ready-to-go table output for Arrays, Hashes, and ActiveRecord objects.
 
-Here's a quick list of other gems that I've tried out that are awesome and do much more than what Tablesmith does,
-but don't seem to specialize in what I want:
+Here's a quick list of other gems that I've tried out that are awesome and do
+much more than what Tablesmith does, but don't seem to specialize in what I
+want:
 
-  - Hirb
-  - text-table
-  - table_print
-  - awesome_print
+  - [text-table](https://github.com/aptinio/text-table) _Tablesmith uses text-table underneath_
+  - [Hirb](https://github.com/cldwalker/hirb) _Hirb is cool, and pretty close to what I want_
+  - [table_print](http://tableprintgem.com/)
+  - [awesome_print](https://github.com/awesome-print/awesome_print)
+  - [tabulo](https://github.com/matt-harvey/tabulo)

data/Rakefile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
 
-FileList['tasks/*.rake'].each { |task| load task }
+FileList['tasks/*.rake'].each(&method(:load))
 
-task :default => :spec
+task default: :spec
 
 desc 'Run the specs.'
 RSpec::Core::RakeTask.new do |t|

data/gemfiles/activerecord_4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/activerecord_6.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/lib/tablesmith.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tablesmith/table'
 require 'tablesmith/array_rows_source'
 require 'tablesmith/hash_rows_base'

data/lib/tablesmith/active_record_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tablesmith::ActiveRecordSource
   include Tablesmith::HashRowsBase
 
@@ -37,7 +39,7 @@ module Tablesmith::ActiveRecordSource
       end
 
       include.each do |association, opts|
-        ar_class = first.class.reflections[association].klass
+        ar_class = first.class.reflections[association.to_s].klass
         process_columns(opts, ar_class)
       end
     end
@@ -73,7 +75,7 @@ module Tablesmith::ActiveRecordSource
   def flatten_inner_hashes(hash)
     new_hash = {}
     stack = hash.each_pair.to_a
-    while ary = stack.shift
+    while (ary = stack.shift)
       key, value = ary
       if value.is_a?(Hash)
         value.each_pair do |assoc_key, assoc_value|

data/lib/tablesmith/array_rows_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tablesmith::ArrayRowsSource
   def text_table
     build_columns if columns.nil?
@@ -11,7 +13,7 @@ module Tablesmith::ArrayRowsSource
   # TODO: no support for deep
   def build_columns
     @columns ||= []
-    self.map do |array_row|
+    map do |array_row|
       @columns << array_row.map { |item| Tablesmith::Column.new(name: item) }
     end
     @columns.flatten!

data/lib/tablesmith/hash_rows_base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ActiveRecord and HashRowsSource share a lot, but not everything.
 module Tablesmith::HashRowsBase
   # not all resulting rows will have data in all columns, so make sure all rows pad out missing columns
@@ -8,6 +10,7 @@ module Tablesmith::HashRowsBase
 
   def sort_columns(rows)
     return if column_order.empty?
+
     rows.map! do |row|
       # this sort gives preference to column_order then falls back to alphabetic for leftovers.
       # this is handy when columns auto-generate based on hash data.
@@ -32,4 +35,4 @@ module Tablesmith::HashRowsBase
     column_names = rows.first.map(&:first)
     grouped_headers(column_names) + [apply_column_aliases(column_names), :separator]
   end
-end
+end