tty-editor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5c057d8235f3df81858c683b0539edc842df87
+  data.tar.gz: f2cb1e9226af7be53681b4b8ea28f764adcf8c4a
+SHA512:
+  metadata.gz: 173d74b4f112e67b703e4cfa13a9a86e135722350961320130e83556165945bf05a2e0f8840f893a844dbe79551b1927ab1b582af239e8bb9800f1e2be29aade
+  data.tar.gz: 47eeb14b06b3973187d368c412c93fc22407040b61d3cc9b276c28cb6dfb04ceb26ea5616a04e0429bef0e454e545271e655bd9438ed7edb9a5c8463f370097e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+language: ruby
+sudo: false
+cache: bundler
+script: "bundle exec rake ci"
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - ruby-head
+  - jruby-9000
+  - jruby-head
+  - rbx-3
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3
+  fast_finish: true
+branches:
+  only: master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - unreleased
+
+* Initial implementation and release
+
+[v0.1.0]: https://github.com/piotrmurach/tty-editor/compare/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# 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

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Piotr Murach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# 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]
+[![Build status](https://ci.appveyor.com/api/projects/status/yw4guy16meq5wkee?svg=true)][appveyor]
+[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-editor/badges/gpa.svg)][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]
+
+[gitter]: https://gitter.im/piotrmurach/tty
+[gem]: http://badge.fury.io/rb/tty-editor
+[travis]: http://travis-ci.org/piotrmurach/tty-editor
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-editor
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-editor
+[coverage]: https://coveralls.io/github/piotrmurach/tty-editor
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-editor
+
+> Opens a file or text in in the user's preferred editor.
+
+**TTY::Editor** provides independent component for [TTY](https://github.com/piotrmurach/tty) toolkit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-editor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-editor
+
+## Usage
+
+Open file or text in default editor by calling `open`:
+
+```ruby
+TTY::Editor.open               # opens editor with no input
+TTY::Editor.open('hello.rb')   # opens editor with the file contents
+TTY::Editor.open('some text')  # opens editor with text
+```
+
+You can force to always use a specific editor by passing `:command` option:
+
+```ruby
+
+TTY::Editor.open('hello.rb', command: :vim)
+```
+
+Use `:env` key to forward environment variables to  the editor.
+
+```ruby
+TTY::Editor.open('hello.rb', env: { ... })
+```
+
+## Interface
+
+### open
+
+When editor successfully opens file or content then `true` is returned as value, otherwise `TTY::Editor::CommandInvocation` error is raised.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Copyright
+
+Copyright (c) 2017 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,23 @@
+---
+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

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

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

data/examples/empty.rb

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

data/examples/tempfile.rb

@@ -0,0 +1,7 @@
+# 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/lib/tty-editor.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require 'tty/editor'
+require 'tty/editor/version'

data/lib/tty/editor.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+require 'tty-which'
+require 'tempfile'
+require 'shellwords'
+
+module TTY
+  # A class responsible for launching an editor
+  #
+  # @api private
+  class Editor
+    # Raised when command cannot be invoked
+    class CommandInvocationError < RuntimeError; end
+
+    # Raised when editor cannot be found
+    class EditorNotFoundError < RuntimeError; end
+
+    # Check if editor exists
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def self.exist?(cmd)
+      TTY::Which.exist?(cmd)
+    end
+
+    # List possible executable for editor command
+    #
+    # @return [Array[String]]
+    #
+    # @api private
+    def self.executables
+      [ENV['VISUAL'], ENV['EDITOR'],
+       'vim', 'vi', 'emacs', 'nano', 'nano-tiny', 'pico', 'mate -w'].compact
+    end
+
+    # Find available command
+    #
+    # @param [Array[String]] commands
+    #   the commands to use intstead of defaults
+    #
+    # @return [Array[String]]
+    #
+    # @api public
+    def self.available(*commands)
+      commands = commands.empty? ? executables : commands
+      commands.uniq.select(&method(:exist?))
+    end
+
+    # Open file in system editor
+    #
+    # @example
+    #   TTY::Editor.open('filename.rb')
+    #
+    # @param [String] file
+    #   the name of the file
+    #
+    # @return [Object]
+    #
+    # @api public
+    def self.open(*args)
+      editor = new(*args)
+
+      yield(editor) if block_given?
+
+      editor.run
+    end
+
+    # Initialize an Editor
+    #
+    # @param [String] file
+    #
+    # @api public
+    def initialize(filename = nil, **options)
+      @env      = options.fetch(:env) { {} }
+      @command  = options[:command]
+      @filename = filename ? file_or_temp_path(filename) : nil
+    end
+
+    # Decide if temp file path needs generating
+    #
+    # @return [String]
+    #   the file path
+    #
+    # @api private
+    def file_or_temp_path(filename)
+      FileTest.file?(filename) ? filename : tempfile_path(filename)
+    end
+
+    # Finds command using a configured command(s) or detected shell commands.
+    #
+    # @param [Array[String]] commands
+    #
+    # @raise [TTY::CommandInvocationError]
+    #
+    # @return [String]
+    #
+    # @api public
+    def command(*commands)
+      if @command && commands.empty?
+        @command
+      else
+        execs = self.class.available(*commands)
+        if execs.empty?
+          raise EditorNotFoundError,
+                'Could not find editor to use. Please specify $VISUAL or $EDITOR'
+        else
+          exec = if execs.size > 1
+                   prompt = TTY::Prompt.new
+                   prompt.enum_select('Select an editor?', execs)
+                 else
+                   execs[0]
+                 end
+          @command = TTY::Which.which(exec)
+        end
+      end
+    end
+
+    # Check if Windowz
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def windows?
+      File::ALT_SEPARATOR == "\\"
+    end
+
+    # Escape file path
+    #
+    # @api private
+    def escape_file
+      if windows?
+        @filename.gsub(/\//, '\\')
+      else
+        Shellwords.shellescape(@filename)
+      end
+    end
+
+    # Build command path to invoke
+    #
+    # @return [String]
+    #
+    # @api private
+    def command_path
+      "#{command} #{escape_file}"
+    end
+
+    # Create tempfile with content
+    #
+    # @param [String] content
+    #
+    # @return [String]
+    # @api private
+    def tempfile_path(content)
+      tempfile = Tempfile.new('tty-editor')
+      tempfile << content
+      tempfile.flush
+      unless tempfile.nil?
+        tempfile.close
+      end
+      tempfile.path
+    end
+
+    # Inovke editor command in a shell
+    #
+    # @raise [TTY::CommandInvocationError]
+    #
+    # @api private
+    def run
+      status = system(*Shellwords.split(command_path))
+      return status if status
+      fail CommandInvocationError,
+           "`#{command_path}` failed with status: #{$? ? $?.exitstatus : nil}"
+    end
+  end # Editor
+end # TTY

data/lib/tty/editor/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+#
+module TTY
+  class Editor
+    VERSION = "0.1.0"
+  end # Editor
+end # TTY

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,28 @@
+# 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{}
+  spec.description   = %q{}
+  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.add_dependency 'tty-prompt',   '~> 0.10.0'
+  spec.add_dependency 'tty-which',    '~> 0.2.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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: tty-editor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !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: ''
+email:
+- ''
+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
+- examples/empty.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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []