term_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60ba5398037f0291a34bfdce7f66e51c0176aeb52adb19106ac99069c76f93b3
+  data.tar.gz: b36a84ff036db667ca44d5db3cf7ec1ff043a003082e21b15f5883dbb92f7907
+SHA512:
+  metadata.gz: dad2e32447a9dc4cfdea92e404e4950dd43eb85a6cb6494739540b5387b7d29cd79b6b233814eef36a56b3c0e8bd016260946c428b4856099f385eabee65bf08
+  data.tar.gz: fa4a83783fc89c162f6e0232fe25010b7e9098fc290116a8d9f913e5c415da209fa1740ddf6e09202e7587e2a0b7a36152c217bfcc7877c42339cb27696460d3

data/lib/term_utils/tab.rb

@@ -0,0 +1,318 @@
+module TermUtils
+  module Tab
+    # Represents a table.
+    class Table
+      # @return [Symbol]
+      attr_accessor :id
+      # @return [Array<Tab::Column>]
+      attr_accessor :columns
+      # @param opts [Hash]
+      # @option opts [Symbol] :id
+      def initialize(opts = {})
+        @id = opts.fetch(:id, nil)
+        @columns = []
+      end
+      # Defines a column.
+      # @param id [Symbol]
+      # @param opts [Hash]
+      # @option opts [Integer] :width
+      # @return [Tab::Column]
+      def define_column(id, opts = {}, &block)
+        col = @columns.find { |c| c.id == id }
+        if col
+          block.call(col) if block
+          col.validate
+        else
+          opts[:id] = id
+          opts[:index] = @columns.length
+          col = Column.new(opts)
+          block.call(col) if block
+          col.validate
+          @columns << col
+        end
+        col
+      end
+      # Finds a column.
+      # @param id [Symbol]
+      # @return [Tab::Column, nil]
+      def find_column(id)
+        @columns.find { |c| c.id == id }
+      end
+      # Creates a new table printer.
+      # @param io [IO]
+      # @param values [Array<Object>, Hash<Symbol, Object>]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [Tab::Printer]
+      def printer(io, opts = {}, &block)
+        ptr = Printer.new(self, io, opts)
+        block.call(ptr) if block
+        ptr
+      end
+      # Prints a header row.
+      # @param io [IO]
+      # @param values [Array<Object>, Hash<Symbol, Object>]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [nil]
+      def print_header(io, values = nil, opts = {})
+        vals = values
+        if values.nil?
+          vals = @columns.map { |col| col.id.to_s }
+        elsif values.is_a? Hash
+          vals = []
+          @columns.each do |col|
+            vals << values[col.id]
+          end
+        end
+        raise "wrong values (not array)" unless vals.is_a? Array
+        offset = opts.fetch(:offset, 0)
+        column_separator_width = opts.fetch(:column_separator_width, 2)
+        sb = StringIO.new
+        sb << " " * offset if offset > 0
+        @columns.each do |col|
+          sb << " " * column_separator_width if col.index > 0
+          sb << col.render_header(vals[col.index])
+        end
+        io.puts sb.string
+      end
+      # Prints a data row.
+      # @param io [IO]
+      # @param values [Array<Object>, Hash<Symbol, Object>]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [nil]
+      def print_data(io, values, opts = {})
+        vals = values
+        if values.is_a? Hash
+          vals = []
+          @columns.each do |col|
+            vals << values[col.id]
+          end
+        end
+        raise "wrong values (not array)" unless vals.is_a? Array
+        offset = opts.fetch(:offset, 0)
+        column_separator_width = opts.fetch(:column_separator_width, 2)
+        sb = StringIO.new
+        sb << " " * offset if offset > 0
+        @columns.each do |col|
+          sb << " " * column_separator_width if col.index > 0
+          sb << col.render_data(vals[col.index])
+        end
+        io.puts sb.string
+      end
+      # Prints a separator row.
+      # @param io [IO]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [nil]
+      def print_separator(io, opts = {})
+        offset = opts.fetch(:offset, 0)
+        column_separator_width = opts.fetch(:column_separator_width, 2)
+        sb = StringIO.new
+        sb << " " * offset if offset > 0
+        @columns.each do |col|
+          sb << " " * column_separator_width if col.index > 0
+          sb << "-" * col.width
+        end
+        io.puts sb.string
+      end
+      # Returns column titles.
+      # @return [Hash<Symbol, String>]
+      def titles
+        h = {}
+        @columns.each do |col|
+          h[col.id] = col.id.to_s
+        end
+        h
+      end
+    end
+    # Represents a table column.
+    class Column
+      # @return [Symbol]
+      attr_accessor :id
+      # @return [Integer]
+      attr_accessor :index
+      # @return [Integer]
+      attr_accessor :width
+      # @return [Symbol] `:left`, `:right`.
+      attr_accessor :align
+      # @return [Boolean]
+      attr_accessor :fixed
+      # @return [String]
+      attr_accessor :ellipsis
+      # @return [Proc, String, nil]
+      attr_accessor :format
+      # @param opts [Hash]
+      # @option opts [Symbol] :id
+      # @option opts [Integer] :index
+      # @option opts [Integer] :width
+      # @option opts [Symbol] :align
+      # @option opts [Boolean] :fixed
+      # @option opts [String] :ellipsis
+      # @option opts [Proc, String, nil] :format
+      def initialize(opts = {})
+        @id = opts.fetch(:id)
+        @index = opts.fetch(:index)
+        @width = opts.fetch(:width, 8)
+        @align = opts.fetch(:align, :left)
+        @fixed = opts.fetch(:fixed, false)
+        @ellipsis = opts.fetch(:ellipsis, "?")
+        @format = opts.fetch(:format, nil)
+      end
+      # Validates the column represented by this one.
+      # @return [nil]
+      def validate
+        raise "missing column id (nil)" if @id.nil?
+        raise "missing column index (nil)" if @index.nil?
+        raise "wrong column index (not integer)" unless @index.is_a? Integer
+        raise "wrong column index (not >= 0)" if @index < 0
+        raise "missing column width (nil)" if @width.nil?
+        raise "wrong column width (not integer)" unless @width.is_a? Integer
+        raise "wrong column width (not > 0)" if @width <= 0
+        raise "wrong column align (not :left or :right)" unless %i{left right}.index @align
+      end
+      # Aligns and cuts a given string.
+      # @param str [String]
+      # @return [String]
+      def align_cut(str)
+        if @align == :left
+          # Align left
+          if @fixed and (str.length > @width)
+            str = "#{str[0..(@width - (@ellipsis.length + 1))]}#{@ellipsis}"
+          else
+            str = "%-*s" % [@width, str]
+          end
+        else
+          # Align right
+          if @fixed and (str.length > @width)
+            str = "#{@ellipsis}#{str[(str.length - @width + @ellipsis.length)..(str.length - 1)]}"
+          else
+            str = "%*s" % [@width, str]
+          end
+        end
+        str
+      end
+      # Renders a given header.
+      # @param v [Object]
+      # return [String]
+      def render_header(v)
+        str = v
+        str = str.to_s unless str.is_a? String
+        align_cut str
+      end
+      # Renders a given value.
+      # @param v [Object]
+      # return [String]
+      def render_data(v)
+        str = v
+        if v
+          if @format.is_a? Proc
+            str = @format.call(v)
+          elsif @format.is_a? String
+            str = @format % v
+          end
+        end
+        str = str.to_s unless str.is_a? String
+        align_cut str
+      end
+    end
+    # Represents a table printer.
+    class Printer
+      # @return [Tab::Table]
+      attr_accessor :table
+      # @return [IO]
+      attr_accessor :io
+      # @return [Hash]
+      attr_accessor :options
+      # @param table [Tab::Table]
+      # @param io [IO]
+      # @param options [Hash]
+      def initialize(table, io, options)
+        @table = table
+        @io = io
+        @options = options
+      end
+      def line
+        @io.puts ""
+      end
+      def header(values = nil, opts = {})
+        @table.print_header(@io, values, @options.merge(opts))
+      end
+      def data(values, opts = {})
+        @table.print_data(@io, values, @options.merge(opts))
+      end
+      # Prints a separator.
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [nil]
+      def separator(opts = {})
+        @table.print_separator(@io, @options.merge(opts))
+      end
+    end
+    # Represents a holder of tables.
+    class Holder
+      # @return [Hash<Symbol, Tab::Table>]
+      attr_accessor :tables
+      def initialize(opts = {})
+        @tables = {}
+      end
+      # Defines a table.
+      # @param id [Symbol]
+      # @param opts [Hash]
+      # @return [Tab::Table]
+      def define_table(id, opts = {}, &block)
+        if @tables.has_key? id
+          block.call(@tables[id]) if block
+        else
+          opts[:id] = id
+          new_tab = Table.new(opts)
+          block.call(new_tab) if block
+          @tables[id] = new_tab
+        end
+        @tables[id]
+      end
+      # Finds a table.
+      # @param id [Symbol]
+      # @return [Tab::Table, nil]
+      def find_table(id)
+        @tables[id]
+      end
+      # Creates a new table printer.
+      # @param id [Symbol]
+      # @param io [IO]
+      # @param values [Array<Object>, Hash<Symbol, Object>]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [Tab::Printer]
+      def printer(id, io, opts = {}, &block)
+        find_table(id).printer(io, opts, &block)
+      end
+    end
+    @@default_holder = Holder.new
+    # Defines a table.
+    # @param id [Symbol]
+    # @param opts [Hash]
+    # @return [Tab::Table]
+    def self.define_table(id, opts = {}, &block)
+      @@default_holder.define_table(id, opts = {}, &block)
+    end
+    # Creates a new table printer.
+    # @param id [Symbol]
+    # @param io [IO]
+    # @param values [Array<Object>, Hash<Symbol, Object>]
+    # @param opts [Hash]
+    # @option opts [Integer] :offset
+    # @option opts [Integer] :column_separator_width
+    # @return [Tab::Printer]
+    def self.printer(id, io, opts = {}, &block)
+      @@default_holder.find_table(id).printer(io, opts, &block)
+    end
+  end
+end

data/lib/term_utils.rb

@@ -0,0 +1 @@
+require 'term_utils/tab'

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: term_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Baron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-15 00:00:00.000000000 Z
+dependencies: []
+description: 'Provides terminal utilities like table formatting.
+
+'
+email: tvbaron at gmail dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/term_utils.rb
+- lib/term_utils/tab.rb
+homepage: https://git.yellowcube.net/tvb/term_utils
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Terminal utilities.
+test_files: []