baretest 0.2.4 → 0.4.0.pre1

data/lib/command/directorynotfounderror.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  class DirectoryNotFoundError < NoDirectoryError; end
+end

data/lib/command/env.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  Env = Struct.new(:name, :variable)
+end

data/lib/command/filenotfounderror.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  class FileNotFoundError < NoFileError; end
+end

data/lib/command/kernel.rb

@@ -0,0 +1,14 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Kernel
+private
+  def Command(*args, &block)
+    $command = Command.define(nil, *args, &block)
+  end
+end

data/lib/command/nodirectoryerror.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  class NoDirectoryError < ArgumentError; end
+end

data/lib/command/nofileerror.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  class NoFileError < ArgumentError; end
+end

data/lib/command/option.rb

@@ -0,0 +1,16 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  Option = Struct.new(:name, :short, :long, :negated, :necessity, :type, :declaration, :description) do
+    def process!(argument)
+      argument = Command::Types[type][argument] if type
+      argument
+    end
+  end
+end

data/lib/command/parser.rb

@@ -0,0 +1,145 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  class Parser
+    attr_reader :definition
+    attr_reader :command
+    attr_reader :options
+    attr_reader :argv
+
+    def initialize(definition, argv)
+      @definition = definition
+      @argv       = argv
+      @affix      = [] # arguments after '--'
+      if i = argv.index('--')
+        @affix     = argv[(i+1)..-1]
+        @arguments = argv.first(i)
+      else
+        @arguments = @argv.dup
+      end
+      @options    = {}
+    end
+
+    def argument(name)
+      position = @definition.argument_position[name]
+      raise ArgumentError, "No argument #{name.inspect} available" unless position
+      arguments[position]
+    end
+
+    def option(name)
+      @options[name]
+    end
+
+    def arguments
+      @arguments+@affix
+    end
+
+    def command!
+      if @definition.commands_by_name.include?(@arguments.first)
+        @command = @arguments.shift
+      else
+        @command = @definition.default_command
+      end
+
+      @command
+    end
+
+    def normalize_arguments!
+      options    = @definition[@command].options_by_flag
+      parse_argv = @arguments
+      @arguments = []
+      while arg = parse_argv.shift
+        if arg =~ /\A-([^-]{2,})/ then
+          flags  = $1
+          until flags.empty?
+            flag = flags.slice!(0,1)
+            if opt  = options["-#{flag}"] then
+              case opt.necessity
+                when :required
+                  @arguments << "-#{flag}"
+                  @arguments << flags unless flags.empty?
+                  flags = ""
+                when :optional
+                  raise "Invalid option - can't merge short options with optional arguments"
+                when :none
+                  @arguments << "-#{flag}"
+                else
+                  raise "Unknown necessity #{opt.necessity.inspect} for option #{opt}"
+              end
+            else
+              @arguments << "-#{flag}#{flags}"
+            end
+          end
+        else
+          @arguments << arg
+        end
+      end
+    end
+
+    def options!(*flags)
+      ignore_invalid_options = flags.delete(:ignore_invalid_options)
+      options                = @definition[@command].options_by_flag # options available to this command
+      env                    = @definition[@command].env_by_variable # options available to this command
+      defaults               = @definition[@command].default_options # options available to this command
+
+      normalize_arguments!
+
+      parse_argv             = @arguments
+      @arguments             = []
+
+      defaults.each do |key, default|
+        @options[key] = default unless @options.has_key?(key)
+      end
+
+      env.each do |key, definition|
+        if ENV.has_key?(key) && !@options.has_key?(key) then
+          mapped = options[definition.name]
+          value  = mapped.process!(ENV[key])
+          @options[key] = value
+        end
+      end
+
+      while arg = parse_argv.shift
+        if option = options[arg] then
+          case option.necessity
+            when :required
+              value = option.process!(parse_argv.shift)
+            when :optional
+              if parse_argv.first && parse_argv.first !~ /\A-/ then
+                value = option.process!(parse_argv.shift)
+              else
+                value = true
+              end
+            when :none
+              value = true
+          end
+          @options[option.name] = (arg == option.negated) ? !value : value
+        elsif arg =~ /\A-/ then
+          raise "Invalid option #{arg}" unless ignore_invalid_options
+          @arguments << arg
+        else
+          @arguments << arg
+        end
+      end
+
+      @options
+    end
+
+    def result
+      Result.new(@command, @options, @arguments+@affix)
+    end
+
+    def parse(*flags)
+      command!
+      options!(*flags)
+
+      result
+    end
+  end
+end

data/lib/command/result.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  Result = Struct.new(:command, :options, :arguments)
+end

data/lib/command/types.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+  Types = {
+    :Virtual   => nil,
+    :Boolean   => proc { |v| v =~ /\A(?:true|y(?:es)?)\z/i },
+    :String    => proc { |v| v },
+    :Integer   => proc { |v| Integer(v) },
+    :Octal     => proc { |v| Intever("0#{v}") },
+    :Hex       => proc { |v| Integer("0x#{v}") },
+    :Float     => proc { |v| Float(v) },
+    :File      => proc { |v|
+      raise FileNotFoundError, "No such file or directory - #{v}" unless File.exist?(v)
+      raise NoFileError, "Not a file - #{v}" unless File.file?(v)
+      v
+    },
+    :Directory => proc { |v|
+      raise DirectoryNotFoundError, "No such file or directory - #{v}" unless File.exist?(v)
+      raise NoDirectoryError, "Not a directory - #{v}" unless File.directory?(v)
+      v
+    },
+    :Path => proc { |v|
+      require 'pathname'
+      Pathname.new(v)
+    }
+  }
+end

data/lib/command/version.rb

@@ -0,0 +1,28 @@
+#--
+# Copyright 2010 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+module Command
+
+  # The version of the 'command' library
+  module VERSION
+
+    # The major version number
+    MAJOR = 0
+
+    # The minor version number
+    MINOR = 0
+
+    # The tiny version number
+    TINY  = 1
+
+    # The version as a string
+    def self.to_s
+      "#{MAJOR}.#{MINOR||0}.#{TINY||0}"
+    end
+  end
+end

data/test/setup.rb

@@ -1,2 +1,5 @@
+BareTest.require_baretest "0.4"
+BareTest.require_ruby     "1.8.6"
+
 $LOAD_PATH.unshift(File.expand_path("#{__FILE__}/../../lib"))
 require 'baretest'

data/test/suite/lib/baretest.rb

@@ -33,26 +33,6 @@ BareTest.suite "BareTest" do
 
       equal(suites_before+1, suites_after)
     end
-
-    assert "Should be used by BareTest::run_if_mainfile" do
-      test = ::BareTest.clone # avoid interfering with the current run
-      test.init
-      suites_before = test.toplevel_suite.suites.size
-      test.run_if_mainfile "A new suite" do end
-      suites_after = test.toplevel_suite.suites.size
-
-      equal(suites_before+1, suites_after)
-    end
-
-    assert "Should be run by BareTest::run" do
-      this = self # needed because touch is called in the block of another assertion, so otherwise it'd be local to that assertion
-      test = ::BareTest.clone # avoid interfering with the current run
-      test.init
-      test.suite "A new suite" do assert do this.touch(:assertion_executed) end end
-      test.run
-
-      touched(:assertion_executed)
-    end
   end
 
   suite "::suite" do
@@ -66,162 +46,4 @@ BareTest.suite "BareTest" do
       equal(suites_before+1, suites_after)
     end
   end
-
-  suite "::run_if_mainfile", :requires => ['rbconfig', 'shellwords'] do
-    setup do
-      ENV['FORMAT'] = 'minimal'
-      @ruby      = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
-      @test_path = Shellwords.escape(File.expand_path("#{__FILE__}/../../../external/bootstraptest.rb"))
-      @wrap_path = Shellwords.escape(File.expand_path("#{__FILE__}/../../../external/bootstrapwrap.rb"))
-      @inc_path  = Shellwords.escape(File.dirname(BareTest.required_file))
-    end
-
-    suite "File is the program" do
-      assert "Should run the suite" do
-        IO.popen("#{@ruby} -I#{@inc_path} -rbaretest #{@test_path}") { |sio|
-          sio.read
-        } =~ /\ATests:    1\nSuccess:  1\nPending:  0\nFailures: 0\nErrors:   0\nTime:     [^\n]+\nStatus:   success\n\z/
-      end
-    end
-
-    suite "File is not the program" do
-      assert "Should not run the suite if the file is not the program" do
-        IO.popen("#{@ruby} -I#{@inc_path} -rbaretest #{@wrap_path}") { |sio|
-          sio.read
-        } =~ /\ADone\n\z/
-      end
-    end
-  end
-
-  suite "::run" do
-    assert "Should run BareTest's toplevel suite" do
-      this = self # needed because touch is called in the block of another assertion, so otherwise it'd be local to that assertion
-      test = ::BareTest.clone # avoid interfering with the current run
-      test.init
-      test.suite "A new suite" do assert do this.touch(:assertion_executed) end end
-      test.run
-
-      touched(:assertion_executed)
-    end
-  end
-
-  suite "Skipped" do
-    suite "Suite" do
-      setup do
-        parent = ::BareTest::Suite.new
-        parent.setup do end
-        parent.teardown do end
-        @suite = ::BareTest::Skipped::Suite.new("None", parent)
-        @suite.setup do end
-        @suite.teardown do end
-      end
-
-      suite "#ancestry_setup" do
-        assert "Should always be an empty array." do
-          equal([], @suite.ancestry_setup)
-        end
-      end
-
-      suite "#setup" do
-        assert "Should always be an empty array." do
-          equal([], @suite.setup)
-        end
-      end
-
-      suite "#ancestry_teardown" do
-        assert "Should always be an empty array." do
-          equal([], @suite.ancestry_teardown)
-        end
-      end
-
-      suite "#teardown" do
-        assert "Should always be an empty array." do
-          equal([], @suite.teardown)
-        end
-      end
-
-      suite "#assert" do
-        assert "Should add new skipped assertions to a suite." do
-          equal(
-            :expected => 0,
-            :actual   => @suite.assertions.size,
-            :message  => "number of defined tests before adding any"
-          )
-
-          @suite.assert "a"
-          equal(
-            :expected => 1,
-            :actual   => @suite.skipped.size,
-            :message  => "number of defined tests after adding one"
-          )
-
-          @suite.assert "b"
-          equal(
-            :expected => 2,
-            :actual   => @suite.skipped.size,
-            :message  => "number of defined tests after adding two"
-          )
-
-          equal_unordered(
-            :expected => ['a', 'b'],
-            :actual   => @suite.skipped.map { |child| child.description },
-            :message  => "the descriptions"
-          )
-
-          @suite.skipped.all? { |test| kind_of(::BareTest::Skipped::Assertion, test) }
-        end
-
-        assert "Added tests should have the receiving suite as suite." do
-          @suite.assert "a"
-          assertion = @suite.skipped.first
-
-          same(
-            :expected => @suite,
-            :actual   => assertion.suite,
-            :message  => "the suite"
-          )
-        end
-      end
-    end
-
-    suite "Assertion" do
-      suite "#execute" do
-        suite "Given a test that succeeds" do
-          assert "Should have status :skipped" do
-            assertion = ::BareTest::Skipped::Assertion.new(nil, "") do true end
-            assertion.execute
-
-            equal(:skipped, assertion.status)
-          end
-        end
-
-        suite "Given a test that is pending" do
-          assert "Should have status :skipped" do
-            assertion = ::BareTest::Skipped::Assertion.new(nil, "")
-            assertion.execute
-
-            equal(:skipped, assertion.status)
-          end
-        end
-
-        suite "Given a test that fails" do
-          assert "Should have status :skipped" do
-            assertion = ::BareTest::Skipped::Assertion.new(nil, "") do false end
-            assertion.execute
-
-            equal(:skipped, assertion.status)
-          end
-        end
-
-        suite "Given a test that errors" do
-          assert "Should have status :skipped" do
-            assertion = ::BareTest::Skipped::Assertion.new(nil, "") do raise end
-            assertion.execute
-
-            equal(:skipped, assertion.status)
-          end
-        end
-      end
-    end
-  end
 end