baretest 0.2.4 → 0.4.0.pre1

data/LICENSE.txt

@@ -11,14 +11,14 @@ below (also known as the 'Ruby License'):
 
        a) place your modifications in the Public Domain or otherwise
           make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
 
        b) use the modified software only within your corporation or
           organization.
 
        c) rename any non-standard executables so the names do not conflict
-	  with standard executables, which must also be provided.
+          with standard executables, which must also be provided.
 
        d) make other distribution arrangements with the author.
 
@@ -26,11 +26,11 @@ below (also known as the 'Ruby License'):
      form, provided that you do at least ONE of the following:
 
        a) distribute the executables and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
 
        b) accompany the distribution with the machine-readable source of
-	  the software.
+          the software.
 
        c) give non-standard executables non-standard names, with
           instructions on where to get the original software distribution.

data/MANIFEST.txt

@@ -4,49 +4,71 @@ README.rdoc
 bin/baretest
 doc/baretest.rdoc
 doc/mocking_stubbing_test_doubles.rdoc
+doc/news/news-0.3.0.rdoc
 doc/quickref.rdoc
 doc/whats_going_on.rdoc
 doc/writing_tests.rdoc
-examples/test.rake
-examples/tests/irb_mode/failures.rb
-examples/tests/mock_developer/test/helper/mocks.rb
-examples/tests/mock_developer/test/setup.rb
-examples/tests/mock_developer/test/suite/mock_demo.rb
-examples/tests/overview/test.rb
-examples/tests/variations/variations_01.rb
-examples/tests/variations/variations_02.rb
-examples/tests/variations/variations_03.rb
+examples/components/rack-test.rb
+examples/irb_mode/failures.rb
+examples/rake/test.rake
+examples/tests/01_basics_I.rb
+examples/tests/02_basics_II_helpers.rb
+examples/tests/03_basics_III_setup_and_teardown.rb
+examples/tests/04_advanced_I_dependencies.rb
+examples/tests/05_advanced_II_tags.rb
+examples/tests/06_advanced_III_requires.rb
+examples/tests/07_advanced_IV_components.rb
+examples/tests/08_expert_I_setup_variants.rb
 lib/baretest.rb
 lib/baretest/assertion.rb
 lib/baretest/assertion/context.rb
 lib/baretest/assertion/failure.rb
 lib/baretest/assertion/skip.rb
 lib/baretest/assertion/support.rb
+lib/baretest/commandline.rb
+lib/baretest/formatter.rb
+lib/baretest/invalidselectors.rb
 lib/baretest/irb_mode.rb
 lib/baretest/layout.rb
-lib/baretest/mocha.rb
-lib/baretest/rr.rb
+lib/baretest/persistence.rb
 lib/baretest/run.rb
 lib/baretest/run/cli.rb
-lib/baretest/run/errors.rb
 lib/baretest/run/minimal.rb
+lib/baretest/run/none.rb
 lib/baretest/run/profile.rb
 lib/baretest/run/spec.rb
 lib/baretest/run/tap.rb
 lib/baretest/run/xml.rb
 lib/baretest/setup.rb
-lib/baretest/skipped.rb
-lib/baretest/skipped/assertion.rb
-lib/baretest/skipped/suite.rb
+lib/baretest/status.rb
 lib/baretest/suite.rb
+lib/baretest/uid.rb
+lib/baretest/use/mocha.rb
+lib/baretest/use/rack_test.rb
+lib/baretest/use/rr.rb
 lib/baretest/version.rb
+lib/command.rb
+lib/command/argument.rb
+lib/command/decoratinghash.rb
+lib/command/definition.rb
+lib/command/directorynotfounderror.rb
+lib/command/env.rb
+lib/command/filenotfounderror.rb
+lib/command/kernel.rb
+lib/command/nodirectoryerror.rb
+lib/command/nofileerror.rb
+lib/command/option.rb
+lib/command/parser.rb
+lib/command/result.rb
+lib/command/types.rb
+lib/command/version.rb
 lib/ruby/kernel.rb
-test/external/bootstraptest.rb
-test/external/bootstrapwrap.rb
-test/helper/mocks.rb
 test/setup.rb
 test/suite/lib/baretest.rb
 test/suite/lib/baretest/assertion.rb
+test/suite/lib/baretest/assertion/context.rb
+test/suite/lib/baretest/assertion/failure.rb
+test/suite/lib/baretest/assertion/skip.rb
 test/suite/lib/baretest/assertion/support.rb
 test/suite/lib/baretest/irb_mode.rb
 test/suite/lib/baretest/run.rb

data/README.rdoc

@@ -1,4 +1,4 @@
-= Bare Test
+= BareTest
 
 
 
@@ -6,6 +6,8 @@
 
 A testframework that doesn't stand in your way or forces you to learn a new
 language. Two methods is all that is required to know.
+If you need it, it provides you with all kinds of features to support you
+writing your tests.
 
 
 
@@ -70,6 +72,11 @@ To get baretest edge, use:
 2. Change into the baretest directory: `cd the/baretest/directory`
 3. Run the installation task: `rake gem:install` (alternatively `rake install:lib`)
 
+IMPORTANT: if the gem:install task fails, it might be because I forgot to update
+the MANIFEST.txt. Simply delete MANIFEST.txt, then run `rake manifest:create`
+and then retry `rake gem:install`.
+Also notice that you should have the gems 'nokogiri' and 'rdoc' installed.
+
 If you have multiple ruby versions installed parallely, this might pick the wrong gem
 executable to install the gem. You can set the GEM env variable to ensure it uses the
 right one: `rake gem:install GEM=gem1.9`

data/bin/baretest

@@ -8,143 +8,151 @@
 
 
 
-Version = "0.3.2"
+Version = "0.4.0" # Executable version
 
+# assume baretest is not installed and this is a cold-run from source
+lib_dir = File.expand_path("#{__FILE__}/../../lib")
+$LOAD_PATH.unshift(lib_dir) if File.directory?(lib_dir)
+lib_dir = File.expand_path("#{__FILE__}/../../../command/lib")
+$LOAD_PATH.unshift(lib_dir) if File.directory?(lib_dir)
 
 
-require 'optparse'
-begin
-  # if baretest is installed as a gem, the executable is be wrapped by rubgems anyway, so we don't
-  # need to require rubygems ourself.
-  require 'baretest'
-rescue LoadError
-  # assume baretest is not installed and this is a cold-run from source
-  $LOAD_PATH.unshift(File.expand_path("#{__FILE__}/../../lib"))
-  require 'baretest'
-end
 
+require 'command'
+require 'baretest'
 
 
-# Get all the command-line arguments and adapt options to it
-format      = ENV['FORMAT'] || 'cli'
-interactive = ['false', nil].include?(ENV['INTERACTIVE']) ? false : true
-setup_path  = nil
-
-opts = OptionParser.new("", 24, '  ') do |opts|
-  opts.banner = "Usage: baretest [options] [glob, ...]"
-
-  opts.separator "Glob defaults to 'test/{suite,unit,integration,system}/**/*.rb'"
-  opts.separator "Providing a directory as glob is equivalent to dir/**/*.rb\n"
-  opts.separator "Options:"
-
-  opts.on(nil, "--init", "create the necessary directories and files") {
-    core = %w[
-      test
-      test/external
-      test/helper
-      test/helper/suite
-      test/suite
-    ]
-    mirror = {
-      'bin'  => %w[test/helper/suite test/suite],
-      'lib'  => %w[test/helper/suite test/suite],
-      'rake' => %w[test/helper/suite test/suite],
-    }
-    files = {
-      'test/setup.rb' => <<-END_OF_SETUP.gsub(/^ {8}/, '')
-        $LOAD_PATH.unshift(File.expand_path("\#{__FILE__}/../../lib")) # Add PROJECT/lib to $LOAD_PATH
-      END_OF_SETUP
-    }
-
-    puts "Creating all directories and files needed in #{File.expand_path('.')}"
-    core.each do |dir|
-      if File.exist?(dir) then
-        puts "Directory #{dir} exists already -- skipping"
-      else
-        puts "Creating #{dir}"
-        Dir.mkdir(dir)
-      end
-    end
-    mirror.each do |path, destinations|
-      if File.exist?(path) then
-        destinations.each do |destination|
-          destination = File.join(destination,path)
-          if File.exist?(destination) then
-            puts "Mirror #{destination} of #{path} exists already -- skipping"
-          else
-            puts "Mirroring #{path} in #{destination}"
-            Dir.mkdir(destination)
-          end
-        end
-      end
-    end
-    files.each do |path, data|
-      if File.exist?(path) then
-        puts "File #{path} exists already -- skipping"
-      else
-        puts "Writing #{path}"
-        File.open(path, 'wb') do |fh|
-          fh.write(data)
-        end
-      end
-    end
 
-    exit
-  }
+# Specify commands and options
+Command "run" do
+  # global arguments
+  virtual_argument :command, '[command]', "The command to run. See `baretest commands`"
+  virtual_argument :options, '[options]', "The flags and options, see in the \"Options\" section."
 
-  opts.on("-f", "--format FORMAT", "use FORMAT for output") { |use|
-    format = use
-  }
+  # global options
+  o :commands,    nil,  '--commands', :Boolean, "overview over the commands"
+  o :help,        '-h', '--help',     :Boolean, "help for usage and flags"
+  o :version,     '-v', '--version',  :Boolean, "print the version and exit"
+  o :init,        nil,  '--init',     "Deprecated form for `baretest --init`"
 
-  opts.on("-F", "--formats", "show available formats") { |use|
-    puts "Available formats:"
-    Dir.glob("{#{$LOAD_PATH.join(',')}}/baretest/run/*.rb") { |path|
-      puts "- #{File.basename(path, '.rb')}"
-    }
-    exit
-  }
+  # specify the 'run' command, its default options, its options and helptext
+  command "run", :format => 'cli', :interactive => false, :verbose => false do
+    usage
 
-  opts.on("-d", "--debug", "set debugging flags (set $DEBUG to true)") {
-    $DEBUG   = true
-    $VERBOSE = true
-  }
+    virtual_argument :command
+    virtual_argument :options
+    virtual_argument :selector, '*(selector | -selector)', :String,
+      "The tests to run. Example:\n" \
+      "  baretest -- test/suite/a -test/suite/a/x @tag -@other %failure -%pending\n" \
+      "Defaults to 'test/{suite,unit,integration,system}\n" \
+      "See `baretest selectors` to get more information"
 
-  opts.on("-i", "--interactive", "drop into IRB on error or failure") {
-    interactive = true
-  }
+    text "\nDefault command is 'run', which runs the testsuite or the provided testfiles.\n\nOptions:\n"
 
-  opts.on("-s", "--setup FILE", "specify setup file") { |path|
-    setup_path = path
-  }
+    o :commands
+    o :debug,       '-d', '--debug',         :Boolean, "set debugging flags (set $DEBUG to true)"
+    o :interactive, '-i', '--interactive',   :Boolean, "drop into IRB on error or failure"
+    o :format,      '-f', '--format FORMAT', :String,  "use FORMAT for output, see `baretest formats`"
+    o :setup_file,  '-s', '--setup FILE',    :File,    "specify setup file"
+    o :verbose,     '-w', '--warn',          :Boolean, "turn warnings on for your script"
+    o :help
+    o :version
+    o :init
 
-  opts.on("-v", "--version", "print the version and exit") {
-    puts "baretest executable version #{Version}, library version #{BareTest::VERSION}"
-    exit
-  }
+    text ""
 
-  opts.on("-w", "--warn", "turn warnings on for your script") {
-    $VERBOSE = true
-  }
+    placeholder :format_options
 
-  opts.parse! ARGV
-end
+    text "\nEnvironment variables:\n"
+
+    env_option :format,      'FORMAT'
+    env_option :verbose,     'VERBOSE'
+    env_option :interactive, 'INTERACTIVE'
+  end
+
+  command "init" do
+    usage
 
+    virtual_argument :command
+    virtual_argument :options
+    text "\n  Create the necessary directories and files"
 
+    o :help
+  end
 
-# Load the setup file, all helper files and all test files
-BareTest.load_standard_test_files(
-  :verbose    => $VERBOSE,
-  :setup_path => setup_path,
-  :files      => (ARGV.empty? ? nil : ARGV),
-  :chdir      => '.'
-)
+  command "formats"
+  command "env"
+  command "version"
+  command "commands"
+  command "selectors"
+  command "help"
+end
 
 
 
-# Run the tests
-puts if $VERBOSE
-if BareTest.run(:format => format, :interactive => interactive).global_status == :success then
-  exit 0
-else
-  exit 1
+# Execute command
+Command.with(ARGV) do
+  # parse out the command
+  command = command!
+  # parse all options we know about and leave alone those we don't
+  options = options! :ignore_invalid_options
+
+  # some options are equivalent to commands - if they are set, change the
+  # command
+  if set = [:help, :commands, :version].find { |flag| options[flag] } then
+    run_command = set.to_s
+  elsif options[:init]
+    abort "`#{$0} --init` is depreciated, please use `baretest init`."
+  else
+    run_command = command
+  end
+  if %w[run help].include?(command) then
+    formatter = BareTest::CommandLine.load_formatter(options[:format])
+
+    definition[command].content_for :format_options do |d|
+      if formatter.is_a?(BareTest::Formatter) then
+        d.default_options.update(formatter.command[:option_defaults]) do |k,v1,v2| v2 end
+        formatter.command[:elements].each do |key, args|
+          d.send(key, *args)
+        end
+      else
+        d.text "Formatter '#{options[:format]}' does not specify any custom options."
+      end
+    end
+  end
+
+  options = options! # reparse with new information
+
+  case run_command
+    when "run" # run the testsuite/-file
+      begin
+        success = BareTest::CommandLine.run(arguments, options)
+      rescue BareTest::InvalidSelectors => e
+        puts e
+        puts "Valid state selectors are: #{BareTest::ValidStateSelectors.join(', ')}"
+        success = false
+      end
+      exit(success ? 0 : 1)
+    when "init" # create the test directory
+      BareTest::CommandLine.init(arguments, options)
+    when "formats" # list available formats
+      BareTest::CommandLine.formats(arguments, options)
+    when "env" # show information about baretest (config, version, paths, ...)
+      BareTest::CommandLine.env(arguments, options)
+    when "version" # show version information about baretest
+      BareTest::CommandLine.version(arguments, options)
+    when "selectors" # show version information about selectors baretest recognizes
+      BareTest::CommandLine.selectors(arguments, options)
+    when "help"
+      if command == 'help' then
+        BareTest::CommandLine.help(arguments, options)
+      else
+        puts definition[command].usage_text
+      end
+    when "commands"
+      BareTest::CommandLine.commands(arguments, options)
+    else
+      puts "Unknown command '#{command}'"
+      BareTest::CommandLine.commands(arguments, options)
+  end
 end

data/doc/baretest.rdoc

@@ -6,7 +6,7 @@
 
 Basic Usage:
 
-  baretest [options] [glob, ...]"
+  baretest [options] [glob, ...]
 
 Either you provide a `glob` (or a directory, which is equivalent to DIRECTORY/\*\*/\*.rb),
 then baretest will load all the files it matches and invoke BareTest.run in the end. Or you

data/doc/mocking_stubbing_test_doubles.rdoc

@@ -1,5 +1,33 @@
 = Mocking, Stubbing and TestDoubles
 
-BareTest off-the-shelf provides currently only integration with mocha.
-You can use mocha (assuming you have installed the mocha gem) by requiring 'baretest/mocha'.
-Best you add that to your setup.rb.
+BareTest off-the-shelf provides currently only integration with mocha and rr.
+They are available as components.
+Until baretest 0.5 is released (which will resolve the issue), you should not
+use multiple different stubbing/mocking libraries within your tests, as they
+might collide (define methods with the same name e.g.).
+
+== Mocha
+
+Example suite using mocha:
+    suite "Some suite using mocha", :use => :mocha do
+      setup do
+        ...FIXME...
+      end
+
+      assert FIXME do
+        ...FIXME...
+      end
+    end
+
+== RR
+
+Example suite using rr:
+    suite "Some suite using rr", :use => :rr do
+      setup do
+        ...FIXME...
+      end
+
+      assert FIXME do
+        ...FIXME...
+      end
+    end