nazar 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f577a21e50d8bf8606ed8e8bf115a2c2fb0909b2ee7c1fae72fb4ef871064d0
-  data.tar.gz: '0609ff110d8ce48f3df2fd297ccd02e047d6730985b2698f9592c8f68e39df1b'
+  metadata.gz: 29342461f59fd102beeb9253deb00b6f54086d855a2a62a11c1e108933f72600
+  data.tar.gz: 758f662b5a103a244beea03963ebb79d658ae6e076874cba2cadea66c14869df
 SHA512:
-  metadata.gz: fbf98c584b508c82a19e69730403dda91e54b3f5d6c6a833ba535149591647445c14222b4bda7440090565c5b97a5e777c0b33d331c6a90194b3f32ac5962d03
-  data.tar.gz: da49a17743f2676d1178eb76df8e17c93752f6ad4d22dbe6195398a59f34ec4121315ffb4007c87ee704ed2d9fc4507fd9d9ac87ef72fbafb98eb933f8e1725d
+  metadata.gz: d0fcbdca62c72558c2ae5278efc603dbe30ef4a08ea7966a198a4f53ce58227cec71b36bdf5acc37954b47f7c379e460947c6ab8e12c804b38e74b08610aa1d9
+  data.tar.gz: 07e02b611b902f7736ff1936b80b285da36e3fcacfc1492832eaf1b9ae307eaaa274d12f407d7cbbac4abc22a250a723943b449955dcb764c393b0a8d3650803

data/.rubocop.yml

@@ -12,4 +12,6 @@ Metrics/BlockLength:
 Layout/CaseIndentation:
   EnforcedStyle: end
 Layout/EndAlignment:
-  EnforcedStyleAlignWith: variable
+  EnforcedStyleAlignWith: variable
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent

data/README.md

@@ -241,7 +241,9 @@ You can also configure behaviour of Nazar:
 | `Nazar.config.formatter.paginate` | `true` | Determines if results too long/wide should be printed directly, or paginated with `less`. Horizontal layout is always paginated.
 | `Nazar.config.formatter.boolean` | ['✓', '✗'] | First item in array is a character for `true`, second for `false` |
 | `Nazar.config.enable_shorthand_method` | true | Determines if shorthand method should be defined. See <a href="#opt-in-setup">Opt-in setup</a> for more details |
-
+| `Nazar.config.table.resize`  | `true` | Determines if the table should always be resized to take full width |
+| `Nazar.config.table.min_width`  | `nil` | Sets minimum width. By default uses the longest header length |
+| `Nazar.config.table.max_width`  | `nil` | Determines maximum table width. If `resize` is set to true, uses terminal width by default, otherwise uses content length |
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/krzyzak/nazar.

data/lib/nazar/base_table.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Nazar
+  class BaseTable
+    def initialize(headers, cells)
+      @headers = headers
+      @cells = cells
+    end
+
+    def render
+      table.render
+    end
+
+    def add_summary(value)
+      table << :separator
+      table << summary_row(value)
+    end
+
+    private
+
+    attr_reader :headers, :cells
+
+    def table
+      @table ||= TTY::Table.new(header: headers, rows: cells)
+    end
+
+    def resize
+      Nazar.config.table.resize
+    end
+
+    def summary_row(value)
+      [pastel.bold('Total'), value]
+    end
+
+    def pastel
+      @pastel ||= Pastel.new(enabled: Nazar.config.colors.enabled)
+    end
+  end
+end

data/lib/nazar/horizontal_table.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nazar
+  class HorizontalTable < BaseTable
+    def render
+      table.render(:unicode, options)
+    end
+
+    private
+
+    def summary_row(value)
+      super.fill(nil, 3, table.columns_size - 3)
+    end
+
+    def options
+      { border: { separator: :each_row }, multiline: true, resize: resize }.tap do |hash|
+        hash[:width] = Nazar.config.table.max_width if Nazar.config.table.max_width
+      end
+    end
+  end
+end

data/lib/nazar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nazar
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/nazar/vertical_table.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Nazar
+  class VerticalTable < BaseTable
+    class VerticalBorder < TTY::Table::Border
+      def_border do
+        top '─'
+        top_mid '─'
+        top_left '─'
+        top_right '─'
+        bottom '─'
+        bottom_mid '─'
+        bottom_left '─'
+        bottom_right '─'
+        mid '─'
+        mid_mid '─'
+        mid_left '─'
+        mid_right '─'
+        left ''
+        center ''
+        right ''
+      end
+    end
+
+    def render
+      table.render_with(VerticalBorder, options) do |renderer|
+        renderer.border.style = :green if Nazar.config.colors.enabled
+        renderer.border.separator = separators_around_each_item
+      end
+    end
+
+    private_constant :VerticalBorder
+
+    private
+
+    def table
+      @table ||= TTY::Table.new(rows: cells)
+    end
+
+    def options
+      {
+        multiline: true,
+        resize: resize,
+        column_widths: column_widths,
+        width: max_width
+      }
+    end
+
+    def cells
+      @cells.flat_map do |cell|
+        cell.map.with_index do |item, index|
+          ["#{headers[index]} ", item]
+        end
+      end
+    end
+
+    def separators_around_each_item
+      (0...cells.size).select do |i|
+        (i % headers.size).zero? || ((i + 1) % headers.size).zero?
+      end
+    end
+
+    def column_widths
+      [headers_width, values_width]
+    end
+
+    def max_width
+      Nazar.config.table.max_width || default_width
+    end
+
+    def default_width
+      Nazar.config.table.resize ? TTY::Screen.width : natural_width + padding
+    end
+
+    def natural_width
+      content_size = headers_width + content_width
+
+      [content_size, TTY::Screen.width].min
+    end
+
+    def content_width
+      cells.flatten.map(&:size).max
+    end
+
+    def headers_width
+      [headers.map(&:size).max + 1, Nazar.config.table.min_width].compact.min
+    end
+
+    def values_width
+      if Nazar.config.table.resize
+        TTY::Screen.width - headers_width
+      else
+        [content_width, TTY::Screen.width - headers_width].min
+      end
+    end
+
+    def padding
+      3
+    end
+  end
+end

data/lib/nazar/view.rb

@@ -4,7 +4,7 @@ module Nazar
   class View
     extend Forwardable
 
-    def_delegators :formatter, :headers, :summary
+    def_delegators :formatter, :headers, :cells, :summary
 
     def initialize(data, layout:, use_generic_formatter: false)
       @data = data
@@ -15,9 +15,9 @@ module Nazar
     def render
       return unless supported_data?
 
-      table.tap do
-        add_summary if summary
-      end
+      table.add_summary(summary) if summary
+
+      table.render
     end
 
     def supported_data?
@@ -52,7 +52,7 @@ module Nazar
     def table_width
       [
         headers.map(&:size).sum,
-        horizontal_cells.map { |row| row.map(&:size).sum }.max
+        *cells.map { |row| row.map(&:size).sum }
       ].max
     end
 
@@ -70,48 +70,8 @@ module Nazar
       @formatter ||= formatter_klass.new(data)
     end
 
-    def add_summary
-      colspan = horizontal? ? headers.size - 1 : 1
-
-      table.add_separator
-      table.add_row [pastel.bold('Total'), { value: summary, colspan: colspan }]
-    end
-
     def table
-      @table ||= Terminal::Table.new(
-        headings: display_headers,
-        rows: display_cells,
-        style: { border: :unicode_thick_edge }
-      )
-    end
-
-    def display_headers
-      horizontal? ? formatter.headers : []
-    end
-
-    def display_cells
-      horizontal? ? horizontal_cells : vertical_cells
-    end
-
-    def horizontal_cells
-      formatter.cells
-    end
-
-    def vertical_cells
-      data = horizontal_cells.inject([]) do |output, items|
-        items.each.with_index do |item, index|
-          output << [headers[index], item]
-        end
-
-        output << :separator
-      end
-
-      data.pop # remove last separator
-      data
-    end
-
-    def pastel
-      @pastel ||= Pastel.new(enabled: Nazar.config.colors.enabled)
+      @table ||= horizontal? ? HorizontalTable.new(headers, cells) : VerticalTable.new(headers, cells)
     end
   end
 end

data/lib/nazar.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require 'dry-configurable'
-require 'terminal-table'
+require 'tty-table'
 require 'pastel'
 require 'tty-pager'
 
 require 'nazar/version'
+require 'nazar/base_table'
+require 'nazar/horizontal_table'
+require 'nazar/vertical_table'
 require 'nazar/cell_formatter'
 require 'nazar/headers_formatter'
 require 'nazar/renderer'
@@ -23,6 +26,12 @@ module Nazar # rubocop:disable Metrics/ModuleLength
     setting :paginate, default: true
   end
 
+  setting :table do
+    setting :resize, default: true
+    setting :min_width, default: nil
+    setting :max_width, default: nil
+  end
+
   setting :colors do
     setting :enabled, default: ENV.fetch('ENABLE_TTY_COLORS') { TTY::Color.color? ? 'true' : 'false' } == 'true'
   end

data/nazar.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   spec.add_runtime_dependency 'dry-configurable', '~> 0.12'
   spec.add_runtime_dependency 'pastel', '~> 0.8'
-  spec.add_runtime_dependency 'terminal-table', '~> 3.0'
   spec.add_runtime_dependency 'tty-pager', '~> 0.14'
   spec.add_runtime_dependency 'tty-screen', '~> 0.8'
+  spec.add_runtime_dependency 'tty-table', '~> 0.12'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nazar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Michał Krzyżanowski
@@ -36,7 +36,7 @@ cert_chain:
   WXVb638bzH4OYBIYuGcw50jqBK1SyDx4exzThr6KxSiGwhAKj2xFqy51MIQjfUN0
   TL5B7Buq
   -----END CERTIFICATE-----
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -143,47 +143,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: tty-pager
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: tty-pager
+  name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: tty-screen
+  name: tty-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.12'
 description:
 email:
 - michal.krzyzanowski+github@gmail.com
@@ -203,6 +203,7 @@ files:
 - bin/setup
 - certs/krzyzak.pem
 - lib/nazar.rb
+- lib/nazar/base_table.rb
 - lib/nazar/cell_formatter.rb
 - lib/nazar/formatter.rb
 - lib/nazar/formatter/active_record_collection.rb
@@ -214,8 +215,10 @@ files:
 - lib/nazar/formatter/sequel_interface.rb
 - lib/nazar/formatter/sequel_item.rb
 - lib/nazar/headers_formatter.rb
+- lib/nazar/horizontal_table.rb
 - lib/nazar/renderer.rb
 - lib/nazar/version.rb
+- lib/nazar/vertical_table.rb
 - lib/nazar/view.rb
 - nazar.gemspec
 homepage: https://github.com/krzyzak/nazar