simple-sql 0.5.15 → 0.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d594c256de7bf4157b70be496694616ade42814fb0a1559a67fc893b61cbd2
-  data.tar.gz: e8c200c5a73ea3b64787ab597ea7eb6b8c4a4e9be06416c968eb86654aaf27d9
+  metadata.gz: 10f81f5db33aaa6a5f76d3b22fa5f73cd5327fd6fca0f276b112024db322f852
+  data.tar.gz: 7c4b1301bd7fb1de48957cd1cb1d7b402cabd99ee1d3defb7d9971290168159f
 SHA512:
-  metadata.gz: b4ea4c955d1957d9e774e7aa27f8bc5508014a6ef75090acbe6ba46319e4f443899ae46bad712a11b45aa19a5240d2f68dba8639fa8f8f811e6fd6e3cc796be1
-  data.tar.gz: 7f220c8ec126a72dec5369bd9600f361ee1ecd3e552f437b9d136d36067f6564978402184f488a5289c68a8997ce834490b31019480c9fe1fbe816a5a55c2909
+  metadata.gz: b4a7f2c661bf5751a2d6c06ddf9e261f0327832f236d80ef19da676826899cff721e0bb21e16d8d8bf64019a3006bc11d1720730d3d512fc991c023c464c61ed
+  data.tar.gz: ed8e1227f194bdd687e5329c22dc8406ed076d25d973dc3b7624dca033c0db86ac1c84804cba204b169a20c73d5028d0c3ccd0d2047f321a2b4b966fe9301fb9

data/lib/simple/sql/connection/base.rb

@@ -68,7 +68,7 @@ class Simple::SQL::Connection
       records = all sql, *args, into: Hash
     end
 
-    Simple::SQL::Helpers::Printer.print(records, width: width, io: io)
+    ::Simple::SQL::Helpers::Printer.print(records, width: width, io: io)
     records
   end
 

data/lib/simple/sql/helpers/printer.rb

@@ -1,4 +1,4 @@
-# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
 # private
 module Simple::SQL::Helpers::Printer
@@ -6,30 +6,42 @@ module Simple::SQL::Helpers::Printer
 
   ROW_SEPARATOR = " | "
 
-  def self.print(records, io: STDOUT, width: :auto)
+  def print(records, io: STDOUT, width: :auto)
     # check args
 
     return if records.empty?
-    return if records.first.keys.empty?
 
-    if width == :auto && io.isatty
-      width = `tput cols`.to_i
-    end
+    column_count = records.first.length
+    return if column_count == 0
+
+    # -- determine/adjust total width for output. -----------------------------
+
+    width = terminal_width(io) if width == :auto
     width = nil if width && width <= 0
 
-    # prepare printing
+    # -- prepare printing -----------------------------------------------------
 
     rows = materialize_rows(records)
-    column_widths = calculate_column_widths(rows)
-    column_widths = optimize_column_widths(column_widths, width, rows.first.length) if width
+    column_widths = column_max_lengths(rows)
+    if width
+      column_widths = distribute_column_widths(column_widths, width, column_count, rows.first)
+    end
 
-    # print
+    # -- print ----------------------------------------------------------------
 
     print_records(rows, io, column_widths)
   end
 
   private
 
+  def terminal_width(io)
+    return unless io.isatty
+
+    `tput cols`.to_i
+  rescue Errno::ENOENT
+    nil
+  end
+
   def materialize_rows(records)
     keys = records.first.keys
 
@@ -41,31 +53,75 @@ module Simple::SQL::Helpers::Printer
     rows
   end
 
-  def calculate_column_widths(rows)
+  def column_max_lengths(rows)
     rows.inject([0] * rows.first.length) do |ary, row|
       ary.zip(row.map(&:length)).map(&:max)
     end
   end
 
-  def optimize_column_widths(column_widths, width, column_count)
-    required_width = column_widths.sum + column_count * ROW_SEPARATOR.length
-    overflow = required_width - width
-    return column_widths if overflow <= 0
+  MIN_COLUMN_WIDTH = 7
+
+  def distribute_column_widths(column_widths, total_chars, column_count, title_row)
+    # caluclate available width: this is the number of characters available in
+    # total, reduced by the characters "wasted" for row separators.
+    available_chars = total_chars - (column_count - 1) * ROW_SEPARATOR.length
+
+    return column_widths if available_chars <= 0
+
+    # [TODO] The algorithm below produces ok-ish results - but usually misses a few characters
+    # that could still be assigned a column. To do this we shuld emply D'Hondt or something
+    # similar.
+
+    # -- initial setup --------------------------------------------------------
+    #
+    # We guarantee each column a minimum number of characters of MIN_COLUMN_WIDTH.
+    # If the column does not need that many characters, it will only be allocated
+    # the number of characters that are really necessary.
+    #
+    # If necessary we then extend a column to fit its title.
 
-    # TODO: Use d'hondt with a minimum percentage for a fairer distribution
-    # The following is just a quick hack...
-    overflow += 40
+    result = [MIN_COLUMN_WIDTH] * column_count
+    result = result.zip(column_widths).map(&:min)
+    result = result.zip(title_row).map { |r, title| [r, title.length].max }
+
+    # -- return if there are no more characters available ---------------------
+
+    # This happens if the terminal is **way** to narrow.
+    return column_widths if result.sum > available_chars
+
+    # -- distribute unassigned characters -------------------------------------
+
+    unassigned_widths = column_widths.zip(result).sum { |cw, r| cw - r }
+    if unassigned_widths > 0
+      available_space = available_chars - result.sum
+      if available_space > 0
+
+        result = result.zip(column_widths).map do |r, cw|
+          r + (cw - r) * available_space / unassigned_widths
+        end
+      end
+    end
+
+    # [TODO] We can still have available characters at this point.
+    # unassigned_chars = available_chars - result.sum
+
+    result
+  end
 
-    column_widths.map do |col_width|
-      (col_width - overflow * col_width * 1.0 / required_width).to_i
+  def format_value(value, width)
+    if value.length < width
+      "%-#{width}s" % value
+    elsif value.length == width
+      value
+    else
+      value[0, width - 1] + "…"
     end
   end
 
   def print_records(rows, io, column_widths)
     rows.each_with_index do |row, idx|
       parts = row.zip(column_widths).map do |value, col_width|
-        s = "%-#{col_width}s " % value
-        s[0..col_width]
+        format_value value, col_width
       end
 
       io.puts parts.join(ROW_SEPARATOR)

data/lib/simple/sql/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module SQL
-    VERSION = "0.5.15"
+    VERSION = "0.5.16"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-sql
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.5.16
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_array_parser