tty-editor 0.5.1 → 0.6.0

data/lib/tty/editor/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Editor
-    VERSION = '0.5.1'
+    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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -16,42 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-- !ruby/object:Gem::Dependency
-  name: tty-which
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,42 +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:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- 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
-- spec/spec_helper.rb
-- spec/unit/available_spec.rb
-- spec/unit/command_path_spec.rb
-- spec/unit/command_spec.rb
-- spec/unit/executables_spec.rb
-- spec/unit/open_spec.rb
-- spec/unit/tempfile_path_spec.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:
@@ -131,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+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/Rakefile

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

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 @@
-# frozen_string_literal: true
-
-require_relative '../lib/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 @@
-# frozen_string_literal: true
-
-require_relative '../lib/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 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-editor'
-
-TTY::Editor.open

data/examples/env.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/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 @@
-# frozen_string_literal: true
-
-require_relative '../lib/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: content)

data/spec/spec_helper.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require 'tty/editor'
-
-module Helpers
-  def fixtures_path(filename = nil)
-    ::File.join(::File.dirname(__FILE__), 'fixtures', filename.to_s)
-  end
-
-  def tmp_path(filename = nil)
-    File.join(File.dirname(__FILE__), '..', 'tmp', filename.to_s)
-  end
-end
-
-RSpec.configure do |config|
-  config.include(Helpers)
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  if config.files_to_run.one?
-    config.default_formatter = 'doc'
-  end
-
-  config.profile_examples = 2
-
-  config.order = :random
-
-  Kernel.srand config.seed
-end

data/spec/unit/available_spec.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Editor, '#available' do
-  before do
-    allow(ENV).to receive(:[]).with('VISUAL').and_return(nil)
-    allow(ENV).to receive(:[]).with('EDITOR').and_return(nil)
-    allow(TTY::Editor).to receive(:windows?).and_return(false)
-  end
-
-  it "detects editor from env" do
-    allow(ENV).to receive(:[]).with('VISUAL').and_return('vi')
-
-    expect(TTY::Editor.available).to eq(['vi'])
-  end
-
-  it "offers notepad editor on windows platform" do
-    allow(TTY::Editor).to receive(:windows?).and_return(true)
-
-    expect(TTY::Editor.available).to eq(['notepad'])
-  end
-
-  it 'finds a single editor on unix' do
-    editor = TTY::Editor
-    allow(editor).to receive(:exist?).and_return(false)
-    allow(editor).to receive(:exist?).with('vim').and_return(true)
-
-    expect(editor.available).to eql(['vim'])
-  end
-
-  it "finds all available editors" do
-    editor = TTY::Editor
-    allow(editor).to receive(:exist?).and_return(false)
-    allow(editor).to receive(:exist?).with('vim').and_return(true)
-    allow(editor).to receive(:exist?).with('emacs').and_return(true)
-
-    expect(editor.available).to eql(['vim', 'emacs'])
-  end
-
-  it "doesn't find any editor on unix" do
-    editor = TTY::Editor
-    allow(editor).to receive(:exist?).and_return(false)
-
-    expect(editor.available).to eq([])
-  end
-
-  it "uses custom editor" do
-    editor = TTY::Editor
-    name = 'sublime'
-
-    expect(editor.available(name)).to eql([name])
-  end
-end

data/spec/unit/command_path_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Editor, '#command' do
-  it 'escapes editor filename on Unix' do
-    filename = "/usr/bin/hello world.rb"
-    allow(::FileTest).to receive(:file?).with(filename).and_return(true)
-    allow(::File).to receive(:exist?).with(filename).and_return(true)
-    allow(TTY::Editor).to receive(:windows?).and_return(false)
-
-    editor = TTY::Editor.new(filename, command: :vim)
-
-    expect(editor.command_path).to eql("vim /usr/bin/hello\\ world.rb")
-  end
-
-  it "escapes path separators on Windows" do
-    filename = 'C:\User\hello world.rb'
-    allow(::FileTest).to receive(:file?).with(filename).and_return(true)
-    allow(::File).to receive(:exist?).with(filename).and_return(true)
-    allow(TTY::Editor).to receive(:windows?).and_return(true)
-
-    editor = TTY::Editor.new(filename, command: :vim)
-
-    expect(editor.command_path).to eql("vim C:\\\\User\\\\hello\\ world.rb")
-  end
-end

data/spec/unit/command_spec.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Editor, '#command' do
-  it 'specifies desired editor' do
-    editor = TTY::Editor.new(fixtures_path('hello.txt'))
-
-    allow(TTY::Editor).to receive(:available).and_return(['vim'])
-    allow(TTY::Which).to receive(:which).with('vim').and_return('/usr/bin/vim')
-
-    expect(editor.command).to eq('/usr/bin/vim')
-  end
-
-  it "doesn't find any available editor" do
-    editor = TTY::Editor.new(fixtures_path('hello.txt'))
-    allow(TTY::Editor).to receive(:available).and_return([])
-
-    expect {
-      editor.command
-    }.to raise_error(TTY::Editor::EditorNotFoundError,
-      /Could not find editor to use. Please specify \$VISUAL or \$EDITOR/)
-  end
-
-  it 'finds only one editor' do
-    editor = TTY::Editor.new(fixtures_path('hello.txt'))
-
-    allow(TTY::Editor).to receive(:available).and_return(['vim'])
-    allow(TTY::Which).to receive(:which).with('vim').and_return('/usr/bin/vim')
-
-    expect(editor.command).to eq('/usr/bin/vim')
-  end
-
-  it "finds more than one editor" do
-    editor = TTY::Editor.new(fixtures_path('hello.txt'))
-
-    prompt = double(:prompt, enum_select: 'vim')
-
-    allow(TTY::Editor).to receive(:available).and_return(['vim', 'emacs'])
-    allow(TTY::Which).to receive(:which).with('vim').and_return('/usr/bin/vim')
-    allow(TTY::Prompt).to receive(:new).and_return(prompt)
-
-    expect(editor.command).to eq('/usr/bin/vim')
-  end
-
-  it "caches editor name" do
-    editor = TTY::Editor.new(fixtures_path('hello.txt'))
-
-    allow(TTY::Editor).to receive(:available).and_return(['vim'])
-    allow(TTY::Which).to receive(:which).with('vim').and_return('/usr/bin/vim')
-
-    editor.command
-    editor.command
-
-    expect(TTY::Editor).to have_received(:available).once
-  end
-end

data/spec/unit/executables_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Editor, '#executables' do
-  it "returns default executables" do
-    expect(TTY::Editor.executables).to be_an(Array)
-  end
-
-  it "includes default editor execs" do
-    allow(ENV).to receive(:[]).with('VISUAL').and_return(nil)
-    allow(ENV).to receive(:[]).with('EDITOR').and_return(nil)
-
-    expect(TTY::Editor.executables).to eq([
-       'vim', 'vi', 'emacs', 'nano', 'nano-tiny', 'pico', 'mate -w'
-    ])
-  end
-end

data/spec/unit/open_spec.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-
-RSpec.describe TTY::Editor, '#open' do
-  before do
-    ::FileUtils.mkdir_p(tmp_path)
-  end
-
-  after do
-    ::FileUtils.rm_rf(tmp_path)
-  end
-
-
-  it "opens existing file" do
-    file = fixtures_path('hello.txt')
-    editor = TTY::Editor.new(file, command: :vim)
-
-    allow(editor).to receive(:system).and_return(true)
-    expect(editor.open).to eq(true)
-
-    expect(editor).to have_received(:system).with({}, 'vim', file)
-  end
-
-  it "opens non-existing file without content" do
-    new_file = File.join(tmp_path, 'new.rb')
-    editor = TTY::Editor.new(new_file, command: :vim)
-
-    allow(editor).to receive(:system).and_return(true)
-    expect(editor.open).to eq(true)
-
-    expect(::File.exist?(new_file)).to eq(true)
-    expect(editor).to have_received(:system).with({}, 'vim', new_file)
-  end
-
-  it "opens non-existing file with new content" do
-    new_file = File.join(tmp_path, 'new.rb')
-    editor = TTY::Editor.new(new_file, content: 'Hello Ruby!', command: :vim)
-
-    allow(editor).to receive(:system).and_return(true)
-    expect(editor.open).to eq(true)
-
-    expect(::File.read(new_file)).to eq("Hello Ruby!")
-    expect(editor).to have_received(:system).with({}, 'vim', new_file)
-  end
-
-  it "opens existing file with existing content" do
-    file = tmp_path('hello.txt')
-    ::File.write(file, "Hello Ruby!\n")
-    editor = TTY::Editor.new(file, content: 'more content', command: :vim)
-
-    allow(editor).to receive(:system).and_return(true)
-    expect(editor.open).to eq(true)
-
-    expect(::File.read(file)).to eq("Hello Ruby!\nmore content")
-    expect(editor).to have_received(:system).with({}, 'vim', file)
-  end
-
-  it "opens content in a temp file" do
-    tmp_file = StringIO.new
-    def tmp_file.path
-      'tty-editor-path'
-    end
-    allow(Tempfile).to receive(:new).and_return(tmp_file)
-    allow(tmp_file).to receive(:<<)
-    editor = TTY::Editor.new(content: 'Hello Ruby!', command: :vim)
-
-    allow(editor).to receive(:system).and_return(true)
-    expect(editor.open).to eq(true)
-
-    expect(editor).to have_received(:system).with({}, 'vim', 'tty-editor-path')
-    expect(tmp_file).to have_received(:<<).with('Hello Ruby!')
-  end
-
-  it "opens editor without filename or content" do
-    editor = TTY::Editor.new(command: :vim)
-    allow(editor).to receive(:system).and_return(true)
-    expect(editor.open).to eq(true)
-    expect(editor).to have_received(:system).with({}, 'vim', '')
-  end
-
-  it "fails to open non-file without content" do
-    expect {
-      TTY::Editor.open(fixtures_path)
-    }.to raise_error(ArgumentError, /Don't know how to handle `#{fixtures_path}`./)
-  end
-
-  it 'opens file in editor with known command' do
-    invocable = double(:invocable, open: nil)
-    allow(TTY::Editor).to receive(:new).
-      with('hello.rb', command: :vim).and_return(invocable)
-
-    TTY::Editor.open('hello.rb', command: :vim)
-
-    expect(TTY::Editor).to have_received(:new).with('hello.rb', command: :vim)
-  end
-
-  it 'fails to open editor with unknown command' do
-    expect {
-      TTY::Editor.open(fixtures_path('hello.txt'), command: :unknown)
-    }.to raise_error(TTY::Editor::CommandInvocationError)
-  end
-end