quickl 0.2.0 → 0.2.1

data/examples/delegator/lib/help.rb

@@ -1,24 +0,0 @@
-class Delegator
-  # 
-  # Show help about a specific command
-  #
-  # SYNOPSIS
-  #   #{program_name} #{command_name} help COMMAND
-  #
-  class Help < Quickl::Command(__FILE__, __LINE__)
-    
-    # Let NoSuchCommandError be passed to higher stage
-    no_react_to Quickl::NoSuchCommand
-    
-    # Command execution
-    def execute(args)
-      if args.size != 1
-        puts super_command.help
-      else
-        cmd = has_command!(args.first, super_command)
-        puts cmd.help
-      end
-    end
-    
-  end # class Help
-end # class Delegator

data/examples/delegator/test/delegator_test.rb

@@ -1,68 +0,0 @@
-require 'test/unit'
-require 'stringio'
-begin 
-  require 'quickl'
-rescue LoadError
-  $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
-  require 'quickl'
-end
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'Delegator'
-
-class DelegatorTest < Test::Unit::TestCase
-
-  def assert_exits(match, exit_code)  
-    yield
-    assert_false true, "Expected to exit with #{match}, nothing raised"
-  rescue Quickl::Exit => ex
-    assert_equal ex.exit_code, exit_code
-    assert ex.message =~ match
-  end
-  
-  def run_command(*args)
-    $stdout = StringIO.new
-    Delegator.no_react_to(Quickl::Exit)
-    Delegator.run args
-    $stdout.string
-  ensure
-    $stdout = STDOUT
-  end
-  
-  def test_alone
-    assert_exits(/Delegate execution to a sub command/, 0){ run_command }
-  end
-  
-  def test_help_option
-    assert_exits(/DESCRIPTION/, 0){ 
-      run_command("--help") 
-    }
-  end
-  
-  def test_version_option
-    assert_exits(/(c)/, 0){ 
-      run_command("--version") 
-    }
-  end
-  
-  def test_no_such_option
-    assert_exits(/invalid option/, -1){ 
-      run_command("--no-such-option") 
-    }
-  end
-  
-  def test_help_delegation
-    assert run_command("help", "hello-world") =~ /Say hello/
-  end
-  
-  def test_hello_delegation
-    assert_equal "Hello world!\n", run_command("hello-world")
-    assert_equal "Hello bob!\n", run_command("hello-world", "bob")
-  end
-  
-  def test_hello_capitalize
-    assert_equal "Hello World!\n", run_command("hello-world", "--capitalize")
-    assert_equal "Hello Bob!\n", run_command("hello-world", "bob", "--capitalize")
-  end
-  
-end
-

data/examples/hello/README.md

@@ -1,74 +0,0 @@
-# Quickl example: hello 
-
-This example shows how to create a really simple commandline program. 
-
-## Structure
-
-The structure it follows is simply:
-
-    #
-    # Short description here
-    #
-    # SYNOPSIS
-    #   Usage: ...
-    #
-    # OPTIONS
-    # #{sumarized_options}
-    #
-    # DESCRIPTION
-    #   Long description here...
-    #
-    class SimpleCommand < Quickl::Command(__FILE__, __LINE__)
-    
-      # install options below
-      options do |opt|
-        # _opt_ is an OptionParser instance
-      end
-      
-      # install the code to run the command
-      def execute(args)
-        # _args_ are non-option command line parameters
-      end
-    
-    end
-    
-    # To run the command, typically in a bin/simple_command 
-    # shell file
-    SimpleCommand.run(ARGV)
-    
-
-## Example
-
-Try the following:
-
-    ./hello 
-    # => Hello world!
-    
-    ./hello --capitalize
-    # => Hello World!
-
-    ./hello bob
-    # => Hello bob!
-    
-    ./hello --capitalize bob
-    # => Hello Bob!
-    
-    ./hello --version
-    # => hello 0.1.0 (c) 2010, Bernard Lambeau
-    
-    ./hello --help
-    # => ...
-    
-    ./hello too many arguments
-    # => needless argument: too many arguments
-    # => hello [--help] [--version] [--capitalize] [WHO]
-    
-    ./hello --no-such-option 
-    # invalid option: --no-such-option
-    # hello [--help] [--version] [--capitalize] [WHO]
-
-## You have to known that ...
-
-* An **instance** of command is actually executed. Therefore, it is safe to install instance variables through options and to use them in execute().
-* Documentation shown with --help is the rdoc documentation evaluated in the binding of the SimpleCommand **class**. Therefore, you can use #{...} to display specific things (like #{sumarized_options}).
-* Default error handlers are installed by default to catch Interrupt, Quickl::Exit and OptionParser::Error. See error_handling example to learn more about them.

data/examples/hello/hello

@@ -1,57 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../helper', __FILE__)
-
-#
-# Say hello 
-#
-# SYNOPSIS
-#   #{program_name} [--help] [--version] [--capitalize] [WHO]
-#
-# OPTIONS
-# #{summarized_options}
-#
-# DESCRIPTION
-#   Without any argument, says hello to the world. When a single argument 
-#   is given says hello to the user.
-#
-class Hello < Quickl::Command(__FILE__, __LINE__)
-  
-  # Command's version
-  VERSION = "0.1.0"
-  
-  # Install command options
-  options do |opt|
-
-    # Capitalize user name?
-    opt.on("--capitalize", "-c", "Capitalize user name") do 
-      @capitalize = true
-    end
-
-    # Show the help and exit
-    opt.on_tail("--help", "Show help") do
-      raise Quickl::Help
-    end
-
-    # Show version and exit
-    opt.on_tail("--version", "Show version") do
-      raise Quickl::Exit, "#{program_name} #{VERSION} (c) 2010, Bernard Lambeau"
-    end
-    
-  end
-  
-  # Execute the command on some arguments
-  def execute(args)
-    if args.size <= 1
-      name = args.first || "world"
-      name = name.capitalize if @capitalize
-      puts "Hello #{name}!"
-    else
-      raise Quickl::InvalidArgument, "Useless arguments: #{args.join(' ')}"
-    end
-  end
-  
-end # class Hello
-
-if __FILE__ == $0
-  Hello.run(ARGV, __FILE__)
-end

data/examples/hello/hello_test.rb

@@ -1,65 +0,0 @@
-require 'test/unit'
-require 'stringio'
-begin 
-  require 'quickl'
-rescue LoadError
-  $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
-  require 'quickl'
-end
-Kernel.load File.expand_path('../hello', __FILE__)
-
-class HelloTest < Test::Unit::TestCase
-    
-  def assert_exits(match, exit_code)  
-    yield
-    assert_false true, "Expected to exit with #{match}, nothing raised"
-  rescue Quickl::Exit => ex
-    assert_equal exit_code, ex.exit_code
-    assert ex.message =~ match
-  end
-  
-  def run_command(*args)
-    $stdout = StringIO.new
-    Hello.no_react_to(Quickl::Exit)
-    Hello.run args
-    $stdout.string
-  ensure
-    $stdout = STDOUT
-  end
-  
-  def test_normal_runs
-    assert_equal "Hello world!\n",    run_command
-    assert_equal "Hello blambeau!\n", run_command("blambeau")
-  end
-  
-  def test_capitalize
-    assert_equal "Hello World!\n",    run_command("--capitalize")
-    assert_equal "Hello Blambeau!\n", run_command("--capitalize", "blambeau")
-  end
-  
-  def test_version_option
-    assert_exits(/(c)/, 0){ 
-      run_command("--version") 
-    }
-  end
-  
-  def test_help_option
-    assert_exits(/DESCRIPTION/, 0){ 
-      run_command("--help") 
-    }
-  end
-  
-  
-  def test_no_such_option
-    assert_exits(/invalid option/, -1){ 
-      run_command("--no-such-option") 
-    }
-  end
-  
-  def test_too_many_arguments
-    assert_exits(/Useless arguments/, -1){ 
-      run_command('hello', 'too') 
-    }
-  end
-  
-end

data/examples/helper.rb

@@ -1,6 +0,0 @@
-begin 
-  require 'quickl'
-rescue LoadError
-  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-  require 'quickl'
-end

data/templates/single.erb

@@ -1,40 +0,0 @@
-begin
-  require 'quickl'
-rescue LoadError
-  require 'rubygems'
-  gem 'quickl'
-  retry  
-end
-
-#
-# FIX: overview
-#
-# SYNOPSIS
-#   #{command_name} [options] ARGS...
-#
-# OPTIONS
-# #{summarized_options}
-#
-# DESCRIPTION
-#   FIX: description 
-#
-class <%= cmd_class_name %> < Quickl::Command(__FILE__, __LINE__)
-
-  VERSION   = "0.1.0"
-
-  # Install options
-  options do |opt|
-<%= option_helpers.collect{|s| tabto(s,4)}.join("\n") %>
-  end
-  
-  # Run the command
-  def execute(args)
-    # FIX: do something here
-    puts "Hello #{args.join(' and ')} from #{program_name}"
-  end
-
-end # class <%= cmd_class_name %>
-
-if __FILE__ == $0
-  <%= cmd_class_name %>.run(ARGV)
-end