Class: Typr::Browser

Inherits:
Grid show all
Defined in:
lib/browser.rb

Overview

A file-system directory browser built on Grid. Renders entries as rows with columns for name, symlink target, permissions, owner/group, size, timestamps, and MIME type. Directories sort to the top and appear in yellow; files get per-MIME-type foreground colors.

Column Views

:simple   - name
:compact  - name, size, type
:stats    - name, size, permissions, owner, group, modified
:full     - all columns

Navigation Keys (interactive picker)

[h]             | help
[r]             | reset view
[d]             | directory history
[m] / [M]       | mark / mark range
[a] / [i]       | mark all / invert mark
[`] / [~] / [..] | root / home / back
[v]             | switch view
[s] / [f]       | sort / filter
Return          | confirm (cd on directories)
Escape          | quit, returns nil

Constant Summary

Constants included from Typr

COLORS, COLOR_MAP, DEFAULT_KEYS, ERASE_LINE, INPUT, KEY_ESCAPE, KEY_PAGEDOWN, KEY_PAGEUP, KEY_RETURN, KEY_TAB, MIMETYPES, MODES, MOUSE_OFF, MOUSE_ON, ORIG_COLORS, TERMINFO

Instance Attribute Summary collapse

Attributes inherited from Grid

#align, #data, #filters, #format, #map, #procs, #rawfilter, #rawsort, #reverse, #sequence

Attributes inherited from Stack

#header, #hints, #hints_start, #keymap, #selected, #separator, #start

Attributes inherited from Space

#borders, #colors, #interval, #left, #margin, #right

Instance Method Summary collapse

Methods inherited from Grid

#<<, #[], #[]=, #add_filter, #clear, #columns, #filter, #header=, #ids, #is_hash?, #page, #positions, #print, #reset, #rows, #sort_by, #sorted_by, #width_for

Methods inherited from Stack

#cycle, #down, #draw_hints, #headspace, #height, #hit, #page, #page_down, #page_up, #print, #reset, #to_bottom, #to_top, #up

Methods inherited from Space

#border=, #draw_border, #height, #start, #stop, #symbolize, #width

Methods included from Typr

#background, clear, #clip, #coerce_type, #color, #color_code, column, decode_mouse, #draw, exit, #fade, #foreground, #get_background, #get_foreground, height, init, #mode, #mode_code, #move, #move_code, on_resize, position, #prepare, #printables, read_key, read_line, #real_size, row, size, text_width, width, word_next, word_prev

Constructor Details

#initialize(args = {}) ⇒ Browser

Construct a Browser widget. Keyword arguments:

Option               | Default                         | Description
--------------------|---------------------------------|-----------------------------------
+directory+          | +"~"+                           | Starting directory to browse
+mimetype_db+       | true                            | Load MIME from file extensions
+mimetype_magic+    | true                            | Use +file --mime-type+ for unknowns
+colors[:actions]+  | { "[f]ilter": :red, ... }       | Status bar item colors
+colors[:dir_history]+ | :yellow                      | History picker column color
+colors[:types]+     | (see below)                    | Per MIME-type foreground color

Type Color Defaults

image: :blue          audio: :green         video: :cyan
text: 146             pdf: 136              inode: :magenta
directory: :yellow    symlink: 123          'x-empty': :grey70
'x-msdownload': :red  'x-pie-executable': :red


395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/browser.rb', line 395

def initialize args={}
  @mimetype_db, @mimetype_magic = true, true
  @view, @sort, @views, @positions, @show_hidden = :compact, 0, {}, {}, false
  @filter_dirs = args[:filter_dirs]
  super
  @left ||= 0
  @top ||= 0
  @directory ||= ?~
  @colors[:actions] = { "[f]ilter": :red, "[s]ort": :blue, "[v]iews": :green
    }.merge @colors[:actions] || {}
  @colors[ :types ] = {
        image: :blue,
        audio: :green,
        video: :cyan,
         text: 146, pdf: 136, 'epub+zip': 136,
         html: 150, xhtml: 150, javascript: 150,
    'x-bzip2': 190, 'x-xz': 190, 'x-compressed': 190,
        inode: :magenta, blockdevice:148, chardevice:144, symlink:123,
    directory: :yellow,
    'x-empty': :grey70, '?': :grey70,
    'x-msdownload': :red, 'x-pie-executable': :red
  }.merge( @colors[ :types ] || {} )

  @keymap = { back: KEY_BACKSPACE, confirm: KEY_RETURN, help: ?h,
    home: ?~, views: ?v,         sort_view: ?s, search: ?/,
    mark: ?m, mark_range: ?M, mark_all: ?a, mark_invert: ?i,
    filter_view: ?f, reset_view: ?r,
    toggle_hidden: ?H}.merge @keymap

  self.header = %w[ name target permissions executable owner group size
    accessed modified created type subtype ]

  @format[NAME] = :max
  @format[TYPE] = 5
  @ignore[NAME] = @ignore[TARGET] = true
  @hints = "1234567890"
  [NAME, SIZE, ACCESSED, MODIFIED, CREATED].each{|col| @rawsort[col] = true}

  @procs[ACCESSED] = @procs[MODIFIED] = @procs[CREATED] = :datetime
  @procs[SIZE] = :magnitudes
  @procs[OWNER] = Proc.new{|uid| Etc.getpwuid(uid).name rescue uid }
  @procs[GROUP] = Proc.new{|gid| Etc.getgrgid(gid).name rescue gid }

  @procs[NAME] = Proc.new{ |name, row| target = @data[row][TARGET]
    File.basename(name.to_s) + ( target ? " > " + color_code(File.exist?(target) ? :green : :red) +
      target : "" ) }

  @views = { simple: %i[ name ],
    compact: %i[ name size type],
    stats:   %i[ name size permissions owner group modified ],
    full:    %i[ name size permissions executable owner group
                 accessed modified created type subtype ] }.merge @views
  @parent = self
  @head ||= Grid.new( parent:self, left: ->{@parent.left}, margin: '',
    right: ->{@parent.width + @parent.left - 1}, top: ->{@parent.top-1},
    input: [ [->{Etc.getpwuid(Process.euid).name rescue ENV["USER"] || Etc.getlogin}, ->{@parent.directory},
      ->{@parent.filter_display},
      ->{ (s = @parent.sorted_by(true)) &&
        "#{s} #{@parent.reverse ? "\u2193" : "\u2191"}"},
      ->{@parent.view} ] ], format: [:min, :max, :min, :min, :min],
    colors: { columns: [@colors[:default], @colors[:default],
      @colors[:actions][:"[f]ilter"], @colors[:actions][:"[s]ort"],
      @colors[:actions][:"[v]iews"]] } )

  @user ||= Line.new( parent:self, left:->{@parent.left},top:->{@parent.bottom+1},
    bindings: %w[ [h]elp [/]:search ] + @colors[:actions].map{|name,color|
      color_code( color ) + name.to_s + color_code(@colors[:default]) } +
        %w[ [r]eset [d]irectories [m]ark [M]ark_range mark_[a]ll
        [i]nvert_mark [~]:home [H]idden_files [back]:.. [up] [down] [pageup] [pagedown] [home] [end] [esc]:quit [return]:confirm\  ])
  cd @directory
end

Instance Attribute Details

#directory ⇒ Object

Returns the value of attribute directory.



36
37
38
 
# File 'lib/browser.rb', line 36

def directory
  @directory
end

#mimetype_db ⇒ Object

Returns the value of attribute mimetype_db.



37
38
39
 
# File 'lib/browser.rb', line 37

def mimetype_db
  @mimetype_db
end

#mimetype_magic ⇒ Object

Returns the value of attribute mimetype_magic.



37
38
39
 
# File 'lib/browser.rb', line 37

def mimetype_magic
  @mimetype_magic
end

#pwd ⇒ Object

Returns the value of attribute pwd.



36
37
38
 
# File 'lib/browser.rb', line 36

def pwd
  @pwd
end

#user ⇒ Object

Returns the value of attribute user.



36
37
38
 
# File 'lib/browser.rb', line 36

def user
  @user
end

#view ⇒ Object

Returns the value of attribute view.



36
37
38
 
# File 'lib/browser.rb', line 36

def view
  @view
end

Instance Method Details

#back ⇒ Object

Navigate up one directory.

browser.back   # equivalent to cd ".."


191
 
# File 'lib/browser.rb', line 191

def back; cd ".." end

#bottom ⇒ Object

Height minus 2 rows reserved for path bar and command line.



41
 
# File 'lib/browser.rb', line 41

def bottom; super - 1 end

#cd(dir, append = false) ⇒ Object

Change to dir (absolute path, "..", "~", or integer index into dir_history). When append is false (default), clears data and colors before scanning. Pushes onto dir_history.

browser.cd "/tmp"        # => changes to /tmp
browser.cd "~"           # => changes to home
browser.cd ".."          # => parent directory
browser.cd 2             # => jump to history entry 2


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/browser.rb', line 57

def cd dir, append=false
  return unless dir
  data, missing = [],{}
  unless append
    @colors[:fields] = {}
    clear
    Dir.chdir( @directory = File.expand_path( dir ) )
  end
  data = Dir.new(@directory).children.reject{|f|
    !@show_hidden and f[0] == ?. }.map.with_index do |file,id|
    if File.symlink? file
      target = File.readlink( file ) rescue $!.to_s
      next [file, target, "????", false, "?", "?", 0, 0, 0, 0, "inode", "symlink"] unless File.exist?(file)
    end
    stat = File.stat(file) rescue nil
    next [file, "", "????", false, "?", "?", 0, 0, 0, 0, "?", "?"] unless stat
    type = stat.ftype.to_sym

    mime = { "directory": "inode/directory",
      "characterSpecial": "inode/chardevice",
      "blockSpecial": "inode/blockdevice", "link": "inode/symlink",
      "fifo": "inode/fifo", "socket": "inode/socket"}[type]
    if type == :file and @mimetype_db
      ext = file.match(/.+\.(\w+)$/)
      mime ||= MIMETYPES[ext[1].to_sym] if ext
    end

    ( missing[file] = id ; mime = "?/?" ) unless mime
    [  file, target, stat.mode.to_s(8)[-3..-1].chars.map{|d|
      "rwx".chars.map.with_index{|c,i| d.to_i[2-i]==0 ? ?- : c } }.join,
      File.executable?(file), stat.uid, stat.gid, stat.size,
      stat.atime.to_i, stat.mtime.to_i, stat.ctime.to_i,
      *mime.to_s.split( ?/ ) ]
  end

  if @mimetype_magic and not missing.empty?
    begin
      out = IO.popen(['file', '--mime-type', *missing.keys]){ |io| io.read }
    rescue Errno::ENOENT
      out = ''
    end
    out.split($/).each{ |line|
      file, mime = line.match(/^(.*):\s+(\w+\/[\w\-\.]+)$/)&.captures
      next unless file
      data[ missing[file] ][-2,2] = mime.split( ?/ ) if missing[file] }
  end
  data.each { |row| row[0] = File.join(@directory, row[0]) }
  self << data
  sort
  filter
  unless append
    @directory += ?/ unless @directory == ?/
    switch_to @view
    reset :position
  end
  return
end

#check(row) ⇒ Object

True when the row is a directory or passes base Grid filtering.

browser.check 0   # => true if navigable


258
 
# File 'lib/browser.rb', line 258

def check row; super or ( !@filter_dirs and @data[row][SUBTYPE] == "directory" ) end

#confirm ⇒ Object

Returns the current directory path as the confirm result.



158
 
# File 'lib/browser.rb', line 158

def confirm; return @directory end

#directories ⇒ Object

Returns row ids for all directories in the current listing.

browser.directories   # => [0, 1, 3]


345
 
# File 'lib/browser.rb', line 345

def directories; ids.select{ |id| @data[id][SUBTYPE] == 'directory' } end

#filter_display ⇒ String

Formats active filters as 'column: query', joined by ' / '.

browser.filter_display  # => "name: foo / size: big"

Returns:

  • (String) 


333
334
335
336
337
338
339
 
# File 'lib/browser.rb', line 333

def filter_display
  return "no filter" if @filters.empty?
  @filters.map { |col, q|
    q = "/#{q.source}/" if q.is_a?(Regexp)
    "#{col.is_a?(Symbol) ? col : @header[col] || col}:#{q}"
  }.join(" / ")
end

#filter_view ⇒ Object

Open a filter popup on the chosen row/column and apply the input.

browser.filter_view   # prompts for filter text


229
230
 
# File 'lib/browser.rb', line 229

def filter_view; add_filter *@user.ask(
filter: [ popup( type: :"[f]ilter" ), :row, NAME], with: :line ) end

#help ⇒ Object

Display a help grid listing all keybindings.



216
 
# File 'lib/browser.rb', line 216

def help; @user.help end

#home ⇒ Object

Navigate to the home directory.

browser.home   # => cd "~"


203
 
# File 'lib/browser.rb', line 203

def home; cd ?~ end

#mark ⇒ Object

Prompts to select rows by index. Returns chosen ids or nil.

browser.mark   # => [0, 2, 5] or nil


164
 
# File 'lib/browser.rb', line 164

def mark; return @user.ask( 'mark files': [self, :rows] ) end

#mark_all ⇒ Object

Selects all non-directory rows.

browser.mark_all   # => [0, 3, 7] (file ids only)


179
 
# File 'lib/browser.rb', line 179

def mark_all; return @selected[:rows] = ids - directories end

#mark_invert ⇒ Object

Inverts selection across all non-directory rows.

browser.mark_invert   # => toggled ids


185
 
# File 'lib/browser.rb', line 185

def mark_invert; return @selected[:rows] = ids - @selected[:rows] end

#mark_range ⇒ Object

Toggles selection for every row within a "from..to" range.

browser.mark_range   # prompts for from/to, toggles selection


170
171
172
173
 
# File 'lib/browser.rb', line 170

def mark_range; return ids[ ( eval @user.ask(
      'mark from': [self, :relative_row], 'to': [self, :relative_row]
      ).join '..' ) ].each{|id| @selected[:rows].include?(id) ?
@selected[:rows].delete(id) : @selected[:rows] << id } end

#pick(type = 'file', **kw) ⇒ Object

Interactive file/directory picker. Blocks until a selection or Escape. Return on a file yields its raw absolute path; multi-select joins the chosen paths double-quoted with spaces. Enter on a directory triggers cd. type optionally filters by MIME family (audio, video, image, text, application, inode). Mouse: left-click a row to pick it; wheel up/down scrolls the listing.

browser.pick              # => /home/user/file.txt
browser.pick 'image'      # => /path/to/photo.png (images only)
browser.pick nil          # => anything, same as 'file'


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/browser.rb', line 272

def pick type='file', **kw
  type ||= 'file'
  type = type.to_s
  return super(type, **kw) if type[/row|column|field|none/]
  add_filter ( %w[audio video image text application inode].include?(
    type) ? TYPE : SUBTYPE ), type if type != 'file'
  loop do
    show
    draw_hints :row
    key = Typr.read_key
    if key == @keymap[:exit]
      reset :display
      return
    end
    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 choice = hit( key.y, key.x )
      else next end
    else
      next unless choice = send( key )
    end
    case choice
      when Array; choice = choice.map{ |id| @data[id][NAME] }.join('" "')
      when Integer; file = @data[ choice ]
        if file[SUBTYPE] == 'directory'; cd file[TARGET] || file[NAME]; next
        else choice = file[NAME] end
    end
    reset :display
    return choice
  end
end

#popup(args = {}) ⇒ Object

Create a small Grid popup under an info bar item for column selection. args must include :type matching an actions key for positioning.

browser.popup type: :"[s]ort"   # sort-picker popup


367
368
369
370
371
372
373
374
 
# File 'lib/browser.rb', line 367

def popup args={}
  Grid.new( { alternate:false, border: :light,
    borders:{ top:nil, top_left:nil, top_right:nil },
    top: top, align: [:right], input:@header,
    left: left + ( @positions[args[:type]] || 0 ) -
      ( args[:input] || @header ).map( &:size ).max - 1,
    colors:{ columns: [ @colors[:actions][args[:type]] ] } }.merge args )
end

#process(row) ⇒ Object

Colors symlink names green/red based on target existence and applies per-MIME-type foreground colors from @colors[:types].

browser.process 0   # => sets colors for row 0


121
122
123
124
125
 
# File 'lib/browser.rb', line 121

def process row; super
  color = @colors[:types][@data[row][SUBTYPE].to_sym] ||
    @colors[:types][@data[row][TYPE].to_sym]
  @colors[:fields][[row,NAME]] = color if color
end

#reset_view ⇒ Object

Reset display, selection, and position state then re-sort.

browser.reset_view


223
 
# File 'lib/browser.rb', line 223

def reset_view; cd @directory; reset [:display, :selection, :position]; sort end

#root ⇒ Object

Navigate to the root directory.

browser.root   # => cd "/"


197
 
# File 'lib/browser.rb', line 197

def root; cd ?/ end

#search ⇒ Object

Open live / search filtered on the name column.

browser.search   # type to narrow, Escape restores, Enter commits


236
237
238
239
240
 
# File 'lib/browser.rb', line 236

def search
  @suppress_user = true
  pick :none, column: NAME
  @suppress_user = false
end

#send(key) ⇒ Object

Resolves hint characters typed on a row. Returns the matching row id for fast navigation, otherwise falls through to Stack#send.

browser.send "1"   # => row id if hint "1" is visible


149
150
151
152
153
154
 
# File 'lib/browser.rb', line 149

def send key
  if key.is_a?(String) and
    id = @hints[0..[height, rows-1+headspace].min-@hints_start-1].index(key)
    return page[id+@hints_start]
  else super end
end

#show ⇒ Object

Renders the grid with an info bar above showing the current directory path and colored status items for filter, sort, and view.

browser.show   # shows browser with info bar


312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/browser.rb', line 312

def show; super
  user = Etc.getpwuid(Process.euid).name rescue ENV["USER"] || Etc.getlogin
  @head.colors[:columns][0] = user == "root" ? [:red, :black] : [:green, :black]
  @head.reset :format
  @head.show
  move @head.positions(0)[1] - @head.separator.size, @parent.top - 1
  color @colors[:default]
  draw '@'
  @positions = { :"[f]ilter" => 2, :"[s]ort" => 3, :"[v]iews" => 4
    }.transform_values do |col|
      @head.left + @head.positions(0)[col] + @head.width_for(col) - 1
    end
  @user.show unless @suppress_user
end

#sort ⇒ Object

Sort by NAME by default; directories always appear before files within each prefix grouping.

browser.sort   # re-sorts with dirs first


353
354
355
356
357
358
359
 
# File 'lib/browser.rb', line 353

def sort
  @sort ||= NAME
  super
  dirs = ids.select{ |id| @data[id][SUBTYPE] == 'directory' }
  @map = (directories + ids).uniq
  nil
end

#sort_view ⇒ Object

Open a sort-picker popup to choose a column to sort by.

browser.sort_view   # pick a column header to sort


246
 
# File 'lib/browser.rb', line 246

def sort_view; sort_by @user.ask( "sort by": [ popup( type: :"[s]ort" ), :row] ) end

#switch_to(view = nil) ⇒ Object

Switch to a named or indexed column view. Resets format widths.

browser.switch_to :full      # all columns
browser.switch_to 0          # first view key
browser.switch_to :stats     # name, size, perms, owner, group, modified


134
135
136
137
138
139
140
141
 
# File 'lib/browser.rb', line 134

def switch_to view=nil
  return unless view
  view = @views.keys[ view ] if view.is_a? Integer
  @sequence = @views[ view ].map{|title| @header.index title.to_s}
  reset :format
  @view = view
  return
end

#toggle_hidden ⇒ Object

Toggle visibility of hidden files (those starting with a dot).

browser.toggle_hidden


209
210
211
212
 
# File 'lib/browser.rb', line 209

def toggle_hidden
  @show_hidden = !@show_hidden
  cd @directory
end

#top ⇒ Object

Top offset plus one row for the path info bar.



45
 
# File 'lib/browser.rb', line 45

def top; super + 1 end

#views ⇒ Object

Open a view-picker popup and switch to the selected view.

browser.views   # choose :simple, :compact, :stats, or :full


252
 
# File 'lib/browser.rb', line 252

def views; switch_to( popup( type: :"[v]iews", input: @views.keys ).pick :row )  end