terminal-file-picker 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f07dbb5a7aa9a96128b360a8c326301aac7cad3783a9962bf7a99b9921f769bb
-  data.tar.gz: 49164b98d2645238d09777eda25d28272089a7e2d7f6cc12c6d2b2352e1ccfba
+  metadata.gz: af483ed650624caf3dc074f752cf63a969826b3da2f86b340071adcc6bc2329b
+  data.tar.gz: 9e63b9d7878d86f96827b3fc4f267ba3e07fa81049c30a76d8c63b49dfad2e9f
 SHA512:
-  metadata.gz: ca6b198dada64c7612e21130f9a01b6f960008c91eacdd5a4b6315d845bc7f6d2da64b28fe4cec4ca72e5be3be097d6788ff2a2b4214c5f0736e7d071cedf814
-  data.tar.gz: 032e125883ceac5aeb4ab844602640aff05c02026b30a1b1f04d12cfaaaccfdd303592bc7aa93e132d18945af00a37142a3e81763aa660f09f4d59621038c490
+  metadata.gz: 8cd35ad0a76eba5eb98693d7360ad2f783efb2b1306ee2509f8850b9679fc54c25b6a3462d9cf3bdc27398b2b8c1d6ce0b972cf80e11b0e69f4b4c91a1cb609b
+  data.tar.gz: cf4fffc39d5e39ffcb8a8b8026f3de032e5a4487776afe732b957de5207838d705323c827a86242c86d42c8b0b9a4afff922506adeea034db2d13ab373304078

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ilkutkutlar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -10,7 +10,7 @@ The gem is useful when your program needs to accept a file path as input and you
 
 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
+## Installation
 
 ```rb
 gem install 'terminal-file-picker'
@@ -22,9 +22,11 @@ or add it to your project's `Gemfile`:
 gem 'terminal-file-picker'
 ```
 
-# Simple Usage
+## Simple Usage
 
 ```rb
+require 'terminal-file-picker'
+
 # 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.
@@ -39,7 +41,7 @@ picker = FilePicker.new('.')
 puts(picker.pick_file)
 ```
 
-# Options
+## 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)
 
@@ -89,3 +91,9 @@ You can change the date and time format of date modified and time modified colum
 ```rb
 FilePicker.new('.',  date_format: '%d-%m-%Y', time_format: '%H.%m')
 ```
+
+## Development
+
+- Officially, this gem supports Ruby versions >= 2.0.0 and such a Ruby version should be used during development as well.
+- Tests are written with [Rspec](https://github.com/rspec/rspec), version ~3.9. Run the tests on terminal with `rspec` in the project directory (need to install rspec first).
+- [Rubocop](https://github.com/rubocop-hq/rubocop) version ~0.8.2 is used to check for use of best practices and standard styling. Run Rubocop on the terminal with `rubocop` in the project directory (need to install Rubocop first). Currently, there are a couple of failing Rubocop checks which will be fixed soon.

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

@@ -1,5 +1,3 @@
-require 'pry'
-
 # Functions related to retrieving and formatting
 # information related to directories and their contents.
 class FileBrowserModel
@@ -35,6 +33,8 @@ class FileBrowserModel
   # Order files such that '.' and '..' come before
   # all the other files.
   def order_files(files)
+    # Pre-sort files.
+    files.sort!{|a,b| a[0]<=>b[0]}
     # Put "." and ".." at the start
     groups = files.group_by do |f|
       if f.first == './' || f.first == '../'

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

@@ -1,4 +1,3 @@
-require 'pry'
 require 'tty-cursor'
 require 'tty-reader'
 require_relative 'file_browser_view'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal-file-picker
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Ilkut Kutlar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -101,8 +101,11 @@ email:
 - ilkutkutlar@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
+- LICENSE
 - README.md
 - lib/terminal-file-picker.rb
 - lib/terminal-file-picker/file_browser_model.rb
@@ -129,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Interactive terminal file picker