tty-editor 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e9145c73047747147deaee2f06829d2defe3f465
-  data.tar.gz: 92a3157a7607890f740ba1b12fe1ee2ee297e9fe
+SHA256:
+  metadata.gz: b1f457f50b0e6fbc28f6bce355c3f9cd8850daa3d7bef3d2f9f05f5e26f0160a
+  data.tar.gz: c4ffbcc18b975275ccf6a41219c704919b0c2e33ac4eea3c209a70be5884ad98
 SHA512:
-  metadata.gz: 09dfdbe26a184a2a17516dcea8de5f83931133656fbf2f7e86bc7c9ff0d76c8cf45974c3139ed2339d08a9a90b8015023500ab0942863aa31b0a893404520260
-  data.tar.gz: cc8ce5952131f699be2ccf9cb0a9f22bf0d295c6648cbd661819781a2a614c590bbaf9d268f8368bf52589be85594ca633b2146edafdbcf814efb690bca5e4f1
+  metadata.gz: 3165a9f49debfcc8ad4246ae2960dd83a4b8d9500c2bf562999375e3e3d44011a8701df892316f974284736255bf31a95207d19edaa61408131bd8b990b44112
+  data.tar.gz: 407a3906e0f3551a77c3d2f4987fb77b7b417b636dfd646c9a732c5f63618b6deb47f93b408d809915db3ae46e172434c18138bcd5b1b9ec92461d97e1fb522e

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Change log
 
+## [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
 
@@ -46,6 +52,7 @@
 
 * Initial implementation and release
 
+[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

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty 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]

data/lib/tty-editor.rb

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

data/lib/tty/editor.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'tty-prompt'
 require 'tty-which'

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.4.1'
   end # Editor
 end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+if RUBY_VERSION > '1.9' and (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

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+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

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+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

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+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

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+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

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+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

data/spec/unit/tempfile_path_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Editor, '#tempfile_path' do
+  it 'creates temporary file path for content' do
+    tempfile = StringIO.new
+    def tempfile.path
+      'random-path'
+    end
+
+    allow(Tempfile).to receive(:new).and_return(tempfile)
+    editor = TTY::Editor.new(content: "Multiline\ncontent", command: :vim)
+    allow(editor).to receive(:system).and_return(true)
+
+    editor.open
+
+    expect(editor.command_path).to eql("vim random-path")
+  end
+end

data/tty-editor.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tty/editor/version'
@@ -14,14 +13,14 @@ Gem::Specification.new do |spec|
   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.files         = Dir['{lib,spec,examples}/**/*.rb']
+  spec.files        += Dir['{bin,tasks}/*', 'tty-editor.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'tty-prompt',   '~> 0.16.0'
+  spec.add_dependency 'tty-prompt',   '~> 0.17.0'
   spec.add_dependency 'tty-which',    '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-editor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: tty-which
   requirement: !ruby/object:Gem::Requirement
@@ -93,16 +93,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 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
@@ -113,6 +107,13 @@ files:
 - 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
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Opens a file or text in the user's preferred editor.

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,25 +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
-  - 2.5.0
-  - 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/appveyor.yml

@@ -1,26 +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: "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"
-    - ruby_version: "24"
-    - ruby_version: "24-x64"
-    - ruby_version: "25"
-    - ruby_version: "25-x64"
-matrix:
-  allow_failures:
-    - ruby_version: "25"