tty 0.0.9 → 0.0.10

data/lib/tty/table.rb

@@ -8,12 +8,12 @@ require 'tty/table/header'
 require 'tty/table/row'
 
 module TTY
+
   # A core class intended for storing data in a structured, tabular form.
   # Once the data is stored in a TTY::Table various operations can be performed
   # before the information is dumped into a stdout.
-  #
   class Table
-    include Comparable, Enumerable, Renderer, Conversion
+    include Comparable, Enumerable, Conversion
     include Validatable, Equatable
     extend Forwardable
 
@@ -30,26 +30,7 @@ module TTY
     #
     # @api private
     attr_reader :rows
-    private :rows
-
-    # The table enforced column widths
-    #
-    # @return [Array]
-    #
-    # @api public
-    attr_accessor :column_widths
-
-    # The table column alignments
-    #
-    # @return [Array]
-    #
-    # @api private
-    attr_reader :column_aligns
-
-    # The table border class
-    #
-    # @api private
-    attr_reader :border_class
+    # private :rows
 
     # The table orientation out of :horizontal and :vertical
     #
@@ -58,18 +39,8 @@ module TTY
     # @api public
     attr_reader :orientation
 
-    # A callable object used for formatting field content
-    #
-    # @api public
-    attr_accessor :filter
-
-    # The table operations applied to rows
-    #
-    # @api public
-    attr_reader :operations
-
     # Subset of safe methods that both Array and Hash implement
-    def_delegators(:@rows, :[], :assoc, :flatten, :include?, :index,
+    def_delegators(:data, :assoc, :flatten, :include?, :index,
                    :length, :select, :to_a, :values_at, :pretty_print, :rassoc)
 
     # Create a new Table where each argument is a row
@@ -79,7 +50,7 @@ module TTY
     #
     # @api public
     def self.[](*rows)
-      self.new(:rows => rows)
+      self.new(rows: rows)
     end
 
     # Instantiate a new Table
@@ -105,27 +76,12 @@ module TTY
     def self.new(*args, &block)
       options = Utils.extract_options!(args)
       if args.size.nonzero?
-        super(extract_tuples(args).merge(options), &block)
+        super(Transformation.extract_tuples(args).merge(options), &block)
       else
         super(options, &block)
       end
     end
 
-    # Extract header and row tuples from arguments
-    #
-    # @param [Array] args
-    #
-    # @api private
-    def self.extract_tuples(args)
-      rows   = args.pop
-      header = args.size.zero? ? nil : args.first
-      if rows.first.is_a?(Hash)
-        header = rows.map(&:keys).flatten.uniq
-        rows   = rows.inject([]) { |arr, el| arr + el.values }
-      end
-      { :header => header, :rows => rows }
-    end
-
     # Initialize a Table
     #
     # @param [Hash] options
@@ -134,12 +90,6 @@ module TTY
     #   column names to be displayed
     # @option options [String] :rows
     #   Array of Arrays expressing the rows
-    # @option options [String] :renderer
-    #   used to format table output
-    # @option options [String] :column_aligns
-    #   used to format table individual column alignment
-    # @option options [String] :column_widths
-    #   used to format table individula column width
     # @option options [Symbol] :orientation
     #   used to transform table orientation
     #
@@ -150,29 +100,21 @@ module TTY
       validate_options! options
       @header        = (value = options[:header]) ? Header.new(value) : nil
       @rows          = coerce(options.fetch(:rows) { Row.new([]) })
-      @renderer      = pick_renderer options[:renderer]
-      @border        = TTY::Table::BorderOptions.from(options.delete(:border))
       @orientation   = Orientation.coerce(options.fetch(:orientation) { :horizontal })
+      @rotated       = false
       # TODO: assert that row_size is the same as column widths & aligns
-      @column_widths = Array(options.delete(:column_widths)).map(&:to_i)
-      @column_aligns = Array(options.delete(:column_aligns)).map(&:to_sym)
-      @operations    = TTY::Table::Operations.new(self)
-      @operations.add_operation(:alignment, Operation::AlignmentSet.new(@column_aligns))
-      @filter        = options.fetch(:filter) { nil }
-      @width         = options.fetch(:width) { TTY.terminal.width }
-
       assert_row_sizes @rows
       @orientation.transform(self)
-      yield_or_eval &block if block_given?
+      yield_or_eval(&block) if block_given?
     end
 
-    # Set table fields filter
+    # Provides access to all table data
     #
-    # @param [#call] block
+    # @return [Array]
     #
     # @api public
-    def filter(&block)
-      @operations.add_operation(:filter, block)
+    def data
+      (header && !header.empty?) ? [header] + rows : rows
     end
 
     # Sets table orientation
@@ -225,31 +167,13 @@ module TTY
       end
     end
 
-    # Store border characters, style and separator for the table rendering
-    #
-    # @param [Hash, BorderOptions] options
-    #
-    # @yield [] block representing border options
-    #
-    # @api public
-    def border(options=(not_set=true), &block)
-      @border = TTY::Table::BorderOptions.new unless @border
-      if block_given?
-        border_dsl = TTY::Table::BorderDSL.new(&block)
-        @border = border_dsl.options
-      elsif !not_set
-        @border = TTY::Table::BorderOptions.from(options)
-      end
-      @border
-    end
-
     # Lookup element of the table given a row(i) and column(j)
     #
     # @api public
     def [](i, j=false)
       return row(i) unless j
       if i >= 0 && j >= 0
-        rows.fetch(i){return nil}[j]
+        rows.fetch(i) { return nil }[j]
       else
         raise TTY::Table::TupleMissing.new(i,j)
       end
@@ -284,10 +208,10 @@ module TTY
     # @api public
     def row(index, &block)
       if block_given?
-        rows.fetch(index){return self}.each(&block)
+        rows.fetch(index) { return self }.each(&block)
         self
       else
-        rows.fetch(index){return nil}
+        rows.fetch(index) { return nil }
       end
     end
 
@@ -350,7 +274,7 @@ module TTY
     # @api public
     def each
       return to_enum unless block_given?
-      rows.each { |row| yield row }
+      data.each { |row| yield row }
       self
     end
 
@@ -365,9 +289,17 @@ module TTY
     # @api public
     def each_with_index
       return to_enum unless block_given?
+      start_index = 0
+      if header && !header.empty?
+        header.attributes.each_with_index do |el, col_index|
+          yield el, 0, col_index
+        end
+        start_index = 1
+      end
+
       rows.each_with_index do |row, row_index|
-        row.each_with_index do |el, col_index|
-          yield el, row_index, col_index
+        row.fields.each_with_index do |el, col_index|
+          yield el, row_index + start_index, col_index
         end
       end
       self
@@ -382,7 +314,7 @@ module TTY
     #
     # @api public
     def column_size
-      return rows[0].size if (rows.size > 0)
+      return rows[0].size if rows.size > 0
       return 0
     end
 
@@ -416,7 +348,7 @@ module TTY
     #
     # @api public
     def width
-      ColumnSet.new(self).extract_widths!.total_width
+      ColumnSet.new(self).total_width
     end
 
     # Return true if this is an empty table, i.e. if the number of
@@ -429,13 +361,60 @@ module TTY
       column_size == 0 || row_size == 0
     end
 
-    # Return string representation of table
+    # Return string representation of table using basic renderer.
     #
     # @return [String]
     #
     # @api public
     def to_s
-      render(self)
+      render(:basic)
+    end
+
+    # Render a given table. This method takes options which will be passed
+    # to the renderer prior to rendering, which allows the caller to set any
+    # table rendering variables.
+    #
+    # @param [Symbol] renderer_type
+    #   the renderer to be used
+    #
+    # @param [Hash] options
+    #
+    # @yield [renderer]
+    #
+    # @yieldparam [TTY::Table::Renderer] renderer
+    #   the renderer for the table
+    #
+    # @return [String]
+    #
+    # @api public
+    def render(*args, &block)
+      render_with(nil, *args, &block)
+    end
+
+    # Render a given table using custom border class.
+    #
+    # @param [TTY::Table::Border]
+    #
+    # @param [Symbol] renderer_type
+    #
+    # @yield [renderer]
+    #
+    # @yieldparam [TTY::Table::Renderer] renderer
+    #   the renderer for the table
+    #
+    # @return [String]
+    #
+    # @api public
+    def render_with(border_class, renderer_type=(not_set=true), options={}, &block)
+      unless not_set
+        if renderer_type.respond_to?(:to_hash)
+          options = renderer_type
+        else
+          options[:renderer] = renderer_type
+        end
+      end
+
+      Renderer.render_with(border_class, self, options, &block)
     end
 
     # Coerce an Enumerable into a Table
@@ -453,7 +432,7 @@ module TTY
       rows.map { |row| to_row(row, header) }
     end
 
-  private
+    private
 
     # Evaluate block
     #

data/lib/tty/terminal/color.rb

@@ -76,7 +76,7 @@ module TTY
       #
       # @api public
       def set(string, *colors)
-        validate *colors
+        validate(*colors)
         ansi_colors = colors.map { |color| lookup(color) }
         "#{ansi_colors.join}#{string}#{CLEAR}"
       end
@@ -108,7 +108,7 @@ module TTY
       #
       # @api public
       def code(*colors)
-        validate *colors
+        validate(*colors)
         colors.map { |color| lookup(color) }
       end
 

data/lib/tty/terminal/echo.rb

@@ -30,7 +30,7 @@ module TTY
           value = block.call if block_given?
           self.on
           return value
-        rescue NoMethodError, Interrupt => e
+        rescue NoMethodError, Interrupt
           self.on
           exit
         end

data/lib/tty/terminal/pager/basic.rb

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Terminal
+
+    # A class responsible for paging text
+    class BasicPager < Pager
+
+      PROMPT_HEIGHT = 3
+
+      PAGE_BREAK = "--- Press enter/return to continue (or q to quit) ---"
+
+      # Use ruby to page output text
+      #
+      # @api public
+      def page
+        text_lines = text.lines.to_a
+
+        text_lines.each_slice(page_size) do |chunk|
+          TTY.shell.say chunk.join
+          break if chunk.size < page_size
+          break if !continue?(text_lines)
+        end
+      end
+
+      private
+
+      # Check whether to progress with paging
+      #
+      # @param [Array[String]] text_lines
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def continue?(text_lines)
+        if text_lines.size > page_size
+          question = TTY.shell.ask "\n#{PAGE_BREAK}"
+          return false if question.read_string[/q/i]
+        end
+        return true
+      end
+
+      # Determine current page size
+      #
+      # @api private
+      def page_size
+        @page_size ||= TTY.terminal.height - PROMPT_HEIGHT
+      end
+
+    end # BasicPager
+  end # Terminal
+end # TTY

data/lib/tty/terminal/pager/system.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Terminal
+
+    # A class responsible for paging text
+    class SystemPager < Pager
+
+      # Use system command to page output text
+      #
+      # @api public
+      def page
+        read_io, write_io = IO.pipe
+
+        if Kernel.fork
+          # parent process
+          TTY.shell.input.reopen(read_io)
+          read_io.close
+          write_io.close
+
+          # Wait until we have input before we start the pager
+          Kernel.select [TTY.shell.stdin]
+
+          begin
+            Kernel.exec(Pager.command)
+          rescue
+            Kernel.exec "/bin/sh", "-c", command
+          end
+        else
+          # child process
+          write_io.write(text)
+          write_io.close
+          read_io.close
+        end
+      end
+
+    end # SystemPager
+  end # Terminal
+end # TTY

data/lib/tty/terminal/pager.rb

@@ -0,0 +1,95 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Terminal
+
+    # A class responsible for paging text inside terminal
+    class Pager
+
+      attr_accessor :enabled
+
+      attr_reader :text
+
+      # Initialize a Pager
+      #
+      # @param [String] text
+      #   the text to page
+      #
+      # @api public
+      def initialize(text=nil)
+        @text = text
+        @enabled = true
+      end
+
+      # Check if pager is enabled
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def enabled?
+        !!@enabled
+      end
+
+      # List possible executables for output paging
+      #
+      # @return [Array[String]]
+      #
+      # @api private
+      def self.executables
+        [ ENV['GIT_PAGER'], `git config --get-all core.pager`.split.first,
+          ENV['PAGER'], 'less -isr', 'more', 'cat', 'pager' ]
+      end
+
+      # Find first available system command for paging
+      #
+      # @param [Array[String]] commands
+      #
+      # @return [String]
+      #
+      # @api public
+      def self.available(*commands)
+        commands = commands.empty? ? self.executables : commands
+        commands.compact.uniq.find { |cmd| System.exists?(cmd) }
+      end
+
+      # Check if paging command exists
+      #
+      # @api private
+      def self.available?
+        !!available
+      end
+
+      # Finds command to execute pager from shell commands unless configured is provided.
+      #
+      # @param [Array[String]] commands
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.command(*commands)
+        @command = if (@command && commands.empty?)
+          @command
+        else
+          available(*commands)
+        end
+      end
+
+      # Pages output using configured pager
+      #
+      # @param [String] text
+      #   the text to page
+      #
+      # @api public
+      def self.page(text)
+        return unless TTY.shell.tty?
+
+        if System.unix? && available?
+          SystemPager.new(text).page
+        else
+          BasicPager.new(text).page
+        end
+      end
+
+    end # Pager
+  end # Terminal
+end # TTY

data/lib/tty/terminal.rb

@@ -26,9 +26,17 @@ module TTY
     # @api public
     attr_reader :color
 
+    # Output pager
+    #
+    # @return [Pager]
+    #
+    # @api public
+    attr_reader :pager
+
     def initialize
       @color = TTY::Terminal::Color.new(self.color?)
       @echo  = TTY::Terminal::Echo.new
+      @pager = TTY::Terminal::Pager
       @default_width  = 80
       @default_height = 24
     end
@@ -149,14 +157,24 @@ module TTY
       %x{tput colors 2>/dev/null}.to_i > 2
     end
 
+    # Switch echo on
+    #
+    # @api public
     def echo_on
       @echo.on
     end
 
+    # Switch echo off
+    #
+    # @api public
     def echo_off
       @echo.off
     end
 
+    # Echo given block
+    #
+    # @param [Boolean] is_on
+    #
     # @api public
     def echo(is_on=true, &block)
       @echo.echo(is_on, &block)
@@ -168,7 +186,18 @@ module TTY
     #
     # @api public
     def home
-      @home ||= Home.new.home
+      @home ||= Home.new
+      @home.home
+    end
+
+    # Run text through a dynamically chosen pager
+    #
+    # @param [String] text
+    #   the text to page
+    #
+    # @api public
+    def page(text)
+      @pager.page(text)
     end
 
   end # Terminal

data/lib/tty/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module TTY
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/lib/tty.rb

@@ -17,6 +17,9 @@ require 'tty/vector'
 require 'tty/shell'
 require 'tty/coercer'
 require 'tty/logger'
+require 'tty/plugins'
+
+require 'tty/plugins/plugin'
 
 require 'tty/coercer/range'
 require 'tty/coercer/integer'
@@ -28,14 +31,19 @@ require 'tty/shell/question'
 require 'tty/shell/question/validation'
 require 'tty/shell/question/modifier'
 require 'tty/shell/statement'
+require 'tty/shell/suggestion'
 require 'tty/shell/reader'
 require 'tty/shell/response'
 
 require 'tty/terminal/color'
 require 'tty/terminal/echo'
 require 'tty/terminal/home'
+require 'tty/terminal/pager'
+require 'tty/terminal/pager/basic'
+require 'tty/terminal/pager/system'
 
 require 'tty/system/which'
+require 'tty/system/editor'
 
 require 'tty/text/distance'
 require 'tty/text/truncation'
@@ -51,17 +59,21 @@ require 'tty/table/border_options'
 require 'tty/table/border/unicode'
 require 'tty/table/border/ascii'
 require 'tty/table/border/null'
+require 'tty/table/border/row_line'
 
 require 'tty/table/column_set'
 require 'tty/table/orientation'
 require 'tty/table/orientation/horizontal'
 require 'tty/table/orientation/vertical'
+require 'tty/table/transformation'
 
 require 'tty/table/operations'
 require 'tty/table/operation/alignment_set'
 require 'tty/table/operation/alignment'
 require 'tty/table/operation/truncation'
 require 'tty/table/operation/wrapped'
+require 'tty/table/operation/filter'
+require 'tty/table/operation/escape'
 
 module TTY
 
@@ -89,13 +101,15 @@ module TTY
   # Raised when the attribute is unknown
   class UnknownAttributeError < IndexError; end
 
+  # Raised when command cannot be invoked
+  class CommandInvocationError < StandardError; end
 
   # An empty array used as a default value
   EMPTY_ARRAY = Array.new.freeze
 
   class << self
 
-    # Return terminal instance
+    # Return shared terminal instance
     #
     # @return [TTY::Terminal]
     #
@@ -104,6 +118,32 @@ module TTY
       @terminal ||= Terminal.new
     end
 
+    # Return shared shell instance
+    #
+    # @return [TTY::Shell]
+    #
+    # @api public
+    def shell(input=$stdin, output=$stdout)
+      @shell ||= Shell.new(input, output)
+    end
+
+    # Return shared system object
+    #
+    # @return [TTY::System]
+    #
+    # @api public
+    def system
+      System
+    end
+
+    # Return shared plugins instance
+    #
+    # @return [TTY::Plugins]
+    #
+    # @api public
+    def plugins
+      @plugins ||= Plugins.new
+    end
   end
 
 end # TTY