commander 4.1.0 → 4.1.1

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 4.1.1 / 2012-02-16
+
+* Update `ask_editor` to work with any unix editor - emacs, vim, etc. (thanks to Federico Galassi)
+
 === 4.1.0 / 2012-02-12
 
 * Update highline dependency.

data/README.rdoc

@@ -134,11 +134,14 @@ following methods to simplify common tasks:
   # Enable paging of output after this point
   enable_paging
 
-  # Ask editor for input (EDITOR or TextMate by default)
+  # Ask editor for input (EDITOR environment variable or whichever is available: TextMate, vim, vi, emacs, nano, pico)
   ask_editor
 
   # Ask editor, supplying initial text
   ask_editor 'previous data to update'
+  
+  # Ask editor, preferring a specific editor
+  ask_editor 'previous data', 'vim'
 
   # Choose from an array of elements
   choice = choose("Favorite language?", :ruby, :perl, :js)
@@ -344,10 +347,6 @@ OR
 Feel free to fork and request a pull, or submit a ticket
 http://github.com/visionmedia/commander/issues
 
-== Known Issues
- 
-* ask_editor has been tested with TextMate only
-
 == License
 
 (The MIT License)

data/lib/commander/user_interaction.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+require 'shellwords'
 
 module Commander
   
@@ -40,7 +42,7 @@ module Commander
     
     def choose message, *choices
       say message
-      super *choices
+      super(*choices)
     end
     
     ##
@@ -224,26 +226,40 @@ module Commander
     def reset_io
       $stdin, $stdout = STDIN, STDOUT
     end
+
+    ##
+    # Find an editor available in path. Optionally supply the _preferred_
+    # editor. Returns the name as a string, nil if none is available.
+
+    def available_editor preferred = nil
+      [preferred, ENV['EDITOR'], 'mate -w', 'vim', 'vi', 'emacs', 'nano', 'pico'].
+        compact.
+        find {|name| system("/usr/bin/which #{name.split.first} > /dev/null") }
+    end
     
     ##
-    # Prompt _editor_ for input. Optionally supply initial
+    # Prompt an editor for input. Optionally supply initial
     # _input_ which is written to the editor.
     #
-    # The _editor_ defaults to the EDITOR environment variable
-    # when present, or 'mate' for TextMate. 
+    # _preferred_editor_ can be hinted.
     #
     # === Examples
     #
     #   ask_editor                # => prompts EDITOR with no input
     #   ask_editor('foo')         # => prompts EDITOR with default text of 'foo'
-    #   ask_editor('foo', :mate)  # => prompts TextMate with default text of 'foo'
+    #   ask_editor('foo', 'mate -w')  # => prompts TextMate with default text of 'foo'
     #
        
-    def ask_editor input = nil, editor = ENV['EDITOR'] || 'mate'
-      IO.popen(editor.to_s, 'w+') do |pipe|
-        pipe.puts input.to_s unless input.nil?
-        pipe.close_write
-        pipe.read
+    def ask_editor input = nil, preferred_editor = nil
+      editor = available_editor preferred_editor
+      program = Commander::Runner.instance.program(:name).downcase rescue 'commander'
+      tmpfile = Tempfile.new program
+      begin
+        tmpfile.write input if input
+        tmpfile.close
+        system("#{editor} #{tmpfile.path.shellescape}") ? IO.read(tmpfile.path) : nil
+      ensure
+        tmpfile.unlink
       end
     end
     

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '4.1.0'
+  VERSION = '4.1.1'
 end

data/spec/ui_spec.rb

@@ -20,5 +20,11 @@ describe Commander::UI do
       exception.should_not be_true
     end
   end
+  
+  describe ".available_editor" do
+    it "should not fail on available editors with shell arguments" do
+      Commander::UI.available_editor('sh -c').should eq('sh -c')
+    end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000Z
+date: 2012-02-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70213543949460 !ruby/object:Gem::Requirement
+  requirement: &2157651520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.6.11
   type: :runtime
   prerelease: false
-  version_requirements: *70213543949460
+  version_requirements: *2157651520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70213543948960 !ruby/object:Gem::Requirement
+  requirement: &2157681480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70213543948960
+  version_requirements: *2157681480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70213543948580 !ruby/object:Gem::Requirement
+  requirement: &2157681100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70213543948580
+  version_requirements: *2157681100
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70213543948120 !ruby/object:Gem::Requirement
+  requirement: &2157680640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70213543948120
+  version_requirements: *2157680640
 description: The complete solution for Ruby command-line executables. Commander bridges
   the gap between other terminal related libraries you know and love (OptionParser,
   HighLine), while providing many new features, and an elegant API.
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: commander
-rubygems_version: 1.8.12
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: The complete solution for Ruby command-line executables