hammer_cli 0.0.12 → 0.0.13

data/lib/hammer_cli/shell.rb

@@ -3,18 +3,105 @@ require 'readline'
 
 module HammerCLI
 
+  class ShellMainCommand < AbstractCommand
+
+    class HelpCommand < AbstractCommand
+      command_name "help"
+      desc "Print help for commands"
+
+      parameter "[COMMAND] ...", "command"
+
+      def execute
+        ShellMainCommand.run('', command_list << '-h')
+        HammerCLI::EX_OK
+      end
+    end
+
+    class ExitCommand < AbstractCommand
+      command_name "exit"
+      desc "Exit interactive shell"
+
+      def execute
+        exit HammerCLI::EX_OK
+      end
+    end
+
+    class AuthCommand < AbstractCommand
+      command_name "auth"
+      desc "Login and logout actions"
+
+      class LoginCommand < AbstractCommand
+        command_name "login"
+        desc "Set credentials"
+
+        def execute
+          context[:username] = ask_username
+          context[:password] = ask_password
+          HammerCLI::EX_OK
+        end
+      end
+
+      class LogoutCommand < AbstractCommand
+        command_name "logout"
+        desc "Wipe your credentials"
+
+        def execute
+          context[:username] = nil
+          context[:password] = nil
+
+          if username(false)
+            print_message("Credentials deleted, using defaults now.")
+            print_message("You are logged in as [ %s ]." % username(false))
+          else
+            print_message("Credentials deleted.")
+          end
+          HammerCLI::EX_OK
+        end
+      end
+
+      class InfoCommand < AbstractCommand
+        command_name "status"
+        desc "Information about current user"
+
+        def execute
+          if username(false)
+            print_message("You are logged in as [ %s ]." % username(false))
+          else
+            print_message("You are currently not logged in.\nUse 'auth login' to set credentials.")
+          end
+          HammerCLI::EX_OK
+        end
+      end
+
+      autoload_subcommands
+    end
+
+
+    def self.load_commands(main_cls)
+      cmds = main_cls.recognised_subcommands.select do |sub_cmd|
+        !(sub_cmd.subcommand_class <= HammerCLI::ShellCommand)
+      end
+      self.recognised_subcommands.push(*cmds)
+    end
+
+    autoload_subcommands
+  end
+
   class ShellCommand < AbstractCommand
 
     def execute
-      Readline.completion_append_character = " "
-      Readline.completer_word_break_characters = ''
+      ShellMainCommand.load_commands(HammerCLI::MainCommand)
+
+      Readline.completion_append_character = ''
+      Readline.completer_word_break_characters = ' '
       Readline.completion_proc = complete_proc
 
       stty_save = `stty -g`.chomp
 
       begin
-        while line = Readline.readline('hammer> ', true)
-          HammerCLI::MainCommand.run('hammer', line.split) unless line.start_with? 'shell'
+        print_welcome_message
+        while line = Readline.readline(prompt, true)
+          ShellMainCommand.run('', line.split, context) unless line.start_with? 'shell' or line.strip.empty?
         end
       rescue Interrupt => e
         puts
@@ -25,25 +112,27 @@ module HammerCLI
 
     private
 
+    def prompt
+      'hammer> '
+    end
+
+    def print_welcome_message
+      print_message("Welcome to the hammer interactive shell")
+      print_message("Type 'help' for usage information")
+    end
+
     def common_prefix(results)
       results.delete_if{ |r| !r[0].start_with?(results[0][0][0]) }.length == results.length
     end
 
     def complete_proc
-      Proc.new do |cpl|
-        res = HammerCLI::MainCommand.autocomplete(cpl.split)
-        # if there is one result or if results have common prefix
-        # readline tries to replace current input with results
-        # thus we should join the results with the start of the line
-        if res.length == 1 || common_prefix(res)
-          res.map { |r| r.delete_if{ |e| e == '' }.reverse.join(' ') }
-        else
-          res.map{ |e| e[0] }
-        end
+      completer = Completer.new(ShellMainCommand)
+      Proc.new do |last_word|
+        completer.complete(Readline.line_buffer)
       end
     end
 
   end
 
-  HammerCLI::MainCommand.subcommand "shell", "Interactive Shell", HammerCLI::ShellCommand
+  HammerCLI::MainCommand.subcommand "shell", "Interactive shell", HammerCLI::ShellCommand
 end

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new '0.0.12'
+    @version ||= Gem::Version.new '0.0.13'
   end
 end

data/lib/hammer_cli.rb

@@ -5,6 +5,7 @@ require 'hammer_cli/settings'
 require 'hammer_cli/validator'
 require 'hammer_cli/output'
 require 'hammer_cli/options/normalizers'
+require 'hammer_cli/completer'
 require 'hammer_cli/abstract'
 require 'hammer_cli/main'
 

data/test/unit/apipie/command_test.rb

@@ -14,13 +14,14 @@ describe HammerCLI::Apipie::Command do
     class CommandB < ParentCommand
     end
   end
-  
+
   class CommandC < CommandA
   end
 
 
+  let(:ctx) { { :adapter => :silent, :interactive => false } }
   let(:cmd_class) { HammerCLI::Apipie::Command.dup }
-  let(:cmd) { cmd_class.new("") }
+  let(:cmd) { cmd_class.new("", ctx) }
 
   context "setting identifiers" do
 
@@ -88,7 +89,7 @@ describe HammerCLI::Apipie::Command do
 
       it "must raise exception when no attribute is passed" do
         cmd_class.identifiers :id, :name
-        proc { cmd.run([]) }.must_raise Clamp::UsageError
+        cmd.run([]).must_equal HammerCLI::EX_USAGE
       end
 
       it "must run without error when no identifiers are declared" do
@@ -133,19 +134,19 @@ describe HammerCLI::Apipie::Command do
     end
 
     it "inherits action from a parent class" do
-      cmd_b = CommandA::CommandB.new("")
+      cmd_b = CommandA::CommandB.new("", ctx)
       cmd_b.action.must_equal :show
       cmd_b.class.action.must_equal :show
     end
 
     it "looks up resource in the class' modules" do
-      cmd_b = CommandA::CommandB.new("")
+      cmd_b = CommandA::CommandB.new("", ctx)
       cmd_b.resource.resource_class.must_equal FakeApi::Resources::Architecture
       cmd_b.class.resource.resource_class.must_equal FakeApi::Resources::Architecture
     end
 
     it "looks up resource in the superclass" do
-      cmd_c = CommandC.new("")
+      cmd_c = CommandC.new("", ctx)
       cmd_c.resource.resource_class.must_equal FakeApi::Resources::Architecture
       cmd_c.class.resource.resource_class.must_equal FakeApi::Resources::Architecture
     end

data/test/unit/apipie/read_command_test.rb

@@ -5,7 +5,7 @@ require File.join(File.dirname(__FILE__), 'fake_api')
 describe HammerCLI::Apipie::ReadCommand do
 
   let(:cmd_class) { HammerCLI::Apipie::ReadCommand.dup }
-  let(:cmd) { cmd_class.new("", { :adapter => :silent }) }
+  let(:cmd) { cmd_class.new("", { :adapter => :silent, :interactive => false }) }
   let(:cmd_run) { cmd.run([]) }
 
   it "should raise exception when no action is defined" do

data/test/unit/apipie/write_command_test.rb

@@ -3,7 +3,9 @@ require File.join(File.dirname(__FILE__), 'fake_api')
 
 describe HammerCLI::Apipie::WriteCommand do
 
-  let(:cmd) { HammerCLI::Apipie::WriteCommand.new("") }
+
+  let(:ctx) { { :interactive => false } }
+  let(:cmd) { HammerCLI::Apipie::WriteCommand.new("", ctx) }
   let(:cmd_run) { cmd.run([]) }
 
   it "should raise exception when no action is defined" do

data/test/unit/completer_test.rb

@@ -0,0 +1,178 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'tempfile'
+
+
+describe HammerCLI::CompleterLine do
+
+  let(:unfinished_line) { "architecture list --name arch" }
+  let(:finished_line) { "architecture list --name arch " }
+
+  context "splitting words" do
+
+    it "should split basic line" do
+      line = HammerCLI::CompleterLine.new(finished_line)
+      line.must_equal ["architecture",  "list", "--name", "arch"]
+    end
+
+    it "should split basic line with space at the end" do
+      line = HammerCLI::CompleterLine.new(finished_line)
+      line.must_equal ["architecture",  "list", "--name", "arch"]
+    end
+
+  end
+
+  context "last word finished" do
+
+    it "should recongize unfinished line" do
+      line = HammerCLI::CompleterLine.new(unfinished_line)
+      line.finished?.must_equal false
+    end
+
+    it "should recongize finished line" do
+      line = HammerCLI::CompleterLine.new(finished_line)
+      line.finished?.must_equal true
+    end
+
+    it "should recongize empty line as finished" do
+      line = HammerCLI::CompleterLine.new("")
+      line.finished?.must_equal true
+    end
+
+  end
+
+end
+
+
+describe HammerCLI::Completer do
+
+
+  class FakeMainCmd < HammerCLI::AbstractCommand
+
+    class FakeNormalizer < HammerCLI::Options::Normalizers::AbstractNormalizer
+
+      def format(val)
+        val
+      end
+
+      def complete(val)
+        ["small ", "tall "]
+      end
+
+    end
+
+    class AnabolicCmd < HammerCLI::AbstractCommand
+      command_name "anabolic"
+    end
+
+    class ApeCmd < HammerCLI::AbstractCommand
+      command_name "ape"
+
+      option "--hairy", :flag, "Description"
+      option "--weight", "WEIGHT", "Description",
+        :format => FakeNormalizer.new
+      option "--height", "HEIGHT", "Description",
+        :format => FakeNormalizer.new
+
+      class MakkakCmd < HammerCLI::AbstractCommand
+        command_name "makkak"
+      end
+
+      class MalpaCmd < HammerCLI::AbstractCommand
+        command_name "malpa"
+      end
+
+      class OrangutanCmd < HammerCLI::AbstractCommand
+        command_name "orangutan"
+      end
+
+      autoload_subcommands
+    end
+
+    class ApocalypseCmd < HammerCLI::AbstractCommand
+      command_name "apocalypse"
+    end
+
+    class BeastCmd < HammerCLI::AbstractCommand
+      command_name "beast"
+    end
+
+    autoload_subcommands
+  end
+
+
+  let(:completer) { HammerCLI::Completer.new(FakeMainCmd) }
+
+  context "command completion" do
+    it "should offer all available commands" do
+      completer.complete("").sort.must_equal ["anabolic ", "ape ", "apocalypse ", "beast ", "-h ", "--help "].sort
+    end
+
+    it "should offer nothing when the line does not match" do
+      completer.complete("x").must_equal []
+    end
+
+    it "should filter by first letter" do
+      completer.complete("a").sort.must_equal ["anabolic ", "ape ", "apocalypse "].sort
+    end
+
+    it "should filter by first two letters" do
+      completer.complete("ap").sort.must_equal ["ape ", "apocalypse "].sort
+    end
+
+    it "should offer all available subcommands and options" do
+      completer.complete("ape ").sort.must_equal ["makkak ", "malpa ", "orangutan ", "--hairy ", "--weight ", "--height ", "-h ", "--help "].sort
+    end
+
+    it "should offer all available subcommands and options even if a flag has been passed" do
+      completer.complete("ape --hairy ").sort.must_equal ["makkak ", "malpa ", "orangutan ", "--hairy ", "--weight ", "--height ", "-h ", "--help "].sort
+    end
+
+    it "should offer all available subcommands and options even if an option has been passed" do
+      completer.complete("ape --weight 12kg ").sort.must_equal ["makkak ", "malpa ", "orangutan ", "--hairy ", "--weight ", "--height ", "-h ", "--help "].sort
+    end
+
+    it "should offer all available subcommands and options even if an egual sign option has been passed" do
+      completer.complete("ape --weight=12kg ").sort.must_equal ["makkak ", "malpa ", "orangutan ", "--hairy ", "--weight ", "--height ", "-h ", "--help "].sort
+    end
+  end
+
+
+  context "option value completion" do
+    it "should complete option values" do
+      completer.complete("ape --height ").sort.must_equal ["small ", "tall "].sort
+    end
+
+    it "should complete option values" do
+      completer.complete("ape --height s").must_equal ["small "]
+    end
+  end
+
+
+  context "subcommand completion" do
+    it "should filter subcommands by first letter" do
+      completer.complete("ape m").sort.must_equal ["makkak ", "malpa "].sort
+    end
+
+    it "should offer nothing when the line does not match any subcommand" do
+      completer.complete("ape x").must_equal []
+    end
+
+    it "should ignore flags specified before the last command" do
+      completer.complete("ape --hairy m").sort.must_equal ["makkak ", "malpa "].sort
+    end
+
+    it "should ignore options specified before the last command" do
+      completer.complete("ape --weight 12kg m").sort.must_equal ["makkak ", "malpa "].sort
+    end
+
+    it "should ignore equal sign separated options specified before the last command" do
+      completer.complete("ape --weight=12kg m").sort.must_equal ["makkak ", "malpa "].sort
+    end
+
+    it "should filter subcommands by first three letters" do
+      completer.complete("ape mak").must_equal ["makkak "]
+    end
+  end
+
+end
+

data/test/unit/exception_handler_test.rb

@@ -11,6 +11,7 @@ describe HammerCLI::ExceptionHandler do
   let(:output) { HammerCLI::Output::Output.new }
   let(:handler) { HammerCLI::ExceptionHandler.new(:output => output)}
   let(:heading) { "Something went wrong" }
+  let(:cmd) { Class.new(HammerCLI::AbstractCommand).new("command_name") }
 
   it "should handle unauthorized" do
     output.expects(:print_error).with(heading, "Invalid username or password")
@@ -28,6 +29,18 @@ describe HammerCLI::ExceptionHandler do
     handler.handle_exception(MyException.new('message'), :heading => heading)
   end
 
+  it "should handle help request" do
+    output.expects(:print_message).with(cmd.help)
+    handler.handle_exception(Clamp::HelpWanted.new(cmd), :heading => heading)
+
+  end
+
+  it "should handle usage error" do
+    output.expects(:print_error).with(heading, "Error: wrong_usage\n\nSee: 'command_name --help'")
+    handler.handle_exception(Clamp::UsageError.new('wrong_usage', cmd), :heading => heading)
+
+  end
+
   it "should handle resource not found" do
     ex = RestClient::ResourceNotFound.new
     output.expects(:print_error).with(heading, ex.message)

data/test/unit/options/option_definition_test.rb

@@ -14,6 +14,8 @@ describe HammerCLI::Options::OptionDefinition do
     option "--test-format", "TEST_FORMAT", "Test option with a formatter",
       :format => FakeFormatter.new,
       :default => "A"
+    option "--test-context", "CONTEXT", "Option saved into context",
+      :context_target => :test_option
   end
 
   describe "formatters" do
@@ -30,7 +32,7 @@ describe HammerCLI::Options::OptionDefinition do
 
       opt_instance = opt.of(TestOptionFormattersCmd.new([]))
       # clamp api changed in 0.6.2
-      if opt_instance.respond_to? :write 
+      if opt_instance.respond_to? :write
         opt_instance.write('B')
       else
         opt_instance.take('B')
@@ -39,5 +41,13 @@ describe HammerCLI::Options::OptionDefinition do
     end
   end
 
+  describe "context" do
+    it "should save option to context" do
+      context = {}
+      cmd = TestOptionFormattersCmd.new("", context)
+      cmd.run(["--test-context=VALUE"])
+      context[:test_option].must_equal "VALUE"
+    end
+  end
 end
 

data/test/unit/output/adapter/table_test.rb

@@ -53,6 +53,25 @@ describe HammerCLI::Output::Adapter::Table do
         out.must_match(/.*-DOT-.*/)
       end
     end
+
+    context "sort_columns" do
+      let(:field_firstname) { Fields::DataField.new(:path => [:firstname], :label => "Firstname") }
+      let(:field_lastname) { Fields::DataField.new(:path => [:lastname], :label => "Lastname") }
+      let(:fields) {
+        [field_firstname, field_lastname]
+      }
+      let(:data) { HammerCLI::Output::RecordCollection.new [{
+        :firstname => "John",
+        :lastname => "Doe"
+      }]}
+
+      it "should sort output" do
+        TablePrint::Printer.any_instance.stubs(:table_print).returns(
+          "LASTNAME | FIRSTNAME\n---------|----------\nDoe      | John     \n")
+        proc { adapter.print_collection(fields, data) }.must_output(
+          "----------|---------\nFIRSTNAME | LASTNAME\n----------|---------\nJohn      | Doe     \n----------|---------\n")
+      end
+    end
   end
 
 end

data/test/unit/output/output_test.rb

@@ -5,7 +5,7 @@ describe HammerCLI::Output::Output do
   let(:adapter) { HammerCLI::Output::Adapter::Silent }
   let(:definition) { HammerCLI::Output::Definition.new }
 
-  let(:context) { { :adapter => :silent } }
+  let(:context) { { :adapter => :silent, :interactive => false } }
   let(:out_class) { HammerCLI::Output::Output }
   let(:out) { out_class.new(context) }