drydock 0.6.3 → 0.6.5

data/CHANGES.txt

@@ -5,6 +5,26 @@ DRYDOCK, CHANGES
 * Support putting descriptions into resource file (or __END__)
 
 
+#### 0.6.5 (2009-05-21) #############################
+
+* ADDED: "with_args" support for default command. When specified, 
+arguments can be passed to the default command with run in the 
+short form. e.g. "script arg1 arg2" == "script cmdname arg1 arg2"
+
+#### 0.6.3 (2009-05-10) #############################
+
+* ADDED: show-commands now displays a note about which command is the default
+* CHANGE: Moved mixins to lib/drydock/mixins (so other projects can require 'drydock/mixins')
+* FIXED: Support for inline command aliases when specifying a class: 
+command [:name, :alias1, :alias2] => SomeClass
+
+
+#### 0.6.2 (2009-05-07) #############################
+
+* ADDED: drydock/console.rb to start a new wing in the drydock
+* ADDED: mixins for String and Object (for Console)
+
+
 #### 0.6.1 (2009-05-03) #############################
 
 * FIXED: @@trawler raises an error in Ruby 1.8 if it's a Symbol

data/README.rdoc

@@ -31,7 +31,7 @@ See bin/example for more.
   # variables defined here will be available to all commands.
   end
 
-  desc "A friendly welcome to the Drydock"
+  about "A friendly welcome to the Drydock"
   command :welcome do
     puts "Welcome to Drydock."
     puts "For available commands:"
@@ -39,7 +39,7 @@ See bin/example for more.
   end
   
   usage "USAGE: #{$0} laugh [-f]"
-  desc "The captain commands his crew to laugh"
+  about "The captain commands his crew to laugh"
   option :f, :faster, "A boolean value. Go even faster!"
   command :laugh do |obj|
   # +obj+ is an instance of Drydock::Command. The options you define are available
@@ -58,12 +58,12 @@ See bin/example for more.
     def ahoy!; p "matey"; end
   end
 
-  desc "Do something with John West's Smoked Oysters"
+  about "Do something with John West's Smoked Oysters"
   command :oysters => JohnWestSmokedOysters do |obj|
     p obj  # => #<JohnWestSmokedOysters:0x42179c ... >
   end
 
-  desc "My way of saying hello!"
+  about "My way of saying hello!"
   command :ahoy! => JohnWestSmokedOysters
   # If you don't provide a block, Drydock will call JohnWestSmokedOysters#ahoy!
 

data/bin/example

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/ruby
 
 # Seafaring Drydock Examples
 # 
@@ -102,7 +102,7 @@ module Example
   end
 
   about "My way of saying hello!"
-  command :ahoy! => JohnWestSmokedOysters
+  command [:ahoy!, :hello!] => JohnWestSmokedOysters
   # If you don't provide a block, Drydock will call JohnWestSmokedOysters#ahoy!
 
 

data/drydock.gemspec

@@ -1,6 +1,6 @@
 @spec = Gem::Specification.new do |s|
   s.name = %q{drydock}
-  s.version = "0.6.3"
+  s.version = "0.6.5"
   s.specification_version = 1 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
@@ -12,16 +12,17 @@
   # = MANIFEST =
   # git ls-files
   s.files = %w(
-    CHANGES.txt
-    LICENSE.txt
-    README.rdoc
-    Rakefile
-    bin/example
-    drydock.gemspec
-    lib/drydock.rb
-    lib/drydock/console.rb
-    lib/mixins/object.rb
-    lib/mixins/string.rb
+  CHANGES.txt
+  LICENSE.txt
+  README.rdoc
+  Rakefile
+  bin/example
+  drydock.gemspec
+  lib/drydock.rb
+  lib/drydock/console.rb
+  lib/drydock/mixins.rb
+  lib/drydock/mixins/object.rb
+  lib/drydock/mixins/string.rb
   )
 
   #  s.add_dependency ''

data/lib/drydock.rb

@@ -3,8 +3,7 @@ require 'ostruct'
 require 'stringio'
 
 require 'drydock/console'
-require 'mixins/string'
-require 'mixins/object'
+require 'drydock/mixins'
 
 module Drydock
   class FancyArray < Array #:nodoc:
@@ -292,7 +291,8 @@ module Drydock
       if @global.verbose > 0
         puts # empty line
         cmd_names_sorted.each do |cmd|
-          puts "%s %s" % [@executable, cmds[cmd][:pretty]]
+          puts "$ %s" % [@executable] if Drydock.default?(cmd)
+          puts "$ %s %s" % [@executable, cmds[cmd][:pretty]]
           puts "%10s: %s" % ["About", cmds[cmd][:desc]] if cmds[cmd][:desc]
           if cmds[cmd][:aliases]
             cmds[cmd][:aliases].sort!{ |a,b| a.size <=> b.size }
@@ -306,7 +306,8 @@ module Drydock
           aliases = cmds[cmd][:aliases] || []
           aliases.sort!{ |a,b| a.size <=> b.size }
           aliases = aliases.empty? ? '' : "(aliases: #{aliases.join(', ')})"
-          puts "  %-16s %s" % [cmds[cmd][:pretty], aliases]
+          pattern = Drydock.default?(cmd) ? "* %-16s %s" : "  %-16s %s"
+          puts pattern % [cmds[cmd][:pretty], aliases]
         end
       end
     end
@@ -370,6 +371,7 @@ module Drydock
   @@command_actions = []
   
   @@default_command = nil
+  @@default_command_with_args = false
   
   @@commands = {}
   @@command_descriptions = []
@@ -454,12 +456,31 @@ module Drydock
   #       # ...
   #     end
   #
-  def default(cmd=nil, &b)
+  # If +with_args+ is specified, the default command will receive all unknown
+  # values as arguments. This is necessary to define explicitly because drydock
+  # parses arguments expecting a command name. If the default command accepts
+  # arguments and with_args is not specified, drydock will raise an unknown
+  # command exception for the first argument.
+  #
+  def default(cmd=nil, with_args=false, &b)
     raise "Calling default requires a command name or a block" unless cmd || b
     # Creates the command and returns the name or just stores given name
     @@default_command = (b) ? command(cmd || :default, &b).cmd : canonize(cmd)
+    # IDEA: refactor out the argument parser to support different types of CLI
+    @@default_command_with_args = with_args ? true : false
+    @@default_command
+  end
+  
+  # Is +cmd+ the default command?
+  def default?(cmd)
+    return false if @@default_command.nil?
+    (@@default_command == canonize(cmd))
   end
   
+  # 
+  def default_with_args?; @@default_command_with_args; end
+  
+  
   # Define a block for processing STDIN before the command is called. 
   # The command block receives the return value of this block as obj.stdin:
   #
@@ -588,11 +609,15 @@ module Drydock
     cmd = cmds.shift # Should we accept aliases here?
     
     if cmd.is_a? Hash
-      raise "#{cmd.values.first} is not a subclass of Drydock::Command" unless cmd.values.first.ancestors.member?(Drydock::Command)
-      c = cmd.values.first.new(cmd.keys.first, &b) # A custom class was specified
-    # TODO: handle command [:task, :alias] => Class
-    #elsif cmd.is_a? Array
-    #  p cmd
+      klass = cmd.values.first
+      names = cmd.keys.first
+      if names.is_a? Array
+        cmd, cmds = names.shift, [names].flatten.compact
+      else
+        cmd = names
+      end
+      raise "#{klass} is not a subclass of Drydock::Command" unless klass.ancestors.member?(Drydock::Command)
+      c = klass.new(cmd, &b)          # A custom class was specified
     else
       c = Drydock::Command.new(cmd, &b)
     end
@@ -833,13 +858,21 @@ module Drydock
     global_options = command_options = {}
     cmd = nil     
     
+    argv_copy = argv.clone # See: @@default_command_with_args below
+    
     global_options = @@global_opts_parser.getopts(argv)
     cmd_name = (argv.empty?) ? @@default_command : argv.shift
     
     unless command?(cmd_name)
-      raise UnknownCommand.new(cmd_name)  unless trawler?
-      raise UnknownCommand.new(@@trawler) unless command?(@@trawler)
-      command_alias(@@trawler, cmd_name)
+      # If requested, send all unknown arguments to the default command
+      if @@default_command_with_args
+        cmd_name = @@default_command
+        argv = argv_copy
+      else
+        raise UnknownCommand.new(cmd_name)  unless trawler?
+        raise UnknownCommand.new(@@trawler) unless command?(@@trawler)
+        command_alias(@@trawler, cmd_name)
+      end
     end
     
     cmd = get_command(cmd_name) 

data/lib/drydock/mixins.rb

@@ -0,0 +1,4 @@
+
+
+require 'drydock/mixins/object'
+require 'drydock/mixins/string'

data/lib/{mixins → drydock/mixins}/string.rb

@@ -1,3 +1,4 @@
+
 class String
   @@print_with_attributes = true
   def String.disable_colour; @@print_with_attributes = false; end
@@ -63,4 +64,3 @@ class String
   alias :noansi :noatt
   
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: drydock
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
+  version: 0.6.5
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 -04:00
+date: 2009-05-21 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -32,8 +32,9 @@ files:
 - drydock.gemspec
 - lib/drydock.rb
 - lib/drydock/console.rb
-- lib/mixins/object.rb
-- lib/mixins/string.rb
+- lib/drydock/mixins.rb
+- lib/drydock/mixins/object.rb
+- lib/drydock/mixins/string.rb
 has_rdoc: true
 homepage: http://github.com/delano/drydock
 licenses: []