rubikon 0.5.3 → 0.6.0

data/lib/rubikon/parameter.rb

@@ -19,6 +19,10 @@ module Rubikon
     # @return [Array<Symbol>] The alias names of this parameter
     attr_reader :aliases
 
+    # @return [String] The description of this parameter
+    # @since 0.6.0
+    attr_accessor :description
+
     # @return [Symbol] The primary name of this parameter
     attr_reader :name
 

data/lib/rubikon/version.rb

@@ -0,0 +1,11 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+module Rubikon
+
+  # This is the current version of the Rubikon gem
+  VERSION = '0.6.0'
+
+end

data/samples/config/global/config.yml

@@ -0,0 +1,4 @@
+:boolean: false
+:global:  true
+:number:  1
+:string:  boring

data/samples/config/local/config.yml

@@ -0,0 +1,4 @@
+:boolean: true
+:local:   true
+:number:  2
+:string:  smart

data/samples/helloworld/hello_world.rb

@@ -3,7 +3,7 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2010, Sebastian Staudt
+# Copyright (c) 2010-2011, Sebastian Staudt
 
 if ENV['RUBIKON_DEV']
   require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib', 'rubikon')
@@ -16,20 +16,24 @@ end
 class HelloWorld < Rubikon::Application::Base
 
   # Greet the whole world per default
-  flag :more
-  option :name, [:who]
-  option :names, -1
+  flag :more, 'Display more information while greeting'
+  option :name, 'A single name to greet', :who
+  option :names, 'One or more names to greet', :who => :remainder
+  option :special, 'A special name', :who => ['Guybrush', /LeChuck/, :numeric]
   default 'Simple hello world' do
     debug 'Starting to greet the world...'
     if given? :name
-      greet parameters[:name].who
+      names = [who]
     elsif given? :names
-      names.args.each do |name|
-        greet name
-      end
+      names = who
+    elsif given? :special
+      names = [who]
     else
-      greet 'World'
+      names = %w{World}
     end
+
+    names.each { |name| greet name }
+
     puts 'Nice to see you.' if given? :more
   end
 
@@ -42,7 +46,7 @@ class HelloWorld < Rubikon::Application::Base
   end
 
   # Show a progress bar while iterating through a loop
-  flag :brackets
+  flag :brackets, 'Show brackets around the progress bar'
   command :progress, 'Display a progress bar' do
     put 'Watch my progress while I greet the world: '
     x = 1000000

data/test/config/0/config.yml

@@ -0,0 +1,2 @@
+:value:     0
+:overriden: 0

data/test/config/1/config.yml

@@ -0,0 +1,3 @@
+:value1:    1
+:overriden: 1
+

data/test/config/2/config.yml

@@ -0,0 +1,3 @@
+:value2:    2
+:overriden: 2
+

data/test/config/test.ini

@@ -0,0 +1,10 @@
+# This is a comment
+; and another one
+
+[section]
+  value = 0
+  test1 = 1
+
+[section]
+  value = 1 ; This is overriden
+  test2 = 2 # This is not

data/test/{test_helper.rb → helper.rb}

@@ -10,7 +10,3 @@ include Rubikon
 
 require 'rubygems'
 require 'shoulda'
-
-unless RUBY_VERSION[0..2] == '1.9'
-  begin require 'redgreen'; rescue LoadError; end
-end

data/test/test_application.rb

@@ -1,9 +1,9 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
-require 'test_helper'
+require 'helper'
 require 'testapps'
 
 class TestApplication < Test::Unit::TestCase
@@ -30,7 +30,9 @@ class TestApplication < Test::Unit::TestCase
 
     setup do
       @app = TestApp
+      @estream = StringIO.new
       @ostream = StringIO.new
+      @app.set :estream, @estream
       @app.set :ostream, @ostream
       @app.set :raise_errors, true
     end
@@ -48,8 +50,8 @@ class TestApplication < Test::Unit::TestCase
       else
         error_text = "Error:\n"
       end
-      assert_equal error_text, @ostream.gets
-      assert_equal "    Unknown command: unknown\n", @ostream.gets
+      assert_equal error_text, @estream.gets
+      assert_equal "    Unknown command: unknown\n", @estream.gets
     end
 
     should 'run its default command without arguments' do
@@ -72,11 +74,11 @@ class TestApplication < Test::Unit::TestCase
       @istream = StringIO.new
       @app.set :istream, @istream
 
-      input_string = 'test'
-      @istream.puts input_string
+      @istream.puts "test\ntest\nx\n"
       @istream.rewind
-      assert_equal input_string, @app.run(%w{input})
-      assert_equal 'input: ', @ostream.gets
+
+      assert_equal %w{test x}, @app.run(%w{input})
+      assert_equal 'input: validated [x]: Please provide valid input [x]: ', @ostream.gets
     end
 
     should 'not break output while displaying a throbber or progress bar' do
@@ -120,7 +122,7 @@ class TestApplication < Test::Unit::TestCase
 
     should 'have a working help command' do
       @app.run(%w{help})
-      assert_match /Usage: [^ ]* \[--debug\|-d\] \[--gflag\|--gf1\|--gf2\] \[--gopt\|--go1\|--go2 \.\.\.\] \[--verbose\|-v\] command \[args\]\n\nCommands:\n  arguments      \n  globalopt      \n  help           Display this help screen\n  input          \n  object_id      \n  parameters     \n  progressbar    \n  sandbox        \n  throbber       \n/, @ostream.string
+      assert_match /Usage: [^ ]* \[--debug\|-d\] \[--gflag\|--gf1\|--gf2\] \[--gopt\|--go1\|--go2 \.\.\.\] \[--verbose\|-v\] \[command\] \[args\]\n\nCommands:\n  arguments      \n  globalopt      \n  help           Show help for the application or a single command\n  input          \n  object_id      \n  parameters     \n  progressbar    \n  sandbox        \n  throbber       \n/, @ostream.string
     end
 
     should 'have a working DSL for command parameters' do
@@ -168,61 +170,61 @@ class TestApplication < Test::Unit::TestCase
     end
 
     should 'parse arguments correctly' do
-      cmd, global_params, args = @app.parse_arguments(%w{})
-      assert_instance_of Command, cmd
-      assert_equal cmd.name, :__default
+      global_params, cmd, cmd_params = @app.parse_arguments(%w{})
       assert_equal [], global_params
-      assert_equal [], args
-
-      cmd, global_params, args = @app.parse_arguments(%w{-d -v})
       assert_instance_of Command, cmd
       assert_equal cmd.name, :__default
+      assert_equal [], cmd_params
+
+      global_params, cmd, cmd_params = @app.parse_arguments(%w{-d -v})
       assert_instance_of Array, global_params
       assert_equal 2, global_params.size
       assert_instance_of Flag, global_params[0]
       assert_equal :debug, global_params[0].name
       assert_instance_of Flag, global_params[1]
       assert_equal :verbose, global_params[1].name
-      assert_equal [], args
-
-      cmd, global_params, args = @app.parse_arguments(%w{-dv})
       assert_instance_of Command, cmd
       assert_equal cmd.name, :__default
+      assert_equal [], cmd_params
+
+      global_params, cmd, cmd_params = @app.parse_arguments(%w{-dv})
       assert_instance_of Array, global_params
       assert_equal 2, global_params.size
       assert_instance_of Flag, global_params[0]
       assert_equal :debug, global_params[0].name
       assert_instance_of Flag, global_params[1]
       assert_equal :verbose, global_params[1].name
-      assert_equal [], args
-
-      cmd, global_params, args = @app.parse_arguments(%w{-x})
       assert_instance_of Command, cmd
       assert_equal cmd.name, :__default
-      assert_instance_of Array, global_params
-      assert_equal 0, global_params.size
-      assert_equal %w{-x}, args
+      assert_equal [], cmd_params
 
-      cmd, global_params, args = @app.parse_arguments(%w{-d -v object_id})
-      assert_instance_of Command, cmd
-      assert_equal cmd.name, :object_id
+      global_params, cmd, cmd_params = @app.parse_arguments(%w{-d -v object_id})
       assert_instance_of Array, global_params
       assert_equal 2, global_params.size
       assert_instance_of Flag, global_params[0]
       assert_equal :debug, global_params[0].name
       assert_instance_of Flag, global_params[1]
       assert_equal :verbose, global_params[1].name
-      assert_equal [], args
+      assert_instance_of Command, cmd
+      assert_equal cmd.name, :object_id
+      assert_equal [], cmd_params
 
-      cmd, global_params, args = @app.parse_arguments(%w{sandbox --gopt test puts})
+      global_params, cmd, cmd_params = @app.parse_arguments(%w{-d sandbox --gopt test puts})
+      assert_instance_of Array, global_params
+      assert_equal 2, global_params.size
+      assert_instance_of Flag, global_params[0]
+      assert_equal :debug, global_params[0].name
+      assert_instance_of Option, global_params[1]
+      assert_equal :gopt, global_params[1].name
+      assert_equal %w{test}, global_params[1].args
       assert_instance_of Command, cmd
       assert_equal cmd.name, :sandbox
-      assert_instance_of Array, global_params
-      assert_equal 1, global_params.size
-      assert_instance_of Option, global_params[0]
-      assert_equal :gopt, global_params[0].name
-      assert_equal %w{test}, global_params[0].args
-      assert_equal %w{puts}, args
+      assert_equal %w{puts}, cmd.args
+      assert_equal [], cmd_params
+
+      assert_raise UnknownParameterError do
+        @app.parse_arguments(%w{-x})
+      end
     end
 
   end

data/test/test_argument_vector.rb

@@ -0,0 +1,156 @@
+# This code is free software; you can redistribute it and/or modify it under the
+# terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'helper'
+require 'testapps'
+
+class TestArgumentVector < Test::Unit::TestCase
+
+  context 'An argument vector' do
+
+    setup do
+      @app = TestApp.instance
+      @argv = []
+      @argv.extend ArgumentVector
+    end
+
+    should 'expand arguments correctly' do
+      @argv.expand!
+      assert @argv.empty?
+
+      @argv.replace %w{command --param arg}
+      @argv.expand!
+      assert_equal %w{command --param arg}, @argv
+
+      @argv.replace %w{command -pq arg}
+      @argv.expand!
+      assert_equal %w{command -p -q arg}, @argv
+
+      @argv.replace %w{command -pp arg}
+      @argv.expand!
+      assert_equal %w{command -p arg}, @argv
+
+      @argv.replace %w{command --param=arg}
+      @argv.expand!
+      assert_equal %w{command --param arg}, @argv
+
+      @argv.replace %w{command -pq --param=arg}
+      @argv.expand!
+      assert_equal %w{command -p -q --param arg}, @argv
+    end
+
+    should 'select the command correctly' do
+      assert_equal [nil, 0], @argv.command!(TestAppWithoutDefault.instance.commands)
+      assert @argv.empty?
+
+      command, pos = @argv.command!(@app.commands)
+      assert_equal :__default, command.name
+      assert_equal 0, pos
+      assert @argv.empty?
+
+      @argv.replace %w{unknown}
+      assert_equal [nil, 0], @argv.command!(TestAppWithoutDefault.instance.commands)
+      assert_equal %w{unknown}, @argv
+
+      @argv.replace %w{input}
+      command, pos = @argv.command!(@app.commands)
+      assert_equal :input, command.name
+      assert_equal 0, pos
+      assert @argv.empty?
+
+      @argv.replace %w{--debug input}
+      command, pos = @argv.command!(@app.commands)
+      assert_equal :input, command.name
+      assert_equal 1, pos
+      assert_equal %w{--debug}, @argv
+
+      @argv.replace %w{--debug input input}
+      command, pos = @argv.command!(@app.commands)
+      assert_equal :input, command.name
+      assert_equal 1, pos
+      assert_equal %w{--debug input}, @argv
+
+      @argv.replace %w{--debug -- input}
+      command, pos = @argv.command!(@app.commands)
+      assert_equal :__default, command.name
+      assert_equal 0, pos
+      assert_equal %w{--debug input}, @argv
+    end
+
+    should 'parse parameters correctly' do
+      assert @argv.params!(@app.global_parameters).empty?
+      assert @argv.empty?
+
+      @argv.replace %w{--gopt}
+      params = @argv.params!(@app.global_parameters)
+      assert_equal 1, params.size
+      assert_equal :gopt, params.first.name
+      assert @argv.empty?
+
+      @argv.replace %w{dummy --gopt}
+      params = @argv.params!(@app.global_parameters, 1)
+      assert_equal 1, params.size
+      assert_equal :gopt, params.first.name
+      assert_equal %w{dummy}, @argv
+
+      @argv.replace %w{--gopt arg}
+      params = @argv.params!(@app.global_parameters)
+      assert_equal 1, params.size
+      assert_equal :gopt, params.first.name
+      assert_equal %w{arg}, params.first.args
+      assert @argv.empty?
+
+      @app.global_parameters[:gopt].send :reset
+
+      @argv.replace %w{--gopt arg --gflag}
+      params = @argv.params!(@app.global_parameters)
+      assert_equal 2, params.size
+      assert_equal :gopt, params.first.name
+      assert_equal %w{arg}, params.first.args
+      assert_equal :gflag, params.last.name
+      assert @argv.empty?
+    end
+
+    should 'parse arguments correctly' do
+      gopt = @app.global_parameters[:gopt]
+
+      @argv.scoped_args!(gopt)
+      assert gopt.args.empty?
+      assert @argv.empty?
+
+      @argv.replace %w{arg}
+      @argv.scoped_args!(gopt)
+      assert_equal %w{arg}, gopt.args
+      assert @argv.empty?
+
+      gopt.send :reset
+
+      @argv.replace %w{arg1 arg2}
+      @argv.scoped_args!(gopt)
+      assert_equal %w{arg1}, gopt.args
+      assert_equal %w{arg2}, @argv
+
+      gopt.send :reset
+
+      @argv.replace %w{--gflag arg}
+      @argv.scoped_args!(gopt)
+      assert gopt.args.empty?
+      assert_equal %w{--gflag arg}, @argv
+
+      gopt.send :reset
+
+      @argv.replace %w{--gflag arg}
+      @argv.scoped_args!(gopt, 1)
+      assert_equal %w{arg}, gopt.args
+      assert_equal %w{--gflag}, @argv
+    end
+
+    teardown do
+      @app.send :reset
+    end
+
+  end
+
+end

data/test/test_command.rb

@@ -1,7 +1,7 @@
 # This code is free software; you can redistribute it and/or modify it under
 # the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'test_parameter'
 
@@ -39,40 +39,6 @@ class TestCommand < Test::Unit::TestCase
       end
     end
 
-    should 'correctly parse given parameters' do
-      command = Command.new @app, :command, [:cmd_arg] do end
-      option = Option.new(@app, :test, [:opt_arg])
-      command.send(:add_param, option)
-      flag = Flag.new(@app, :t)
-      command.send(:add_param, flag)
-      command.send(:run, *%w{--test arg -t test})
-      assert option.active?
-      assert flag.active?
-      assert_equal %w{test}, command.arguments
-      assert_equal 'test', command[0]
-      assert_equal 'test', command.cmd_arg
-      assert_equal %w{arg}, command.parameters[:test].args
-      assert_equal 'arg', command.test[0]
-      assert_equal 'arg', command.test.opt_arg
-
-      assert_raise UnknownParameterError do
-        command.send(:run, *%w{--unknown})
-      end
-    end
-
-    should 'allow parameter aliases' do
-      command = Command.new @app, :command do end
-      command.send(:add_param, { :t => :test })
-      flag1 = Flag.new(@app, :test)
-      command.send(:add_param, flag1)
-      flag2 = Flag.new(@app, :test2)
-      command.send(:add_param, flag2)
-      command.send(:add_param, { :t2 => :test2 })
-      command.send(:run, *%w{-t --t2})
-      assert flag1.send(:active?)
-      assert flag2.send(:active?)
-    end
-
     should 'run the code supplied inside its block' do
       block_run = false
       command = Command.new @app, :command do