rubytest-cli 0.1.0

data/.index

@@ -0,0 +1,66 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: trans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- version: 0.7.0+
+  name: rubytest
+- name: ansi
+- groups:
+  - build
+  development: true
+  name: fire
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/rubytest-cli
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/rubytest-cli
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/rubytest-cli/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git@github.com:rubyworks/rubytest-cli.git
+categories: []
+copyrights:
+- holder: RubyWorks
+  year: '2011'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+created: '2011-07-23'
+summary: CLI for Ruby Universal Test Harness
+title: Ruby Test CLI
+version: 0.1.0
+name: rubytest-cli
+description: ! 'Rubytest CLI is a command-line interface for running tests for
+
+  Rubytest-based test frameworks.'
+date: '2013-02-18'

data/.yardopts

@@ -0,0 +1,10 @@
+--title "Ruby Test CLI"
+--readme README.md
+--output-dir doc
+--protected
+--private
+lib
+-
+*.txt
+*.md
+

data/HISTORY.md

@@ -0,0 +1,10 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2013-02-19
+
+First release of Ruby Test CLI.
+
+Changes:
+
+* It's Your Birthday!
+

data/LICENSE.txt

@@ -0,0 +1,33 @@
+# COPYRIGHT NOTICES
+
+## Ruby Test
+
+**Project**   | Ruby Test
+--------------|------------------------------------------
+**Website**   | http://rubyworks.github.com/ruby-test
+**License**   | BSD-2-Clause
+**Copyright** | (c) 2011 Rubyworks
+
+    Copyright 2011 Rubyworks. All rights reserved.  
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice,
+          this list of conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,101 @@
+# Ruby Test CLI
+
+Command line interface for running tests for RubyTest-based
+test frameworks.
+
+[Website](http://rubyworks.github.com/rubytest-cli) /
+[Support](http://github.com/rubyworks/rubytest-cli/issues) /
+[Development](http://github.com/rubyworks/rubytest-cli)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/rubytest.png)](http://travis-ci.org/rubyworks/rubytest-cli)
+[![Gem Version](https://badge.fury.io/rb/rubytest.png)](http://badge.fury.io/rb/rubytest-cli)
+
+
+## Usage
+
+The rubytest command-line tool follows many of the usual conventions
+so it's use is farily straightforward. The `-h/--help` option is 
+available to detail all its options. Here is a basic example of usage. 
+
+    $ rubytest -Ilib test/*_test.rb
+
+This would add `lib` to Ruby's $LOAD_PATH and then load all the 
+test files matching the `test/*_test.rb` glob.
+
+When running tests, you need to be sure to load in your test framework
+or your framework's Ruby Test adapter. This is usually done via a helper
+script in the test files, but might also be done via command line options,
+e.g.
+
+    $ rubytest -r lemon -r ae test/test_*.rb
+
+Of course, it can become tedious having to type such a long command
+over and over. One way to handle this is to use an a *runtime adjunct tool*
+like [DotOpts](http://rubyworks.github.com/dotopts). For example, a project
+might add a `.opts` file with the entry:
+
+    rubytest
+      -f progress
+      -r spectroscope
+      -r rspecial
+      spec/spec_*.rb
+
+That will work in many cases, but to make things <u>solid</u> Ruby Test
+supports default pre-configuration files. To use, add an `etc/test.rb` file
+to a project and add `Test.run` (or the alias `Test.configure`) entries.
+
+```ruby
+    Test.run do |r|
+      r.loadpath 'lib'
+      r.test_files << 'test/*_test.rb'
+    end
+
+    Test.run 'coverage' do |r|
+      r.loadpath 'lib'
+      r.test_files << 'test/*_test.rb'
+      r.before do
+        require 'simplecov'
+        Simplecov.setup do |s|
+          s.filter 'test/'
+          s.command_name File.basename($0)
+          s.coverage_dir 'log/coverage'    
+        end
+        # to ensure proper coverage
+        require 'myapp'
+      end
+    end
+```
+
+Now when `rubytest` is used the first configuration will apply. To use
+the 'coverage' configuration use `-p/--profile` option.
+
+    $ rubytest -p coverage
+
+In this manner your project can have any number of different test
+configurations, and it is easy to select between them.
+
+Note that the above example could have used `Test.configure` instead
+of `Test.run`. They do the same thing. But do not use `Test.run!` because
+that will cause testing to be run immediately.
+
+The configuration file can be in the `config` directory instead of `etc`, which
+is nice for Rails projects. But if you prefer a file in the project's root 
+then either `Testfile` or `.test` can be also be used instead. All of these
+locations are supported simply because no one configuration convention has 
+taken a solid hold in the Ruby community. However, we highly recommend using
+`etc/test.rb`. In the end that seems like the best overall convention
+(and beleive me, I've analyized the hell out of every option!).
+
+
+## Copyrights
+
+Rubytest CLI is copyrighted open-source software.
+
+    Copyright (c) 2013 Rubyworks. All rights reserved.
+
+It is redistributable and modifiable in accordance with the terms of the
+[BSD-2-Clause] license.
+
+See LICENSE.txt for the full text.
+
+

data/bin/ruby-test

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  require 'rubytest-cli'
+  Test::CLI.run
+rescue RuntimeError => error
+  raise error if $DEBUG
+  $stderr.puts error
+end
+

data/bin/rubytest

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  require 'rubytest-cli'
+  Test::CLI.run
+rescue RuntimeError => error
+  raise error if $DEBUG
+  $stderr.puts error
+end
+

data/lib/rubytest-cli.rb

@@ -0,0 +1,280 @@
+require 'rubytest'
+
+module Test
+
+  # Command line interface to test runner.
+  #
+  class CLI
+
+    # Test configuration file can be in `etc/test.rb` or `config/test.rb`, or
+    # `Testfile` or '.test` with optional `.rb` extension, in that order of 
+    # precedence. To use a different file there is the -c/--config option.
+    GLOB_CONFIG = '{etc/test.rb,config/test.rb,testfile.rb,testfile,.test.rb,.test}'
+
+    # Convenience method for invoking the CLI.
+    #
+    # @return nothing
+    def self.run(*argv)
+      new.run(*argv)
+    end
+
+    # Initialize CLI instance.
+    #
+    # @return nothing
+    def initialize
+      require 'optparse'
+
+      @config = {}
+      @config_file = nil
+      #@config = Test.configuration(true)
+    end
+
+    # Run tests.
+    #
+    # @return nothing
+    def run(argv=nil)
+      #require_dotopts
+      argv = (argv || ARGV.dup)
+      options.parse!(argv)
+
+      @config[:files] = argv unless argv.empty?
+
+      load_config
+
+      test_config = Test.configuration(profile)
+      test_config.apply_environment_defaults
+      test_config.apply(@config)
+
+      Test.run!(test_config)
+
+      #runner = Runner.new(test_config)
+      #begin
+      #  success = runner.run
+      #  exit -1 unless success
+      #rescue => error
+      #  raise error if $DEBUG
+      #  $stderr.puts('ERROR: ' + error.to_s)
+      #  exit -1
+      #end
+    end
+
+    # TODO: Not sure if this should be used or not.
+    def require_dotopts
+      begin
+        require 'dotopts'
+      rescue LoadError
+      end
+    end
+
+    # Setup OptionsParser instance.
+    #
+    # @return [OptionParser]
+    def options
+      conf = self
+
+      OptionParser.new do |opt|
+        opt.banner = "Usage: #{File.basename($0)} [options] [files ...]"
+
+        opt.on '-p', '--profile NAME', 'use configuration profile' do |name|
+          conf.profile = name
+        end
+
+        #opt.separator "PRESET OPTIONS:"
+        #pnames = profile_names
+        #unless pnames.empty?
+        #  pnames.each do |pname|
+        #    opt.separator((" " * 40) + "* #{pname}")
+        #  end
+        #end
+        #opt.separator "CONFIG OPTIONS:"
+
+        opt.on '-f', '--format NAME', 'report format' do |name|
+          conf.format = name
+        end
+        opt.on '-y', '--tapy', 'shortcut for -f tapy' do
+          conf.format = 'tapy'
+        end
+        opt.on '-j', '--tapj', 'shortcut for -f tapj' do
+          conf.format = 'tapj'
+        end
+
+        # tempted to change -T
+        opt.on '-t', '--tag TAG', 'select tests by tag' do |tag|
+          conf.tags.concat makelist(tag)
+        end
+        opt.on '-u', '--unit TAG', 'select tests by software unit' do |unit|
+          conf.units.concat makelist(unit)
+        end
+        opt.on '-m', '--match TEXT', 'select tests by description' do |text|
+          conf.match.concat makelist(text)
+        end
+
+        opt.on '-A', '--autopath', 'automatically add paths to $LOAD_PATH' do |paths|
+          conf.autopath = true
+        end
+        opt.on '-I', '--loadpath PATH', 'add given path to $LOAD_PATH' do |paths|
+          #makelist(paths).reverse_each do |path|
+          #  $LOAD_PATH.unshift path
+          #end
+          conf.loadpath.concat makelist(paths)
+        end
+        opt.on '-C', '--chdir DIR', 'change directory before running tests' do |dir|
+          conf.chdir = dir
+        end
+        opt.on '-R', '--chroot', 'change to project root directory before running tests' do
+          conf.chdir = Config.root
+        end
+        opt.on '-r', '--require FILE', 'require file' do |file|
+          conf.requires.concat makelist(file)
+        end
+        opt.on '-c', '--config FILE', "use alternate config file" do |file|
+          conf.config_files << file
+        end
+        #opt.on '-T', '--tests GLOB', "tests to run (if none given as arguments)" do |glob|
+        #  config.files << glob
+        #end
+        opt.on '-V' , '--verbose', 'provide extra detail in reports' do
+          conf.verbose = true
+        end
+        #opt.on('--log PATH', 'log test output to path'){ |path|
+        #  config.log = path
+        #}
+        opt.on("--[no-]ansi" , 'turn on/off ANSI colors'){ |v| $ansi = v }
+        opt.on("--debug" , 'turn on debugging mode'){ $DEBUG = true }
+
+        #opt.separator "COMMAND OPTIONS:"
+        opt.on('--about' , 'display information about rubytest') do
+          puts "Ruby Test v%s" % [Test.index['version']]
+          Test.index['copyrights'].each do |c|
+            puts "(c) %s %s (%s)" % c.values_at('year', 'holder', 'license')
+          end
+          exit
+        end
+        opt.on('--version' , 'display rubytest version') do
+          puts Test::VERSION
+          exit
+        end
+        opt.on('-h', '--help', 'display this help message'){
+          puts opt
+          exit
+        }
+      end
+    end
+
+    # Test run configuration.
+    #
+    # @return [Hash]
+    def config
+      @config
+    end
+
+    # Load configuration file. An example file might look like:
+    #
+    #   Test.configure do |run|
+    #     run.files << 'test/case_*.rb'
+    #   end
+    #
+    # @deprecated Planned for deprecation in April 2013.
+    def load_config
+      file = config_file
+      unless file
+        if chdir
+          file = Dir.glob(File.join(chdir, GLOB_CONFIG)).first
+        else
+          file = Dir.glob(GLOB_CONFIG).first
+        end
+      end
+      load file if file
+    end
+
+    # Find traditional configuration file.
+    #
+    # @return [String] Config file path.
+    def config_file
+      @config_file
+    end
+
+    #
+    def profile
+      @profile
+    end
+
+    #
+    def profile=(name)
+      @profile = name.to_s
+    end
+
+    #
+    def format
+      @config[:format]
+    end
+
+    #
+    def format=(format)
+      @config[:format] = format.to_s
+    end
+
+    def tags
+      @config[:tags] ||= []
+    end
+
+    def units
+      @config[:units] ||= []
+    end
+
+    def match
+      @config[:match] ||= []
+    end
+
+    def autopath?
+      @config[:autopath]
+    end
+
+    def autopath=(bool)
+      @config[:autopath] = !! bool
+    end
+
+    def chdir
+      @config[:chdir]
+    end
+
+    def chdir=(dir)
+      @config[:chdir] = dir.to_str
+    end
+
+    def loadpath
+      @config[:loadpath] ||= []
+    end
+
+    def requires
+      @config[:requires] ||= []
+    end
+
+    def verbose?
+      @config[:verbose]
+    end
+
+    def verbose=(bool)
+      @config[:verbose] = !! bool
+    end
+
+  private
+
+    # If given a String then split up at `:` and `;` markers.
+    # Otherwise ensure the list is an Array and the entries are
+    # all strings and not empty.
+    #
+    # @return [Array<String>]
+    def makelist(list)
+      case list
+      when String
+        list = list.split(/[:;]/)
+      else
+        list = Array(list).map{ |path| path.to_s }
+      end
+      list.reject{ |path| path.strip.empty? }
+    end
+
+  end
+
+end

data/lib/rubytest-cli.yml

@@ -0,0 +1,66 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: trans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- version: 0.7.0+
+  name: rubytest
+- name: ansi
+- groups:
+  - build
+  development: true
+  name: fire
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/rubytest-cli
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/rubytest-cli
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/rubytest-cli/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git@github.com:rubyworks/rubytest-cli.git
+categories: []
+copyrights:
+- holder: RubyWorks
+  year: '2011'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+created: '2011-07-23'
+summary: CLI for Ruby Universal Test Harness
+title: Ruby Test CLI
+version: 0.1.0
+name: rubytest-cli
+description: ! 'Rubytest CLI is a command-line interface for running tests for
+
+  Rubytest-based test frameworks.'
+date: '2013-02-18'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: rubytest-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fire
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Rubytest CLI is a command-line interface for running tests for
+
+  Rubytest-based test frameworks.'
+email:
+- transfire@gmail.com
+executables:
+- ruby-test
+- rubytest
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- HISTORY.md
+- README.md
+files:
+- .index
+- .yardopts
+- bin/ruby-test
+- bin/rubytest
+- lib/rubytest-cli.rb
+- lib/rubytest-cli.yml
+- LICENSE.txt
+- HISTORY.md
+- README.md
+homepage: http://rubyworks.github.com/rubytest-cli
+licenses:
+- BSD-2-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: CLI for Ruby Universal Test Harness
+test_files: []
+has_rdoc: