typr 1.1.4 → 1.3.0

data/lib/graphical.rb

@@ -57,7 +57,7 @@ module Visuals
     end
   end
 
-  def show( str )
+  def draw( str )
     return unless str
     if get_background
       GO.draw_color = get_background
@@ -81,17 +81,14 @@ module Visuals
         e = Event.poll until e.is_a? Event::KeyDown
         return e.sym.between?(32, 126) ? e.sym.chr : e.sym
       when :line
-        x, y = Visuals.row, Visuals.column
-        listen = Thread.new{
-          loop do
-            move x, y
-            show line
-            sleep 0.1
-          end
-        }
-        line = Readline.readline
-        listen.terminate
-        return line
+        str = ''
+        loop do
+          e = Event.poll
+          next unless e.is_a? Event::KeyDown
+          return nil if e.sym == KEY_ESCAPE
+          return str if e.sym == KEY_RETURN
+          str << e.sym.chr if e.sym.between? 32, 126
+        end
     end
   end
 
@@ -117,7 +114,7 @@ if __FILE__ == $0
   loop do
     clear
     COLORS.keys.each_with_index{ |c,i|
-      foreground c; move 0,i; show characters }
+      foreground c; move 0,i; draw characters }
     refresh
     exit if read(:key) == KEY_ESCAPE
   end

data/lib/grid.rb

@@ -9,16 +9,16 @@ module Typr
   #     input:  [ ["Alice", 30], ["Bob", 25] ],
   #     header: [:name, :age],
   #     format: [:max, :right]
-  #   )
-  #   grid.draw
-  #
+#   )
+#   grid.show
+#
   # Column format tokens: +Integer+ (fixed width), +:min+ (auto), +:max+ (fill remaining).
   #
   # Built-in procs: +:filetree+, +:datetime+, +:magnitudes+, +:convert+.
 
   class Grid < Stack # Table
     attr_accessor :format, :procs, :filters, :data, :map
-    attr_accessor :align, :rawsort, :rawfilter
+    attr_accessor :align, :rawsort, :rawfilter, :reverse
     attr_writer :sequence
 
     ##
@@ -177,10 +177,11 @@ module Typr
     end
 
     ##
-    # Add a column filter (substring or regex).
+    # Add a column filter (substring or regex). +:all+ matches any column.
     #
     #   grid.add_filter(0, "Ali")    # name contains "Ali"
     #   grid.add_filter(1, /^\d{2}$/) # age matches regex
+    #   grid.add_filter(:all, "ip")  # any column contains "ip"
     #
     # @param column [Integer, Symbol]
     # @param query [String, Regexp]
@@ -202,8 +203,10 @@ module Typr
 
     def check row
       @filters.reject{ |column,query|
-        ( (@procs[column] and not @rawfilter[column]) ?
-          @layer : @data )[row][column].to_s[query] }.empty?
+        cols = column == :all ? @data[row].each_index.to_a : [column]
+        cols.any?{ |col|
+          ( (@procs[col] and not @rawfilter[col]) ?
+            @layer : @data )[row][col].to_s[query] } }.empty?
     end
 
     ##
@@ -237,6 +240,57 @@ module Typr
 
     def sorted_by name=false; (name and @sort) ? @header[@sort] : @sort end
 
+    ##
+    # Pick a row with live-filtering.
+    #
+    # When column is given, `Grid` overrides `Stack#pick` to add interactive
+    # text filtering of rows by the given column. Filter text is shown at the
+    # bottom of the grid. Passes through to `super` for all other types or
+    # when no column is given.
+    #
+    #   grid.pick :row, 0, column: :name
+    #   grid.pick :row, 0, column: :all   # match any column
+    #
+    # @param type [Symbol] type is ignored (always :row); passed to super otherwise
+    # @param column [Symbol, String] column name to filter on, or :all (default nil)
+
+    def pick type = :row, row=0, column: nil
+      return super(type, row) unless column
+
+      saved = [@filters.dup, @map, @start]
+      base = @map || ids
+      @filters = [[column, '']]
+      @map = base.select{ |id| check id }
+      @start = 0
+      show
+      draw_hints
+      result = Typr.read_line '/', left: left, top: self.bottom + 1,
+        &->(key, query, _) {
+          if key.is_a?(String) and idx = @hints[0..height-@hints_start-1].index(key)
+            return page.to_a[idx + @hints_start]
+          end
+          if key.is_a?(String) and !key.each_char.all?{ |c| c.ord.between?(32, 126) } and
+            @keymap.values.include?(key) and ![KEY_BACKSPACE, "\b"].include?(key)
+            send key
+          else
+            @filters = [[column, query]]
+            @map = base.select{ |id| check id }
+            @start = 0
+          end
+          show
+          draw_hints
+          nil
+        }
+      case result
+      when nil;      @filters, @map, @start = saved
+      when Integer; return result
+      else
+        @filters = result.empty? ? saved[0] : saved[0] + [[column, result]]
+        filter :all
+      end
+      return
+    end
+
     ##
     # Sort by column (toggle direction on repeat).
     #
@@ -260,8 +314,9 @@ module Typr
     def sort
       return false unless @sort
       data = (@procs[@sort] and not @rawsort[@sort]) ? @layer : @data
-      @map = ids.sort{ |a,b| (data[a][@sort] <=> data[b][@sort]) || 0 }
+      @map = (0...@data.size).to_a.sort{ |a,b| (data[a][@sort] <=> data[b][@sort]) || 0 }
       @map.reverse! if @reverse
+      @map = @map.select{ |id| check id } unless @filters.empty?
       return
     end
 
@@ -293,11 +348,11 @@ module Typr
     ##
     # Compute column widths from visible data and render the grid.
     #
-    #   grid.draw
+    #   grid.show
     #
     # @return [void]
 
-    def draw
+    def show
       if not @data or @data.empty? or ( @map and @map.empty? )
         @widths = [ width/columns ] * columns if @widths.count < columns
         @rest = 0
@@ -349,20 +404,20 @@ module Typr
     def print row=nil
       return super unless row
       header = ( row == :header )
-      return show @header[0..width-1].ljust(width) if
+      return draw @header[0..width-1].ljust(width) if
         header and @header.is_a? String
       fields = (header ? @header : @data[row] ).dup
       @layer[row].each{ |col,value| fields[col] = value } if
         @layer[row] if @layer unless header
   	    for col,id in sequence.each_with_index
-        show @separator unless id == 0
+        draw @separator unless id == 0
         select = ( @selected[:columns].include? col or
           @selected[:fields].include? [row,col] ) unless
             @selected[:rows].include?(row) or header
         color( @colors[:fields][[row,col]] ||
           @colors[:columns][col] || @colors[:default] ) unless header
         background @colors[:selected] if select
-        show prepare( fields[col].to_s, width_for( id ), @align[col] )
+        draw prepare( fields[col].to_s, width_for( id ), @align[col] )
         background @colors[:default][1] if select
       end
     end
@@ -406,7 +461,7 @@ module Typr
       @colors = { columns: [], fields: {} }.merge ( @colors  )
       @selected = { fields:[], columns:[] }.merge @selected
       @functions = {
-        filetree: Proc.new{ |f| f.gsub /.*\/[^$]/, ' ' },
+        filetree: Proc.new{ |f| ' ' * [(d = f.count('/') - 1), 0].max + '└' + File.basename(f) },
         datetime: Proc.new{|sec|Time.at(sec).strftime"%y-%m-%d %H:%M" rescue ??},
         magnitudes: Proc.new{ |size| mag = (size.to_s.length-1) / 3
           mag>0 ? (size.to_s.insert -(mag*3+1), ?.)[0..4] + %w[B K M G T][mag] :

data/lib/line.rb

@@ -7,36 +7,36 @@ module Typr
 # == Example
 #
 #   line = Line.new( top: 5, left: 10, width: 40 )
-#   line.draw "Hello world"
+#   line.show "Hello world"
 #   line.append " more"
-#   line.ask([ ["Name?", :string], ["Age?", :integer] ])
+#   line.ask([ ["Name?", :line], ["Age?", :line] ])
 
 class Line < Space
-  attr_accessor :default, :prompt, :bindings, :data
+  attr_accessor :default, :prompt, :bindings, :data, :align, :trim
 
   # Render +msg+ (String, Proc, or Space) on this line.
   #
-  #   line.draw "status: ok"
-  #   line.draw Proc.new { show_time }
+  #   line.show "status: ok"
+  #   line.show Proc.new { show_time }
 
-  def draw msg=@data
+  def show msg=@data, align=@align
     @data = msg
     move left, top
     color @colors[:default]
     case msg
       when Proc; msg.call
-      when Space; msg.draw
-      when String; show( prepare msg, width )
+      when Space; msg.show
+      when String; draw( prepare msg, width, align, @trim )
     end
   end
 
   # Append +str+ to the current content and redraw.
   #
-  #   line.draw "hello"
+  #   line.show "hello"
   #   line.append " world"   #=> "hello world"
   #   line << "!"            #=> "hello world!"
 
-  def append(str); draw @data+str end
+  def append(str); show @data+str end
   alias :<< :append
 
   # Display keybinding help in a floating grid.
@@ -56,38 +56,68 @@ class Line < Space
   #
   #   line.reset
 
-  def reset; draw( @default || ( @bindings || [@prompt] ).join(' ') ) end
+  def reset; show( @default || ( @bindings || [@prompt] ).join(' ') ) end
 
   # Prompt the user with a sequence of questions.
-  # +sentence+ is an array of [question, type] pairs.
-  # Returns a single answer or an array when multiple questions.
+  # +sentence+ is an array of [question, type] pairs (or a hash of them).
+  # Returns a single answer, or an array when there are multiple questions.
   #
-  #   line.ask([ ["Name?", :string] ])             #=> "Alice"
-  #   line.ask([ ["Name?", :string], ["Ok?", ["y","n"]] ])  #=> ["Alice", "y"]
+  # The +type+ selects how the answer is collected:
+  #   Array - interactive pick via <widget>.pick(<type>); an optional third
+  #           element renders the chosen row's field into the line
+  #   :key  - a single keypress via Typr.read_key
+  #   :line - interactive line editor via Typr.read_line at the cursor
+  #
+  # Pressing the exit key (@keymap[:exit], Escape by default) aborts the
+  # remaining questions and returns nil.
+  #
+  #   line.ask(name: :line)                  #=> "Alice"
+  #   line.ask(keys: :key)                   #=> "a"
+  #   line.ask(open: [grid, :row, :name])    #=> 2   (picked row id)
+  #   line.ask([ ["Name?", :line], ["Ok?", :key] ])  #=> ["Alice", "a"]
 
   def ask sentence
     answer = []
     move left, top
     Typr.clear :line
-    draw @prompt
-    for question, object in sentence
-      color( @colors[:question] )
-      append " " + question.to_s + " "
-      column = Typr.column
-      color( @colors[:answer] )
-      case object
-        when Array then answer << object.first.pick( object.last )
-        else answer << Typr.read( object, @data )
+    saved = @trim
+    @trim = :left
+    begin
+      @data = @prompt.to_s
+      colored = color_code( @colors[:default] ).to_s + @data
+      move left, top
+      draw prepare( colored, width, @align, @trim )
+      for question, object in sentence
+        text = " " + question.to_s + " "
+        @data += text
+        colored += color_code( @colors[:question] ).to_s + text
+        move left, top
+        draw prepare( colored, width, @align, @trim )
+        color( @colors[:answer] )
+        case object
+          when Array then answer << object.first.pick( object[1] )
+          when :key then answer << Typr.read_key
+          when :line then answer << Typr.read_line( colored + color_code( @colors[:answer] ),
+            left: left, top: top )
+        end
+        return if !answer.last or answer.last == @keymap[:exit]
+        text = ( object.is_a?(Array) and object[2] ) ?
+          object.first.data[answer.last][object[2]].to_s : answer.last.to_s
+        @data += text
+        colored += color_code( @colors[:answer] ).to_s + text
+        move left, top
+        draw prepare( colored, width, @align, @trim )
       end
-      return if !answer.last or answer.last == @keymap[:exit]
-      move column, top
-      append answer.last.to_s
+    ensure
+      @trim = saved
     end
     return ( answer.one? ? answer.first : answer )
   end
 
   def initialize args
     @right= -1
+    @align = :left
+    @trim = :right
     @prompt = ?>
     super
     @bottom = @top

data/lib/space.rb

@@ -10,7 +10,7 @@ module Typr
 #
 # @example
 #   box = Space.new(left: 0, top: 2, right: 0.5, bottom: -4, border: :round)
-#   box.draw
+#   box.show
 
 class Space
 include Typr
@@ -29,21 +29,36 @@ include Typr
 STR
 eval( method % ([name]*11) ) }
 
+  # Deep-convert String keys to Symbols so string-keyed config (e.g. YAML) is honored.
+  def symbolize obj
+    case obj
+    when Hash
+      obj.each_with_object({}) { |(k, v), h|
+        h[k.is_a?(String) ? k.to_sym : k] = symbolize(v) }
+    else obj end
+  end
+
   attr_writer :left, :top, :right, :bottom
   attr_accessor :margin, :colors, :interval, :borders
 
+  # Viewport width in cells (right - left + 1).
   def width; right - left + 1 end
+  # Viewport height in cells (bottom - top + 1).
   def height; bottom - top + 1 end
 
-  def start; @updater = Thread.new{ loop{draw; sleep @interval }} end
+  # Redraw every +interval+ seconds from a background thread.
+  def start; @updater = Thread.new{ loop{show; sleep @interval }} end
+  # Stop the background refresh thread.
   def stop; @updater.terminate end
 
+  # Draw a border char at screen (x, y); skips nil and off-screen positions.
   def draw_border x,y,char
-    show move_code(x, y) + char unless not char or
+    draw move_code(x, y) + char unless not char or
       x < 0 or x > Typr.width or y < 0 or y > Typr.height
   end
 
-  def draw
+  # Draw the widget's border box (no-op when no borders are set).
+  def show
     return if @borders.empty?
     color @colors[:border]
     draw_border(left - 1, top - 1, @borders[:top_left])
@@ -58,6 +73,8 @@ eval( method % ([name]*11) ) }
     draw_border(right + 1, bottom + 1, @borders[:bottom_right])
   end
 
+  # Set border style: :light/:heavy/:double/:round, a char repeated across
+  # the box, or nil for none.
   def border=(border)
     chars = case border
       when Symbol
@@ -70,11 +87,14 @@ eval( method % ([name]*11) ) }
       bottom_right ].map.with_index{ |part,id| [part.to_sym, chars[id]] }.to_h if chars
   end
 
+  # Build a widget from boundary (left/top/right/bottom), border, margin,
+  # colors, interval, and keymap.
   def initialize args={}
-    @max, @keymap, @colors, @margin = 0, {}, {}, ' '
+    @max, @keymap, @colors, @margin = 0, {}, {}, '  '
     @left, @top, @interval, @borders = 0, 0, 1, {}
   	args.each{ |name, value|
       instance_variable_set ?@ + name.to_s, value }
+    @colors = symbolize( @colors ) if @colors.is_a? Hash
     @keymap = { exit: KEY_ESCAPE }.merge @keymap
     @colors = { default: [:white, :black], border: [:white, :black] }.merge(@colors)
     borders = @borders.dup

data/lib/stack.rb

@@ -38,6 +38,20 @@ module Typr
 
     def headspace; @header ? 1 : 0 end
 
+    ##
+    # Map a mouse click at 1-based terminal (row, col) to a data row id on
+    # the current page, or nil when the click lands outside the widget (border,
+    # header, margins). Row ids match what hint presses return from `pick`.
+    #
+    #   stack.hit 3, 5   # => 0  (row 3, col 5 hits data row 0)
+
+    def hit row, col
+      return unless row and col
+      rel = row - 1 - top - headspace
+      return unless rel.between?(0, height - 1) and col.between?(left, right)
+      page.to_a[rel]
+    end
+
     ##
     # The usable height after subtracting any header space.
     #
@@ -50,7 +64,7 @@ module Typr
     #
     #   stack.print 42   # renders a blank row
 
-    def print id; show " " * (width-@margin.size) end
+    def print id; draw " " * (width-@margin.size) end
 
     ##
     # Resets widget state by one or more categories.
@@ -80,16 +94,16 @@ module Typr
       if type.to_s[ /column/ ]
         positions( row_id )[ @hints_start..-1 ].each_with_index{ |pos, idx|
           move( left + pos, top + row_id )
-          show @hints[idx] }
+          draw @hints[idx] }
       else
         bottom = top + headspace + [height, rows].min - 1
         (top + headspace..bottom).each{ |pos|
-          move( left, pos ); show ' ' }
+          move( left, pos ); draw ' ' }
         @hints.chars.each_with_index{ |char, idx|
           pos = idx + @hints_start + headspace
           break if top + pos > bottom
           move( left, top + pos )
-          show char }
+          draw char }
       end
     end
 
@@ -100,11 +114,11 @@ module Typr
     # This method is called by your application's main loop each frame; it does not handle
     # events itself (see {#send}).
 
-    def draw
+    def show
       if @header
         color @colors[ :header ]
         move left,top
-        show @margin
+        draw @margin
         print :header
       end
       list = page.to_a
@@ -116,7 +130,7 @@ module Typr
         dark=!dark if @alternate
         background ( select ? @colors[:selected] :
           (@alternate and dark) ? @colors[:alternate] : @colors[:default][1] )
-        show @margin
+        draw @margin
         print id
         background if select
       end
@@ -193,6 +207,8 @@ module Typr
     #   stack.pick                # single row picker
     #   stack.pick :column, 3     # pick a column in row 3
     #   stack.pick "rows"         # multi-select rows
+    #
+    # Mouse: left-click a row to pick it; wheel up/down scrolls the page.
 
     def pick type = :row, row=0 #, key=nil
       type = type.to_s
@@ -203,11 +219,19 @@ module Typr
           column = pick( :column, page.to_a.index( row  + headspace)) or return
           value = [ row , column ]
         else
-          draw
+          show
           draw_hints type, row unless type['none']
           limit = type['row'] ? height : positions(row).count
-          key = Typr.read :key
-          if key.is_a?(String) and value =
+          key = Typr.read_key
+          if key.is_a?(Typr::Mouse)
+            if key.wheel? and key.press?
+              send( key.wheel_up? ? @keymap[:up] : @keymap[:down] )
+              next
+            elsif key.press? and key.left? and type['row'] and
+              value = hit( key.y, key.x )
+              relative = value if type['relative_']
+            end
+          elsif key.is_a?(String) and value =
             @hints[0..limit-@hints_start-1].index(key)
             value += @hints_start
             relative = value + @start if type['relative_']