quickl 0.2.2 → 0.3.0

data/spec/command/{subcommand_by_name_spec.rb → test_subcommand_by_name.rb}

@@ -1,14 +1,14 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command::subcommand_by_name /" do
     
     specify "when called on single command names" do
-      MiniClient.subcommand_by_name("help").should == MiniClient::Help
+      MiniClient.subcommand_by_name("help").should eq(MiniClient::Help)
       MiniClient.subcommand_by_name("noway").should be_nil
     end
     
     specify "when called on complex command names" do
-      MiniClient.subcommand_by_name("say:hello").should == MiniClient::Say::Hello
+      MiniClient.subcommand_by_name("say:hello").should eq(MiniClient::Say::Hello)
     end
     
   end # Command::command_name

data/spec/command/{subcommands_spec.rb → test_subcommands.rb}

@@ -1,23 +1,24 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command::subcommands /" do
     
     it "should return installed commands in an array" do
-      MiniClient.subcommands.should == [ 
+      MiniClient.subcommands.should eq([ 
         MiniClient::Help, 
         MiniClient::Say,
         MiniClient::Requester,
-      ]
-      MiniClient::Say.subcommands.should == [ 
+      ])
+      MiniClient::Say.subcommands.should eq([ 
         MiniClient::Say::Hello,
         MiniClient::Say::Goodbye,
-      ]
+        MiniClient::Say::Args
+      ])
     end
     
     it "should take care of the command_parent= in command builder" do
-      MiniClient::Requester.subcommands.should == [
+      MiniClient::Requester.subcommands.should eq([
         MiniClient::Factored
-      ]
+      ])
     end
 
   end # Command::subcommand

data/spec/command/test_usage.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+module Quickl
+  describe "Command::usage /" do
+    
+    it "should be installed from inline rdoc" do
+      MiniClient::Say::Hello.usage.should eq("mini-client say:hello")
+      MiniClient::Say::Goodbye.usage.should eq("mini-client say:goodbye")
+    end
+    
+  end # Command::usage
+end # module Quickl

data/spec/mini_client.rb

@@ -2,7 +2,17 @@
 # MiniClient main command
 #
 class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
+  
+  # Is verbose?
+  attr_accessor :verbose
 
+  options do |opt|
+    @verbose = false
+    opt.on("-v", "--[no-]verbose") do |val|
+      self.verbose = val
+    end
+  end
+  
   #
   # Print help
   #
@@ -14,7 +24,7 @@ class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
   #
   class Help < Quickl::Command(__FILE__, __LINE__)
 
-    def execute(*args)
+    def execute(args)
       :help
     end
       
@@ -34,7 +44,7 @@ class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
     #
     class Hello < Quickl::Command(__FILE__, __LINE__)
       
-      def execute(*args)
+      def execute(args)
         :hello
       end
       
@@ -48,12 +58,32 @@ class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
     #
     class Goodbye < Quickl::Command(__FILE__, __LINE__)
 
-      def execute(*args)
+      def execute(args)
         :goodbye
       end
       
     end # class Goodbye
 
+    #
+    # Say the args
+    #
+    # SYNOPSIS
+    #   #{MiniClient.command_name} say:args
+    #
+    class Args < Quickl::Command(__FILE__, __LINE__)
+
+      options do |opt|
+        opt.on('-i', '--ioption'){}
+        opt.on('-j', '--joption'){}
+        opt.on('-k', '--koption'){}
+      end
+
+      def run(args, sep_support = nil)
+        parse_options(args, sep_support)
+      end
+      
+    end # class Args
+
   end # class Say
     
   #
@@ -64,7 +94,7 @@ class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
   #
   class Requester < Quickl::Command(__FILE__, __LINE__)
 
-    def execute(*args)
+    def execute(args)
       requester
     end
     
@@ -87,10 +117,10 @@ class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
   #
   class Factored < Factor(__FILE__, __LINE__, :hello)
     
-    def execute(*args)
+    def execute(args)
       self.class.instance_eval{ @factored_arg }
     end
     
   end
   
-end # module MiniClient
+end # module MiniClient

data/spec/naming/test_command2module.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+module Quickl
+  describe "Naming::command2module /" do
+    include Naming
+    
+    it "should capitalize first char" do
+      command2module("say").should eq("Say")
+      command2module(:say).should eq(:Say)
+    end
+
+    it "should capitalize support dashes" do
+      command2module("say-hello").should eq("SayHello")
+      command2module(:"say-hello").should eq(:SayHello)
+    end
+    
+  end # module Quickl
+end # module Quickl

data/spec/naming/test_module2command.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+module Quickl
+  describe "Naming::module2command /" do
+    include Naming
+    
+    it "should uncapitalize first char" do
+      module2command("Say").should eq("say")
+      module2command(:Say).should eq(:say)
+    end
+
+    it "should uncapitalize and introduce dashes" do
+      module2command("SayHello").should eq("say-hello")
+      module2command(:"SayHello").should eq(:"say-hello")
+    end
+    
+    it "should support taking modules as argument" do
+      module2command(Quickl::Command).should eq("command")
+    end
+    
+  end # module Quickl
+end # module Quickl

data/spec/quickl/test_command_name.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+describe "Quickl#command_name" do
+
+  subject{ Quickl.command_name(cmd) }
+  
+  describe "on a command class" do
+    let(:cmd){ MiniClient::Say::Hello }
+    it{ should eq("hello") }
+  end
+  
+  describe "on a command instance" do
+    let(:cmd){ MiniClient::Say::Hello.new }
+    it{ should eq("hello") }
+  end
+  
+end

data/spec/quickl/test_documentation.rb

@@ -0,0 +1,32 @@
+$hello_doc = <<EOF
+
+Say hello to the user whose name is requested on the standard input
+
+SYNOPSIS
+  mini-client say:hello
+
+DESCRIPTION
+  And an explanation here
+  on multiple lines with replacement: hello
+
+EOF
+require "spec_helper"
+describe "Quickl#documentation" do
+
+  subject{ Quickl.documentation(cmd) }
+  
+  describe "on a command class" do
+    let(:cmd){ MiniClient::Say::Hello }
+    it{ should eq($hello_doc) }
+  end
+  
+  describe "on a command instance" do
+    let(:cmd){ MiniClient::Say::Hello.new }
+    it{ should eq($hello_doc) }
+  end
+
+  it "should be aliased as help" do
+    Quickl.help(MiniClient::Say::Hello).should eq($hello_doc)
+  end
+  
+end

data/spec/quickl/test_overview.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+describe "Quickl#overview" do
+
+  subject{ Quickl.overview(cmd) }
+  
+  describe "on a command class" do
+    let(:cmd){ MiniClient::Help }
+    it{ should eq("Print help") }
+  end
+  
+  describe "on a command instance" do
+    let(:cmd){ MiniClient::Help.new }
+    it{ should eq("Print help") }
+  end
+  
+end

data/spec/quickl/test_parse_commandline_args.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+describe "Quickl.parse_commandline_args" do
+  
+  subject{ Quickl.parse_commandline_args(args) }
+  
+  describe "on empty string" do
+    let(:args){ "" }
+    it { should eq([]) }
+  end
+
+  describe "on pseudo empty string" do
+    let(:args){ "   " }
+    it { should eq([]) }
+  end
+
+  describe "on a single arg" do
+    let(:args){ "--text" }
+    it { should eq(["--text"]) }
+  end
+
+  describe "on a multiple args" do
+    let(:args){ "--text --size=10" }
+    it { should eq(["--text", "--size=10"]) }
+  end
+
+  describe "on single quoted arg" do
+    let(:args){ "'hello'" }
+    it { should eq(["hello"]) }
+  end
+
+  describe "on single quoted arg with spacing" do
+    let(:args){ "'hello the world'" }
+    it { should eq(["hello the world"]) }
+  end
+  
+  describe "on double quoted arg" do
+    let(:args){ '"hello"' }
+    it { should eq(["hello"]) }
+  end
+
+  describe "on double quoted arg with spacing" do
+    let(:args){ "'hello the world'" }
+    it { should eq(['hello the world']) }
+  end
+
+  describe "on typical example" do
+    let(:args){ %q{--verbose 'hello the world' -g -Ilib --term='none'}}
+    it{ should eq(["--verbose", 'hello the world', "-g", "-Ilib", "--term='none'"]) }
+  end
+
+
+end

data/spec/quickl/test_split_commandline_args.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+describe "Quickl.split_commandline_args" do
+
+  subject{ Quickl.split_commandline_args(args) }
+
+  describe "on an empty array" do
+    let(:args){ %w{} }
+    it { should eq([%w{}]) }
+  end
+
+  describe "without an option separator" do
+    let(:args){ %w{hello world} }
+    it { should eq([%w{hello world}]) }
+  end
+
+  describe "with an option at start" do
+    let(:args){ %w{-- hello world} }
+    it { should eq([%w{}, %w{hello world}]) }
+  end
+
+  describe "with an option at end" do
+    let(:args){ %w{hello world --} }
+    it { should eq([%w{hello world}, %w{}]) }
+  end
+
+  describe "with an option separator in the middle" do
+    let(:args){ %w{hello -- world} }
+    it { should eq([%w{hello}, %w{world}]) }
+  end
+
+  describe "on a complex example" do
+    let(:args){ %w{-- hello -- hello2 hello3 -- x --} }
+    let(:expected){[
+      %w{}, %w{hello}, %w{hello2 hello3}, %w{x}, %w{}
+    ]}
+    it { should eq(expected) }
+  end
+
+end

data/spec/quickl/test_sub_command.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+describe "Quickl.sub_command(!)" do
+
+  describe "non bang version" do
+    subject{ Quickl.sub_command(cmd, name) }
+
+    describe "on a command class with existing sub" do
+      let(:cmd){ MiniClient }
+      let(:name){ "say:hello" }
+      it{ should eq(MiniClient::Say::Hello) }
+    end
+    
+    describe "on a command instance with existing sub" do
+      let(:cmd){ MiniClient.new }
+      let(:name){ "say:hello" }
+      it{ should eq(MiniClient::Say::Hello) }
+    end
+    
+    describe "when no such existing sub" do
+      let(:cmd){ MiniClient.new }
+      let(:name){ "say:wouwouwou" }
+      it{ should be_nil }
+    end
+  end
+
+  describe "the bang version" do
+    subject{ Quickl.sub_command!(cmd, name) }
+
+    describe "on a command class with existing sub" do
+      let(:cmd){ MiniClient }
+      let(:name){ "say:hello" }
+      it{ should eq(MiniClient::Say::Hello) }
+    end
+    
+    describe "on a command instance with existing sub" do
+      let(:cmd){ MiniClient.new }
+      let(:name){ "say:hello" }
+      it{ should eq(MiniClient::Say::Hello) }
+    end
+    
+    describe "when no such existing sub" do
+      let(:cmd){ MiniClient.new }
+      let(:name){ "say:wouwouwou" }
+      specify{ lambda{subject}.should raise_error(Quickl::NoSuchCommand) }
+    end
+  end
+  
+end

data/spec/quickl/test_super_command.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+describe "Quickl.super_command" do
+
+  subject{ Quickl.super_command(cmd) }
+  
+  describe "on a command class" do
+    let(:cmd){ MiniClient::Say::Hello }
+    it{ should eq(MiniClient::Say) }
+  end
+  
+  describe "on a command instance" do
+    let(:cmd){ MiniClient::Say::Hello.new }
+    it{ should eq(MiniClient::Say) }
+  end
+  
+  describe "with no super command" do
+    let(:cmd){ MiniClient }
+    it{ should be_nil }
+  end
+  
+end

data/spec/quickl/test_usage.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+describe "Quickl#usage" do
+
+  subject{ Quickl.usage(cmd) }
+  
+  describe "on a command class" do
+    let(:cmd){ MiniClient::Say::Hello }
+    it{ should eq("mini-client say:hello") }
+  end
+  
+  describe "on a command instance" do
+    let(:cmd){ MiniClient::Say::Hello.new }
+    it{ should eq("mini-client say:hello") }
+  end
+  
+end