kknife 0.1.1 → 0.1.2

data/README.md

@@ -1,18 +1,25 @@
-## kknife 0.1.1
+## kknife 0.1.2
 
-### Shortcuts for the chef knife command
+#### Shortcuts for the chef `knife` command
 
-`k n e somenode    = knife node edit somenode`
-`k c u somebook    = knife cookbook upload somebook`
-`k e u ff somefile = knife cookbook from_file somefile`
+kknife lets you use the shortest substring to uniquely identify a knife sub command. 
+kknife also provides a `k` script to launch the lookups
+
+`k n e somenode` = `knife node edit somenode`
+
+`k c u somebook` = `knife cookbook upload somebook`
+
+`k e u ff somefile` = `knife cookbook from_file somefile`
 
 `k -l` lists all your commands
 
 `k -d` might tell you what's going wrong.
 
-Lookups for shortcuts and ambiguous commands are currently statically defined in `lib/kknife/lookup.rb`. These will be user configurable/overridable. Some form of json/yml blob in ~/.chef/ should do. 
+#### Lookups 
+
+Shortcuts and ambiguous commands are currently statically defined in `lib/kknife/lookup.rb`. These will be user configurable/overridable. Some form of json/yml blob in ~/.chef/ should do. 
 
-  Shortcuts
+##### Shortcuts
 ```
     'ff' => [ 'from', 'file' ],
     'db' => [ 'data', 'bag' ],
@@ -22,7 +29,7 @@ Lookups for shortcuts and ambiguous commands are currently statically defined in
     'ns' => [ 'node', 'show' ],
     'rl' => [ 'run', 'list' ],
 ```
-  Ambiguities
+##### Ambiguities
 ```
     'd' => ['download'],
     'e' => ['environment'],

data/lib/kknife/command.rb

@@ -17,16 +17,34 @@
 require 'kknife/dbg'
 
 ### Command 
-# This is used to store a tree of commands
-# Allow you to navigate up and down the tree.
+#
+# This is used to store a tree of Commands by name
+# Like a hash, but with a few extra features
+#
+#   knife
+#     node
+#       list
+#       edit
+#     environment
+#       list
+#       edit
+#
+# Allows you to navigate up and down the tree.
 
 class Command
 
   include Dbg
   
+  # For the end of the tree
   class NoMoreSubCommands < StandardError; end
+
+  # For the end of the user commands
   class NoMoreSuppliedCommands < StandardError; end
+
+  # When more than one Command is looked up
   class AmbiguousCommand < StandardError; end
+
+  # When no Command's can be found
   class NotFoundCommand < StandardError; end
 
   attr_accessor :cmd, :cmd_short, :sub_commands, :source, :level, :parent, :root, :controller
@@ -62,7 +80,7 @@ class Command
     debug_logger.debug( 'Command init' )
   end
   
-  # return the command
+  # return the command string
   def to_s 
     @cmd
   end
@@ -78,7 +96,7 @@ class Command
   end
 
 
-  # Print current command recurse through sub commands
+  # Print current command as a tree, recurse through sub commands
   def pp
     printf "%s%s\n", '  ' * level, cmd
     @sub_commands.each_key do |key|
@@ -86,6 +104,8 @@ class Command
     end
   end
   
+  # Print the current command on a single line if it's the last 
+  # in the tree, otherwise move down.
   def pp_single
     printf "%s\n", command_lookup.reverse.join(' ') if has_no_sub_commands?
     @sub_commands.each_key do |key|
@@ -93,6 +113,7 @@ class Command
     end
   end
 
+  # Recurse back down the Command tree and return the full command
   def command_lookup
     return [ @cmd ] + @parent.command_lookup unless @parent.nil?
     [ @cmd ]
@@ -147,6 +168,7 @@ class Command
     dbg 'list',  sub_command_list
     dbg 'rest',  rest_commands
 
+    # If we have a command or can look one up, all is good
     if has_sub_command? first_command or sub_command_list.length == 1
 
       cmd   = sub_command first_command
@@ -159,9 +181,9 @@ class Command
       return cmd.process_lookup rest_commands
 
 
+    # If there was more than one match, check the ambiguity config
+    # or error
     elsif sub_command_list.length > 1
-      # If there was more than one match, check the ambiguity config
-      # or error
 
       if Lookup.ambiguity( first_command )
         process_lookup Lookup.ambiguity( first_command ) + rest_commands
@@ -171,9 +193,9 @@ class Command
       end
 
 
+    # If there's an underscore, split it out
     elsif first_command.index(/_/)
-      # If there's an underscore, split it out
-
+      
       cmdsplit = first_command.split( /_/ )
 
       # notify the controller of the command changes
@@ -187,17 +209,17 @@ class Command
       process_lookup [ first_command ] + rest_commands
       
 
+    # Otherwise the command wasn't found, 
+    # Look up shortcuts before giving up
     else
-      # Otherwise the command wasn't found, 
-      # Look up shortcuts before giving up
 
       shortcut = Lookup.shortcut( first_command )
+
       if shortcut
         @controller.found_shortcut shortcut
         process_lookup shortcut + rest_commands
-
       else
-        raise NotFoundCommand, "not found [#{first_command}.*]"
+        raise NotFoundCommand, "sub command not found: [#{first_command}*]"
       end
       
     end

data/lib/kknife/dbg.rb

@@ -17,17 +17,16 @@
 require 'logger'
 
 ### Dbg 
-# a quick debug logger 
-# classes can run `dbg`
-
-# ```
-# class Yours
-#   include Dbg
-#   def method
-#     dbg 'some', values, logged
-#   end
-# end
-# ```
+#
+# A quick debug logger so lasses can call `dbg`
+#
+#     class Yours
+#       include Dbg
+#       def method
+#         dbg 'some', values, logged
+#       end
+#     end
+
 
 module Dbg
 

data/lib/kknife/knifecmd.rb

@@ -20,9 +20,11 @@ require 'chef/knife'
 require 'chef/application/knife'
 
 ### Knifecmd 
-# Used as the base for the knife command. 
-# Stories information about the run and the 
-# Command tree
+#
+# Used as the base for the knife commands. 
+#
+# Stores information about the current lookup 
+# and the Command tree
 
 class Knifecmd
 
@@ -128,10 +130,10 @@ class Knifecmd
       @cmd_root.process_lookup commands
 
     rescue Command::AmbiguousCommand => e
-      raise "error [#{commands.to_s}] #{e}"
+      abort "error looking up [#{commands.to_s}]. #{e}"
       
     rescue Command::NotFoundCommand => e
-      raise "error [#{commands.to_s}] #{e}"
+      abort "error looking up [#{commands.to_s}]. #{e}"
 
     rescue Command::NoMoreSubCommands
       dbg "end of knife lookups", @cmd_found.join(','), @cmd_left.join(',')
@@ -145,7 +147,7 @@ class Knifecmd
   end
 
   
-  # if the Command lookup needs to split a command
+  # If the Command lookup needs to split a command
   # remove the command from what's left and split it 
   # into the componenets
   def cmd_split( split_command_array )
@@ -167,7 +169,7 @@ class Knifecmd
   end
 
 
-  # if the Command lookup hits a shortcut, adjust local 
+  # If the Command lookup hits a shortcut, adjust local 
   # variables to match
   def found_shortcut( shortcut )
     dbg 'found_shortcut b4 ', shortcut.join(','), '|', @cmd_left.join(',')
@@ -177,20 +179,20 @@ class Knifecmd
   end
 
 
-  # reset the command found instance variables
+  # Reset the command found instance variables
   def reset_found( commands = [] )
     @cmd_found = []
     @cmd_left  = commands.dup
   end
 
 
-  # return the found command as a space seperated string
+  # Return the found command as a space seperated string
   def found_string
     ([ @root ] + @cmd_found ).join(' ')
   end
 
 
-  # resolve a list of commands into real commands
+  # Resolve a list of commands into real commands
   def resolve( commands )
     lookup commands
     @cmd_found + @cmd_left

data/lib/kknife/log.rb

@@ -17,38 +17,40 @@
 require 'logger'
 
 ### Log - a global logger instance for classes 
-
+#
 # Allows you to call a single logger instance easily from your classes
-
-# ```
-# class Yours
-#   include Log
-#   def method
-#     log.info 'something'
-#   end
-# end
-# ```
+#
+#     class Yours
+#       include Log
+#       def method
+#         log.info 'something'
+#       end
+#     end
 
 module Log
 
   DefaultIO = STDOUT
 
+  # returns the singleton
   def log
     Logging.log
   end
 
+  # replace the logger with a new target
   def self.replace( io )
     l = Logger.new io
     l.level = @log.level
     @log = l
   end
 
+  # create a new logger
   def self.create
     l = Logger.new DefaultIO
     l.level = Logger::INFO
     l
   end
 
+  # return the singleton or create it
   def self.log
     @log ||= create
   end

data/lib/kknife/version.rb

@@ -1,3 +1,3 @@
 module Kknife
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/knifecmd_spec.rb

@@ -107,5 +107,24 @@ describe Knifecmd do
     end
   end
 
+
+  it "abort on ambiguous command" do
+    expect{ 
+      begin
+        @k.resolve( ['s'] )
+      rescue SystemExit
+      end
+    }.to stderr( "error looking up [[\"s\"]]. ambiguous [s] [search,show,ssh,status]\n" )
+  end
+
+  it "abort on ambiguous command" do
+    expect{ 
+      begin
+        @k.resolve( ['z','y'] )
+      rescue SystemExit
+      end
+    }.to stderr( "error looking up [[\"z\", \"y\"]]. sub command not found: [z*]\n" )
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kknife
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef