terminal-file-picker 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36bd9443b474cff7cc402fb518e1a42f8f098a871da283384d74b5fb7cf2510a
-  data.tar.gz: b82f7ce18c958d285d9b55b5898e23c821bf6b49dfc2fe99984a88956cd1277d
+  metadata.gz: cd5a569d7a6b4c67c640aef2acf33f800441b44bd780cd3d3330b396fdb0ff7a
+  data.tar.gz: 6fe26dd58337aa9e21a535c52bf2d96c582c5fd3c531a6e67cd4f69503211f80
 SHA512:
-  metadata.gz: bf21ba6ce88b30cb26cccbcf81b095d5c094e279ea8558a4dd8071fc88c5da39a256a0e080fe48ae2879238f671ae8fbeb33ab7de6526a652a566d598032180e
-  data.tar.gz: bfc0933ba0facedfe964f1008060331611b6d48762bc769d2b7fb1d957529f30f567fa654f4dd9f7525e6da97203c46fd4e3990bc5b3c00845e455b2aaf67ec1
+  metadata.gz: 6b857a6b4a7d337d5d080d399135957323480b6ef0e76f3c89ece5951f064fd314d3b287ea7893e14ed7e91979042a97d205bc432e8e261494f2c488cb86b807
+  data.tar.gz: 27c8dfc8ed0ce2208bf0f169795fac5d528757d2c4bed3d019bf33320cffeab67fadaa71760e4cf77df639b2f8f2727f53e59800d17d9ece24a6342fc3b36140

data/README.md

@@ -1,11 +1,27 @@
 # Terminal File Picker
 
+[![Gem Version](https://badge.fury.io/rb/terminal-file-picker.svg)](https://badge.fury.io/rb/terminal-file-picker)
+
+<img alt="Gif showing usage" src="https://raw.githubusercontent.com/ilkutkutlar/terminal-file-picker/master/usage.gif" width=70%>
+
 This gem shows an interactive terminal file picker to user, allowing them to browse their files with arrow keys and file. The picked file path is then returned to the calling program. The file picker is completely text-based and can be used with a terminal or terminal emulator. It is essentially a terminal version of a GUI file choosing dialogue.
 
 The gem is useful when your program needs to accept a file path as input and you want a more user-friendly option than asking user to find out the file path and enter it as text.
 
 The gem does not rely on the Curses library and instead uses the [TTY toolkit](https://github.com/piotrmurach/tty), which has cross platform support and support for many types of terminals/terminal emulators. Therefore this gem should also have the same level of support.
 
+# Installation
+
+```rb
+gem install 'terminal-file-picker'
+```
+
+or add it to your project's `Gemfile`:
+
+```rb
+gem 'terminal-file-picker'
+```
+
 # Simple Usage
 
 ```rb
@@ -23,25 +39,6 @@ picker = FilePicker.new('.')
 puts(picker.pick_file)
 ```
 
-The simple file picker looks like this:
-
-```
-Page: 1/2 | Directory: .
-
-  Name                            Size (B)    Date modified    Time modified
-  ----------------------------------------------------------------------------
-  .                               4096        21/05/2020       00:53
-  ..                              4096        18/05/2020       22:45
-  terminal-file-picker.rb         113         21/05/2020       00:19
-  .gitignore                      20          17/05/2020       01:04
-  LICENSE                         1068        17/05/2020       22:42
-  README.md                       916         21/05/2020       00:53
-  .rubocop.yml                    497         17/05/2020       19:15
-  terminal-file-picker.gemspec    581         17/05/2020       22:24
-  .git/                           4096        21/05/2020       00:51
-  spec/                           4096        21/05/2020       00:47
-```
-
 # Options
 
 There are some options to customise the look and feel of the file picker (all options do have default values, so all are optional)

data/lib/terminal-file-picker.rb

@@ -1,146 +1 @@
-require 'tty-cursor'
-require 'tty-reader'
-require_relative 'file_browser_view'
-require_relative 'helper'
-
-# Responsible for keeping the state of the interactive file picker.
-# Also responds to user input to modify the state and redraw
-# file picker to reflect new state.
-class FilePicker
-  def initialize(dir_path, options = {})
-    @root_path = dir_path
-    @dir = FileBrowserView.new(options)
-    @reader = TTY::Reader.new(interrupt: :exit)
-    @reader.subscribe(self)
-    @user_have_picked = false
-    @page = 0
-    @cursor = TTY::Cursor
-
-    @date_format = options.fetch(:date_format, '%d/%m/%Y')
-    @time_format = options.fetch(:time_format, '%H:%M')
-    change_directory(dir_path)
-  end
-
-  def pick_file
-    @user_have_picked = false
-    redraw(false)
-
-    @cursor.invisible do
-      @reader.read_keypress until @user_have_picked
-    end
-
-    print(@cursor.clear_screen_down)
-    full_path_of_selected
-  end
-
-  def keydown(_event)
-    @selected += 1 unless selected_at_bottom?
-    if selected_below_page?
-      @page += 1
-      print(@cursor.clear_screen_down)
-    end
-    redraw(true)
-  end
-
-  def keyup(_event)
-    @selected -= 1 unless selected_at_top?
-    if selected_above_page?
-      @page -= 1
-      print(@cursor.clear_screen_down)
-    end
-    redraw(true)
-  end
-
-  def keypress(event)
-    case event.value
-    when "\r"
-      if File.directory?(full_path_of_selected)
-        change_directory(full_path_of_selected)
-        print(@cursor.clear_screen_down)
-        # Cache keeps a rendering of current directory.
-        # Going to a new directory, so needs to refresh
-        # the cache.
-        redraw(false)
-      else
-        @user_have_picked = true
-      end
-    end
-  end
-
-  private
-
-  def redraw(use_cache)
-    rendered = @dir.render(@current_path, @files, @selected, @page, use_cache)
-    Helper.print_in_place(rendered)
-  end
-
-  def selected_at_top?
-    @selected.zero?
-  end
-
-  def selected_at_bottom?
-    @selected == @files.length - 1
-  end
-
-  def selected_above_page?
-    @selected < (@page * @dir.files_per_page)
-  end
-
-  def selected_below_page?
-    @selected > (@page * @dir.files_per_page) + @dir.files_per_page - 1
-  end
-
-  def files_in_dir(dir_path)
-    Dir.entries(dir_path).map do |f|
-      size_bytes = File.size(full_path(f))
-
-      mtime = File.mtime(full_path(f))
-      date_mod = mtime.strftime(@date_format)
-      time_mod = mtime.strftime(@time_format)
-
-      name = file_display_name(f)
-
-      [name, size_bytes, date_mod, time_mod]
-    end
-  end
-
-  def change_directory(full_path)
-    @page = 0
-    @selected = 0
-    @current_path = full_path
-    @files = order_files(files_in_dir(@current_path))
-  end
-
-  def order_files(files)
-    # Put "." and ".." at the start
-    groups = files.group_by do |f|
-      if f.first == '.' || f.first == '..'
-        :dots
-      else
-        :files
-      end
-    end
-
-    # Sort so that "." comes before ".."
-    (groups[:dots] || []).sort + (groups[:files] || [])
-  end
-
-  def full_path(file_name)
-    return @current_path if file_name == '.'
-    return "#{@current_path}#{file_name}" if @current_path[-1] == '/'
-
-    "#{@current_path}/#{file_name}"
-  end
-
-  def full_path_of_selected
-    full_path(@files[@selected].first)
-  end
-
-  def file_display_name(file_name)
-    if File.directory?(full_path(file_name))
-      return "#{file_name}/" unless ['.', '..'].include?(file_name)
-    end
-
-    file_name
-  end
-end
+require_relative 'terminal-file-picker/file_picker'

data/lib/{file_browser_view.rb → terminal-file-picker/file_browser_view.rb}

@@ -1,6 +1,6 @@
-require 'tty-table'
 require 'tty-screen'
 require_relative 'helper'
+require_relative 'table'
 
 # Renders a directory view with pagination support. Allows
 # highlighting an item in the directory to indicate its selected.
@@ -9,8 +9,8 @@ class FileBrowserView
   attr_reader :files_per_page
 
   def initialize(options = {})
-    @header = options.fetch(:header,
-                            ['Name', 'Size (B)', 'Date modified', 'Time modified'])
+    default_header = ['Name', 'Size (B)', 'Date modified', 'Time modified']
+    @header = options.fetch(:header, default_header)
     @dir_label = options.fetch(:dir_label, 'Directory')
     @page_label = options.fetch(:page_label, 'Page')
     @left_pad = options.fetch(:left_pad, 2)
@@ -18,17 +18,11 @@ class FileBrowserView
     @files_per_page = options.fetch(:files_per_page, 10)
     @show_info_line = options.fetch(:show_info_line, true)
     @info_line_position = options.fetch(:info_line_position, :top)
-    @screen_width = TTY::Screen.width
-
     @cache = ''
   end
 
   def render(dir_path, files, selected_index, page, use_cache = false)
-    if !use_cache || (use_cache && @cache.empty?)
-      @cache = render_files_table(files)
-    end
-
-    files_table = @cache
+    files_table = files_table_string(files, use_cache)
     file_browser = render_file_browser(files_table, selected_index, page)
 
     return file_browser unless @show_info_line
@@ -54,15 +48,15 @@ class FileBrowserView
     "#{header}\n#{body}"
   end
 
-  def render_files_table(files)
-    table = TTY::Table.new(@header, files)
+  def files_table_string(files, use_cache)
+    @table = Table.new(@header, files, @left_pad, @right_pad)
 
-    table.render(:basic) do |r|
-      r.width = @screen_width
-      r.resize = table_width_overflowed?(table.width)
-      table_padding(r)
-      table_border(r)
-    end
+    @cache = @table.render if !use_cache || (use_cache && @cache.empty?)
+    return @cache unless table_width_overflowed?
+
+    @cache.split("\n").map do |line|
+      line[0..(screen_width - 1)]
+    end.join("\n")
   end
 
   def highlight_row(rows, row_no)
@@ -73,7 +67,12 @@ class FileBrowserView
 
   def info_bar(total_files, page, dir_path)
     page_count = (total_files.to_f / @files_per_page).ceil
-    "#{@page_label}: #{page + 1}/#{page_count} | #{@dir_label}: #{dir_path}"
+    page_info = "#{@page_label}: #{page + 1}/#{page_count}"
+    dir_info = "#{@dir_label}: #{dir_path}"
+    info_bar = "#{page_info} | #{dir_info}"
+    return info_bar unless info_bar.length > screen_width
+
+    info_bar[0..screen_width - 1]
   end
 
   def paginate_table_body(body_rows, page_no)
@@ -83,21 +82,11 @@ class FileBrowserView
     body_rows[page_start..page_end]
   end
 
-  def table_width_overflowed?(table_content_width)
-    table_padding = @header.length * (@left_pad + @right_pad) + 1
-    full_table_length = table_content_width + table_padding
-
-    full_table_length >= @screen_width
-  end
-
-  def table_padding(renderer)
-    renderer.padding = [0, @right_pad, 0, @left_pad]
+  def table_width_overflowed?
+    @table.total_row_size >= screen_width
   end
 
-  def table_border(renderer)
-    renderer.border do
-      center ''
-      mid '-'
-    end
+  def screen_width
+    TTY::Screen.width
   end
 end

data/lib/terminal-file-picker/file_picker.rb

@@ -0,0 +1,146 @@
+require 'tty-cursor'
+require 'tty-reader'
+require_relative 'file_browser_view'
+require_relative 'helper'
+
+# Responsible for keeping the state of the interactive file picker.
+# Also responds to user input to modify the state and redraw
+# file picker to reflect new state.
+class FilePicker
+  def initialize(dir_path, options = {})
+    @root_path = dir_path
+    @dir = FileBrowserView.new(options)
+    @reader = TTY::Reader.new(interrupt: :exit)
+    @reader.subscribe(self)
+    @user_have_picked = false
+    @page = 0
+    @cursor = TTY::Cursor
+
+    @date_format = options.fetch(:date_format, '%d/%m/%Y')
+    @time_format = options.fetch(:time_format, '%H:%M')
+    change_directory(dir_path)
+  end
+
+  def pick_file
+    @user_have_picked = false
+    redraw(false)
+
+    @cursor.invisible do
+      @reader.read_keypress until @user_have_picked
+    end
+
+    print(@cursor.clear_screen_down)
+    full_path_of_selected
+  end
+
+  def keydown(_event)
+    @selected += 1 unless selected_at_bottom?
+    if selected_below_page?
+      @page += 1
+      print(@cursor.clear_screen_down)
+    end
+    redraw(true)
+  end
+
+  def keyup(_event)
+    @selected -= 1 unless selected_at_top?
+    if selected_above_page?
+      @page -= 1
+      print(@cursor.clear_screen_down)
+    end
+    redraw(true)
+  end
+
+  def keypress(event)
+    case event.value
+    when "\r"
+      if File.directory?(full_path_of_selected)
+        change_directory(full_path_of_selected)
+        print(@cursor.clear_screen_down)
+        # Cache keeps a rendering of current directory.
+        # Going to a new directory, so needs to refresh
+        # the cache.
+        redraw(false)
+      else
+        @user_have_picked = true
+      end
+    end
+  end
+
+  private
+
+  def redraw(use_cache)
+    rendered = @dir.render(@current_path, @files, @selected, @page, use_cache)
+    Helper.print_in_place(rendered)
+  end
+
+  def selected_at_top?
+    @selected.zero?
+  end
+
+  def selected_at_bottom?
+    @selected == @files.length - 1
+  end
+
+  def selected_above_page?
+    @selected < (@page * @dir.files_per_page)
+  end
+
+  def selected_below_page?
+    @selected > (@page * @dir.files_per_page) + @dir.files_per_page - 1
+  end
+
+  def files_in_dir(dir_path)
+    Dir.entries(dir_path).map do |f|
+      size_bytes = File.size(full_path(f))
+
+      mtime = File.mtime(full_path(f))
+      date_mod = mtime.strftime(@date_format)
+      time_mod = mtime.strftime(@time_format)
+
+      name = file_display_name(f)
+
+      [name, size_bytes, date_mod, time_mod]
+    end
+  end
+
+  def change_directory(full_path)
+    @page = 0
+    @selected = 0
+    @current_path = full_path
+    @files = order_files(files_in_dir(@current_path))
+  end
+
+  def order_files(files)
+    # Put "." and ".." at the start
+    groups = files.group_by do |f|
+      if f.first == '.' || f.first == '..'
+        :dots
+      else
+        :files
+      end
+    end
+
+    # Sort so that "." comes before ".."
+    (groups[:dots] || []).sort + (groups[:files] || [])
+  end
+
+  def full_path(file_name)
+    return @current_path if file_name == '.'
+    return "#{@current_path}#{file_name}" if @current_path[-1] == '/'
+
+    "#{@current_path}/#{file_name}"
+  end
+
+  def full_path_of_selected
+    full_path(@files[@selected].first)
+  end
+
+  def file_display_name(file_name)
+    if File.directory?(full_path(file_name))
+      return "#{file_name}/" unless ['.', '..'].include?(file_name)
+    end
+
+    file_name
+  end
+end

data/lib/terminal-file-picker/table.rb

@@ -0,0 +1,48 @@
+# Styles given data to make it suitable for printing on a screen and
+# look like justified columns of a table.
+class Table
+  def initialize(header, data, left_pad, right_pad)
+    @header = header
+    @data = data
+    @left_pad = left_pad
+    @right_pad = right_pad
+    @col_sizes = table_column_sizes
+  end
+
+  def render
+    rendered_header = render_row(@header)
+    rendered_data = @data.map { |row| render_row(row) }.join("\n")
+    border = '-' * total_row_size
+    [rendered_header, border, rendered_data].join("\n")
+  end
+
+  def total_row_size
+    total_padding_size = (@left_pad + @right_pad) * @header.length
+    @col_sizes.sum + total_padding_size
+  end
+
+  private
+
+  def render_row(row)
+    left_pad_str = ' ' * @left_pad
+    right_pad_str = ' ' * @right_pad
+
+    justified_cols = row.zip(@col_sizes).map do |col, col_size|
+      col.to_s.ljust(col_size)
+    end
+
+    justified_cols_str = justified_cols.join("#{left_pad_str}#{right_pad_str}")
+    "#{left_pad_str}#{justified_cols_str}#{right_pad_str}"
+  end
+
+  def table_column_sizes
+    table_data = [@header] + @data
+    col_count = table_data.first.length
+
+    (0..col_count - 1).map do |col|
+      table_data.map do |row|
+        row[col].to_s.length
+      end.max
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal-file-picker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ilkut Kutlar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-23 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-- !ruby/object:Gem::Dependency
-  name: tty-table
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,9 +104,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/file_browser_view.rb
-- lib/helper.rb
 - lib/terminal-file-picker.rb
+- lib/terminal-file-picker/file_browser_view.rb
+- lib/terminal-file-picker/file_picker.rb
+- lib/terminal-file-picker/helper.rb
+- lib/terminal-file-picker/table.rb
 homepage: https://github.com/ilkutkutlar/terminal-file-picker
 licenses:
 - MIT
@@ -133,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="