tty-editor 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43382f86c223e305662a67b003a4337ce5946adaee09dcd48879714a91e45eae
-  data.tar.gz: fd58b6084c4cbedd605c09ce30fca817ea7f4d467e32ddfd558e3c7eb972f0a4
+  metadata.gz: 4c69c19a05883e0929e4f5432eb4732036b11866419842e7e9b08906de54d1fb
+  data.tar.gz: e7a817e4d91766846da2274c4c0cb0b76fc116bb189c9d01f9bb5feb4555fe96
 SHA512:
-  metadata.gz: 31385f2ece1195d0c3801e495830c182f6808050c510ae83f3c78f48117a6a6a088ffce3177ea5283507a7e67cc235f6e580261e73ce03d0916044eeaeed0209
-  data.tar.gz: ddf5f4e74879e30a641ca4d3c7af06ffb0b7e36f8dd989915d599b283855e1fee77843d4788dd60eb7be93b1ef47b77285abb4a06b60528a36aefae75717dead
+  metadata.gz: ee9f89d51a6d0645887416dae70c6c435af1d87ed8d90a8c3f7c459ff2f3e6eb2776afe818cf1b1285ad323e3ca771a7d9e3b31ad91af1083789d1c3fcbc06d5
+  data.tar.gz: 1e3668e7158517017a779b1aac72abc85296c58c81c2388136b08b3228d2c5b045727282216af54daea838aed56474e4e639fb89ebf6e38ffeae02df70fe1698

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## [v0.7.0] - 2021-05-31
+
+### Added
+* Add :enable_color option to allow control over editor menu colouring
+* Add :menu_interrupt to control how editor select menu handles interrupt signal
+* Add gedit and kate to the list of default editors
+
+### Changed
+* Change to search default editors when command and env variables checks fail
+* Change to rename :show_menu option as :hide_menu to indicate default behaviour
+* Change default editors list to be sorted in alphabetical order
+
+### Fixed
+* Fix Editor#exist? to correctly check command with an absolute path
+
 ## [v0.6.0] - 2020-09-22
 
 ### Added
@@ -84,6 +99,7 @@
 
 * Initial implementation and release
 
+[v0.7.0]: https://github.com/piotrmurach/tty-editor/compare/v0.6.0...v0.7.0
 [v0.6.0]: https://github.com/piotrmurach/tty-editor/compare/v0.5.1...v0.6.0
 [v0.5.1]: https://github.com/piotrmurach/tty-editor/compare/v0.5.0...v0.5.1
 [v0.5.0]: https://github.com/piotrmurach/tty-editor/compare/v0.4.1...v0.5.0
@@ -94,4 +110,4 @@
 [v0.2.0]: https://github.com/piotrmurach/tty-editor/compare/v0.1.2...v0.2.0
 [v0.1.2]: https://github.com/piotrmurach/tty-editor/compare/v0.1.1...v0.1.2
 [v0.1.1]: https://github.com/piotrmurach/tty-editor/compare/v0.1.0...v0.1.1
-[v0.1.0]: https://github.com/piotrmurach/tty-editor/compare/v0.1.0
+[v0.1.0]: https://github.com/piotrmurach/tty-editor/compare/762a7ec...v0.1.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Piotr Murach
+Copyright (c) 2016 Piotr Murach (piotrmurach.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,25 +1,25 @@
 <div align="center">
-  <a href="https://ttytoolkit.org" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit logo" /></a>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit logo" /></a>
 </div>
 
 # TTY::Editor [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-editor.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-editor.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/tty-editor/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/yw4guy16meq5wkee?svg=true)][appveyor]
 [![Maintainability](https://api.codeclimate.com/v1/badges/0afb9e75eef4ae4615c6/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-editor/badge.svg)][coverage]
-[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-editor.svg?branch=master)][inchpages]
+[![Inline docs](https://inch-ci.org/github/piotrmurach/tty-editor.svg?branch=master)][inchpages]
 
 [gitter]: https://gitter.im/piotrmurach/tty
-[gem]: http://badge.fury.io/rb/tty-editor
-[travis]: http://travis-ci.org/piotrmurach/tty-editor
+[gem]: https://badge.fury.io/rb/tty-editor
+[gh_actions_ci]: https://github.com/piotrmurach/tty-editor/actions?query=workflow%3ACI
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-editor
 [codeclimate]:https://codeclimate.com/github/piotrmurach/tty-editor/maintainability
 [coverage]: https://coveralls.io/github/piotrmurach/tty-editor
-[inchpages]: http://inch-ci.org/github/piotrmurach/tty-editor
+[inchpages]: https://inch-ci.org/github/piotrmurach/tty-editor
 
-> Opens a file or text in the user's preferred editor.
+> Open a file or text in a preferred terminal text editor.
 
 **TTY::Editor** provides independent component for [TTY](https://github.com/piotrmurach/tty) toolkit.
 
@@ -48,7 +48,11 @@ Or install it yourself as:
     * [2.1.2 :env](#212-env)
     * [2.1.3 :raise_on_failure](#213-raise_on_failure)
     * [2.1.4 :prompt](#214-prompt)
+    * [2.1.5 :hide_menu](#215-hide_menu)
+    * [2.1.6 :enable_color](#216-enable_color)
+    * [2.1.7 :menu_interrupt](#217-menu_interrupt)
   * [2.2 open](#22-open)
+* [3. Default Editors](#3-default-editors)
 
 ## 1. Usage
 
@@ -80,17 +84,17 @@ TTY::Editor.open("/path/to/file", command: "vim -f")
 
 When `VISUAL` or `EDITOR` are not specified, a selection menu will be presented to the user.
 
-For example, if an user has `vim`, `emacs` and `code` editors available on their system, they will see the following menu:
+For example, if an user has `code`, `emacs` and `vim` editors available on their system, they will see the following menu:
 
 ```
-# Select an editor?
-#   1) vim
-#   2) emacs
-#   3) code
-#   Choose 1-2 [1]:
+Select an editor?
+  1) code
+  2) emacs
+  3) vim
+  Choose 1-3 [1]:
 ```
 
-You can further customise this behaviour with [:prompt](#214-prompt).
+You can further customise this behaviour with [:prompt](#214-prompt), [:hide_menu](#215-hide_menu), [:enable_color](#216-enable_color) and [:menu_interrupt](#217-menu_interrupt).
 
 ## 2. API
 
@@ -160,14 +164,14 @@ editor.open("/path/to/unknown/file")
 
 When more than one editor is available and user hasn't specified their preferred choice via `VISUAL` or `EDITOR` variables, a selection menu is presented.
 
-For example, when `vim`, `emacs` and `code` executable exists on the system, the following menu will be displayed:
+For example, when `code`, `emacs` and `vim` executable exists on the system, the following menu will be displayed:
 
 ```
-# Select an editor?
-#   1) vim
-#   2) emacs
-#   3) code
-#   Choose 1-2 [1]:
+Select an editor?
+  1) code
+  2) emacs
+  3) vim
+  Choose 1-3 [1]:
 ```
 
 If you would like to change the menu prompt use `:prompt` keyword:
@@ -180,11 +184,59 @@ editor.open("/path/to/file")
 This may produce the following in the terminal:
 
 ```
-# Which one do you fancy?
-#   1) vim
-#   2) emacs
-#   3) code
-#   Choose 1-2 [1]:
+Which one do you fancy?
+  1) code
+  2) emacs
+  3) vim
+  Choose 1-3 [1]:
+```
+
+#### 2.1.5 :hide_menu
+
+When more than one editor is available from the default list, a selection menu will be displayed in the console:
+
+```
+Select an editor?
+  1) code
+  2) emacs
+  3) vim
+  Choose 1-3 [1]:
+```
+
+To hide the menu and automatically choose the first available editor use the `:hide_menu` keyword option:
+
+```ruby
+editor = TTY::Editor.new(hide_menu: true)
+```
+
+#### 2.1.6 :enable_color
+
+An editor selection menu will display the first choice in colour on terminals that support colours. However, you can turn off colouring with the `:enable_color` keyword option:
+
+```ruby
+editor = TTY::Editor.new(enable_color: false)
+```
+
+Equally, you can enforce the current menu choice to be always coloured:
+
+```ruby
+editor = TTY::Editor.new(enable_color: true)
+```
+
+### 2.1.7 :menu_interrupt
+
+When an editor selection menu gets interrupted by the `Ctrl+C` key, an `InputInterrupt` error is raised. To change this, provide the `:menu_interrupt` option with one of the following:
+
+* `:error` - raises `InputInterrupt` error
+* `:exit` - exits with `130` status code
+* `:noop` - skips handler
+* `:signal` - sends interrupt signal
+* `proc` - custom proc handler
+
+For example, to immediately exit the menu and program do:
+
+```ruby
+editor = TTY::Editor.new(menu_interrupt: :exit)
 ```
 
 ### 2.2 open
@@ -241,6 +293,25 @@ You can also open multiple existing and non-existing files providing them as con
 TTY::Editor.open("file_1", "file_2", "new_file_3")
 ```
 
+## 3. Default Editors
+
+When an editor in `EDITOR` and `VISUAL` environment variables can't be found or isn't specified, a choice menu is displayed. The menu includes available editors from the default list of text editors:
+
+* `Atom`
+* `Emacs`
+* `gedit`
+* `JED`
+* `Kate`
+* `Mg`
+* `Nano`
+* `Notepad`
+* `Pico`
+* `Sublime Text`
+* `TextMate`
+* `Vi`
+* `Vim`
+* `Visual Studio Code`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -249,12 +320,16 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-editor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-editor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/piotrmurach/tty-editor/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Code of Conduct
+
+Everyone interacting in the TTY::Editor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-editor/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
 Copyright (c) 2017 Piotr Murach. See LICENSE for further details.

data/lib/tty/editor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "fileutils"
+require "pathname"
 require "shellwords"
 require "tempfile"
 require "tty-prompt"
@@ -25,13 +25,13 @@ module TTY
 
     # List possible command line text editors
     #
-    # @return [Array[String]]
+    # @return [Array<String>]
     #
     # @api public
     EXECUTABLES = [
-      "nano -w", "notepad", "vim", "vi", "emacs",
-      "code", "subl -n -w", "mate -w", "atom",
-      "pico", "qe", "mg", "jed"
+      "atom", "code", "emacs", "gedit", "jed", "kate",
+      "mate -w", "mg", "nano -w", "notepad", "pico",
+      "qe", "subl -n -w", "vi", "vim"
     ].freeze
 
     # Check if editor command exists
@@ -39,20 +39,35 @@ module TTY
     # @example
     #   exist?("vim") # => true
     #
+    # @example
+    #   exist?("/usr/local/bin/vim") # => true
+    #
+    # @example
+    #   exist?("C:\\Program Files\\Vim\\vim.exe") # => true
+    #
+    # @param [String] command
+    #   the command to check for the existence
+    #
     # @return [Boolean]
     #
     # @api private
     def self.exist?(command)
-      exts = ENV.fetch("PATHEXT", "").split(::File::PATH_SEPARATOR)
+      path = Pathname(command)
+      exts = [""].concat(ENV.fetch("PATHEXT", "").split(::File::PATH_SEPARATOR))
+
+      if path.absolute?
+        return exts.any? { |ext| ::File.exist?("#{command}#{ext}") }
+      end
+
       ENV.fetch("PATH", "").split(::File::PATH_SEPARATOR).any? do |dir|
         file = ::File.join(dir, command)
-        ::File.exist?(file) || exts.any? { |ext| ::File.exist?("#{file}#{ext}") }
+        exts.any? { |ext| ::File.exist?("#{file}#{ext}") }
       end
     end
 
     # Check editor from environment variables
     #
-    # @return [Array[String]]
+    # @return [Array<String>]
     #
     # @api public
     def self.from_env
@@ -61,24 +76,37 @@ module TTY
 
     # Find available text editors
     #
-    # @param [Array[String]] commands
+    # @param [Array<String>] commands
     #   the commands to use intstead of defaults
     #
-    # @return [Array[String]]
+    # @return [Array<String>]
     #   the existing editor commands
     #
     # @api public
     def self.available(*commands)
-      execs = if !commands.empty?
-                commands.map(&:to_s)
-              elsif from_env.any?
-                [from_env.first]
-              else
-                EXECUTABLES
-              end
+      if commands.any?
+        execs = search_executables(commands.map(&:to_s))
+        return execs unless execs.empty?
+      end
+
+      if from_env.any?
+        execs = search_executables(from_env)
+        return execs unless execs.empty?
+      end
+
+      search_executables(EXECUTABLES)
+    end
+
+    # Search for existing executables
+    #
+    # @return [Array<String>]
+    #
+    # @api private
+    def self.search_executables(execs)
       execs.compact.map(&:strip).reject(&:empty?).uniq
            .select { |exec| exist?(exec.split.first) }
     end
+    private_class_method :search_executables
 
     # Open file in system editor
     #
@@ -93,11 +121,11 @@ module TTY
     #
     # @param [Array<String>] files
     #   the files to open in an editor
-    # @param [String] :command
+    # @param [String] command
     #   the editor command to use, by default auto detects
-    # @param [String] :text
+    # @param [String] text
     #   the text to edit in an editor
-    # @param [Hash] :env
+    # @param [Hash] env
     #   environment variables to forward to the editor
     #
     # @return [Object]
@@ -110,30 +138,40 @@ module TTY
 
     # Initialize an Editor
     #
-    # @param [String] :command
+    # @example
+    #   TTY::Editor.new(command: "vim")
+    #
+    # @param [String] command
     #   the editor command to use, by default auto detects
-    # @param [Hash] :env
+    # @param [Hash] env
     #   environment variables to forward to the editor
-    # @param [IO] :input
+    # @param [IO] input
     #   the standard input
-    # @param [IO] :output
+    # @param [IO] output
     #   the standard output
-    # @param [Boolean] :raise_on_failure
+    # @param [Boolean] raise_on_failure
     #   whether or not raise on command failure, false by default
-    # @param [Boolean] :show_menu
-    #   whether or not show commands menu, true by default
+    # @param [Boolean] hide_menu
+    #   whether or not to hide commands menu, false by default
+    # @param [Boolean] enable_color
+    #   disable or force prompt coloring, defaults to nil
+    # @param [Symbol] menu_interrupt
+    #   how to handle Ctrl+C key interrupt out of :error, :signal, :exit, :noop
     #
     # @api public
-    def initialize(command: nil, raise_on_failure: false, show_menu: true,
-                   prompt: "Select an editor?", env: {},
-                   input: $stdin, output: $stdout, &block)
+    def initialize(command: nil, raise_on_failure: false, hide_menu: false,
+                   prompt: "Select an editor?", env: {}, enable_color: nil,
+                   input: $stdin, output: $stdout, menu_interrupt: :error,
+                   &block)
       @env = env
       @command = nil
       @input = input
       @output = output
       @raise_on_failure = raise_on_failure
-      @show_menu = show_menu
+      @enable_color = enable_color
+      @hide_menu = hide_menu
       @prompt = prompt
+      @menu_interrupt = menu_interrupt
 
       block.(self) if block
 
@@ -142,6 +180,12 @@ module TTY
 
     # Read or update environment vars
     #
+    # @example
+    #   editor.env({"FOO" => "bar"})
+    #
+    # @param [Hash{String => String}] value
+    #   the environment variables to use
+    #
     # @return [Hash]
     #
     # @api public
@@ -151,12 +195,15 @@ module TTY
       @env = value
     end
 
-    # Finds command using a configured command(s) or detected shell commands.
+    # Finds command using a configured command(s) or detected shell commands
+    #
+    # @example
+    #   editor.command("vim")
     #
-    # @param [Array[String]] commands
+    # @param [Array<String>] commands
     #   the optional command to use, by default auto detecting
     #
-    # @raise [TTY::CommandInvocationError]
+    # @raise [TTY::Editor::CommandInvocationError]
     #
     # @return [String]
     #
@@ -178,10 +225,10 @@ module TTY
     #
     # @param [Array<String>] files
     #   the files to open in an editor
-    # @param [String] :text
+    # @param [String] text
     #   the text to edit in an editor
     #
-    # @raise [TTY::CommandInvocationError]
+    # @raise [TTY::Editor::CommandInvocationError]
     #
     # @return [Boolean]
     #   whether editor command suceeded or not
@@ -234,6 +281,8 @@ module TTY
     #
     # @raise [InvalidArgumentError]
     #
+    # @return [nil]
+    #
     # @api private
     def validate_arguments(files, text)
       return if files.empty?
@@ -269,8 +318,10 @@ module TTY
     #
     # @api private
     def choose_exec_from(execs)
-      if @show_menu && execs.size > 1
-        prompt = TTY::Prompt.new(input: @input, output: @output, env: @env)
+      if !@hide_menu && execs.size > 1
+        prompt = TTY::Prompt.new(input: @input, output: @output, env: @env,
+                                 enable_color: @enable_color,
+                                 interrupt: @menu_interrupt)
         exec = prompt.enum_select(@prompt, execs)
         @output.print(prompt.cursor.up + prompt.cursor.clear_line)
         exec

data/lib/tty/editor/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Editor
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end # Editor
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-editor
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -42,17 +42,17 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Open a file or text in a terminal text editor.
+description: Open a file or text in a preferred terminal text editor.
 email:
 - piotr@piotrmurach.com
 executables: []
@@ -78,7 +78,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/tty-editor
   homepage_uri: https://ttytoolkit.org
   source_code_uri: https://github.com/piotrmurach/tty-editor
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: Open a file or text in a terminal text editor.
+summary: Open a file or text in a preferred terminal text editor.
 test_files: []