tty-editor 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b9918234c5fc0e4eabd6a59d859fc16a2827c88
-  data.tar.gz: e609ed53f8aa25a9590405d924ac27a35f8fb47c
+SHA256:
+  metadata.gz: 43382f86c223e305662a67b003a4337ce5946adaee09dcd48879714a91e45eae
+  data.tar.gz: fd58b6084c4cbedd605c09ce30fca817ea7f4d467e32ddfd558e3c7eb972f0a4
 SHA512:
-  metadata.gz: bea5f34a6cd157e0804107ffa1c6fec9ade2a12bebe6506843a56f212bb2a93af37050ed5e5ed7bd359e3a1e76bd8a0a11efc3b9e8261f37093bf962e852df27
-  data.tar.gz: 21dd8869bcba744dc42759e70f70db5e653e597eee5b13b1cb258f55e5b8965502ca2a37d5a7582d9d6fae318c6c2d8213232a54bcfe53cc62b7a2ccf8671f71
+  metadata.gz: 31385f2ece1195d0c3801e495830c182f6808050c510ae83f3c78f48117a6a6a088ffce3177ea5283507a7e67cc235f6e580261e73ce03d0916044eeaeed0209
+  data.tar.gz: ddf5f4e74879e30a641ca4d3c7af06ffb0b7e36f8dd989915d599b283855e1fee77843d4788dd60eb7be93b1ef47b77285abb4a06b60528a36aefae75717dead

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Change log
 
+## [v0.6.0] - 2020-09-22
+
+### Added
+* Add ability to edit multiple files
+* Add ability to configure input and output
+* Add :raise_on_failure configuration option to control editor failure to run
+* Add :show_menu configuration option to disable editor menu choice
+* Add :prompt to configure an editor choice menu prompt
+
+### Changed
+* Change Editor#exist? to use direct path env var search
+* Change Editor#new to stop accepting filename and text arguments
+* Change Editor#new to select available text editors
+* Change Editor#open to accept keyword arguments
+* Change to stop raising when editor command cannot be run and return false instead
+* Remove tty-which dependency
+* Update tty-prompt dependency
+
+### Fixed
+* Fix to allow setting editor commands with flags
+
+## [v0.5.1] - 2019-08-06
+
+### Changed
+* Change to update tty-prompt dependency
+* Change to relax bundler & rake version requirement
+
+## [v0.5.0] - 2018-12-18
+
+### Changed
+* Change to update and relax tty-prompt & tty-which constraints
+
+## [v0.4.1] - 2018-08-29
+
+### Changed
+* Update tty-prompt dependency
+
+## [v0.4.0] - 2018-04-14
+
+### Changed
+* Update tty-prompt dependency
+* Change to freeze all strings
+
 ## [v0.3.0] - 2018-01-06
 
 ### Changed
@@ -41,6 +84,11 @@
 
 * Initial implementation and release
 
+[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
+[v0.4.1]: https://github.com/piotrmurach/tty-editor/compare/v0.4.0...v0.4.1
+[v0.4.0]: https://github.com/piotrmurach/tty-editor/compare/v0.3.0...v0.4.0
 [v0.3.0]: https://github.com/piotrmurach/tty-editor/compare/v0.2.1...v0.3.0
 [v0.2.1]: https://github.com/piotrmurach/tty-editor/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/piotrmurach/tty-editor/compare/v0.1.2...v0.2.0

data/README.md

@@ -1,3 +1,7 @@
+<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>
+</div>
+
 # TTY::Editor [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-editor.svg)][gem]
@@ -24,7 +28,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-editor'
+gem "tty-editor"
 ```
 
 And then execute:
@@ -35,70 +39,206 @@ Or install it yourself as:
 
     $ gem install tty-editor
 
-## Usage
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. API](#2-api)
+  * [2.1 new](#21-new)
+    * [2.1.1 :command](#211-command)
+    * [2.1.2 :env](#212-env)
+    * [2.1.3 :raise_on_failure](#213-raise_on_failure)
+    * [2.1.4 :prompt](#214-prompt)
+  * [2.2 open](#22-open)
+
+## 1. Usage
+
+To edit a file in a default text editor do:
+
+```ruby
+TTY::Editor.open("/path/to/file")
+```
 
-To edit a file in default editor:
+To edit text in a default editor:
 
 ```ruby
-TTY::Editor.open('hello.rb')
+TTY::Editor.open(text: "Some text")
 ```
 
-To edit content in a default editor:
+You can also open multiple existing and/or new files:
 
 ```ruby
-TTY::Editor.open(content: "some text")
+TTY::Editor.open("file_1", "file_2", "new_file_3")
 ```
 
-You can also set your preferred editor command:
+Note that the `VISUAL` or `EDITOR` shell environment variables take precedence when auto detecting available editors.
+
+You can also set your preferred editor command(s) and ignore `VISUAL` and `EDITOR` as well as other user preferences:
 
 ```ruby
-TTY::Editor.open('hello.rb', command: :vim)
+TTY::Editor.open("/path/to/file", command: "vim -f")
 ```
 
-Also, the `VISUAL` or `EDITOR` shell environment variables take precedencee when auto detecting available editors.
+When `VISUAL` or `EDITOR` are not specified, a selection menu will be presented to the user.
 
-## Interface
+For example, if an user has `vim`, `emacs` and `code` editors available on their system, they will see the following menu:
 
-### open
+```
+# Select an editor?
+#   1) vim
+#   2) emacs
+#   3) code
+#   Choose 1-2 [1]:
+```
 
-If you wish to open editor with no file or content do:
+You can further customise this behaviour with [:prompt](#214-prompt).
+
+## 2. API
+
+### 2.1 new
+
+Instantiation of an editor will trigger automatic search for available command-line editors:
 
 ```ruby
-TTY::Editor.open
+editor = TTY::Editor.new
 ```
 
-When editor successfully opens file or content then `true` is returned.
+You can change default search with the `:command` keyword argument.
 
-If the editor cannot be opened, a `TTY::Editor::CommandInvocation` error is raised.
+#### 2.1.1 :command
 
-In order to open text content inside an editor do:
+You can force to always use a specific editor by passing `:command` option:
 
 ```ruby
-TTY::Editor.open(content: 'text')
+editor = TTY::Editor.new(command: "vim")
 ```
 
-You can also provide filename that will be created with specified content before editor is opened:
+Or you can specify multiple commands and give a user a choice:
+
+```ruby
+editor = TTY::Editor.new(command: ["vim", "emacs"])
+```
+
+The class-level `open` method accepts the same parameters:
 
 ```ruby
-TTY::Editor.open('new.rb', content: 'text')
+TTY::Editor.open("/path/to/file", command: "vim")
 ```
 
-If you open a filename with already existing content then new content gets appended at the end of the file.
+#### 2.1.2 :env
 
-### :env
+Use `:env` key to forward environment variables to the text editor launch command:
 
-Use `:env` key to forward environment variables to  the editor.
+```ruby
+TTY::Editor.new(env: {"FOO" => "bar"})
+```
+
+The class-level `open` method accepts the same parameters:
 
 ```ruby
-TTY::Editor.open('hello.rb', env: {"FOO" => "bar"})
+TTY::Editor.open("/path/to/file", env: {"FOO" => "bar"})
 ```
 
-### :command
+#### 2.1.3 :raise_on_failure
 
-You can force to always use a specific editor by passing `:command` option:
+By default when editor fails to open a `false` status is returned:
+
+```ruby
+TTY::Editor.open("/path/to/unknown/file") # => false
+```
+
+Alternatively, you can use `:raise_on_failure` to raise an error on failure to open a file.
+
+The `TTY::Editor::CommandInvocationError` will be raised anytime an editor fails to open a file:
+
+```ruby
+editor = TTY::Editor.new(raise_on_failure: true)
+editor.open("/path/to/unknown/file")
+# => raises TTY::Editor::ComandInvocationError
+```
+
+#### 2.1.4 :prompt
+
+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:
+
+```
+# Select an editor?
+#   1) vim
+#   2) emacs
+#   3) code
+#   Choose 1-2 [1]:
+```
+
+If you would like to change the menu prompt use `:prompt` keyword:
+
+```ruby
+editor = TTY::Editor.new(prompt: "Which one do you fancy?")
+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]:
+```
+
+### 2.2 open
+
+There is a class-level and instance-level `open` method. These are equivalent:
+
+```ruby
+editor = TTY::Editor.new
+editor.open(...)
+# or
+TTY::Editor.open(...)
+```
+
+Creating `TTY::Editor` instance means that the search for a command editor will be performed only once. Then the editor command will be shared between invocations of `open` call.
+
+Conversely, the class-level `open` method will search for an editor each time it is invoked.
+
+The following examples of using the `open` method apply to both the instance and class level invocations.
+
+If you wish to open an editor without giving a file or content do:
+
+```ruby
+TTY::Editor.open
+```
+
+To open a file, pass a path as an argument to `open`:
+
+```ruby
+TTY::Editor.open("../README.md")
+# => true
+```
+
+When editor successfully opens a file or content then `true` is returned, `false` otherwise.
+
+You can change this with `:raise_on_failure` keyword to raise a `TTY::Editor::CommandInvocation` error when an editor cannot be opened.
+
+In order to open text content inside an editor use `:text` keyword like so:
+
+```ruby
+TTY::Editor.open(text: "Some text")
+```
+
+You can also provide filename that will be created with specified content before editor is opened:
+
+```ruby
+TTY::Editor.open("/path/to/new-file", text: "Some text")
+```
+
+If you open a filename with already existing content then the new content will be appended at the end of the file.
+
+You can also open multiple existing and non-existing files providing them as consecutive arguments:
 
 ```ruby
-TTY::Editor.open('hello.rb', command: :vim)
+TTY::Editor.open("file_1", "file_2", "new_file_3")
 ```
 
 ## Development
@@ -117,4 +257,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright (c) 2017-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2017 Piotr Murach. See LICENSE for further details.

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,40 +1,53 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-prompt'
-require 'tty-which'
-require 'tempfile'
-require 'fileutils'
-require 'shellwords'
+require "fileutils"
+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 = [
+      "nano -w", "notepad", "vim", "vi", "emacs",
+      "code", "subl -n -w", "mate -w", "atom",
+      "pico", "qe", "mg", "jed"
+    ].freeze
 
-    # Check if Windowz
+    # Check if editor command exists
+    #
+    # @example
+    #   exist?("vim") # => true
     #
     # @return [Boolean]
     #
-    # @api public
-    def self.windows?
-      ::File::ALT_SEPARATOR == "\\"
+    # @api private
+    def self.exist?(command)
+      exts = ENV.fetch("PATHEXT", "").split(::File::PATH_SEPARATOR)
+      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}") }
+      end
     end
 
     # Check editor from environment variables
@@ -43,90 +56,98 @@ module TTY
     #
     # @api public
     def self.from_env
-      [ENV['VISUAL'], ENV['EDITOR']].compact
-    end
-
-    # List possible executable for editor command
-    #
-    # @return [Array[String]]
-    #
-    # @api public
-    def self.executables
-      ['vim', 'vi', 'emacs', 'nano', 'nano-tiny', 'pico', 'mate -w']
+      [ENV["VISUAL"], ENV["EDITOR"]].compact
     end
 
-    # Find available command
+    # Find available text editors
     #
     # @param [Array[String]] commands
     #   the commands to use intstead of defaults
     #
     # @return [Array[String]]
+    #   the existing editor commands
     #
     # @api public
     def self.available(*commands)
-      return commands unless commands.empty?
-
-      if !from_env.all?(&:empty?)
-        [from_env.find { |e| !e.empty? }]
-      elsif windows?
-        ['notepad']
-      else
-        executables.uniq.select(&method(:exist?))
-      end
+      execs = if !commands.empty?
+                commands.map(&:to_s)
+              elsif from_env.any?
+                [from_env.first]
+              else
+                EXECUTABLES
+              end
+      execs.compact.map(&:strip).reject(&:empty?).uniq
+           .select { |exec| exist?(exec.split.first) }
     end
 
     # 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
+    # @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] :show_menu
+    #   whether or not show commands menu, true by default
     #
     # @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, show_menu: true,
+                   prompt: "Select an editor?", env: {},
+                   input: $stdin, output: $stdout, &block)
+      @env = env
+      @command = nil
+      @input = input
+      @output = output
+      @raise_on_failure = raise_on_failure
+      @show_menu = show_menu
+      @prompt = prompt
+
+      block.(self) if block
+
+      command(*Array(command))
     end
 
     # Read or update environment vars
     #
+    # @return [Hash]
+    #
     # @api public
     def env(value = (not_set = true))
       return @env if not_set
+
       @env = value
     end
 
@@ -146,64 +167,116 @@ 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::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]
     #
     # @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 @show_menu && execs.size > 1
+        prompt = TTY::Prompt.new(input: @input, output: @output, env: @env)
+        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.3.0'.freeze
+    VERSION = "0.6.0"
   end # Editor
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-editor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-01-06 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -16,62 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.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
@@ -86,41 +52,32 @@ dependencies:
     - - "~>"
       - !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 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: {}
+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:
@@ -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
+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 terminal text editor.
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,3 +0,0 @@
---require spec_helper
---color
---warnings

data/.travis.yml

@@ -1,24 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-script: "bundle exec rake ci"
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.8
-  - 2.3.6
-  - 2.4.3
-  - ruby-head
-  - jruby-9.1.7.0
-  - jruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: jruby-9.1.7.0
-  fast_finish: true
-branches:
-  only: master
-notifications:
-  email: false

data/CODE_OF_CONDUCT.md

@@ -1,49 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at [email]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem 'simplecov', '~> 0.12.0'
-  gem 'coveralls', '~> 0.8.0'
-end

data/Rakefile

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-task default: :spec
-
-desc 'Run all specs'
-task ci: %w[ spec ]

data/appveyor.yml

@@ -1,23 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake ci
-environment:
-  matrix:
-    - ruby_version: "193"
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
-matrix:
-  allow_failures:
-    - ruby_version: "193"

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tty/editor"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/basic.rb

@@ -1,7 +0,0 @@
-# encoding: utf-8
-
-require 'tty-editor'
-
-path = File.join(File.expand_path(File.dirname(__FILE__)), '../README.md')
-
-TTY::Editor.open(path)

data/examples/choices.rb

@@ -1,9 +0,0 @@
-# encoding: utf-8
-
-require 'tty-editor'
-
-path = File.join(File.expand_path(File.dirname(__FILE__)), '../README.md')
-
-TTY::Editor.open(path) do |editor|
-  editor.command :vim, :emacs
-end

data/examples/empty.rb

@@ -1,5 +0,0 @@
-# encoding: utf-8
-
-require 'tty-editor'
-
-TTY::Editor.open

data/examples/env.rb

@@ -1,7 +0,0 @@
-# encoding: utf-8
-
-require 'tty-editor'
-
-path = File.join(File.expand_path(File.dirname(__FILE__)), '../README.md')
-
-TTY::Editor.open(path, env: {"FOO" => "bar"})

data/examples/tempfile.rb

@@ -1,7 +0,0 @@
-# encoding: utf-8
-
-require 'tty-editor'
-
-content = "Human madness is oftentimes a cunning and most feline thing.\n When you think it fled, it may have but become transfigured into some still subtler form."
-
-TTY::Editor.open(content)

data/tasks/console.rake

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-desc 'Load gem inside irb console'
-task :console do
-  require 'irb'
-  require 'irb/completion'
-  require File.join(__FILE__, '../../lib/tty-editor')
-  ARGV.clear
-  IRB.start
-end

data/tasks/coverage.rake

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-desc 'Measure code coverage'
-task :coverage do
-  begin
-    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
-    Rake::Task['spec'].invoke
-  ensure
-    ENV['COVERAGE'] = original
-  end
-end

data/tasks/spec.rake

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-begin
-  require 'rspec/core/rake_task'
-
-  desc 'Run all specs'
-  RSpec::Core::RakeTask.new(:spec) do |task|
-    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
-  end
-
-  namespace :spec do
-    desc 'Run unit specs'
-    RSpec::Core::RakeTask.new(:unit) do |task|
-      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
-    end
-
-    desc 'Run integration specs'
-    RSpec::Core::RakeTask.new(:integration) do |task|
-      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
-    end
-  end
-
-rescue LoadError
-  %w[spec spec:unit spec:integration].each do |name|
-    task name do
-      $stderr.puts "In order to run #{name}, do `gem install rspec`"
-    end
-  end
-end

data/tty-editor.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tty/editor/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "tty-editor"
-  spec.version       = TTY::Editor::VERSION
-  spec.authors       = ["Piotr Murach"]
-  spec.email         = [""]
-
-  spec.summary       = %q{Opens a file or text in the user's preferred editor.}
-  spec.description   = %q{Opens a file or text in the user's preferred editor.}
-  spec.homepage      = "https://piotrmurach.github.io/tty"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 2.0.0'
-
-  spec.add_dependency 'tty-prompt',   '~> 0.14.0'
-  spec.add_dependency 'tty-which',    '~> 0.3.0'
-
-  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
-  spec.add_development_dependency 'rake',  '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end