tty-editor 0.4.0 → 0.7.0

data/lib/tty-editor.rb

@@ -1,3 +1 @@
-# encoding: utf-8
-
-require_relative 'tty/editor'
+require_relative "tty/editor"

data/lib/tty/editor.rb

@@ -1,141 +1,209 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-prompt'
-require 'tty-which'
-require 'tempfile'
-require 'fileutils'
-require 'shellwords'
+require "pathname"
+require "shellwords"
+require "tempfile"
+require "tty-prompt"
 
-require_relative 'editor/version'
+require_relative "editor/version"
 
 module TTY
   # A class responsible for launching an editor
   #
   # @api public
   class Editor
+    Error = Class.new(StandardError)
+
+    # Raised when user provides unnexpected or incorrect argument
+    InvalidArgumentError = Class.new(Error)
+
     # Raised when command cannot be invoked
     class CommandInvocationError < RuntimeError; end
 
     # Raised when editor cannot be found
     class EditorNotFoundError < RuntimeError; end
 
-    # Check if editor exists
+    # List possible command line text editors
     #
-    # @return [Boolean]
+    # @return [Array<String>]
     #
-    # @api private
-    def self.exist?(cmd)
-      TTY::Which.exist?(cmd)
-    end
+    # @api public
+    EXECUTABLES = [
+      "atom", "code", "emacs", "gedit", "jed", "kate",
+      "mate -w", "mg", "nano -w", "notepad", "pico",
+      "qe", "subl -n -w", "vi", "vim"
+    ].freeze
 
-    # Check if Windowz
+    # Check if editor command exists
+    #
+    # @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 public
-    def self.windows?
-      ::File::ALT_SEPARATOR == "\\"
+    # @api private
+    def self.exist?(command)
+      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)
+        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
-      [ENV['VISUAL'], ENV['EDITOR']].compact
+      [ENV["VISUAL"], ENV["EDITOR"]].compact
     end
 
-    # List possible executable for editor command
-    #
-    # @return [Array[String]]
+    # Find available text editors
     #
-    # @api public
-    def self.executables
-      ['vim', 'vi', 'emacs', 'nano', 'nano-tiny', 'pico', 'mate -w']
-    end
-
-    # Find available command
-    #
-    # @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)
-      return commands unless commands.empty?
+      if commands.any?
+        execs = search_executables(commands.map(&:to_s))
+        return execs unless execs.empty?
+      end
 
-      if !from_env.all?(&:empty?)
-        [from_env.find { |e| !e.empty? }]
-      elsif windows?
-        ['notepad']
-      else
-        executables.uniq.select(&method(:exist?))
+      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
     #
     # @example
-    #   TTY::Editor.open('filename.rb')
+    #   TTY::Editor.open("/path/to/filename")
     #
-    # @param [String] file
-    #   the name of the file
+    # @example
+    #   TTY::Editor.open("file1", "file2", "file3")
+    #
+    # @example
+    #   TTY::Editor.open(text: "Some text")
+    #
+    # @param [Array<String>] files
+    #   the files to open in an editor
+    # @param [String] command
+    #   the editor command to use, by default auto detects
+    # @param [String] text
+    #   the text to edit in an editor
+    # @param [Hash] env
+    #   environment variables to forward to the editor
     #
     # @return [Object]
     #
     # @api public
-    def self.open(*args)
-      editor = new(*args)
-
-      yield(editor) if block_given?
-
-      editor.open
+    def self.open(*files, text: nil, **options, &block)
+      editor = new(**options, &block)
+      editor.open(*files, text: text)
     end
 
     # Initialize an Editor
     #
-    # @param [String] file
-    # @param [Hash[Symbol]] options
-    # @option options [Hash] :command
+    # @example
+    #   TTY::Editor.new(command: "vim")
+    #
+    # @param [String] command
     #   the editor command to use, by default auto detects
-    # @option options [Hash] :env
+    # @param [Hash] env
     #   environment variables to forward to the editor
+    # @param [IO] input
+    #   the standard input
+    # @param [IO] output
+    #   the standard output
+    # @param [Boolean] raise_on_failure
+    #   whether or not raise on command failure, false 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(*args, **options)
-      @filename = args.unshift.first
-      @env      = options.fetch(:env) { {} }
-      @command  = options[:command]
-      if @filename
-        if ::File.exist?(@filename) && !::FileTest.file?(@filename)
-          raise ArgumentError, "Don't know how to handle `#{@filename}`. " \
-                               "Please provida a file path or content"
-        elsif ::File.exist?(@filename) && !options[:content].to_s.empty?
-          ::File.open(@filename, 'a') { |f| f.write(options[:content]) }
-        elsif !::File.exist?(@filename)
-          ::File.write(@filename, options[:content])
-        end
-      elsif options[:content]
-        @filename = tempfile_path(options[:content])
-      end
+    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
+      @enable_color = enable_color
+      @hide_menu = hide_menu
+      @prompt = prompt
+      @menu_interrupt = menu_interrupt
+
+      block.(self) if block
+
+      command(*Array(command))
     end
 
     # Read or update environment vars
     #
+    # @example
+    #   editor.env({"FOO" => "bar"})
+    #
+    # @param [Hash{String => String}] value
+    #   the environment variables to use
+    #
+    # @return [Hash]
+    #
     # @api public
     def env(value = (not_set = true))
       return @env if not_set
+
       @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
     #
-    # @param [Array[String]] commands
+    # @example
+    #   editor.command("vim")
+    #
+    # @param [Array<String>] commands
     #   the optional command to use, by default auto detecting
     #
-    # @raise [TTY::CommandInvocationError]
+    # @raise [TTY::Editor::CommandInvocationError]
     #
     # @return [String]
     #
@@ -146,64 +214,120 @@ module TTY
       execs = self.class.available(*commands)
       if execs.empty?
         raise EditorNotFoundError,
-              'Could not find editor to use. Please specify $VISUAL or $EDITOR'
+              "could not find a text editor to use. Please specify $VISUAL or "\
+              "$EDITOR or install one of the following editors: " \
+              "#{EXECUTABLES.map { |ed| ed.split.first }.join(", ")}."
       end
-      exec = choose_exec_from(execs)
-      @command = TTY::Which.which(exec.to_s)
+      @command = choose_exec_from(execs)
     end
 
+    # Run editor command in a shell
+    #
+    # @param [Array<String>] files
+    #   the files to open in an editor
+    # @param [String] text
+    #   the text to edit in an editor
+    #
+    # @raise [TTY::Editor::CommandInvocationError]
+    #
+    # @return [Boolean]
+    #   whether editor command suceeded or not
+    #
     # @api private
-    def choose_exec_from(execs)
-      if execs.size > 1
-        prompt = TTY::Prompt.new
-        prompt.enum_select('Select an editor?', execs)
-      else
-        execs[0]
+    def open(*files, text: nil)
+      validate_arguments(files, text)
+      text_written = false
+
+      filepaths = files.reduce([]) do |paths, filename|
+        if !::File.exist?(filename)
+          ::File.write(filename, text || "")
+          text_written = true
+        end
+        paths + [filename]
+      end
+
+      if !text.nil? && !text_written
+        tempfile = create_tempfile(text)
+        filepaths << tempfile.path
       end
+
+      run(filepaths)
+    ensure
+      tempfile.unlink if tempfile
     end
 
-    # Escape file path
+    private
+
+    # Run editor command with file arguments
+    #
+    # @param [Array<String>] filepaths
+    #   the file paths to open in an editor
+    #
+    # @return [Boolean]
+    #   whether command succeeded or not
     #
     # @api private
-    def escape_file
-      Shellwords.shellescape(@filename)
+    def run(filepaths)
+      command_path = "#{command} #{filepaths.shelljoin}"
+      status = system(env, *Shellwords.split(command_path))
+      if @raise_on_failure && !status
+        raise CommandInvocationError,
+              "`#{command_path}` failed with status: #{$? ? $?.exitstatus : nil}"
+      end
+      !!status
     end
 
-    # Build command path to invoke
+    # Check if filename and text arguments are valid
     #
-    # @return [String]
+    # @raise [InvalidArgumentError]
+    #
+    # @return [nil]
     #
     # @api private
-    def command_path
-      "#{command} #{escape_file}"
+    def validate_arguments(files, text)
+      return if files.empty?
+
+      if files.all? { |file| ::File.exist?(file) } && !text.nil?
+        raise InvalidArgumentError,
+              "cannot give a path to an existing file and text at the same time."
+      elsif filename = files.find { |file| ::File.exist?(file) && !::FileTest.file?(file) }
+        raise InvalidArgumentError, "don't know how to handle `#{filename}`. " \
+                                    "Please provide a file path or text"
+      end
     end
 
-    # Create tempfile with content
+    # Create tempfile with text
     #
-    # @param [String] content
+    # @param [String] text
+    #
+    # @return [Tempfile]
     #
-    # @return [String]
     # @api private
-    def tempfile_path(content)
-      tempfile = Tempfile.new('tty-editor')
-      tempfile << content
+    def create_tempfile(text)
+      tempfile = Tempfile.new("tty-editor")
+      tempfile << text
       tempfile.flush
-      unless tempfile.nil?
-        tempfile.close
-      end
-      tempfile.path
+      tempfile.close
+      tempfile
     end
 
-    # Inovke editor command in a shell
+    # Render an editor selection prompt to the terminal
     #
-    # @raise [TTY::CommandInvocationError]
+    # @return [String]
+    #   the chosen editor
     #
     # @api private
-    def open
-      status = system(env, *Shellwords.split(command_path))
-      return status if status
-      fail CommandInvocationError,
-           "`#{command_path}` failed with status: #{$? ? $?.exitstatus : nil}"
+    def choose_exec_from(execs)
+      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
+      else
+        execs[0]
+      end
     end
   end # Editor
 end # TTY

data/lib/tty/editor/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module TTY
   class Editor
-    VERSION = '0.4.0'.freeze
+    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.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -16,112 +16,69 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: tty-which
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   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: Opens a file or text in the user's preferred editor.
+description: Open a file or text in a preferred terminal text editor.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- bin/console
-- bin/setup
-- examples/basic.rb
-- examples/choices.rb
-- examples/empty.rb
-- examples/env.rb
-- examples/tempfile.rb
 - lib/tty-editor.rb
 - lib/tty/editor.rb
 - lib/tty/editor/version.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-editor.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-editor/issues
+  changelog_uri: https://github.com/piotrmurach/tty-editor/blob/master/CHANGELOG.md
+  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:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Opens a file or text in the user's preferred editor.
+summary: Open a file or text in a preferred terminal text editor.
 test_files: []