rubikon 0.3.0 → 0.4.0

data/test/{application_tests.rb → test_application.rb}

@@ -6,7 +6,7 @@
 require 'test_helper'
 require 'testapps'
 
-class ApplicationTests < Test::Unit::TestCase
+class TestApplication < Test::Unit::TestCase
 
   context 'A Rubikon application\'s class' do
 
@@ -32,6 +32,7 @@ class ApplicationTests < Test::Unit::TestCase
       @app = TestApp
       @ostream = StringIO.new
       @app.set :ostream, @ostream
+      @app.set :raise_errors, true
     end
 
     should 'exit gracefully' do
@@ -45,7 +46,6 @@ class ApplicationTests < Test::Unit::TestCase
       @ostream.rewind
       assert_equal "Error:\n", @ostream.gets
       assert_equal "    Unknown command: unknown\n", @ostream.gets
-      @app.set :raise_errors, true
     end
 
     should 'run its default command without arguments' do
@@ -76,9 +76,10 @@ class ApplicationTests < Test::Unit::TestCase
       assert_equal 'input: ', @ostream.gets
     end
 
-    should "not break output while displaying a throbber or progress bar" do
+    should 'not break output while displaying a throbber or progress bar' do
       @app.run(%w{throbber})
-      assert_equal " \b-\b\\\b|\b/\bdon't\nbreak\n", @ostream.string
+      assert_match (/ \x08(?:(?:-|\\|\/|\|)\x08){4,}don't\nbreak\n/), @ostream.string
+
       @ostream.rewind
 
       @app.run(%w{progressbar})
@@ -108,17 +109,54 @@ class ApplicationTests < Test::Unit::TestCase
       $VERBOSE = false
     end
 
+    should 'have working global parameters' do
+      assert_equal 'flag', @app.run(%w{globalopt --gflag})
+      assert_equal 'flag', @app.run(%w{globalopt --gf1})
+      assert_equal 'flag', @app.run(%w{globalopt --gf2})
+      assert_equal 'test', @app.run(%w{globalopt --gopt test})
+      assert_equal 'test', @app.run(%w{globalopt --go1 test})
+      assert_equal 'test', @app.run(%w{globalopt --go2 test})
+    end
+
     should 'have a working help command' do
       @app.run(%w{help})
-      assert_match /Usage: [^ ]* \[--debug\|-d\] \[--gopt\|--go \.\.\.\] \[--verbose\|-v\] command \[args\]\n\nCommands:\n  help           Display this help screen\n  input          \n  object_id      \n  parameters     \n  progressbar    \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           Display this help screen\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
       params = @app.run(%w{parameters}).values.uniq.sort { |a,b| a.name.to_s <=> b.name.to_s }
       assert_equal :flag, params[0].name
       assert_equal [:f], params[0].aliases
+      assert !params[0].active?
       assert_equal :option, params[1].name
       assert_equal [:o], params[1].aliases
+      assert !params[1].active?
+    end
+
+    should 'allow simplified access to arguments' do
+      result = @app.run(%w{arguments cmd_test --arg opt_test})
+      assert_equal %w{opt_test opt_test cmd_test}, result
+    end
+
+    should 'be protected by a sandbox' do
+      %w{init parse_arguments run}.each do |method|
+        assert_raise NoMethodError do
+          @app.run(['sandbox', method])
+        end
+      end
+    end
+
+    should 'know its file system location' do
+      dir = File.expand_path(File.dirname(__FILE__))
+      assert_equal dir + '/testapps.rb', @app.base_file
+      assert_equal dir, @app.path
+    end
+
+    should 'have working hooks' do
+      TestAppWithHooks.set :ostream, @ostream
+      TestAppWithHooks.run(%w{execute})
+
+      assert_equal "pre init\npost init\npre execute\nexecute\npost execute\n", @ostream.string
     end
 
   end

data/test/{command_tests.rb → test_command.rb}

@@ -3,27 +3,14 @@
 #
 # Copyright (c) 2009-2010, Sebastian Staudt
 
-require 'test_helper'
+require 'test_parameter'
 
-class DummyApp < Application::Base
+class TestCommand < Test::Unit::TestCase
 
-  set :autorun, false
-
-  attr_accessor :external_command_run
-
-end
-
-class CommandTests < Test::Unit::TestCase
+  include TestParameter
 
   context 'A Rubikon command' do
 
-    setup do
-      @app = DummyApp.instance
-      @app.instance_eval do
-        @path = File.dirname(__FILE__)
-      end
-    end
-
     should 'be a Parameter' do
       assert Command.included_modules.include?(Parameter)
       assert Command.new(@app, :command){}.is_a?(Parameter)
@@ -53,16 +40,20 @@ class CommandTests < Test::Unit::TestCase
     end
 
     should 'correctly parse given parameters' do
-      command = Command.new @app, :command do end
-      option = Option.new(:test, 1)
-      command << option
-      flag = Flag.new(:t)
-      command << flag
+      command = Command.new @app, :command, [:cmd_arg] do end
+      option = Option.new(@app, :test, [:opt_arg])
+      command.add_param option
+      flag = Flag.new(@app, :t)
+      command.add_param flag
       command.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.run(*%w{--unknown})
@@ -71,11 +62,12 @@ class CommandTests < Test::Unit::TestCase
 
     should 'allow parameter aliases' do
       command = Command.new @app, :command do end
-      flag1 = Flag.new(:test)
-      command << flag1
-      flag2 = Flag.new(:test2)
-      command << flag2
-      command << { :t => :test, :t2 => :test2 }
+      command.add_param({ :t => :test })
+      flag1 = Flag.new(@app, :test)
+      command.add_param flag1
+      flag2 = Flag.new(@app, :test2)
+      command.add_param flag2
+      command.add_param({ :t2 => :test2 })
       command.run(*%w{-t --t2})
       assert flag1.active?
       assert flag2.active?
@@ -91,10 +83,9 @@ class CommandTests < Test::Unit::TestCase
     end
 
     should 'run external code if no block is given' do
-      @app.external_command_run = false
       command = Command.new @app, :external_command
       command.run
-      assert @app.external_command_run
+      assert @app.sandbox.instance_variable_get(:@external_command_run)
     end
 
   end

data/test/{flag_tests.rb → test_flag.rb}

@@ -3,20 +3,22 @@
 #
 # Copyright (c) 2010, Sebastian Staudt
 
-require 'test_helper'
+require 'test_parameter'
 
-class FlagTests < Test::Unit::TestCase
+class TestFlag < Test::Unit::TestCase
+
+  include TestParameter
 
   context 'A Rubikon flag' do
 
     should 'be a Parameter' do
       assert Flag.included_modules.include?(Parameter)
-      assert Flag.new(:test).is_a?(Parameter)
+      assert Flag.new(@app, :test).is_a?(Parameter)
     end
 
     should 'call its code block if it is activated' do
       block_run = false
-      flag = Flag.new :flag do
+      flag = Flag.new @app, :flag do
         block_run = true
       end
       flag.active!
@@ -25,7 +27,7 @@ class FlagTests < Test::Unit::TestCase
     end
 
     should 'not allow any arguments' do
-      flag = Flag.new :test
+      flag = Flag.new @app, :test
       assert_raise ExtraArgumentError do
         flag << 'argument'
       end

data/test/test_has_arguments.rb

@@ -0,0 +1,99 @@
+# 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
+
+require 'test_helper'
+require 'test_parameter'
+
+class HasArg
+  include HasArguments
+
+  attr_reader :arg_names
+
+  def initialize(arg_count)
+     super(DummyApp.instance, 'dummy', arg_count)
+  end
+end
+
+class TestHasArguments < Test::Unit::TestCase
+
+  context 'A parameter with arguments' do
+
+    should 'allow a Numeric as argument count' do
+      @has_arg = HasArg.new(1)
+      assert_equal 1..1, @has_arg.arg_count
+      assert_nil @has_arg.arg_names
+    end
+
+    should 'allow a Range as argument count' do
+      @has_arg = HasArg.new(1..3)
+      assert_equal 1..3, @has_arg.arg_count
+      assert_nil @has_arg.arg_names
+    end
+
+    should 'allow an Array as argument count' do
+      @has_arg = HasArg.new([2, 5, 6])
+      assert_equal 2..6, @has_arg.arg_count
+      assert_nil @has_arg.arg_names
+    end
+
+    should 'allow a Symbol Array as argument names' do
+      @has_arg = HasArg.new([:arg1, :arg2, :arg3])
+      assert_equal 3..3, @has_arg.arg_count
+      assert_equal [:arg1, :arg2, :arg3], @has_arg.arg_names
+    end
+
+    should 'only have required arguments if argument count is > 0' do
+      @has_arg = HasArg.new(2)
+      assert !@has_arg.args_full?
+      assert @has_arg.more_args?
+      @has_arg << 'argument'
+      assert_equal %w{argument}, @has_arg.args
+      assert_raise MissingArgumentError do
+        @has_arg.check_args
+      end
+      @has_arg << 'argument'
+      assert @has_arg.args_full?
+      assert !@has_arg.more_args?
+      assert_equal %w{argument argument}, @has_arg.args
+      assert_raise ExtraArgumentError do
+        @has_arg << 'argument'
+      end
+      assert_equal %w{argument argument}, @has_arg.args
+    end
+
+    should 'have required and optional arguments if argument count is < 0' do
+      @has_arg = HasArg.new(-1)
+      assert !@has_arg.args_full?
+      assert @has_arg.more_args?
+      assert_raise MissingArgumentError do
+        @has_arg.check_args
+      end
+      @has_arg << 'argument'
+      assert @has_arg.args_full?
+      assert @has_arg.more_args?
+      assert_equal %w{argument}, @has_arg.args
+    end
+
+    should 'only have optional arguments if argument count is 0' do
+      @has_arg = HasArg.new(0)
+      assert @has_arg.args_full?
+      assert @has_arg.more_args?
+      @has_arg << 'argument'
+      assert_equal %w{argument}, @has_arg.args
+    end
+
+    should 'provide named arguments' do
+      @has_arg = HasArg.new([:named])
+      @has_arg << 'argument'
+      assert_equal 'argument', @has_arg[:named]
+      assert_equal 'argument', @has_arg.named
+      assert_raise NoMethodError do
+        @has_arg.not_named
+      end
+    end
+
+  end
+
+end

data/test/test_helper.rb

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

data/test/test_option.rb

@@ -0,0 +1,32 @@
+# 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
+
+require 'test_parameter'
+
+class TestOption < Test::Unit::TestCase
+
+  include TestParameter
+
+  context 'A Rubikon option' do
+
+    should 'be a Parameter with arguments' do
+      assert Option.included_modules.include?(Parameter)
+      assert Option.included_modules.include?(HasArguments)
+      assert Option.new(@app, :test).is_a?(Parameter)
+    end
+
+    should 'call its code block if it is activated' do
+      block_run = false
+      option = Option.new @app, :test do
+        block_run = true
+      end
+      option.active!
+      assert option.active?
+      assert block_run
+    end
+
+  end
+
+end

data/test/test_parameter.rb

@@ -0,0 +1,21 @@
+# 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
+
+require 'test_helper'
+require 'testapps'
+
+module TestParameter
+
+  def setup
+    @app = DummyApp.instance
+    sandbox = nil
+    @app.instance_eval do
+      @path = File.dirname(__FILE__)
+      sandbox = @sandbox
+    end
+    @sandbox = sandbox
+  end
+
+end

data/test/{progress_bar_tests.rb → test_progress_bar.rb}

@@ -5,7 +5,7 @@
 
 require 'test_helper'
 
-class ProgressBarTests < Test::Unit::TestCase
+class TestProgressBar < Test::Unit::TestCase
 
   context 'A progress bar' do
 

data/test/{throbber_tests.rb → test_throbber.rb}

@@ -5,7 +5,7 @@
 
 require 'test_helper'
 
-class ThrobberTests < Test::Unit::TestCase
+class TestThrobber < Test::Unit::TestCase
 
   context 'A throbber' do
 
@@ -14,13 +14,7 @@ class ThrobberTests < Test::Unit::TestCase
     end
 
     should 'have default throbber strings' do
-      unless RUBY_VERSION[0..2] == '1.9'
-        consts = %w{SPINNER}
-      else
-        consts = [:SPINNER, :MUTEX_FOR_THREAD_EXCLUSIVE]
-      end
-      assert_equal consts, Throbber.constants
-      assert_equal '-\|/', Throbber.const_get(:SPINNER)
+      assert_equal '-\|/', Throbber::SPINNER
     end
 
     should 'work correctly' do
@@ -35,7 +29,7 @@ class ThrobberTests < Test::Unit::TestCase
       thread.join
       throbber.join
 
-      spinner = Throbber.const_get(:SPINNER)
+      spinner = Throbber::SPINNER
       check_throbber = ' '
       ((finished_at - started_at) / 0.25).floor.times do |char_index|
         check_throbber << "\b"

data/test/testapps.rb

@@ -3,21 +3,46 @@
 #
 # Copyright (c) 2009-2010, Sebastian Staudt
 
+class DummyApp < Application::Base
+
+  set :autorun, false
+
+  attr_accessor :external_command_run
+
+end
+
 class TestApp < Application::Base
 
   set :autorun, false
   set :name, 'Rubikon test application'
   set :raise_errors, true
 
-  global_option :go => :gopt
+  global_flag :gf1 => :gflag
+  global_flag :gflag do
+    @global = 'flag'
+  end
+  global_flag :gf2 => :gflag
+
+  global_option :go1 => :gopt
   global_option :gopt, 1 do
     @global = args[0]
   end
+  global_option :go2 => :gopt
 
   default do
     'default command'
   end
 
+  option :arg, [:opt_arg] do
+    @result = []
+    @result << opt_arg
+  end
+  command :arguments, [:cmd_arg] do
+    @result << arg.opt_arg
+    @result << cmd_arg
+    @result
+  end
+
   command :input do
     input 'input'
   end
@@ -44,6 +69,14 @@ class TestApp < Application::Base
     end
   end
 
+  command :sandbox, 1 do
+    send(args[0].to_sym)
+  end
+
+  command :globalopt do
+    @global
+  end
+
   command :throbber do
     throbber do
       sleep 0.5
@@ -62,3 +95,29 @@ class TestAppWithoutDefault < Application::Base
   set :raise_errors, true
 
 end
+
+class TestAppWithHooks < Application::Base
+
+  set :autorun, false
+
+  pre_init do
+    puts 'pre init'
+  end
+
+  post_init do
+    puts 'post init'
+  end
+
+  pre_execute do
+    puts 'pre execute'
+  end
+
+  post_execute do
+    puts 'post execute'
+  end
+
+  command :execute do
+    puts 'execute'
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubikon
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sebastian Staudt
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-26 00:00:00 +02:00
+date: 2010-10-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,6 +46,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: A simple to use, yet powerful Ruby framework for building console-based applications.
 email: koraktor@gmail.com
 executables: []
@@ -59,28 +73,34 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/core_ext/object.rb
 - lib/core_ext/string.rb
 - lib/rubikon.rb
 - lib/rubikon/application/base.rb
 - lib/rubikon/application/class_methods.rb
 - lib/rubikon/application/dsl_methods.rb
 - lib/rubikon/application/instance_methods.rb
+- lib/rubikon/application/sandbox.rb
 - lib/rubikon/command.rb
 - lib/rubikon/exceptions.rb
 - lib/rubikon/flag.rb
+- lib/rubikon/has_arguments.rb
 - lib/rubikon/option.rb
 - lib/rubikon/parameter.rb
 - lib/rubikon/progress_bar.rb
 - lib/rubikon/throbber.rb
-- test/application_tests.rb
-- test/command_tests.rb
+- samples/helloworld/hello_world.rb
 - test/commands/external_command.rb
-- test/flag_tests.rb
-- test/option_tests.rb
-- test/progress_bar_tests.rb
+- test/test_application.rb
+- test/test_command.rb
+- test/test_flag.rb
+- test/test_has_arguments.rb
 - test/test_helper.rb
+- test/test_option.rb
+- test/test_parameter.rb
+- test/test_progress_bar.rb
+- test/test_throbber.rb
 - test/testapps.rb
-- test/throbber_tests.rb
 has_rdoc: false
 homepage: http://koraktor.github.com/rubikon
 licenses: []
@@ -116,12 +136,14 @@ signing_key:
 specification_version: 3
 summary: Rubikon - A Ruby console app framework
 test_files: 
-- test/application_tests.rb
-- test/command_tests.rb
 - test/commands/external_command.rb
-- test/flag_tests.rb
-- test/option_tests.rb
-- test/progress_bar_tests.rb
+- test/test_application.rb
+- test/test_command.rb
+- test/test_flag.rb
+- test/test_has_arguments.rb
 - test/test_helper.rb
+- test/test_option.rb
+- test/test_parameter.rb
+- test/test_progress_bar.rb
+- test/test_throbber.rb
 - test/testapps.rb
-- test/throbber_tests.rb