terminal-file-picker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5a569d7a6b4c67c640aef2acf33f800441b44bd780cd3d3330b396fdb0ff7a
-  data.tar.gz: 6fe26dd58337aa9e21a535c52bf2d96c582c5fd3c531a6e67cd4f69503211f80
+  metadata.gz: f07dbb5a7aa9a96128b360a8c326301aac7cad3783a9962bf7a99b9921f769bb
+  data.tar.gz: 49164b98d2645238d09777eda25d28272089a7e2d7f6cc12c6d2b2352e1ccfba
 SHA512:
-  metadata.gz: 6b857a6b4a7d337d5d080d399135957323480b6ef0e76f3c89ece5951f064fd314d3b287ea7893e14ed7e91979042a97d205bc432e8e261494f2c488cb86b807
-  data.tar.gz: 27c8dfc8ed0ce2208bf0f169795fac5d528757d2c4bed3d019bf33320cffeab67fadaa71760e4cf77df639b2f8f2727f53e59800d17d9ece24a6342fc3b36140
+  metadata.gz: ca6b198dada64c7612e21130f9a01b6f960008c91eacdd5a4b6315d845bc7f6d2da64b28fe4cec4ca72e5be3be097d6788ff2a2b4214c5f0736e7d071cedf814
+  data.tar.gz: 032e125883ceac5aeb4ab844602640aff05c02026b30a1b1f04d12cfaaaccfdd303592bc7aa93e132d18945af00a37142a3e81763aa660f09f4d59621038c490

data/README.md

@@ -2,7 +2,7 @@
 
 [![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%>
+<img alt="Gif showing usage" src="https://raw.githubusercontent.com/ilkutkutlar/terminal-file-picker/main/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.
 
@@ -25,15 +25,15 @@ gem 'terminal-file-picker'
 # Simple Usage
 
 ```rb
-# Only required argument is the "root path". The user starts
-# navigating from the root path and the returned path of
-# the chosen file is relative to this root path.
+# Only required argument is the "root path". The user will
+# start navigating from the root path once file picker is invoked.
+# Root path can be either absolute or relative.
 picker = FilePicker.new('.')
 
-# This brings up the interactive file picker. Once the user
-# has picked a file, the picker is cleared from screen and
-# the chosen file path returned.
 
+# `pick_file` brings up the interactive file picker. Once the user
+# has picked a file, the picker is cleared from screen and
+# the chosen file path (as an absolute path) is returned.
 # If user picks a directory, instead of returning its path,
 # the files inside the chosen directory is shown instead.
 puts(picker.pick_file)

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

@@ -0,0 +1,70 @@
+require 'pry'
+
+# Functions related to retrieving and formatting
+# information related to directories and their contents.
+class FileBrowserModel
+  attr_accessor :selected, :page, :current_path, :files
+
+  def initialize(starting_path, options = {})
+    @options = options
+    @current_path = starting_path
+    @page = 0
+    @selected = 0
+    @files = order_files(files_in_dir)
+  end
+
+  def files_in_dir
+    date_format = @options.fetch(:date_format, '%d/%m/%Y')
+    time_format = @options.fetch(:time_format, '%H:%M')
+
+    Dir.entries(@current_path).map do |f|
+      file_path = File.join(@current_path, f)
+
+      name = add_indicator(f)
+
+      size_bytes = File.size(file_path)
+
+      mtime = File.mtime(file_path)
+      date_mod = mtime.strftime(date_format)
+      time_mod = mtime.strftime(time_format)
+
+      [name, size_bytes, date_mod, time_mod]
+    end
+  end
+
+  # Order files such that '.' and '..' come before
+  # all the other files.
+  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.reverse + (groups[:files] || [])
+  end
+
+  # Absolute path of the currently selected file
+  def selected_absolute_path
+    selected_file_name = @files[@selected].first
+    # This may not be the absolute path (e.g. file_name may be '.')
+    selected_full_path = File.join(@current_path, selected_file_name)
+    File.absolute_path(selected_full_path)
+  end
+
+  def path_rel_to_start(file_name)
+    File.join(@current_path, file_name)
+  end
+
+  private
+
+  def add_indicator(file_name)
+    return "#{file_name}/" if File.directory?(path_rel_to_start(file_name))
+
+    file_name
+  end
+end

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

@@ -1,24 +1,24 @@
+require 'pry'
 require 'tty-cursor'
 require 'tty-reader'
 require_relative 'file_browser_view'
 require_relative 'helper'
+require_relative 'file_browser_model'
 
 # 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)
+  def initialize(start_dir_path, options = {})
+    @model = FileBrowserModel.new(start_dir_path, options)
+    @view = FileBrowserView.new(options)
     @reader = TTY::Reader.new(interrupt: :exit)
     @reader.subscribe(self)
-    @user_have_picked = false
-    @page = 0
     @cursor = TTY::Cursor
+    @user_have_picked = false
 
-    @date_format = options.fetch(:date_format, '%d/%m/%Y')
-    @time_format = options.fetch(:time_format, '%H:%M')
-    change_directory(dir_path)
+    absolute_start_path = File.absolute_path(start_dir_path)
+    change_directory(absolute_start_path)
   end
 
   def pick_file
@@ -30,22 +30,22 @@ class FilePicker
     end
 
     print(@cursor.clear_screen_down)
-    full_path_of_selected
+    @model.selected_absolute_path
   end
 
   def keydown(_event)
-    @selected += 1 unless selected_at_bottom?
+    @model.selected += 1 unless selected_at_bottom?
     if selected_below_page?
-      @page += 1
+      @model.page += 1
       print(@cursor.clear_screen_down)
     end
     redraw(true)
   end
 
   def keyup(_event)
-    @selected -= 1 unless selected_at_top?
+    @model.selected -= 1 unless selected_at_top?
     if selected_above_page?
-      @page -= 1
+      @model.page -= 1
       print(@cursor.clear_screen_down)
     end
     redraw(true)
@@ -54,8 +54,10 @@ class FilePicker
   def keypress(event)
     case event.value
     when "\r"
-      if File.directory?(full_path_of_selected)
-        change_directory(full_path_of_selected)
+      selected = @model.selected_absolute_path
+
+      if File.directory?(selected)
+        change_directory(selected)
         print(@cursor.clear_screen_down)
         # Cache keeps a rendering of current directory.
         # Going to a new directory, so needs to refresh
@@ -69,78 +71,35 @@ class FilePicker
 
   private
 
+  def change_directory(absolute_file_path)
+    @model.current_path = absolute_file_path
+    @model.page = 0
+    @model.selected = 0
+    @model.files = @model.order_files(@model.files_in_dir)
+  end
+
   def redraw(use_cache)
-    rendered = @dir.render(@current_path, @files, @selected, @page, use_cache)
+    rendered = @view.render(@model.current_path,
+                            @model.files,
+                            @model.selected,
+                            @model.page,
+                            use_cache)
     Helper.print_in_place(rendered)
   end
 
   def selected_at_top?
-    @selected.zero?
+    @model.selected.zero?
   end
 
   def selected_at_bottom?
-    @selected == @files.length - 1
+    @model.selected == @model.files.length - 1
   end
 
   def selected_above_page?
-    @selected < (@page * @dir.files_per_page)
+    @model.selected < (@model.page * @view.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
+    @model.selected > (@model.page * @view.files_per_page) + @view.files_per_page - 1
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal-file-picker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ilkut Kutlar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-13 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -105,6 +105,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/terminal-file-picker.rb
+- lib/terminal-file-picker/file_browser_model.rb
 - lib/terminal-file-picker/file_browser_view.rb
 - lib/terminal-file-picker/file_picker.rb
 - lib/terminal-file-picker/helper.rb