tty-editor 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c8b0f90f5fb1aa59d1958533101e0f5356b109e
-  data.tar.gz: 1e428a93f7c29dfd4514dc0f4c74146d46b15253
+  metadata.gz: 3f635e6b8b169d9aa4acb44bba6bc733e5cf6304
+  data.tar.gz: fb78c565c78344b4b213f5ba650e630b411ea0c6
 SHA512:
-  metadata.gz: 258d6caf6bb9e949c2904915b21019fa415f3d0467c8102ca376eedfff2a91912fe66fdf68d5f45eb4f426a06f34afc4ae04032de7b0651019cdf63fc1fa9ec4
-  data.tar.gz: 292d62648e65079364d1c0980c6b118362d62292ff32e66f3af778df52d0c7a4a3eb33b7ee405e3c852667708c1f64001022e41f5af4e51cd5959c1712ab5e16
+  metadata.gz: 273927959a7bcbd0af32c5227ee83f903215fc274184c219fb4284692508cdcac65e872aaf4c1ac73714e2745c9605628110b2ac2327c6c6cada01893f01d3d4
+  data.tar.gz: b2d1ab5052f8310d45694bfaa2a592a0833963e6ec5f5961755087c43c1e76ee36c5fd39386f194e740346ccd9dd5d678895f0cf165f1aea54597993442bac21

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change log
 
+## [v0.2.0] - 2017-03-26
+
+### Added
+* Add support for Windows by using notepad editor
+* Add :content option to Editor#open to distinguish between opening
+  a file with/without content
+
+### Changed
+* Change to prioritise $VISUAL & $EDITOR env variables
+* Change to stop generating tempfiles when open without filename or content
+* Change loading paths
+* Change dependencies
+
+### Fixed
+* Fix windows shell escaping
+
 ## [v0.1.2] - 2017-02-06
 
 ### Fixed
@@ -14,6 +30,7 @@
 
 * Initial implementation and release
 
+[v0.2.0]: https://github.com/piotrmurach/tty-editor/compare/v0.1.2...v0.2.0
 [v0.1.2]: https://github.com/piotrmurach/tty-editor/compare/v0.1.1...v0.1.2
 [v0.1.1]: https://github.com/piotrmurach/tty-editor/compare/v0.1.0...v0.1.1
 [v0.1.0]: https://github.com/piotrmurach/tty-editor/compare/v0.1.0

data/README.md

@@ -1,4 +1,5 @@
 # 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]
@@ -36,32 +37,69 @@ Or install it yourself as:
 
 ## Usage
 
-Open file or text in default editor by calling `open`:
+To edit a file in default editor:
 
 ```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
+TTY::Editor.open('hello.rb')
 ```
 
-You can force to always use a specific editor by passing `:command` option:
+To edit content in a default editor:
 
 ```ruby
+TTY::Editor.open(content: "some text")
+```
+
+You can also set your preferred editor command:
 
+```ruby
 TTY::Editor.open('hello.rb', command: :vim)
 ```
 
+Also, the `VISUAL` or `EDITOR` shell environment variables take precedencee when auto detecting available editors.
+
+## Interface
+
+### open
+
+If you wish to open editor with no file or content do:
+
+```ruby
+TTY::Editor.open
+```
+
+When editor successfully opens file or content then `true` is returned.
+
+If the editor cannot be opened, a `TTY::Editor::CommandInvocation` error is raised.
+
+In order to open text content inside an editor do:
+
+```ruby
+TTY::Editor.open(content: 'text')
+```
+
+You can also provide filename that will be created with specified content before editor is opened:
+
+```ruby
+TTY::Editor.open('new.rb', content: 'text')
+```
+
+If you open a filename with already existing content then new content gets appended at the end of the file.
+
+### :env
+
 Use `:env` key to forward environment variables to  the editor.
 
 ```ruby
-TTY::Editor.open('hello.rb', env: { ... })
+TTY::Editor.open('hello.rb', env: {"FOO" => "bar"})
 ```
 
-## Interface
+### :command
 
-### open
+You can force to always use a specific editor by passing `:command` option:
 
-When editor successfully opens file or content then `true` is returned as value, otherwise `TTY::Editor::CommandInvocation` error is raised.
+```ruby
+TTY::Editor.open('hello.rb', command: :vim)
+```
 
 ## Development
 

data/examples/choices.rb

@@ -0,0 +1,9 @@
+# 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/env.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, env: {"FOO" => "bar"})

data/lib/tty-editor.rb

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

data/lib/tty/editor.rb

@@ -3,12 +3,15 @@
 require 'tty-prompt'
 require 'tty-which'
 require 'tempfile'
+require 'fileutils'
 require 'shellwords'
 
+require_relative 'editor/version'
+
 module TTY
   # A class responsible for launching an editor
   #
-  # @api private
+  # @api public
   class Editor
     # Raised when command cannot be invoked
     class CommandInvocationError < RuntimeError; end
@@ -25,14 +28,31 @@ module TTY
       TTY::Which.exist?(cmd)
     end
 
+    # Check if Windowz
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def self.windows?
+      ::File::ALT_SEPARATOR == "\\"
+    end
+
+    # Check editor from environment variables
+    #
+    # @return [Array[String]]
+    #
+    # @api public
+    def self.from_env
+      [ENV['VISUAL'], ENV['EDITOR']].compact
+    end
+
     # List possible executable for editor command
     #
     # @return [Array[String]]
     #
-    # @api private
+    # @api public
     def self.executables
-      [ENV['VISUAL'], ENV['EDITOR'],
-       'vim', 'vi', 'emacs', 'nano', 'nano-tiny', 'pico', 'mate -w'].compact
+      ['vim', 'vi', 'emacs', 'nano', 'nano-tiny', 'pico', 'mate -w']
     end
 
     # Find available command
@@ -44,8 +64,15 @@ module TTY
     #
     # @api public
     def self.available(*commands)
-      commands = commands.empty? ? executables : commands
-      commands.uniq.select(&method(:exist?))
+      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
     end
 
     # Open file in system editor
@@ -64,33 +91,49 @@ module TTY
 
       yield(editor) if block_given?
 
-      editor.run
+      editor.open
     end
 
     # Initialize an Editor
     #
     # @param [String] file
+    # @param [Hash[Symbol]] options
+    # @option options [Hash] :command
+    #   the editor command to use, by default auto detects
+    # @option options [Hash] :env
+    #   environment variables to forward to the editor
     #
     # @api public
-    def initialize(filename = nil, **options)
+    def initialize(*args, **options)
+      @filename = args.unshift.first
       @env      = options.fetch(:env) { {} }
       @command  = options[:command]
-      @filename = filename ? file_or_temp_path(filename) : nil
+      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
     end
 
-    # Decide if temp file path needs generating
+    # Read or update environment vars
     #
-    # @return [String]
-    #   the file path
-    #
-    # @api private
-    def file_or_temp_path(filename)
-      ::FileTest.file?(filename) ? filename : tempfile_path(filename)
+    # @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.
     #
     # @param [Array[String]] commands
+    #   the optional command to use, by default auto detecting
     #
     # @raise [TTY::CommandInvocationError]
     #
@@ -98,43 +141,32 @@ module TTY
     #
     # @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
+      return @command if @command && commands.empty?
+
+      execs = self.class.available(*commands)
+      if execs.empty?
+        raise EditorNotFoundError,
+              'Could not find editor to use. Please specify $VISUAL or $EDITOR'
       end
+      exec = choose_exec_from(execs)
+      @command = TTY::Which.which(exec.to_s)
     end
 
-    # Check if Windowz
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def windows?
-      ::File::ALT_SEPARATOR == "\\"
+    # @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]
+      end
     end
 
     # Escape file path
     #
     # @api private
     def escape_file
-      if windows?
-        @filename.gsub(/\//, '\\')
-      else
-        Shellwords.shellescape(@filename)
-      end
+      Shellwords.shellescape(@filename)
     end
 
     # Build command path to invoke
@@ -167,8 +199,8 @@ module TTY
     # @raise [TTY::CommandInvocationError]
     #
     # @api private
-    def run
-      status = system(*Shellwords.split(command_path))
+    def open
+      status = system(env, *Shellwords.split(command_path))
       return status if status
       fail CommandInvocationError,
            "`#{command_path}` failed with status: #{$? ? $?.exitstatus : nil}"

data/lib/tty/editor/version.rb

@@ -2,6 +2,6 @@
 #
 module TTY
   class Editor
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end # Editor
 end # TTY

data/tty-editor.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   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_dependency 'tty-prompt',   '~> 0.12.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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-editor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: tty-which
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +106,9 @@ files:
 - 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