tablesmith 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7a031da03b4834e3512f66e1ee9541826d6dfdd7992d593dbbf686f9b5029d0
-  data.tar.gz: fcca01f815f5b51e31ff1c148e8137edec52a5405e54588216305e50d5ff1a3f
+  metadata.gz: e3c75c62ab94384c394373d395134e52bbb21e4e94f8cc94646f450ada1f9678
+  data.tar.gz: 9aa2c83212ca484555bd5f7344e38e0ddc7b603315e2f976ff29e6054bb571bb
 SHA512:
-  metadata.gz: 0e1360f9d29e4b9439253b5e6e40279842df875daa2d926f30b265ab32531befe69911dbe3f436cf4c99b0d0adb00188180e9aa5578f7b1f48a121a52149c2f6
-  data.tar.gz: e93c2e664a4c3809c557dc173643d9d38bc51c8913252490bbd46065e1a7c877fe54af44d8140a788e6478c083f93542dcf5fb2abaa8585a98cd44da32840a76
+  metadata.gz: f0b940e2db92a0941ed25daaf81f501bec3d13964e1769f4d582a2966d76674ab151b6576010929ee2028f01e02e9fbdd10de0e526e7a7c0d26680f31193b1ee
+  data.tar.gz: 949d1f0e968bb9f4c8315508e755ba596736e9cb68dc037f5c06bbce3303e2062ac235e942f32b44a8ca9943b2961a42846270847dab18cb3a1b62a0e3ae32d1

data/.rubocop.yml

@@ -1,6 +1,3 @@
-require:
-- rubocop_lineup
-
 AllCops:
   TargetRubyVersion: 2.3
 
@@ -54,6 +51,9 @@ Layout/ClassStructure:
 Layout/DotPosition:
   EnforcedStyle: trailing
 
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
 Lint/Void:
   Exclude:
     - 'spec/**'
@@ -89,6 +89,9 @@ Metrics/MethodLength:
   CountComments: false  # count full line comments?
   Max: 15
 
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 Rails/Date:
   Enabled: true
   EnforcedStyle: flexible

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'activerecord-4' do
   gem 'activerecord', '~> 4.0'
   gem 'sqlite3', '~> 1.3.6'

data/README.md

@@ -39,13 +39,25 @@ require 'tablesmith'
 | 1 | 2 |
 +---+---+
    
-> [{date: '1/1/2020', amt: 35}, {date: '1/2/2020', amt: 80}].to_table
+> t = [{date: '1/1/2020', amt: 35}, {date: '1/2/2020', amt: 80}].to_table
 => +----------+-----+
 |   date   | amt |
 +----------+-----+
 | 1/1/2020 | 35  |
 | 1/2/2020 | 80  |
 +----------+-----+
+                                    
+> # Table delegates to Array, all Array methods are available.
+> t.select! { |h| h[:amt] > 40 }    
+=> [{:date=>"1/2/2020", :amt=>80}]
+
+> t
+=> +----------+-----+
+|   date   | amt |
++----------+-----+
+| 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"}>

data/Rakefile

@@ -11,3 +11,9 @@ desc 'Run the specs.'
 RSpec::Core::RakeTask.new do |t|
   t.pattern = '*_spec.rb'
 end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :rubocop

data/gemfiles/activerecord_4.gemfile

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

data/gemfiles/activerecord_5.1.gemfile

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

data/gemfiles/activerecord_5.2.gemfile

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

data/gemfiles/activerecord_6.0.gemfile

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

data/lib/tablesmith.rb

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

data/lib/tablesmith/delegated_array_class.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Tablesmith
+  # This adjustment to `DelegateClass(Array)` is necessary to allow calling puts
+  # on a `Tablesmith::Table` and still get the table output, rather than the
+  # default puts output of the underlying `Array`.
+  #
+  # Explaining why requires breaking some things down.
+  #
+  # The implementation of `Kernel::puts` has special code for an `Array`. The
+  # code inside `rb_io_puts` (in io.c) first checks to see if the object passed
+  # to it is a `String`. If not, it then calls `io_puts_ary`, which in turn
+  # calls `rb_check_array_type`. If `rb_check_array_type` confirms the passed
+  # object is an `Array`, then `io_puts_ary` loops over the elements of the
+  # `Array` and passes it to `rb_io_puts`. If the `Array` check fails in the
+  # original `rb_io_puts`, `rb_obj_as_string` is used.
+  #
+  # Early versions of `Tablesmith::Table` subclassed `Array`, but even after
+  # changing `Tablesmith::Table` to use any of the `Delegator` options, the code
+  # in `rb_check_array_type` still detected `Tablesmith::Table` as an `Array`.
+  # How does it do this?
+  #
+  # `rb_check_array_type` calls:
+  #
+  #   `return rb_check_convert_type_with_id(ary, T_ARRAY, "Array", idTo_ary);`
+  #
+  # If a straight up type check fails, then it attempts to convert the object to
+  # an `Array` via the `to_ary` method.
+  #
+  # And wha-lah. We simply need to undefine the `to_ary` method added to
+  # `Tablesmith::Table` by `DelegateClass(Array)` and `rb_io_puts` will no
+  # longer output `Table` as an `Array` and will use its `to_s` method, the same
+  # as `print`.
+  def self.delegated_array_class
+    DelegateClass(Array).tap do |klass|
+      klass.undef_method(:to_ary)
+    end
+  end
+end

data/lib/tablesmith/table.rb

@@ -4,17 +4,30 @@ require 'text-table'
 require 'csv'
 
 module Tablesmith
-  class Table < Array
+  class Table < Tablesmith.delegated_array_class
+    def initialize(array = [])
+      super(array)
+      @array = array
+    end
+
     def method_missing(meth_id, *args)
-      count = 1
-      map do |t|
-        $stderr.print '.' if (count.divmod(100)[1]).zero?
-        count += 1
-        t.send(meth_id, *args)
-      end
+      # In order to support `Kernel::puts` of a `Table`, we need to ignore
+      # `to_ary` calls here as well. See comments on `delegated_array_class`.
+      #
+      # While `DelegatorClass(Array)` proactively defines methods on `Table`
+      # that come from `Array`, it _also_ will pass calls through method_missing
+      # to the target object if it says it will respond to it.
+      #
+      # It seems a little redundant, but it is what it is, and so we must also
+      # cut off calls to `to_ary` in both places.
+      return nil if meth_id.to_sym == :to_ary
+
+      super
     end
 
-    def respond_to_missing?
+    def respond_to_missing?(meth_id, _include_all)
+      return false if meth_id.to_sym == :to_ary
+
       super
     end
 
@@ -118,9 +131,7 @@ module Tablesmith
       else
         row = []
         # this relies on Ruby versions where hash retains add order
-        groups.each_pair do |name, span|
-          row << { value: name, align: :center, colspan: span }
-        end
+        groups.each { |name, span| row << {value: name, align: :center, colspan: span} }
         [row, :separator]
       end
     end

data/lib/tablesmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tablesmith
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/array_table_spec.rb

@@ -14,7 +14,7 @@ describe 'Array Source' do
     [%w[a b c], %w[d e f]].to_table.to_s.should == expected
   end
 
-  def do_just_works_test(_expected, meth_id)
+  def do_just_works_test(meth_id)
     orig_stdout = $stdout
     sio = StringIO.new
     $stdout = sio
@@ -33,7 +33,7 @@ describe 'Array Source' do
       +---+---+---+
     TABLE
 
-    actual = do_just_works_test(expected, meth_id)
+    actual = do_just_works_test(meth_id)
     actual.should == expected
   end
 
@@ -42,14 +42,22 @@ describe 'Array Source' do
   end
 
   it 'just works with puts' do
-    pending
-
-    # Kernel.puts has special behavior for puts with Array,
-    # which Table subclasses, so this isn't going to work,
-    # unless we can stop subclassing Array.
     just_works(:puts)
   end
 
+  it 'just works with p' do
+    expected = <<~TABLE
+      +---+---+---+
+      | a | b | c |
+      +---+---+---+
+      | d | e | f |
+      +---+---+---+
+    TABLE
+
+    actual = do_just_works_test(:p)
+    actual.should == "#{expected}\n"
+  end
+
   it 'just works with inspect' do
     expected = <<~TABLE
       +---+---+---+

data/spec/table_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 include Tablesmith # rubocop:disable Style/MixinUsage:
 
 describe Table do
-  it 'should subclass array' do
+  it 'should delegate to the internal array' do
     b = Table.new
     b.length.should == 0
     b << 1
@@ -15,12 +15,17 @@ describe Table do
     b.class.should == Table
   end
 
-  it 'should pass unmatched Array messages to all items' do
+  it 'should no longer pass unmatched Array messages to all items' do
+    # earlier pre-1.0 versions implemented method_missing in order to provide
+    # syntactic sugar for calling map on the underlying Array. But as time went
+    # on, it felt too heavy-handed and not worth it.
+
     b = Table.new
     b.length.should == 0
     b << 1
     b << '2'
-    b.to_i.should == [1, 2]
+    b.map(&:to_i).should == [1, 2]
+    -> { b.to_i }.should raise_error(NoMethodError)
   end
 
   it 'should handle empty Array' do
@@ -29,7 +34,7 @@ describe Table do
       | (empty) |
       +---------+
     TEXT
-    [].to_table.text_table.to_s.should == expected
+    [].to_table.to_s.should == expected
   end
 
   it 'should handle a simple two row Array' do
@@ -42,7 +47,7 @@ describe Table do
       | d | e | f |
       +---+---+---+
     TABLE
-    actual.to_table.text_table.to_s.should == expected
+    actual.to_table.to_s.should == expected
   end
 
   it 'should output csv' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablesmith
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - chrismo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text-table
@@ -190,6 +190,7 @@ files:
 - lib/tablesmith.rb
 - lib/tablesmith/active_record_source.rb
 - lib/tablesmith/array_rows_source.rb
+- lib/tablesmith/delegated_array_class.rb
 - lib/tablesmith/hash_rows_base.rb
 - lib/tablesmith/hash_rows_source.rb
 - lib/tablesmith/html_formatter.rb