rubikon 0.2.1 → 0.3.0

data/test/command_tests.rb

@@ -0,0 +1,102 @@
+# 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
+
+require 'test_helper'
+
+class DummyApp < Application::Base
+
+  set :autorun, false
+
+  attr_accessor :external_command_run
+
+end
+
+class CommandTests < Test::Unit::TestCase
+
+  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)
+    end
+
+    should 'raise an exception when no appliation is given' do
+      assert_raise ArgumentError do
+        Command.new nil, :command
+      end
+    end
+
+    should 'raise an exception when no code block is given' do
+      assert_raise BlockMissingError do
+        Command.new @app, :command
+      end
+    end
+
+    should 'not raise an exception when created with correct options' do
+      description = 'This is a command'
+      name        = :command
+      assert_nothing_raised do
+        command = Command.new @app, name do end
+        command.description = description
+        assert_equal name, command.name
+        assert_equal description, command.description
+      end
+    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.run(*%w{--test arg -t test})
+      assert option.active?
+      assert flag.active?
+      assert_equal %w{test}, command.arguments
+      assert_equal %w{arg}, command.parameters[:test].args
+
+      assert_raise UnknownParameterError do
+        command.run(*%w{--unknown})
+      end
+    end
+
+    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.run(*%w{-t --t2})
+      assert flag1.active?
+      assert flag2.active?
+    end
+
+    should 'run the code supplied inside its block' do
+      block_run = false
+      command = Command.new @app, :command do
+        block_run = true
+      end
+      command.run
+      assert block_run
+    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
+    end
+
+  end
+
+end

data/test/commands/external_command.rb

@@ -0,0 +1 @@
+@external_command_run = true

data/test/flag_tests.rb

@@ -0,0 +1,40 @@
+# 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'
+
+class FlagTests < Test::Unit::TestCase
+
+  context 'A Rubikon flag' do
+
+    should 'be a Parameter' do
+      assert Flag.included_modules.include?(Parameter)
+      assert Flag.new(:test).is_a?(Parameter)
+    end
+
+    should 'call its code block if it is activated' do
+      block_run = false
+      flag = Flag.new :flag do
+        block_run = true
+      end
+      flag.active!
+      assert flag.active?
+      assert block_run
+    end
+
+    should 'not allow any arguments' do
+      flag = Flag.new :test
+      assert_raise ExtraArgumentError do
+        flag << 'argument'
+      end
+
+      assert flag.args_full?
+      assert !flag.more_args?
+      assert !flag.respond_to?(:args)
+    end
+
+  end
+
+end

data/test/option_tests.rb

@@ -0,0 +1,75 @@
+# 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'
+
+class FlagTests < Test::Unit::TestCase
+
+  context 'A Rubikon option' do
+
+    should 'be a Parameter' do
+      assert Option.included_modules.include?(Parameter)
+      assert Option.new(:test).is_a?(Parameter)
+    end
+
+    should 'call its code block if it is activated' do
+      block_run = false
+      option = Option.new :test do
+        block_run = true
+      end
+      option.active!
+      assert option.active?
+      assert block_run
+    end
+
+    should 'have arguments' do
+      option = Option.new :test
+      assert option.respond_to?(:arg_count)
+      assert option.respond_to?(:args)
+    end
+
+    should 'only have required arguments if argument count is > 0' do
+      option = Option.new :test, 2
+      assert !option.args_full?
+      assert option.more_args?
+      option << 'argument'
+      assert_equal %w{argument}, option.args
+      assert_raise MissingArgumentError do
+        option.check_args
+      end
+      option << 'argument'
+      assert option.args_full?
+      assert !option.more_args?
+      assert_equal %w{argument argument}, option.args
+      assert_raise ExtraArgumentError do
+        option << 'argument'
+      end
+      assert_equal %w{argument argument}, option.args
+    end
+
+    should 'have required and optional arguments if argument count is < 0' do
+      option = Option.new :test, -1
+      assert !option.args_full?
+      assert option.more_args?
+      assert_raise MissingArgumentError do
+        option.check_args
+      end
+      option << 'argument'
+      assert option.args_full?
+      assert option.more_args?
+      assert_equal %w{argument}, option.args
+    end
+
+    should 'only have optional arguments if argument count is 0' do
+      option = Option.new :test, 0
+      assert option.args_full?
+      assert option.more_args?
+      option << 'argument'
+      assert_equal %w{argument}, option.args
+    end
+
+  end
+
+end

data/test/progress_bar_tests.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.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009, Sebastian Staudt
+# Copyright (c) 2009-2010, Sebastian Staudt
 
 require 'test_helper'
 
@@ -19,6 +19,16 @@ class ProgressBarTests < Test::Unit::TestCase
       assert_equal 0,       @bar.instance_variable_get(:@value)
     end
 
+    should 'have an easily changeable maximum' do
+      @bar = ProgressBar.new(10)
+      assert_equal 2,     @bar.instance_variable_get(:@factor)
+      assert_equal 10,     @bar.instance_variable_get(:@maximum)
+      assert_equal $stdout, @bar.instance_variable_get(:@ostream)
+      assert_equal 0,       @bar.instance_variable_get(:@progress)
+      assert_equal '#',     @bar.instance_variable_get(:@progress_char)
+      assert_equal 0,       @bar.instance_variable_get(:@value)
+    end
+
     should 'be customizable' do
       options = {
         :char    => '+',

data/test/test_helper.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.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009, Sebastian Staudt
+# Copyright (c) 2009-2010, Sebastian Staudt
 
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 $: << File.dirname(__FILE__)

data/test/testapps.rb

@@ -0,0 +1,64 @@
+# 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
+
+class TestApp < Application::Base
+
+  set :autorun, false
+  set :name, 'Rubikon test application'
+  set :raise_errors, true
+
+  global_option :go => :gopt
+  global_option :gopt, 1 do
+    @global = args[0]
+  end
+
+  default do
+    'default command'
+  end
+
+  command :input do
+    input 'input'
+  end
+
+  command :alias_before => :object_id
+
+  command :object_id do
+    object_id
+  end
+
+  command :alias_after => :object_id
+
+  flag :flag
+  flag :f => :flag
+  option :option, 1
+  option :o => :option
+  command :parameters do
+    parameters
+  end
+
+  command :progressbar do
+    progress_bar(:maximum => 4) do |progress|
+      4.times { progress.+; puts 'test' }
+    end
+  end
+
+  command :throbber do
+    throbber do
+      sleep 0.5
+      puts 'don\'t'
+      sleep 0.5
+      puts 'break'
+    end
+  end
+
+end
+
+class TestAppWithoutDefault < Application::Base
+
+  set :autorun, false
+  set :help_as_default, false
+  set :raise_errors, true
+
+end

data/test/throbber_tests.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.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009, Sebastian Staudt
+# Copyright (c) 2009-2010, Sebastian Staudt
 
 require 'test_helper'
 
@@ -23,6 +23,28 @@ class ThrobberTests < Test::Unit::TestCase
       assert_equal '-\|/', Throbber.const_get(:SPINNER)
     end
 
+    should 'work correctly' do
+      ostream = StringIO.new
+      started_at  = Time.now
+      finished_at = nil
+      thread = Thread.new do
+        sleep 1
+        finished_at = Time.now
+      end
+      throbber = Throbber.new(ostream, thread)
+      thread.join
+      throbber.join
+
+      spinner = Throbber.const_get(:SPINNER)
+      check_throbber = ' '
+      ((finished_at - started_at) / 0.25).floor.times do |char_index|
+        check_throbber << "\b"
+        check_throbber << spinner[char_index % 4]
+      end
+      check_throbber << "\b"
+      assert_equal check_throbber, ostream.string
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubikon
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sebastian Staudt
@@ -9,10 +15,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-09 00:00:00 +01:00
+date: 2010-09-26 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: A simple to use, yet powerful Ruby framework for building console-based applications.
 email: koraktor@gmail.com
 executables: []
@@ -26,57 +59,69 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- VERSION.yml
+- lib/core_ext/string.rb
 - lib/rubikon.rb
-- lib/rubikon/action.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/command.rb
 - lib/rubikon/exceptions.rb
+- lib/rubikon/flag.rb
+- lib/rubikon/option.rb
+- lib/rubikon/parameter.rb
 - lib/rubikon/progress_bar.rb
 - lib/rubikon/throbber.rb
-- test/action_tests.rb
 - 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_helper.rb
-- test/testapp.rb
+- test/testapps.rb
 - test/throbber_tests.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://koraktor.github.com/rubikon
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --all
-- --inline-source
-- --line-numbers
-- --charset=utf-8
-- --webcvs=http://github.com/koraktor/rubikon/blob/master/%s
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rubikon
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rubikon - A Ruby console app framework
 test_files: 
-- test/action_tests.rb
 - 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/testapp.rb
 - test/test_helper.rb
+- test/testapps.rb
 - test/throbber_tests.rb

data/VERSION.yml

@@ -1,4 +0,0 @@
----
-:major: 0
-:minor: 2
-:patch: 1

data/lib/rubikon/action.rb

@@ -1,74 +0,0 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
-#
-# Copyright (c) 2009, Sebastian Staudt
-
-module Rubikon
-
-  # Instances of the Action class are used to define the real code that should
-  # be executed when running the application.
-  class Action
-
-    attr_reader :block, :description, :name, :param_type
-
-    # Create a new Action using the given name, options and code block.
-    #
-    # +name+::    The name of this Action, used in Application options
-    # +options+:: A Hash of options that define more details about the Action
-    # +block+::   The code block which should be executed by this Action
-    #
-    # Options:
-    # +description+:: A description of the action. This isn't used at the
-    #                 moment.
-    # +param_type+::  A single Class or a Array of classes that represent the
-    #                 type(s) of argument(s) this action expects
-    def initialize(options = {}, &block)
-      raise BlockMissingError unless block_given?
-
-      @description = options[:description] || ''
-      @param_type = options[:param_type] || Object
-
-      @block = block
-      @arg_count = block.arity
-    end
-
-    # Run this action's code block
-    #
-    # +args+:: The argument which should be relayed to the block of this Action
-    def run(*args)
-      raise MissingArgumentError unless check_argument_count(args.size)
-      raise Rubikon::ArgumentTypeError unless check_argument_types(args)
-      @block[*args]
-    end
-
-    private
-
-    # Checks if the number of arguments given fits the number of arguments of
-    # this Action
-    #
-    # +count+:: The number of arguments
-    def check_argument_count(count)
-      !((@arg_count >= 0 && count < @arg_count) || (@arg_count < 0 && count < -@arg_count - 1))
-    end
-
-    # Checks the types of the given arguments using the Class or Array of
-    # classes given in the +:param_type+ option of this action.
-    #
-    # +args+:: The arguments which should be checked
-    def check_argument_types(args)
-      if @param_type.is_a? Array
-        args.each_index do |arg_index|
-          return false unless args[arg_index].is_a? @param_type[arg_index]
-        end
-      else
-        args.each do |arg|
-          return false unless arg.is_a? @param_type
-        end
-      end
-
-      true
-    end
-
-  end
-
-end

data/test/action_tests.rb

@@ -1,36 +0,0 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
-#
-# Copyright (c) 2009, Sebastian Staudt
-
-require 'test_helper'
-
-class ActionTests < Test::Unit::TestCase
-
-  context 'A Rubikon action' do
-
-    should 'throw an exception when no code block is given' do
-      assert_raise BlockMissingError do
-        Action.new
-      end
-      assert_raise BlockMissingError do
-        options = {}
-        Action.new options
-      end
-    end
-
-    should 'not raise an exception when created without options' do
-      action_options = {
-        :description => 'this is an action',
-        :param_type  => String
-      }
-      assert_nothing_raised do
-        action = Action.new action_options do end
-        assert_equal action_options[:description], action.description
-        assert_equal action_options[:param_type], action.param_type
-      end
-    end
-
-  end
-
-end

data/test/testapp.rb

@@ -1,64 +0,0 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
-#
-# Copyright (c) 2009, Sebastian Staudt
-
-class RubikonTestApp < Application::Base
-
-  set :autorun, false
-  set :name, 'Rubikon test application'
-  set :raise_errors, true
-
-  default do
-    'default action'
-  end
-
-  action 'input' do
-    input 'input'
-  end
-
-  action_alias :alias_before, :object_id
-
-  action 'object_id' do
-    object_id
-  end
-
-  action_alias :alias_after, :object_id
-
-  action 'noarg' do
-    'noarg action'
-  end
-
-  action 'realnoarg' do ||
-  end
-
-  action 'noarg2' do
-  end
-
-  action 'number_string', :param_type => [Numeric, String] do |s,n|
-  end
-
-  action 'output', :param_type => String do |s|
-    puts s
-    put s
-    putc s[0]
-  end
-
-  action 'required' do |what|
-    "required argument was #{what}"
-  end
-
-  action 'throbber' do |*output|
-    throbber do
-      if output[0]
-        sleep 0.5
-        puts 'don\'t'
-        sleep 0.5
-        puts 'break'
-      else
-        sleep 1
-      end
-    end
-  end
-
-end