quickl 0.2.2 → 0.3.0

data/lib/quickl/command/options.rb

@@ -43,13 +43,38 @@ module Quickl
         @options ||= self.class.build_options(self)
       end
       
-      # Parses options
-      def parse_options(argv)
-        options.parse!(argv)
+      #
+      # Parses options in `argv` with an OptionParser instance and returns 
+      # non-options arguments.
+      #
+      # The following example illustrates the role of `sep_support`
+      #
+      #     parse_options %w{--verbose hello -- quickl --say and world}
+      #     # => ["hello", "quickl", "--say", "and", "world"]
+      #
+      #     parse_options %w{--verbose hello -- quickl --say and world}, :keep
+      #     # => ["hello", "--", "quickl", "--say", "and", "world"]
+      #
+      #     parse_options %w{--verbose hello -- quickl --say and world}, :split
+      #     # => [["hello"], ["quickl", "--say", and", "world"]]
+      #
+      def parse_options(argv, sep_support = :none)
+        case sep_support
+        when NilClass, :none
+          options.parse!(argv)
+        when :split, :keep
+          parts = Quickl.split_commandline_args(argv)
+          parts[0] = options.parse!(parts[0])
+          if sep_support == :keep
+            parts.inject(nil){|memo,arr| memo ? memo + ["--"] + arr : arr.dup}
+          else
+            parts
+          end
+        end
       rescue OptionParser::ParseError => ex
         raise Quickl::InvalidOption, ex.message, ex.backtrace
       end
       
     end # module InstanceMethods
   end # module Command::Options
-end # module Quickl
+end # module Quickl

data/lib/quickl/command/robustness.rb

@@ -6,24 +6,17 @@ module Quickl
       # Checks that a command whose name is given exists
       # or raises a NoSuchCommand.
       def has_command!(name, referer = self.class)
-        unless cmd = referer.subcommand_by_name(name)
-          raise NoSuchCommand, "No such command #{name}" 
-        end
-        cmd
+        Quickl.deprecated("Command#has_command!", "Quickl.sub_command!", caller)
+        Quickl.sub_command!(referer, name)
       end
       
       # Checks that _file_ is a readable file or raises an error.
       # Returns _file_ on success.
       def valid_read_file!(file, error_class = nil, msg = nil)
-        if File.file?(file) and File.readable?(file)
-          file
-        else
-          error_class ||= Quickl::IOAccessError
-          msg ||= "Not a file or not readable: #{file}"
-          raise error_class, msg, caller
-        end
+        Quickl.deprecated("Command#valid_read_file!", "Quickl.valid_read_file!", caller)
+        Quickl.valid_read_file!(file, error_class, msg)
       end
       
     end # module Robustness
   end # class Command
-end # module Quickl
+end # module Quickl

data/lib/quickl/command/single.rb

@@ -3,11 +3,9 @@ module Quickl
   # Instance method for being a single command
   module Command::Single
     
-    # Command arguments after options parsing
-    attr_reader :args
-
     # Run the command by delegation
-    def _run(argv = [])
+    def run(argv = [], requester = nil)
+      @requester = requester
       execute(parse_options(argv))
     end
     
@@ -18,8 +16,8 @@ module Quickl
   #
   def self.Command(*args)
     command_builder do |b|
-      b.document *args
-      b.instance_module Command::Single
+      b.document(*args)
+      b.instance_module(Command::Single)
       yield(b) if block_given?
     end
     Command

data/lib/quickl/errors.rb

@@ -107,9 +107,9 @@ module Quickl
     
     def react!
       msg = if (self.message || "").empty?
-        command.help
+        command.class.help
       else
-        self.message.to_s + "\n" + command.help
+        self.message.to_s + "\n" + command.class.help
       end
       raise Exit.new(self.exit_code), msg, backtrace
     end

data/lib/quickl/version.rb

@@ -2,8 +2,8 @@ module Quickl
   module Version
   
     MAJOR = 0
-    MINOR = 2
-    TINY  = 2
+    MINOR = 3
+    TINY  = 0
   
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')

data/quickl.gemspec

@@ -125,10 +125,10 @@ Gem::Specification.new do |s|
   #
   s.add_development_dependency("rake", "~> 0.9.2")
   s.add_development_dependency("bundler", "~> 1.0")
-  s.add_development_dependency("rspec", "~> 2.4.0")
-  s.add_development_dependency("yard", "~> 0.6.4")
-  s.add_development_dependency("bluecloth", "~> 2.0.9")
-  s.add_development_dependency("wlang", "~> 0.10.1")
+  s.add_development_dependency("rspec", "~> 2.6.0")
+  s.add_development_dependency("yard", "~> 0.7.2")
+  s.add_development_dependency("bluecloth", "~> 2.1.0")
+  s.add_development_dependency("wlang", "~> 0.10.2")
   
 
   # The version of ruby required by this gem

data/quickl.noespec

@@ -1,58 +1,34 @@
 # Noe template for ruby gem libraries (https://github.com/blambeau/noe) - short version
 # Run 'noe show-spec' and 'noe help show-spec' for additional details.
-
-# Don't remove this entry!
 template-info:
   name: "ruby"
-  version: 1.3.0
-
-# Update to match your own configuration.
+  version: 1.4.0
+  manifest:
+    tasks/unit_test.rake:
+      safe-override: false
+    tasks/spec_test.rake:
+      safe-override: false
 variables:
-  # A ruby lower case project name.
   lower: 
     quickl
-
-  # A ruby upper case project name. 
   upper:
     Quickl
-
-  # Version of your library
   version:
-    0.2.2
-    
-  # Project summary (~ 1 line).
+    0.3.0
   summary: |-
     Helper to create commandline ruby programs
-
-  # Project description (~ 5 lines). Project description should be more complete
-  # than the summary and will be used to describe your gem on rubygems.org
   description: |-
     Quickl helps you creating commandline ruby programs. From simple commands 
     with options to complex delegators with subcommands, global and local 
     options.
-      
-  # Authors of the project (- {name: Bob, email: bob@gmail.com}, ...) 
   authors: 
     - { name: "Bernard Lambeau", email: blambeau@gmail.com }
-
-  # Web links for the project (- http://..., - http://...). 
   links:
     - http://github.com/blambeau/quickl
-
-  # Gem dependencies. (- {name: ..., version: ..., groups: [...]}, ...)
   dependencies: 
-    # Rake is required for developers, as usual
-    - {name: rake,      version: "~> 0.9.2", groups: [development]}
-    # Bundler is required for developers and is used by the Rakefile
-    - {name: bundler,   version: "~> 1.0",   groups: [development]}
-    # RSpec is required to run 'rake spec'. See tasks/spec.rake 
-    - {name: rspec,     version: "~> 2.4.0", groups: [development]}
-    # YARD and BlueCloth are required to run 'rake yard'. See tasks/yard.rake 
-    - {name: yard,      version: "~> 0.6.4", groups: [development]}
-    - {name: bluecloth, version: "~> 2.0.9", groups: [development]}
-    # wlang is required to run 'rake debug_mail'. See tasks/debug_mail.rake
-    - {name: wlang, version: "~> 0.10.1",    groups: [development]}
-
-  rake_tasks:
-    unit_test: 
-      pattern: examples/**/*_test.rb
+    - {name: rake,      version: "~> 0.9.2",  groups: [development]}
+    - {name: bundler,   version: "~> 1.0",    groups: [development]}
+    - {name: rspec,     version: "~> 2.6.0",  groups: [development]}
+    - {name: yard,      version: "~> 0.7.2",  groups: [development]}
+    - {name: bluecloth, version: "~> 2.1.0",  groups: [development]}
+    - {name: wlang,     version: "~> 0.10.2", groups: [development]}

data/spec/command/delegator/test_split_argv.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+module Quickl
+  module Command::Delegator
+    describe "InstanceMethods#split_argv" do
+      
+      let(:cmd){ Object.new.extend(InstanceMethods) }
+      subject{ cmd.send(:split_argv, argv) }
+      
+      describe "on an empty array" do
+        let(:argv){ [] }
+        it { should eql([[],[]]) }
+      end
+      
+      describe "on an array without options" do
+        let(:argv){ ["hello", "world"] }
+        it { should eql([[],["hello", "world"]]) }
+      end
+        
+      describe "on an array with one single double dashed options" do
+        let(:argv){ ["--verbose", "hello", "--world"] }
+        it { should eql([["--verbose"],["hello", "--world"]]) }
+      end
+        
+      describe "on an array with one single dashed options" do
+        let(:argv){ ["-Ilib", "hello", "--world"] }
+        it { should eql([["-Ilib"],["hello", "--world"]]) }
+      end
+        
+      describe "on an array with multiple options" do
+        let(:argv){ ["--verbose", "-Ilib", "hello", "--world"] }
+        it { should eql([["--verbose","-Ilib"],["hello", "--world"]]) }
+      end
+        
+      describe "in presence of an argument separator" do
+        let(:argv){ ["--verbose", "-Ilib", "--", "-b", "hello", "--world"] }
+        it { should eql([["--verbose","-Ilib"],["--", "-b", "hello", "--world"]]) }
+      end
+
+    end
+  end
+end

data/spec/command/{command_building_spec.rb → test_command_building.rb}

@@ -1,15 +1,15 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command building /" do
     
     it "should execute callback methods" do
-      MiniClient::Factored.run.should == :hello
+      MiniClient::Factored.run.should eq(:hello)
     end
     
     it "should install hierarchy correctly when command_parent= is used" do
-      MiniClient::Factored.super_command.should == MiniClient::Requester
+      MiniClient::Factored.super_command.should eq(MiniClient::Requester)
       MiniClient::Requester.subcommands.should include(MiniClient::Factored)
-      lambda{ MiniClient::Requester.new.has_command!("factored") }.should_not raise_error
+      lambda{ Quickl.sub_command!(MiniClient::Requester, "factored") }.should_not raise_error
     end
     
   end # Command::command_name

data/spec/command/{command_name_spec.rb → test_command_name.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command::command_name /" do
     
@@ -7,10 +7,5 @@ module Quickl
       MiniClient::Say::Goodbye.command_name.should == "goodbye"
     end
     
-    it "should be accessible on instance" do
-      MiniClient::Say::Hello.new.command_name.should == "hello"
-      MiniClient::Say::Goodbye.new.command_name.should == "goodbye"
-    end
-
   end # Command::command_name
 end # module Quickl

data/spec/command/{documentation_spec.rb → test_documentation.rb}

@@ -11,7 +11,7 @@ DESCRIPTION
 
 EOF
 
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command::documentation /" do
     

data/spec/command/{overview_spec.rb → test_overview.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command::overview /" do
     
@@ -6,9 +6,5 @@ module Quickl
       MiniClient::Help.overview.should == "Print help"
     end
 
-    it "should be installed accessible on instance" do
-      MiniClient::Help.new.overview.should == "Print help"
-    end
-
   end # Command::overview
 end # module Quickl

data/spec/command/test_parse_options.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+describe "Command#parse_options" do
+
+  let(:cmd){ MiniClient::Say::Args.new }
+  subject{ cmd.parse_options(argv, sep_support) }
+
+  describe "when no separator support" do
+    let(:sep_support){ :none }
+    
+    describe "on empty array" do
+      let(:argv){ [] }
+      it { should eq([]) }
+    end
+
+    describe "without any option nor separator" do
+      let(:argv){ ["hello", "world"] }
+      it { should eq(argv) }
+    end
+
+    describe "with disseminated options" do
+      let(:argv){ %w{-i hello --joption -k world} }
+      it { should eq(%w{hello world}) }
+    end
+
+    describe "with an option separator" do
+      let(:argv){ %w{-i hello -- --joption -k world} }
+      it { should eq(%w{hello --joption -k world}) }
+    end
+
+  end
+
+  describe "when separator support set to :keep" do
+    let(:sep_support){ :keep }
+    
+    describe "on empty array" do
+      let(:argv){ [] }
+      it { should eq([]) }
+    end
+
+    describe "without any option nor separator" do
+      let(:argv){ ["hello", "world"] }
+      it { should eq(argv) }
+    end
+
+    describe "with disseminated options" do
+      let(:argv){ %w{-i hello --joption -k world} }
+      it { should eq(%w{hello world}) }
+    end
+
+    describe "with an option separator" do
+      let(:argv){ %w{-i hello -- --joption -k world} }
+      it { should eq(%w{hello -- --joption -k world}) }
+    end
+
+    describe "with an option separator at first" do
+      let(:argv){ %w{-- -i hello -- --joption -k world} }
+      it { should eq(%w{-- -i hello -- --joption -k world}) }
+    end
+
+    describe "with an option separator at last" do
+      let(:argv){ %w{-i hello --joption -k world --} }
+      it { should eq(%w{hello world --}) }
+    end
+
+    describe "with multiple option separators" do
+      let(:argv){ %w{-i hello -- --joption -k -- world --} }
+      it { should eq(%w{hello -- --joption -k -- world --}) }
+    end
+
+  end
+
+  describe "when separator support set to :split" do
+    let(:sep_support){ :split }
+    
+    describe "on empty array" do
+      let(:argv){ [] }
+      it { should eq([[]]) }
+    end
+
+    describe "without any option nor separator" do
+      let(:argv){ ["hello", "world"] }
+      it { should eq([argv]) }
+    end
+
+    describe "with disseminated options" do
+      let(:argv){ %w{-i hello --joption -k world} }
+      it { should eq([%w{hello world}]) }
+    end
+
+    describe "with an option separator" do
+      let(:argv){ %w{-i hello -- --joption -k world} }
+      it { should eq([%w{hello},%w{--joption -k world}]) }
+    end
+
+    describe "with an option separator at first" do
+      let(:argv){ %w{-- -i hello -- --joption -k world} }
+      it { should eq([%w{}, %w{-i hello}, %w{--joption -k world}]) }
+    end
+
+    describe "with an option separator at last" do
+      let(:argv){ %w{-i hello --joption -k world --} }
+      it { should eq([%w{hello world},%w{}]) }
+    end
+
+    describe "with multiple option separators" do
+      let(:argv){ %w{-i hello -- --joption -k -- world --} }
+      it { should eq([%w{hello}, %w{--joption -k}, %w{world}, %w{}]) }
+    end
+
+  end
+
+end

data/spec/command/{requester_spec.rb → test_requester.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require 'spec_helper'
 module Quickl
   describe "Command::requester /" do
     

data/spec/command/test_run.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+module Quickl
+  describe "Command::run /" do
+    
+    specify "when invoked on a terminal command" do
+      MiniClient::Say::Hello.run.should eql(:hello)
+      MiniClient::Say::Goodbye.run.should eql(:goodbye)
+    end
+
+    specify "when invoked on a delegator command" do
+      MiniClient.run(["help"]).should eql(:help)
+      MiniClient::Say.run(["hello"]).should eql(:hello)
+      MiniClient::Say.run(["goodbye"]).should eql(:goodbye)
+    end
+
+    specify "when invoked on qualified command names" do
+      MiniClient.run(["say:hello"]).should eql(:hello)
+      MiniClient.run(["say:goodbye"]).should eql(:goodbye)
+    end
+    
+    specify "when --options are passed to a delegator command" do
+      mini = MiniClient.new
+      mini.run(%w{--verbose say:hello}).should eql(:hello)
+      mini.verbose.should be_true
+    end
+    
+    specify "when -option is passed to a delegator command" do
+      mini = MiniClient.new
+      mini.run(%w{-v say:hello}).should eql(:hello)
+      mini.verbose.should be_true
+    end
+    
+    specify "when --no-option is passed to a delegator command" do
+      mini = MiniClient.new
+      mini.run(%w{--no-verbose say:hello}).should eql(:hello)
+      mini.verbose.should be_false
+    end
+    
+  end # Command::command
+end # module Quickl