kknife 0.1.1

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2013 Deployable Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,31 @@
+## kknife 0.1.1
+
+### 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`
+
+`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. 
+
+  Shortcuts
+```
+    'ff' => [ 'from', 'file' ],
+    'db' => [ 'data', 'bag' ],
+    'cs' => [ 'cookbook', 'site' ],
+    'bd' => [ 'bulk', 'delete' ],
+    'ne' => [ 'node', 'edit' ],
+    'ns' => [ 'node', 'show' ],
+    'rl' => [ 'run', 'list' ],
+```
+  Ambiguities
+```
+    'd' => ['download'],
+    'e' => ['environment'],
+    'r' => ['role'],
+    'c' => ['cookbook'],
+```

data/bin/k

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+### ./k - shortcuts for chef knife command line
+
+# Author: Matt Hoyle (<matt@deployable.co>)
+# Copyright: Copyright (c) 2013 Deployable Ltd.
+# License: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# nothing to see here...
+require 'kknife'
+Kknife.new.run

data/lib/kknife/command.rb

@@ -0,0 +1,208 @@
+# Author: Matt Hoyle (<matt@deployable.co>)
+# Copyright: Copyright (c) 2013 Deployable Ltd.
+# License: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'kknife/dbg'
+
+### Command 
+# This is used to store a tree of commands
+# Allow you to navigate up and down the tree.
+
+class Command
+
+  include Dbg
+  
+  class NoMoreSubCommands < StandardError; end
+  class NoMoreSuppliedCommands < StandardError; end
+  class AmbiguousCommand < StandardError; end
+  class NotFoundCommand < StandardError; end
+
+  attr_accessor :cmd, :cmd_short, :sub_commands, :source, :level, :parent, :root, :controller
+  
+  def initialize( command, argopts = {} )
+    @cmd = command
+    
+    opts = {
+      :cmd_short    => nil,
+      :source       => nil,
+      :level        => 0,
+      :sub_commands => {},
+      :parent       => nil,
+      :root         => self,
+      :controller   => nil
+    }.merge argopts
+
+    @cmd_short    = opts[:cmd_short]
+    @source       = opts[:source]
+    @parent       = opts[:parent]
+    @level        = opts[:level]
+    @sub_commands = opts[:sub_commands]
+    @root         = opts[:root]
+    @controller   = opts[:controller]
+
+    # this could just return the root's controller. 
+    @controller   = @root.controller if not @root.nil? and @controller.nil?
+    raise "require controller" if @controller.nil?
+    
+    @level        = @parent.level + 1 unless @parent.nil?
+
+    dbg 'test'
+    debug_logger.debug( 'Command init' )
+  end
+  
+  # return the command
+  def to_s 
+    @cmd
+  end
+
+
+  # Add a sub Command to this Command
+  def add_subcmd( command )
+    unless has_sub_command? command 
+      dbg 'add_subcmd', command, cmd
+      @sub_commands[command] = Command.new( command, :parent => self, :root => @root )
+    end
+    @sub_commands[command]
+  end
+
+
+  # Print current command recurse through sub commands
+  def pp
+    printf "%s%s\n", '  ' * level, cmd
+    @sub_commands.each_key do |key|
+      @sub_commands[key].pp
+    end
+  end
+  
+  def pp_single
+    printf "%s\n", command_lookup.reverse.join(' ') if has_no_sub_commands?
+    @sub_commands.each_key do |key|
+      @sub_commands[key].pp_single
+    end
+  end
+
+  def command_lookup
+    return [ @cmd ] + @parent.command_lookup unless @parent.nil?
+    [ @cmd ]
+  end
+
+  # Test for existence of a sub Command
+  def has_no_sub_commands?
+    @sub_commands.empty?
+  end
+
+  # Test for existence of a sub Command
+  def has_sub_command?( command )
+    @sub_commands.has_key? command
+  end
+
+  # Find a sub Comamnd via substr
+  def sub_command_find( command )
+    @sub_commands.keys.grep( Regexp.new( '^' + Regexp.escape(command) + '.*' ) )
+  end
+
+  # Return a sub Comamnd by name
+  def sub_command( command )
+    @sub_commands[command] if has_sub_command? command
+  end
+
+
+  # Add a list of commands, recursing down the tree
+  def add_command( commands )
+    first = commands.shift
+    
+    dbg "first", first
+    if has_sub_command? first
+      dbg "first exists", first
+    end
+
+    sub_cmd = add_subcmd first
+    sub_cmd.add_command( commands ) unless commands.empty?
+  end
+
+
+  # Recursively lookup a list of commands
+  def process_lookup( commands )
+
+    raise NoMoreSuppliedCommands, "end of args" if commands.empty?
+
+    commands_local   = commands.dup
+    first_command    = commands_local.shift
+    sub_command_list = sub_command_find first_command
+    rest_commands    = commands_local
+
+    dbg 'first', first_command
+    dbg 'list',  sub_command_list
+    dbg 'rest',  rest_commands
+
+    if has_sub_command? first_command or sub_command_list.length == 1
+
+      cmd   = sub_command first_command
+      cmd ||= sub_command sub_command_list.first
+
+      dbg 'cmd', cmd.cmd
+      @controller.found_cmd cmd.cmd
+      raise NoMoreSubCommands, "end of lookup commands" if cmd.sub_commands.empty?
+      
+      return cmd.process_lookup rest_commands
+
+
+    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
+
+      else
+        raise AmbiguousCommand, "ambiguous [#{first_command}] [#{sub_command_list.join(',')}]"
+      end
+
+
+    elsif first_command.index(/_/)
+      # If there's an underscore, split it out
+
+      cmdsplit = first_command.split( /_/ )
+
+      # notify the controller of the command changes
+      @controller.cmd_split cmdsplit
+
+      # rebuild the local commands
+      first_command = cmdsplit.shift
+      rest_commands = cmdsplit + rest_commands
+
+      # now start again with the new values
+      process_lookup [ first_command ] + rest_commands
+      
+
+    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}.*]"
+      end
+      
+    end
+
+  end
+
+end
+

data/lib/kknife/dbg.rb

@@ -0,0 +1,62 @@
+# Author: Matt Hoyle (<matt@deployable.co>)
+# Copyright: Copyright (c) 2013 Deployable Ltd.
+# License: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'logger'
+
+### Dbg 
+# a quick debug logger 
+# classes can run `dbg`
+
+# ```
+# class Yours
+#   include Dbg
+#   def method
+#     dbg 'some', values, logged
+#   end
+# end
+# ```
+
+module Dbg
+
+  DefaultIO = STDERR
+  DefaultLevel = Logger::INFO
+
+  def debug_logger
+    Dbg.debug_logger
+  end
+
+  def self.replace( io = DefaultIO, llevel = DefaultLevel )
+    llevel = @debug_logger.level if @debug_logger
+    @debug_logger = create( io, llevel )
+  end
+
+  def self.create( io = DefaultIO, llevel = DefaultLevel )
+    l = Logger.new io
+    l.level = llevel
+    l
+  end
+
+  def self.debug_logger
+    @debug_logger ||= create
+  end
+
+  def dbg( str, *vars )
+    Dbg.debug_logger.debug sprintf( "%s [%s]", str, vars.join("] [") )  # if Debug
+  end
+
+end
+
+

data/lib/kknife/k2.rb

@@ -0,0 +1,99 @@
+# Author: Matt Hoyle (<matt@deployable.co>)
+# Copyright: Copyright (c) 2013 Deployable Ltd.
+# License: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'chef/knife'
+
+Debug = true
+$cmd = {}
+
+def dbg( str, *vars )
+  printf "%s [%s]\n", str, vars.join("] [") if Debug
+end
+
+def add( h, cmds )
+  dbg 'cmds', cmds.to_s
+  first = cmds.shift
+  if cmds.empty?
+    h[first] = nil
+  else
+    h[first] = {} unless h.has_key? first and !h[first].nil?
+    add h[first], cmds
+  end
+end
+
+Chef::Knife.load_commands
+Chef::Knife.subcommands_by_category.each do |category,command_arr|
+  dbg 'category', category
+  #$cmd[category] = {} unless $cmd.has_key? category
+  command_arr.each do |command|
+    dbg 'command', command
+    commands = command.split( /_/ )
+    add $cmd, commands
+  end
+end
+
+pp $cmd
+
+commands = ARGV.dup
+cmd_extra = ARGV.dup
+h = $cmd
+cmd_knife = []
+
+commands.each do |command|
+  dbg 'command', command
+
+  if h.nil?
+    # Last knife command possible
+    dbg 'final'
+    break
+
+  elsif h.has_key? command
+    # Direct lookup
+    dbg 'found cmd', command
+    h = h[command]
+    cmd_knife.push command
+    cmd_extra.shift
+
+  elsif command.index(/_/)
+    # Split into spaces
+    cmdsplit = command.split( /_/ )
+    cmdsplit.each do |cmd|
+      if h.has_key? cmd
+        h = h[cmd]
+        cmd_knife.push cmd
+      else
+        raise "command not found [#{cmd}] [#{command}]"
+      end
+    end
+    cmd_extra.shift
+
+  else
+    # Search for ^command.*
+    re = Regexp.new( '^' + Regexp.escape(command) + '.*$')
+    search = h.keys.grep re
+    case search.length
+    when 0
+      raise "command not found [#{re}]"
+    when 1
+      dbg 'srch cmd', command, search[0]
+      cmd_knife.push command
+      cmd_extra.shift
+    else
+      dbg 'srch cmds', command, search.to_s
+    end
+  end
+end
+dbg cmd_knife, '|', cmd_extra