runssh 0.4.1 → 0.4.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    runssh (0.3.0.beta.3)
+    runssh (0.4.2)
       highline (~> 1.6.1)
       trollop (~> 1.16.2)
 

data/README.rdoc

@@ -12,27 +12,31 @@ I am planning to add scp support as well.
 This requires you to have the _ssh_ binary in your path and optionally the
 <i>ssh-copy-id</i> binary (for copying ssh key).
 
-=== Installation
+== Installation
 You must have ruby[http://www.ruby-lang.org/] and
 rubygems[http://rubygems.org/] installed and then run:
 	gem install runssh
 
+=== Zsh Completion
+Finally we have a <b>fully functional</b> zsh completion. It includes options, subcommands
+and path completions. 
+
+To install just copy the <tt>completions/_runssh</tt> file which is included in the gem (run 
+<tt>gem contents runssh</tt> to get the path to this file) to one of the directories in your 
+<tt>$fpath</tt>.
+
+Note: I don't really know how it works. I just read some docs, looked at a few
+samples (mainly _cvs) and went through a _lot_ of trial and error until it worked for
+me. I hope it'll work for you as well :)
+
 === Bash Completion
-For bash completion I added a simple <tt>runssh_comp.sh</tt> file which completes
-the subcommands and the paths, but not the arguments. To use it, just copy
-it from your gem's +bin+ directory to <tt>/etc/bash-completion.d/</tt> (or wherever
-your bash-completion scripts are).
+Bash completion is not as complete as the zsh one. It only supports path completions.
+Since I'm now using zsh, I have very little interest in improving this. Anybody willing
+to contribute?
 
-=== Zsh Completion
-For zsh - Until I'll write a proper zsh completion file - I'm using bashcompinit
-to use the bash completion script. To use the bash completion file with zsh, copy
-the file to some place and switch the comments between line 14 and 15. Then add
-the following to your .zshrc file:
-	autoload bashcompinit
-	bashcompinit
-	source /path/to/modified/runssh_comp.sh
-This works for me, but I'm only starting with zsh so I hope it will work for you
-as well.
+To install just copy the <tt>completions/runssh_comp.sh</tt> file which is included in the gem (run
+<tt>gem contents runssh</tt> to get the path to this file) to <tt>/etc/bash-completion.d/</tt>
+(or wherever your bash completion files reside).
 
 == Usage
 For usage run _runssh_ without arguments.
@@ -132,6 +136,12 @@ and there's no going back ...)
 === 0.4.1
 * Doc fixes regarding version skip.
 
+=== 0.4.2
+* If, when exporting, the output file exists, the user is prompted for approval.
+* Completion now works for commands that requires options (e.g. add) even if 
+  the required option is not given.
+* Finally - proper zsh completion :)
+
 == TODO
 * Create a _proper_ zsh completion script.
 * Add scp capabilities.

data/completions/_runssh

@@ -0,0 +1,93 @@
+#compdef runssh
+
+_runssh() {
+  _arguments \
+    '(* -)'{-h,--help}'[print help]' \
+    '(* -)'{-v,--version}'[print version and exit]' \
+    '(-f --config-file)'{-f,--config-file}'+[bookmarks file]: : _files' \
+    '(* -)'{-U,--update-config}'[Update config version (after upgrade)]' \
+    '*:: :_runssh_commands'
+}
+
+(( $+funtions[_runssh_commands] )) ||
+_runssh_commands() {
+  if (( CURRENT == 1 )); then
+    _describe -t commands 'runssh commands' "(shell add del update print import export cpid)" && ret=0
+  else
+    # Since we're using a syntax that clears $words we have to get
+    # the custom config file (if given) somehow.
+    [[ -n "$opt_args[-f]" ]] && runssh_config_file="-f $opt_args[-f]"
+    subcommand=$words[1]
+    case $subcommand in
+      shell|del|print|import|export|cpid)
+        _call_function ret _runssh_subcmd_$subcommand
+        ;;
+      add|update) # they have the same options
+        _call_function ret _runssh_subcmd_add
+        ;;
+      *) # we can not identify the subcommand but since the user
+         # might have used abbreviations, we'll just complete the path.
+         _call_function ret _runssh_path_completions
+        ;;
+    esac
+  fi
+}
+
+(( $+functions[_runssh_subcmd_shell] )) ||
+_runssh_subcmd_shell() {
+  _arguments \
+    '(-l --login)'{-l,--login}'+[Override login]: :' \
+    '(-n --host-name)'{-n,--host-name}'+[host to connect to]: :' \
+    '*: :_runssh_path_completions'
+}
+
+(( $+functions[_runssh_subcmd_cpid] )) ||
+_runssh_subcmd_cpid() {
+  _arguments \
+    '(-i --identity-file)'{-i,--identity-file}'+[Ssh key to copy]: : _files' \
+    '*: :_runssh_path_completions'
+}
+
+(( $+functions[_runssh_subcmd_import] )) ||
+_runssh_subcmd_import() {
+  _arguments \
+    '(-i --input-file)'{-i,--input-file}'+[Yaml file to import]: : _files'\
+}
+
+(( $+functions[_runssh_subcmd_export] )) ||
+_runssh_subcmd_export() {
+  _arguments \
+    '(-o --output-file)'{-o,--output-file}'+[File to export to]: : _files'\
+}
+
+(( $+functions[_runssh_subcmd_del] )) ||
+_runssh_subcmd_del() {
+  _arguments \
+    '(-y --yes)'{-y,--yes}'[Delete without asking]' \
+    '*: :_runssh_path_completions'
+}
+
+(( $+functions[_runssh_subcmd_print] )) ||
+_runssh_subcmd_print() {
+  _arguments \
+    '*: :_runssh_path_completions'
+}
+
+(( $+functions[_runssh_subcmd_add] )) ||
+_runssh_subcmd_add() {
+  _arguments \
+    '(-l --login)'{-l,--login}'+[Login user]: :' \
+    '(-n --host-name)'{-n,--host-name}'+[host to connect to]: :' \
+    '(-L --local-tunnel)'{-L,--local-tunnel}'+[Local tunnel definition]: :' \
+    {\*-o,\*--option}'+[Ssh option]: :' \
+    '(-N --no-host-key-checking)'{-N,--no-host-key-checking}"[Don't verify host key!]" \
+    '*: :_runssh_path_completions'
+}
+
+# Call 'runssh ... ?' and get possible completions
+(( $+functions[_runssh_path_completions] )) ||
+_runssh_path_completions() {
+  completion_command="runssh $runssh_config_file $words[0,CURRENT-1] \? 2>/dev/null"
+  path_completions="( $(_call_program paths $completion_command ) )"
+  _describe -t paths 'available paths' $path_completions && ret=0
+}

data/{bin → completions}/runssh_comp.sh

@@ -11,8 +11,7 @@ function _runssh () {
     fi
     # complete path or commands according to the position.
     if [ ${COMP_CWORD} -gt $COM_POSITION ]; then
-        options=$(${COMP_WORDS[@]:0:COMP_CWORD} ? 2>/dev/null) # BASH
-        # options=$(${COMP_WORDS[0,COMP_CWORD-1]} ? 2>/dev/null) # ZSH
+        options=$(${COMP_WORDS[@]:0:COMP_CWORD} ? 2>/dev/null)
     elif [ $COMP_CWORD -eq $COM_POSITION ]; then
         options="shell cpid add del update print import export"
     fi

data/lib/runsshlib/cli.rb

@@ -61,7 +61,7 @@ EOS
       # workaround to enable 'help COMMAND' functionality.
       if args.first == 'help'; args.shift; args << '-h'; end
       # indicate path completion request
-      @completion_requested = args.delete('?')
+      @completion_requested = args.delete('?') ? true : false # flag for required options
       @cmd = extract_subcommand(args)
       @options = parse_subcommand(@cmd, args)
       @c = init_config
@@ -263,7 +263,7 @@ EOH
       options = Trollop::options(args) do
         banner help
         opt :host_name, 'The name or address of the host (e.g, host.example.com).',
-            :short => :n, :type => :string, :required => true
+            :short => :n, :type => :string, :required => @completion_requested
         opt :login, 'The login to connect as.',
             :type => :string
         opt :local_tunnel, "Tunnel definition (see description above).",
@@ -403,6 +403,10 @@ EOS
 
     # we don't use path here, it's just for easier invocation
     def run_export(path)
+      if File.exist? @options[:output_file]
+        question = "Output file (#{@options[:output_file]}) exists!. Overwrite? [yes/no] "
+        agree_or_abort question, 'Cancelled'
+      end
       @c.export(@options[:output_file])
     end
 

data/lib/runsshlib/version.rb

@@ -20,7 +20,7 @@ module RunSSHLib
   module Version
     MAJOR = 0
     MINOR = 4
-    BUILD = 1
+    BUILD = 2
 
     STRING = [MAJOR, MINOR, BUILD].compact.join('.')
   end

data/spec/runsshlib/cli_spec.rb

@@ -21,7 +21,7 @@ require 'stringio'
 require 'yaml'
 
 describe "The CLI interface" do
-  context "argument parser" do
+  context "global options parsing" do
     it "should correctly process the -f argument" do
       cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print test))
       global_options = cli.instance_variable_get :@global_options
@@ -48,7 +48,9 @@ describe "The CLI interface" do
       end.to exit_abnormaly
       @buf.should match(/invalid command/)
     end
+  end
 
+  context "completion mechanism" do
     it "displays completions and exit if requested" do
       import_fixtures
       capture(:stdout) {
@@ -57,6 +59,15 @@ describe "The CLI interface" do
       @buf.should include("cust1")
       @buf.should include("cust2")
     end
+
+    it "displays completion even if required option for subcommand is missing" do
+      import_fixtures
+      capture(:stdout) {
+        RunSSHLib::CLI.new(%W(-f #{TMP_FILE} update ?)).run
+      }
+      @buf.should include("cust1")
+      @buf.should include("cust2")
+    end
   end
 
   context "help" do
@@ -214,6 +225,39 @@ describe "The CLI interface" do
     end
   end
 
+  describe "export subcommand" do
+    context "when export file exists" do
+      let(:cli) {
+        RunSSHLib::CLI::new(%W(-f #{TMP_FILE} export -o #{TMP_YML}))
+      }
+
+      before(:each) do
+        File.open(TMP_YML, 'w') { |io| io.write "" }
+      end
+
+      it "overwrites the file if the user approves the prompt" do
+        capture(:stderr) do
+          capture(:stdout, 'yes') do
+            cli.run
+          end
+        end
+        @buf.should include('Overwrite?')
+        @buf.should include(TMP_YML)
+        IO.read(TMP_YML).should_not == ""
+      end
+
+      it "correctly cancels exporting if answered no at the prompt" do
+        capture(:stdout) do
+          capture(:stderr, 'no') do
+            expect { cli.run }.to exit_abnormaly
+          end
+        end
+        @buf.should include('Cancelled')
+        IO.read(TMP_YML).should == ''
+      end
+    end
+  end
+
   context "Add bookmark with ssh options" do
     it "adds options specified with '-o' to the '--no-host-key-checking' options" do
       options = %W(-f #{TMP_FILE} add -o ForwardAgent=true --no-host-key-checking -n some.host one two)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: runssh
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Haim Ashkenazi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-03 00:00:00 +03:00
+date: 2011-05-07 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,7 +71,8 @@ files:
 - Rakefile
 - autotest/discover.rb
 - bin/runssh
-- bin/runssh_comp.sh
+- completions/_runssh
+- completions/runssh_comp.sh
 - features/add_bookmarks.feature
 - features/cli_help.feature
 - features/copy_id.feature