remi-simplecli 0.1.5 → 0.1.6

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 ryan "remi" Taylor
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,133 @@
+= SimpleCLI
+
+Super Simple RubyGems-like CLI
+
+SimpleCLI gives you a stupidly simple way to implement command-line 
+interfaces like that of RubyGems with a basic interface like:
+
+    gem command [options]
+
+SimpleCLI gives you a way of defining your commands (or actions) so 
+they'll automatically show up when you run `yourapp commands`
+
+SimpleCLI also makes it really easy to add documentation to each of
+your commands (or actions)
+
+== Real Examples
+
+I use SimpleCLI in most of my apps for quick and dirty command-line interfaces.
+
+Here are a few real examples:
+
+* {Syntax On}[http://github.com/remi/syntax-on/tree/master/lib/syntax-on/bin.rb]
+* {Domain Finder}[http://github.com/remi/domain-finder/tree/master/lib/domain-finder/bin.rb]
+* ADF[http://github.com/remi/adf/tree/master/lib/adf/bin.rb]
+
+== Example
+
+Here's a super simple SimpleCLI example:
+
+    #! /usr/bin/env ruby
+
+    require File.dirname(__FILE__) + '/../lib/simplecli'
+
+    class Hello
+      include SimpleCLI
+
+      def usage
+        puts <<doco
+
+      Hello CLI
+
+        Usage:
+          #{ script_name } command [options]
+        
+        Futher help:
+          #{ script_name } commands         # list all available commands
+          #{ script_name } help <COMMAND>   # show help for COMMAND
+          #{ script_name } help             # show this help message
+
+    doco
+      end
+
+      def sayhello_help
+        <<doco
+    Usage: #{ script_name } sayhello [SAY]
+
+      Arguments:
+        SAY:         Something to say (default 'Hello World!')
+
+      Summary:
+        Says hello!
+    doco
+      end
+      def sayhello *args
+        puts args.empty? ? "Hello World!" : args.join(' ')
+      end
+
+    end
+
+    # POSTAMBLE
+    if __FILE__ == $0
+      Hello.new( ARGV, :default => 'sayhello' ).run
+    end
+
+Example usage:
+
+<em><tt>$ ./hello-cli</tt></em>
+
+    Hello CLI
+
+      Usage:
+        hello-cli command [options]
+      
+      Futher help:
+        hello-cli commands         # list all available commands
+        hello-cli help <COMMAND>   # show help for COMMAND
+        hello-cli help             # show this help message
+
+<em><tt>$ ./hello-cli commands</tt></em>
+
+    hello-cli commands are:
+
+        DEFAULT COMMAND   sayhello
+
+        commands          List all 'hello-cli' commands
+        help              Provide help documentation for a command
+        sayhello          Says hello!
+
+    For help on a particular command, use 'hello-cli help COMMAND'.
+
+<em><tt>$ ./hello-cli help</tt></em>
+
+    Usage: hello-cli help COMMAND
+
+      Summary:
+        Provide help documentation for a command
+
+<em><tt>$ ./hello-cli help sayhello</tt></em>
+
+    Usage: hello-cli sayhello [SAY]
+
+      Arguments:
+        SAY:         Something to say (default 'Hello World!')
+
+      Summary:
+        Says hello!
+
+<em><tt>$ ./hello-cli sayhello</tt></em>
+
+    Hello World!
+
+<em><tt>$ ./hello-cli sayhello Hi There</tt></em>
+
+  Hi There
+
+<em><tt>$ ./hello-cli Hi There</tt></em>    `# this works because sayhello is configured as the default command`
+
+    Hi There
+
+TODO
+----
+
+* implement <tt>command_missing</tt> method

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = "simplecli"
+    s.summary     = "For making simple RubyGem-like command-line interfaces"
+    s.email       = "remi@remitaylor.com"
+    s.homepage    = "http://github.com/remi/simplecli"
+    s.description = "SimpleCLI gives you a stupidly simple way to implement command-line interfaces like that of RubyGems"
+    s.authors     = %w( remi )
+    s.files       = FileList["[A-Z]*", "{lib,spec,examples}/**/*"] 
+    # s.add_dependency 'person-project' 
+    # s.executables = "neato" 
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'simplecli'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('simplecli.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 6

data/lib/simplecli.rb

@@ -59,20 +59,61 @@ module SimpleCLI
 
     @default_command  = @options[:default].to_s if @options.keys.include? :default
     @commands         = all_commands
-    
-    if not args.empty? and @commands.map{|c|c.downcase}.include? args.first.downcase
+
+    # if a command is discovered, eg. $ myscript foo 1 2 3 # where foo is a command
+    if not args.empty? and @commands.map {|c| c.downcase }.include? args.first.downcase
       @command = args.shift.downcase
+
+    # if a command is not discovered, and no arguments were sent at all, eg. $ myscript
+    elsif args.empty?
+      @command = @default_command || 'usage'
+
+    # there were args passed, but we don't know what to call ... try command_missing first
+    elsif command_from_command_missing = command_missing(args)
+      @command = command_from_command_missing # if it returns something that's not nil, set it to command
+
+    # there were some arguments, pass if to the default command if there is one, else 'command not found'
+    elsif @default_command
+      @command = @default_command
+
+    # nothing worked out ... show command not found & usage
     else
-      @command = (args.empty?) ? 'usage' : ( @default_command || 'usage' )
+      puts "command not found: #{ args.first.downcase }"
+      @command = 'usage'
+
     end
     
-    @command_args     = args
+    @command_args = args
+  end
+
+  # before dropping to default command ( if defined via :default option ), 
+  # the arguments get passed along to command_missing (you get the original args array)
+  #
+  # your command_missing can return a command string (name of the command) or just a proc to call!
+  #
+  # actually, if what you respond with responds to #call, we use that, else we call #to_s to 
+  # get the name of the command to run
+  #
+  # ***NOTE*** if command_missing makes changes to the args passed to it, these are persisted 
+  #            and passed to the command.  args.dup if you need to mess with args!
+  #
+  # if you return something #call-able, the command arguments will be passed to your block
+  #
+  # you can call super to drop back to the default command_missing in SimpleCLI 
+  # or just return nil to say "nope, can't find a command for this"
+  #
+  def command_missing args
+    nil
   end
   
   # run command determined by parse
   def run
     begin
-      self.send @command, *@command_args
+      if @command.respond_to? :call
+        @command.call @command_args
+      else
+        self.send @command.to_s, *@command_args
+      end
     rescue ArgumentError => ex
       puts "'#{@command}' called with wrong number of arguments\n\n"
       puts help_for( @command )

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: remi-simplecli
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
-- remi Taylor
+- remi
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-04-27 00:00:00 -07:00
+date: 2009-03-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,25 +19,21 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
-- README
+- Rakefile
+- VERSION.yml
+- README.rdoc
+- LICENSE
 - lib/simplecli.rb
 - examples/hello-cli
 has_rdoc: true
 homepage: http://github.com/remi/simplecli
 post_install_message: 
 rdoc_options: 
-- --quiet
-- --title
-- SimpleCLI - Simple RubyGems-like Command-line Interface
-- --opname
-- index.html
-- --line-numbers
-- --main
-- README
 - --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -55,9 +51,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Super Simple RubyGems-like CLI
+summary: For making simple RubyGem-like command-line interfaces
 test_files: []
 

data/README

@@ -1,118 +0,0 @@
-== SimpleCLI
-
-Super Simple RubyGems-like CLI
-
-SimpleCLI gives you a stupidly simple way to implement command-line 
-interfaces like that of RubyGems with a basic interface like:
-
-  gem command [options]
-
-SimpleCLI gives you a way of defining your commands (or actions) so 
-they'll automatically show up when you run <tt>`yourapp commands`</tt>
-
-SimpleCLI also makes it really easy to add documentation to each of
-your commands (or actions)
-
-=== Example
-
-Here's a super simple SimpleCLI example:
-
-  #! /usr/bin/env ruby
-
-  require File.dirname(__FILE__) + '/../lib/simplecli'
-
-  class Hello
-    include SimpleCLI
-
-    def usage
-      puts <<doco
-
-    Hello CLI
-
-      Usage:
-        #{ script_name } command [options]
-        
-      Futher help:
-        #{ script_name } commands         # list all available commands
-        #{ script_name } help <COMMAND>   # show help for COMMAND
-        #{ script_name } help             # show this help message
-
-  doco
-    end
-
-    def sayhello_help
-      <<doco
-  Usage: #{ script_name } sayhello [SAY]
-
-    Arguments:
-      SAY:         Something to say (default 'Hello World!')
-
-    Summary:
-      Says hello!
-  doco
-    end
-    def sayhello *args
-      puts args.empty? ? "Hello World!" : args.join(' ')
-    end
-
-  end
-
-  # POSTAMBLE
-  if __FILE__ == $0
-    Hello.new( ARGV, :default => 'sayhello' ).run
-  end
-
-Example usage:
-
-<b><tt>$ ./hello-cli</b></tt>
-
-  Hello CLI
-
-    Usage:
-      hello-cli command [options]
-      
-    Futher help:
-      hello-cli commands         # list all available commands
-      hello-cli help <COMMAND>   # show help for COMMAND
-      hello-cli help             # show this help message
-
-<b><tt>$ ./hello-cli commands</b></tt>
-
-  hello-cli commands are:
-
-      DEFAULT COMMAND   sayhello
-
-      commands          List all 'hello-cli' commands
-      help              Provide help documentation for a command
-      sayhello          Says hello!
-
-  For help on a particular command, use 'hello-cli help COMMAND'.
-
-<b><tt>$ ./hello-cli help</b></tt>
-
-  Usage: hello-cli help COMMAND
-
-    Summary:
-      Provide help documentation for a command
-
-<b><tt>$ ./hello-cli help sayhello</b></tt>
-
-  Usage: hello-cli sayhello [SAY]
-
-    Arguments:
-      SAY:         Something to say (default 'Hello World!')
-
-    Summary:
-      Says hello!
-
-<b><tt>$ ./hello-cli sayhello</b></tt>
-
-  Hello World!
-
-<b><tt>$ ./hello-cli sayhello Hi There</b></tt>
-
-  Hi There
-
-<b><tt>$ ./hello-cli Hi There</b></tt>  <tt># this works because sayhello is configured as the default command</tt>
-
-  Hi There