tty-table 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5a7d889fe3c0a30613340ff98741bdf6fe60e59
-  data.tar.gz: 41477fe8e7edddf80275eb253c5505efcde49b1b
+SHA256:
+  metadata.gz: 7e62b5af0c89b3acf1aa73598053bc5b5f364d9f346fc40e20129d2a639c3919
+  data.tar.gz: 812b92b6eccf2743f121bfd85c069f833e0e3d80507526a8c1cabfacb776df15
 SHA512:
-  metadata.gz: 28d1f65541cd25ba4dab63f85cdc66294a67e485ca88424ddf0386824b2a28744d2b5143c0880a7eb6d7ba51597a85d4df3c5bf824285f782961c6964d39c6fc
-  data.tar.gz: 30e29bacb151c98f5cb41f0b09a53ac3cb53e1cbb030493362713522d7ffc7f2fce6a8cca00edde189e940626cf6848614394365f55af3dd34c5b5b1ff88f651
+  metadata.gz: bdc6608e3633b35eaed9481e545732c6d55f9ec43823ca111b08b177edb03046e1710221d36e7e4b6df8980d8555ebfecfdfc07535786199ae04f37e18423228
+  data.tar.gz: 1a77ffd2f0ef11427c5bb4769edb6ec41f691f0226f6f216c3988abd19519ce5ab84685de4b90d7a2f590023b3fedde2a075a4b80f7992b74a6160be909280a6

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## [v0.11.0] - 2019-08-01
+
+### Add
+* Add ability to specify border separator as an Array, Proc value by Mitch VanDuyn(@catmando)
+
+### Changed
+* Change Indentation#indent to stop mutating input
+* Change gemspec to load files directly
+* Change to freeze strings
+* Change to relax constraints on tty-screen & equatable
+* Change to remove upper boundary on bundler dev dependency
+
 ## [v0.10.0] - 2018-02-18
 
 ### Changed
@@ -91,6 +103,7 @@
 
 * Initial implementation and release
 
+[v0.11.0]: https://github.com/piotrmurach/tty-table/compare/v0.10.0...v0.11.0
 [v0.10.0]: https://github.com/piotrmurach/tty-table/compare/v0.9.0...v0.10.0
 [v0.9.0]: https://github.com/piotrmurach/tty-table/compare/v0.8.0...v0.9.0
 [v0.8.0]: https://github.com/piotrmurach/tty-table/compare/v0.7.0...v0.8.0

data/README.md

@@ -1,4 +1,9 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/blob/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::Table [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
 [![Gem Version](https://badge.fury.io/rb/tty-table.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty-table.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/8fxrbawbyomqd979?svg=true)][appveyor]
@@ -152,7 +157,7 @@ table.each_with_index  { |row, index| ... }    # iterate over rows with an index
 
 ### 2.3 Access
 
-In order to referene the row at `index` do:
+In order to reference the row at `index` do:
 
 ```ruby
 table = TTY::Table.new [['a1','a2'], ['b1','b2']]
@@ -520,7 +525,7 @@ table.render_with MyBorder
 
 #### 3.5.3 Separator
 
-In addition to specifying border characters you can force table to render separator line on each row like:
+In addition to specifying border characters you can force the table to render a separator line on each row like:
 
 ```ruby
 table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2']]
@@ -537,6 +542,65 @@ end
 #  +-------+-------+
 ```
 
+If you want more control you can provide an array of rows *after* which a separator will be added:
+
+```ruby
+table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2'], ['c1', 'c2']]
+table.render do |renderer|
+  renderer.border.separator = [0, 2]
+end
+# =>
+#  +-------+-------+
+#  |header1|header2|
+#  +-------+-------+
+#  |a1     |a2     |
+#  |b1     |b2     |
+#  +-------+-------+
+#  |c1     |c2     |
+#  +-------+-------+
+```
+
+**Note:** if you supply a detailed list of rows to separate, then the separator between the header and the rows
+will not be automatically added.
+
+You can also give the separator option a proc to control where the separators are:
+
+```ruby
+table = TTY::Table.new ['header1', 'header2'],
+                       [['a1', 'a2'], ['b1', 'b2'], ['c1', 'c2'], ['d1', 'd2']]
+table.render do |renderer|
+  renderer.border.separator = ->(row) { row == 0 || (row+1) % 2 == 0} # separate every two rows
+end
+# =>
+#  +-------+-------+
+#  |header1|header2|
+#  +-------+-------+
+#  |a1     |a2     |
+#  |b1     |b2     |
+#  +-------+-------+
+#  |c1     |c2     |
+#  |d1     |d2     |
+#  +-------+-------+
+```
+
+Finally you can also position a separator using the `:separator` key word in place of a row:
+
+```ruby
+table = TTY::Table.new ['header1', 'header2'],
+                       [:separator, ['a1', 'a2'], ['b1', 'b2']]
+table << :separator << ['c1', 'c2']  # you can push separators on too!
+table.render
+# =>
+#  +-------+-------+
+#  |header1|header2|
+#  +-------+-------+
+#  |a1     |a2     |
+#  |b1     |b2     |
+#  +-------+-------+
+#  |c1     |c2     |
+#  +-------+-------+
+```
+
 #### 3.5.4 Style
 
 If you want to change the display color of your border do:
@@ -710,4 +774,4 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 
 ## Copyright
 
-Copyright (c) 2015-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -6,3 +6,5 @@ FileList['tasks/**/*.rake'].each(&method(:import))
 
 desc 'Run all specs'
 task ci: %w[ spec ]
+
+task default: :spec

data/lib/tty-table.rb

@@ -1,4 +1 @@
-# encoding: utf-8
-
-require_relative 'tty/table/version'
 require_relative 'tty/table'

data/lib/tty/table.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'equatable'
 require 'forwardable'
@@ -11,6 +11,7 @@ require_relative 'table/row'
 require_relative 'table/renderer'
 require_relative 'table/transformation'
 require_relative 'table/validatable'
+require_relative 'table/version'
 
 module TTY
   # A core class intended for storing data in a structured, tabular form.
@@ -37,21 +38,21 @@ module TTY
 
     # The table orientation out of :horizontal and :vertical
     #
-    # @reutrn [TTY::Table::Orientation]
+    # @return [TTY::Table::Orientation]
     #
     # @api public
     attr_reader :orientation
 
     # The table original row count
     #
-    # @reutrn [Integer]
+    # @return [Integer]
     #
     # @api public
     attr_reader :original_rows
 
     # The table original column count
     #
-    # @reutrn [Integer]
+    # @return [Integer]
     #
     # @api public
     attr_reader :original_columns
@@ -86,7 +87,7 @@ module TTY
     # @example of parameters passed as hash
     #   Table.new [{'Header1' => ['a1','a2'], 'Header2' => ['b1', 'b2'] }]}
     #
-    # @param [Array[Symbol], Hash] *args
+    # @param [Array[Symbol], Hash] args
     #
     # @api public
     def self.new(*args, &block)
@@ -126,6 +127,15 @@ module TTY
       yield_or_eval(&block) if block_given?
     end
 
+    # Provides a list of rows to have separations applied
+    #
+    # @return [Array]
+    #
+    # @api public
+    def separators
+      @separators ||= []
+    end
+
     # Provides access to all table data
     #
     # @return [Array]
@@ -285,9 +295,13 @@ module TTY
     #
     # @api public
     def <<(row)
-      rows_copy = rows.dup
-      assert_row_sizes rows_copy << row
-      rows << to_row(row)
+      if row == Border::SEPARATOR
+        separators << columns_size - (header ? 0 : 2)
+      else
+        rows_copy = rows.dup
+        assert_row_sizes rows_copy << row
+        rows << to_row(row)
+      end
       self
     end
 
@@ -428,10 +442,12 @@ module TTY
 
     # Render a given table using custom border class.
     #
-    # @param [TTY::Table::Border]
+    # @param [TTY::Table::Border] border_class
     #
     # @param [Symbol] renderer_type
     #
+    # @param [Hash] options
+    #
     # @yield [renderer]
     #
     # @yieldparam [TTY::Table::Renderer] renderer
@@ -456,15 +472,22 @@ module TTY
     # This coercion mechanism is used by Table to handle Enumerable types
     # and force them into array type.
     #
-    # @param [Enumerable] object
+    # @param [Enumerable] rows
     #    the object to coerce
     #
     # @return [Array]
     #
     # @api public
     def coerce(rows)
-      rows = @converter.convert(rows).to(:array)
-      rows.map { |row| to_row(row, header) }
+      coerced_rows = []
+      @converter.convert(rows).to(:array).each do |row|
+        if row == Border::SEPARATOR
+          separators << coerced_rows.length - (header ? 0 : 1)
+        else
+          coerced_rows << to_row(row, header)
+        end
+      end
+      coerced_rows
     end
 
     private

data/lib/tty/table/alignment_set.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'necromancer'
 
@@ -39,7 +39,7 @@ module TTY
 
       # Lookup an alignment by index
       #
-      # @param [Integer]
+      # @param [Integer] index
       #
       # @return [Symbol] alignment
       #

data/lib/tty/table/border.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'equatable'
 require 'pastel'
@@ -22,6 +22,9 @@ module TTY
       # Represent a separtor on each row
       EACH_ROW = :each_row
 
+      # specify a separator as a row
+      SEPARATOR = :separator
+
       class << self
         # Store characters for border
         #
@@ -138,7 +141,7 @@ module TTY
       #
       # @param [Symbol] color
       #
-      # @param [Array[String]] array of strings
+      # @param [Array[String]] strings array of strings
       #
       # @return [Array[String]]
       #
@@ -188,7 +191,7 @@ module TTY
       # @param [TTY::Table::Row] row
       #   the table row
       #
-      # @param [Integer] line
+      # @param [Integer] line_index
       #  the index for current line inside multiline
       #
       # @param [TTY::Table::Border::RowLine] line

data/lib/tty/table/border/ascii.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../border'
 

data/lib/tty/table/border/null.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../border'
 
@@ -23,7 +23,8 @@ module TTY
         #
         # @api private
         def separator
-          return [] if border_options.separator == EACH_ROW
+          return [] if border_options.separator # == EACH_ROW #TODO ask about this looks broken.
+          # how could border_options ever be nil, if we just did border_options.separator
           border_options ? super : nil
         end
 

data/lib/tty/table/border/row_line.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table

data/lib/tty/table/border/unicode.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-#require 'tty/table/border'
 require_relative '../border'
 
 module TTY

data/lib/tty/table/border_dsl.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'forwardable'
 
@@ -37,7 +37,7 @@ module TTY
 
       # Apply style color to the border
       #
-      # @param [Symbol] style
+      # @param [Symbol] value
       #   the style color for the border
       #
       # @return [undefined]
@@ -50,7 +50,7 @@ module TTY
 
       # Apply table tuple separator
       #
-      # @param [Symbol] separator
+      # @param [Symbol] value
       #   the table tuple separator
       #
       # @return [undefined]

data/lib/tty/table/border_options.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table
@@ -48,6 +48,26 @@ module TTY
         end
         hash
       end
+
+      # return true if there should be a separator AFTER this line
+      #
+      # @param [Integer] line
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def separator?(line)
+        case separator
+        when TTY::Table::Border::EACH_ROW
+          true
+        when Array
+          separator.include?(line)
+        when Proc
+          separator.call(line)
+        else
+          false
+        end
+      end
     end # BorderOptions
   end # Table
 end # TTY

data/lib/tty/table/column_constraint.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'border/null'
 require_relative 'columns'

data/lib/tty/table/columns.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require_relative 'error'

data/lib/tty/table/empty.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTY
   class Table
     class Empty < TTY::Table

data/lib/tty/table/error.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table

data/lib/tty/table/field.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'equatable'
 require 'pastel'

data/lib/tty/table/header.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'forwardable'