rubytest-cli 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +7 -0
  2. data/.index +12 -27
  3. data/README.md +8 -10
  4. data/lib/rubytest-cli.yml +12 -27
  5. data/man/rubytest.1 +199 -0
  6. data/man/rubytest.1.html +230 -0
  7. data/man/rubytest.1.ronn +159 -0
  8. metadata +23 -91
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0aff2b937b4d105efded6c7e5eecc00dd8658a76
4
+ data.tar.gz: 4a36881c5eb3b1ef2e88a47cb3e7ddc5327ae0a7
5
+ SHA512:
6
+ metadata.gz: 8dfee9658a3f2876618396103bba70b81c51af96b524e25d0c3c47ecdbd67e77664fbd7f41e1438b227ca6416a16c362b18dfbdb5cf43b64cb732af1544b5234
7
+ data.tar.gz: fb1746c2d2b082a3066e23f4f1b12efc35b05e00d8b24afb82c65f549924a2f54a9a87312215348e7660abe71b154b699e5a99a961f57c43a91d325bf7cd3a13
data/.index CHANGED
@@ -2,31 +2,17 @@
2
2
  revision: 2013
3
3
  type: ruby
4
4
  sources:
5
- - var
5
+ - Indexfile
6
+ - Gemfile
6
7
  authors:
7
8
  - name: trans
8
9
  email: transfire@gmail.com
9
10
  organizations: []
10
11
  requirements:
11
- - version: 0.7.0+
12
+ - version: '>= 0.8.0'
12
13
  name: rubytest
13
- - name: ansi
14
- - groups:
15
- - build
16
- development: true
17
- name: fire
18
- - groups:
19
- - build
20
- development: true
21
- name: detroit
22
- - groups:
23
- - test
24
- development: true
25
- name: qed
26
- - groups:
27
- - test
28
- development: true
29
- name: ae
14
+ - version: '>= 0'
15
+ name: ansi
30
16
  conflicts: []
31
17
  alternatives: []
32
18
  resources:
@@ -55,12 +41,11 @@ customs: []
55
41
  paths:
56
42
  lib:
57
43
  - lib
58
- created: '2011-07-23'
59
- summary: CLI for Ruby Universal Test Harness
60
- title: Ruby Test CLI
61
- version: 0.1.0
62
44
  name: rubytest-cli
63
- description: ! 'Rubytest CLI is a command-line interface for running tests for
64
-
65
- Rubytest-based test frameworks.'
66
- date: '2013-02-18'
45
+ title: Rubytest CLI
46
+ version: 0.2.0
47
+ summary: Command line interface for Ruby Universal Test Harness
48
+ description: Rubytest CLI is a command-line interface for running tests for Rubytest-based
49
+ test frameworks.
50
+ created: '2011-07-23'
51
+ date: '2014-07-18'
data/README.md CHANGED
@@ -5,8 +5,7 @@ test frameworks.
5
5
 
6
6
  [Website](http://rubyworks.github.com/rubytest-cli) /
7
7
  [Support](http://github.com/rubyworks/rubytest-cli/issues) /
8
- [Development](http://github.com/rubyworks/rubytest-cli)
9
-
8
+ [Development](http://github.com/rubyworks/rubytest-cli)    
10
9
  [![Build Status](https://secure.travis-ci.org/rubyworks/rubytest.png)](http://travis-ci.org/rubyworks/rubytest-cli)
11
10
  [![Gem Version](https://badge.fury.io/rb/rubytest.png)](http://badge.fury.io/rb/rubytest-cli)
12
11
 
@@ -40,9 +39,9 @@ might add a `.opts` file with the entry:
40
39
  -r rspecial
41
40
  spec/spec_*.rb
42
41
 
43
- That will work in many cases, but to make things <u>solid</u> Ruby Test
44
- supports default pre-configuration files. To use, add an `etc/test.rb` file
45
- to a project and add `Test.run` (or the alias `Test.configure`) entries.
42
+ That will work in many cases, but to make things *solid* Ruby Test CLI
43
+ supports a default configuration file. To utilize, add an `etc/test.rb` file
44
+ to a project and add `Test.run` (or the alias `Test.configure`) entries to it.
46
45
 
47
46
  ```ruby
48
47
  Test.run do |r|
@@ -66,13 +65,13 @@ to a project and add `Test.run` (or the alias `Test.configure`) entries.
66
65
  end
67
66
  ```
68
67
 
69
- Now when `rubytest` is used the first configuration will apply. To use
68
+ Now when rubytest is used, the first configuration will apply. To use
70
69
  the 'coverage' configuration use `-p/--profile` option.
71
70
 
72
71
  $ rubytest -p coverage
73
72
 
74
- In this manner your project can have any number of different test
75
- configurations, and it is easy to select between them.
73
+ In this manner a project can have any number of different test configurations,
74
+ and it is easy to select between them.
76
75
 
77
76
  Note that the above example could have used `Test.configure` instead
78
77
  of `Test.run`. They do the same thing. But do not use `Test.run!` because
@@ -83,8 +82,7 @@ is nice for Rails projects. But if you prefer a file in the project's root
83
82
  then either `Testfile` or `.test` can be also be used instead. All of these
84
83
  locations are supported simply because no one configuration convention has
85
84
  taken a solid hold in the Ruby community. However, we highly recommend using
86
- `etc/test.rb`. In the end that seems like the best overall convention
87
- (and beleive me, I've analyized the hell out of every option!).
85
+ `etc/test.rb`. In the end that seems like the best overall convention.
88
86
 
89
87
 
90
88
  ## Copyrights
data/lib/rubytest-cli.yml CHANGED
@@ -2,31 +2,17 @@
2
2
  revision: 2013
3
3
  type: ruby
4
4
  sources:
5
- - var
5
+ - Indexfile
6
+ - Gemfile
6
7
  authors:
7
8
  - name: trans
8
9
  email: transfire@gmail.com
9
10
  organizations: []
10
11
  requirements:
11
- - version: 0.7.0+
12
+ - version: '>= 0.8.0'
12
13
  name: rubytest
13
- - name: ansi
14
- - groups:
15
- - build
16
- development: true
17
- name: fire
18
- - groups:
19
- - build
20
- development: true
21
- name: detroit
22
- - groups:
23
- - test
24
- development: true
25
- name: qed
26
- - groups:
27
- - test
28
- development: true
29
- name: ae
14
+ - version: '>= 0'
15
+ name: ansi
30
16
  conflicts: []
31
17
  alternatives: []
32
18
  resources:
@@ -55,12 +41,11 @@ customs: []
55
41
  paths:
56
42
  lib:
57
43
  - lib
58
- created: '2011-07-23'
59
- summary: CLI for Ruby Universal Test Harness
60
- title: Ruby Test CLI
61
- version: 0.1.0
62
44
  name: rubytest-cli
63
- description: ! 'Rubytest CLI is a command-line interface for running tests for
64
-
65
- Rubytest-based test frameworks.'
66
- date: '2013-02-18'
45
+ title: Rubytest CLI
46
+ version: 0.2.0
47
+ summary: Command line interface for Ruby Universal Test Harness
48
+ description: Rubytest CLI is a command-line interface for running tests for Rubytest-based
49
+ test frameworks.
50
+ created: '2011-07-23'
51
+ date: '2014-07-18'
data/man/rubytest.1 ADDED
@@ -0,0 +1,199 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "RUBYTEST" "1" "July 2014" "" ""
5
+ .
6
+ .SH "NAME"
7
+ \fBrubytest\fR \- ruby test via rubytest api
8
+ .
9
+ .SH "DESCRIPTION"
10
+ The rubytest command is a command line interface for running tests for RubyTest\-based test frameworks\.
11
+ .
12
+ .SH "OVERVIEW"
13
+ The rubytest command\-line tool follows many of the usual conventions so it\'s use is farily straightforward\. The \fB\-h/\-\-help\fR option is available to detail all its options\. Here is a basic example of usage\.
14
+ .
15
+ .IP "" 4
16
+ .
17
+ .nf
18
+
19
+ $ rubytest \-Ilib test/*_test\.rb
20
+ .
21
+ .fi
22
+ .
23
+ .IP "" 0
24
+ .
25
+ .P
26
+ This would add \fBlib\fR to Ruby\'s $LOAD_PATH and then load all the test files matching the \fBtest/*_test\.rb\fR glob\.
27
+ .
28
+ .P
29
+ 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\.
30
+ .
31
+ .IP "" 4
32
+ .
33
+ .nf
34
+
35
+ $ rubytest \-r lemon \-r ae test/test_*\.rb
36
+ .
37
+ .fi
38
+ .
39
+ .IP "" 0
40
+ .
41
+ .P
42
+ Of course, it can become tedious having to type such a long command over and over\. This can be dealt with via a configuration file\. To utilize, add an \fBetc/test\.rb\fR file to a project and add \fBTest\.run\fR (an alias for \fBTest\.configure\fR) entries to it\.
43
+ .
44
+ .IP "" 4
45
+ .
46
+ .nf
47
+
48
+ Test\.run do |r|
49
+ r\.loadpath \'lib\'
50
+ r\.test_files << \'test/*_test\.rb\'
51
+ end
52
+
53
+ Test\.run \'coverage\' do |r|
54
+ r\.loadpath \'lib\'
55
+ r\.test_files << \'test/*_test\.rb\'
56
+ r\.before do
57
+ require \'simplecov\'
58
+ Simplecov\.setup do |s|
59
+ s\.filter \'test/\'
60
+ s\.command_name File\.basename($0)
61
+ s\.coverage_dir \'log/coverage\'
62
+ end
63
+ # to ensure proper coverage
64
+ require \'myapp\'
65
+ end
66
+ end
67
+ .
68
+ .fi
69
+ .
70
+ .IP "" 0
71
+ .
72
+ .P
73
+ Now when rubytest is used, the first configuration will apply\. To use the \'coverage\' configuration use \fB\-p/\-\-profile\fR option\.
74
+ .
75
+ .IP "" 4
76
+ .
77
+ .nf
78
+
79
+ $ rubytest \-p coverage
80
+ .
81
+ .fi
82
+ .
83
+ .IP "" 0
84
+ .
85
+ .P
86
+ In this manner a project can have any number of different test configurations, and it is easy to select between them\.
87
+ .
88
+ .P
89
+ Note that the above example could have used \fBTest\.configure\fR instead of \fBTest\.run\fR\. They do the same thing\. But do not use \fBTest\.run!\fR because that will cause testing to be run immediately\.
90
+ .
91
+ .P
92
+ The configuration file can be in the \fBconfig\fR directory instead of \fBetc\fR, which is nice for Rails projects\. But if you prefer a file in the project\'s root then either \fBTestfile\fR or \fB\.test\fR 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 \fBetc/test\.rb\fR\. In the end that seems like the best overall convention\.
93
+ .
94
+ .SH "USAGE"
95
+ .
96
+ .nf
97
+
98
+ rubytest [options] [files \.\.\.]
99
+ .
100
+ .fi
101
+ .
102
+ .SH "OPTIONS"
103
+ .
104
+ .IP "\(bu" 4
105
+ \fB\-p\fR \fB\-\-profile <NAME>\fR Use configuration profile\.
106
+ .
107
+ .IP "\(bu" 4
108
+ \fB\-f\fR \fB\-\-format <NAME>\fR Report format\.
109
+ .
110
+ .IP "\(bu" 4
111
+ \fBy\fR \fB\-\-tapy\fR Shortcut for \-f tapy\.
112
+ .
113
+ .IP "\(bu" 4
114
+ \fB\-j\fR \fB\-\-tapj\fR Shortcut for \-f tapj\.
115
+ .
116
+ .IP "\(bu" 4
117
+ \fB\-t\fR \fB\-\-tag <TAG>\fR Select tests by tag\.
118
+ .
119
+ .IP "\(bu" 4
120
+ \fB\-u\fR \fB\-\-unit <TAG>\fR Select tests by software unit\.
121
+ .
122
+ .IP "\(bu" 4
123
+ \fB\-m\fR \fB\-\-match <TEXT>\fR Select tests by description\.
124
+ .
125
+ .IP "\(bu" 4
126
+ \fB\-A\fR \fB\-\-autopath\fR Automatically add paths to $LOAD_PATH\.
127
+ .
128
+ .IP "\(bu" 4
129
+ \fB\-I\fR \fB\-\-loadpath <PATH>\fR Add given path to $LOAD_PATH\.
130
+ .
131
+ .IP "\(bu" 4
132
+ \fB\-C\fR \fB\-\-chdir <DIR>\fR Change directory before running tests\.
133
+ .
134
+ .IP "\(bu" 4
135
+ \fB\-R\fR \fB\-\-chroot\fR Change to project root directory before running tests\.
136
+ .
137
+ .IP "\(bu" 4
138
+ \fB\-r\fR \fB\-\-require <FILE>\fR Require file\.
139
+ .
140
+ .IP "\(bu" 4
141
+ \fB\-c\fR \fB\-\-config <FILE>\fR Use alternate config file\.
142
+ .
143
+ .IP "\(bu" 4
144
+ \fB\-V\fR \fB\-\-verbose\fR Provide extra detail in reports\.
145
+ .
146
+ .IP "\(bu" 4
147
+ \fB\-\-[no\-]ansi\fR Turn on/off ANSI colors\.
148
+ .
149
+ .IP "\(bu" 4
150
+ \fB\-\-debug\fR Turn on debugging mode\.
151
+ .
152
+ .IP "\(bu" 4
153
+ \fB\-\-about\fR Display information about rubytest\.
154
+ .
155
+ .IP "\(bu" 4
156
+ \fB\-\-version\fR Display rubytest version\.
157
+ .
158
+ .IP "\(bu" 4
159
+ \fB\-h\fR \fB\-\-help\fR Display this help message\.
160
+ .
161
+ .IP "" 0
162
+ .
163
+ .SH "RESOURCES"
164
+ .
165
+ .IP "\(bu" 4
166
+ Website \fIhttp://rubyworks\.github\.com/rubytest\-cli\fR /
167
+ .
168
+ .IP "\(bu" 4
169
+ Support \fIhttp://github\.com/rubyworks/rubytest\-cli/issues\fR /
170
+ .
171
+ .IP "\(bu" 4
172
+ Development \fIhttp://github\.com/rubyworks/rubytest\-cli\fR \~ \~
173
+ .
174
+ .IP "\(bu" 4
175
+ \fIhttp://travis\-ci\.org/rubyworks/rubytest\-cli\fR
176
+ .
177
+ .IP "\(bu" 4
178
+ \fIhttp://badge\.fury\.io/rb/rubytest\-cli\fR
179
+ .
180
+ .IP "" 0
181
+ .
182
+ .SH "COPYRIGHT"
183
+ Rubytest is copyrighted open\-source software\.
184
+ .
185
+ .IP "" 4
186
+ .
187
+ .nf
188
+
189
+ Copyright (c) 2013 Rubyworks\. All rights reserved\.
190
+ .
191
+ .fi
192
+ .
193
+ .IP "" 0
194
+ .
195
+ .P
196
+ It is redistributable and modifiable in accordance with the terms of the BSD\-2\-Clause license\.
197
+ .
198
+ .SH "SEE ALSO"
199
+ ruby(1)
data/man/rubytest.1.html ADDED
@@ -0,0 +1,230 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
+ <title>rubytest(1) - ruby test via rubytest api</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ </head>
45
+ <!--
46
+ The following styles are deprecated and will be removed at some point:
47
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
48
+
49
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
50
+ .man-navigation should be used instead.
51
+ -->
52
+ <body id='manpage'>
53
+ <div class='mp' id='man'>
54
+
55
+ <div class='man-navigation' style='display:none'>
56
+ <a href="#NAME">NAME</a>
57
+ <a href="#DESCRIPTION">DESCRIPTION</a>
58
+ <a href="#OVERVIEW">OVERVIEW</a>
59
+ <a href="#USAGE">USAGE</a>
60
+ <a href="#OPTIONS">OPTIONS</a>
61
+ <a href="#RESOURCES">RESOURCES</a>
62
+ <a href="#COPYRIGHT">COPYRIGHT</a>
63
+ <a href="#SEE-ALSO">SEE ALSO</a>
64
+ </div>
65
+
66
+ <ol class='man-decor man-head man head'>
67
+ <li class='tl'>rubytest(1)</li>
68
+ <li class='tc'></li>
69
+ <li class='tr'>rubytest(1)</li>
70
+ </ol>
71
+
72
+ <h2 id="NAME">NAME</h2>
73
+ <p class="man-name">
74
+ <code>rubytest</code> - <span class="man-whatis">ruby test via rubytest api</span>
75
+ </p>
76
+
77
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
78
+
79
+ <p>The rubytest command is a command line interface for running tests
80
+ for RubyTest-based test frameworks.</p>
81
+
82
+ <h2 id="OVERVIEW">OVERVIEW</h2>
83
+
84
+ <p>The rubytest command-line tool follows many of the usual conventions
85
+ so it's use is farily straightforward. The <code>-h/--help</code> option is
86
+ available to detail all its options. Here is a basic example of usage.</p>
87
+
88
+ <pre><code>$ rubytest -Ilib test/*_test.rb
89
+ </code></pre>
90
+
91
+ <p>This would add <code>lib</code> to Ruby's $LOAD_PATH and then load all the
92
+ test files matching the <code>test/*_test.rb</code> glob.</p>
93
+
94
+ <p>When running tests, you need to be sure to load in your test framework
95
+ or your framework's Ruby Test adapter. This is usually done via a helper
96
+ script in the test files, but might also be done via command line options,
97
+ e.g.</p>
98
+
99
+ <pre><code>$ rubytest -r lemon -r ae test/test_*.rb
100
+ </code></pre>
101
+
102
+ <p>Of course, it can become tedious having to type such a long command over and over.
103
+ This can be dealt with via a configuration file. To utilize, add an <code>etc/test.rb</code>
104
+ file to a project and add <code>Test.run</code> (an alias for <code>Test.configure</code>) entries to it.</p>
105
+
106
+ <pre><code>Test.run do |r|
107
+ r.loadpath 'lib'
108
+ r.test_files &lt;&lt; 'test/*_test.rb'
109
+ end
110
+
111
+ Test.run 'coverage' do |r|
112
+ r.loadpath 'lib'
113
+ r.test_files &lt;&lt; 'test/*_test.rb'
114
+ r.before do
115
+ require 'simplecov'
116
+ Simplecov.setup do |s|
117
+ s.filter 'test/'
118
+ s.command_name File.basename($0)
119
+ s.coverage_dir 'log/coverage'
120
+ end
121
+ # to ensure proper coverage
122
+ require 'myapp'
123
+ end
124
+ end
125
+ </code></pre>
126
+
127
+ <p>Now when rubytest is used, the first configuration will apply. To use
128
+ the 'coverage' configuration use <code>-p/--profile</code> option.</p>
129
+
130
+ <pre><code>$ rubytest -p coverage
131
+ </code></pre>
132
+
133
+ <p>In this manner a project can have any number of different test configurations,
134
+ and it is easy to select between them.</p>
135
+
136
+ <p>Note that the above example could have used <code>Test.configure</code> instead
137
+ of <code>Test.run</code>. They do the same thing. But do not use <code>Test.run!</code> because
138
+ that will cause testing to be run immediately.</p>
139
+
140
+ <p>The configuration file can be in the <code>config</code> directory instead of <code>etc</code>, which
141
+ is nice for Rails projects. But if you prefer a file in the project's root
142
+ then either <code>Testfile</code> or <code>.test</code> can be also be used instead. All of these
143
+ locations are supported simply because no one configuration convention has
144
+ taken a solid hold in the Ruby community. However, we highly recommend using
145
+ <code>etc/test.rb</code>. In the end that seems like the best overall convention.</p>
146
+
147
+ <h2 id="USAGE">USAGE</h2>
148
+
149
+ <pre><code>rubytest [options] [files ...]
150
+ </code></pre>
151
+
152
+ <h2 id="OPTIONS">OPTIONS</h2>
153
+
154
+ <ul>
155
+ <li><p><code>-p</code> <code>--profile &lt;NAME></code>
156
+ Use configuration profile.</p></li>
157
+ <li><p><code>-f</code> <code>--format &lt;NAME></code>
158
+ Report format.</p></li>
159
+ <li><p><code>y</code> <code>--tapy</code>
160
+ Shortcut for -f tapy.</p></li>
161
+ <li><p><code>-j</code> <code>--tapj</code>
162
+ Shortcut for -f tapj.</p></li>
163
+ <li><p><code>-t</code> <code>--tag &lt;TAG></code>
164
+ Select tests by tag.</p></li>
165
+ <li><p><code>-u</code> <code>--unit &lt;TAG></code>
166
+ Select tests by software unit.</p></li>
167
+ <li><p><code>-m</code> <code>--match &lt;TEXT></code>
168
+ Select tests by description.</p></li>
169
+ <li><p><code>-A</code> <code>--autopath</code>
170
+ Automatically add paths to $LOAD_PATH.</p></li>
171
+ <li><p><code>-I</code> <code>--loadpath &lt;PATH></code>
172
+ Add given path to $LOAD_PATH.</p></li>
173
+ <li><p><code>-C</code> <code>--chdir &lt;DIR></code>
174
+ Change directory before running tests.</p></li>
175
+ <li><p><code>-R</code> <code>--chroot</code>
176
+ Change to project root directory before running tests.</p></li>
177
+ <li><p><code>-r</code> <code>--require &lt;FILE></code>
178
+ Require file.</p></li>
179
+ <li><p><code>-c</code> <code>--config &lt;FILE></code>
180
+ Use alternate config file.</p></li>
181
+ <li><p><code>-V</code> <code>--verbose</code>
182
+ Provide extra detail in reports.</p></li>
183
+ <li><p><code>--[no-]ansi</code>
184
+ Turn on/off ANSI colors.</p></li>
185
+ <li><p><code>--debug</code>
186
+ Turn on debugging mode.</p></li>
187
+ <li><p><code>--about</code>
188
+ Display information about rubytest.</p></li>
189
+ <li><p><code>--version</code>
190
+ Display rubytest version.</p></li>
191
+ <li><p><code>-h</code> <code>--help</code>
192
+ Display this help message.</p></li>
193
+ </ul>
194
+
195
+
196
+ <h2 id="RESOURCES">RESOURCES</h2>
197
+
198
+ <ul>
199
+ <li><a href="http://rubyworks.github.com/rubytest-cli">Website</a> /</li>
200
+ <li><a href="http://github.com/rubyworks/rubytest-cli/issues">Support</a> /</li>
201
+ <li><a href="http://github.com/rubyworks/rubytest-cli">Development</a> &nbsp; &nbsp;</li>
202
+ <li><a href="http://travis-ci.org/rubyworks/rubytest-cli"><img src="https://secure.travis-ci.org/rubyworks/rubytest.png" alt="Build Status" /></a></li>
203
+ <li><a href="http://badge.fury.io/rb/rubytest-cli"><img src="https://badge.fury.io/rb/rubytest.png" alt="Gem Version" /></a></li>
204
+ </ul>
205
+
206
+
207
+ <h2 id="COPYRIGHT">COPYRIGHT</h2>
208
+
209
+ <p>Rubytest is copyrighted open-source software.</p>
210
+
211
+ <pre><code>Copyright (c) 2013 Rubyworks. All rights reserved.
212
+ </code></pre>
213
+
214
+ <p>It is redistributable and modifiable in accordance with the terms of the
215
+ BSD-2-Clause license.</p>
216
+
217
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
218
+
219
+ <p><span class="man-ref">ruby<span class="s">(1)</span></span></p>
220
+
221
+
222
+ <ol class='man-decor man-foot man foot'>
223
+ <li class='tl'></li>
224
+ <li class='tc'>July 2014</li>
225
+ <li class='tr'>rubytest(1)</li>
226
+ </ol>
227
+
228
+ </div>
229
+ </body>
230
+ </html>
data/man/rubytest.1.ronn ADDED
@@ -0,0 +1,159 @@
1
+ rubytest(1) - ruby test via rubytest api
2
+ ========================================
3
+
4
+ ## DESCRIPTION
5
+
6
+ The rubytest command is a command line interface for running tests
7
+ for RubyTest-based test frameworks.
8
+
9
+
10
+ ## OVERVIEW
11
+
12
+ The rubytest command-line tool follows many of the usual conventions
13
+ so it's use is farily straightforward. The `-h/--help` option is
14
+ available to detail all its options. Here is a basic example of usage.
15
+
16
+ $ rubytest -Ilib test/*_test.rb
17
+
18
+ This would add `lib` to Ruby's $LOAD_PATH and then load all the
19
+ test files matching the `test/*_test.rb` glob.
20
+
21
+ When running tests, you need to be sure to load in your test framework
22
+ or your framework's Ruby Test adapter. This is usually done via a helper
23
+ script in the test files, but might also be done via command line options,
24
+ e.g.
25
+
26
+ $ rubytest -r lemon -r ae test/test_*.rb
27
+
28
+ Of course, it can become tedious having to type such a long command over and over.
29
+ This can be dealt with via a configuration file. To utilize, add an `etc/test.rb`
30
+ file to a project and add `Test.run` (an alias for `Test.configure`) entries to it.
31
+
32
+ Test.run do |r|
33
+ r.loadpath 'lib'
34
+ r.test_files << 'test/*_test.rb'
35
+ end
36
+
37
+ Test.run 'coverage' do |r|
38
+ r.loadpath 'lib'
39
+ r.test_files << 'test/*_test.rb'
40
+ r.before do
41
+ require 'simplecov'
42
+ Simplecov.setup do |s|
43
+ s.filter 'test/'
44
+ s.command_name File.basename($0)
45
+ s.coverage_dir 'log/coverage'
46
+ end
47
+ # to ensure proper coverage
48
+ require 'myapp'
49
+ end
50
+ end
51
+
52
+ Now when rubytest is used, the first configuration will apply. To use
53
+ the 'coverage' configuration use `-p/--profile` option.
54
+
55
+ $ rubytest -p coverage
56
+
57
+ In this manner a project can have any number of different test configurations,
58
+ and it is easy to select between them.
59
+
60
+ Note that the above example could have used `Test.configure` instead
61
+ of `Test.run`. They do the same thing. But do not use `Test.run!` because
62
+ that will cause testing to be run immediately.
63
+
64
+ The configuration file can be in the `config` directory instead of `etc`, which
65
+ is nice for Rails projects. But if you prefer a file in the project's root
66
+ then either `Testfile` or `.test` can be also be used instead. All of these
67
+ locations are supported simply because no one configuration convention has
68
+ taken a solid hold in the Ruby community. However, we highly recommend using
69
+ `etc/test.rb`. In the end that seems like the best overall convention.
70
+
71
+
72
+ ## USAGE
73
+
74
+ rubytest [options] [files ...]
75
+
76
+
77
+ ## OPTIONS
78
+
79
+ * `-p` `--profile <NAME>`
80
+ Use configuration profile.
81
+
82
+ * `-f` `--format <NAME>`
83
+ Report format.
84
+
85
+ * `y` `--tapy`
86
+ Shortcut for -f tapy.
87
+
88
+ * `-j` `--tapj`
89
+ Shortcut for -f tapj.
90
+
91
+ * `-t` `--tag <TAG>`
92
+ Select tests by tag.
93
+
94
+ * `-u` `--unit <TAG>`
95
+ Select tests by software unit.
96
+
97
+ * `-m` `--match <TEXT>`
98
+ Select tests by description.
99
+
100
+ * `-A` `--autopath`
101
+ Automatically add paths to $LOAD_PATH.
102
+
103
+ * `-I` `--loadpath <PATH>`
104
+ Add given path to $LOAD_PATH.
105
+
106
+ * `-C` `--chdir <DIR>`
107
+ Change directory before running tests.
108
+
109
+ * `-R` `--chroot`
110
+ Change to project root directory before running tests.
111
+
112
+ * `-r` `--require <FILE>`
113
+ Require file.
114
+
115
+ * `-c` `--config <FILE>`
116
+ Use alternate config file.
117
+
118
+ * `-V` `--verbose`
119
+ Provide extra detail in reports.
120
+
121
+ * `--[no-]ansi`
122
+ Turn on/off ANSI colors.
123
+
124
+ * `--debug`
125
+ Turn on debugging mode.
126
+
127
+ * `--about`
128
+ Display information about rubytest.
129
+
130
+ * `--version`
131
+ Display rubytest version.
132
+
133
+ * `-h` `--help`
134
+ Display this help message.
135
+
136
+
137
+ ## RESOURCES
138
+
139
+ * [Website](http://rubyworks.github.com/rubytest-cli) /
140
+ * [Support](http://github.com/rubyworks/rubytest-cli/issues) /
141
+ * [Development](http://github.com/rubyworks/rubytest-cli) &nbsp; &nbsp;
142
+ * [![Build Status](https://secure.travis-ci.org/rubyworks/rubytest.png)](http://travis-ci.org/rubyworks/rubytest-cli)
143
+ * [![Gem Version](https://badge.fury.io/rb/rubytest.png)](http://badge.fury.io/rb/rubytest-cli)
144
+
145
+
146
+ ## COPYRIGHT
147
+
148
+ Rubytest is copyrighted open-source software.
149
+
150
+ Copyright (c) 2013 Rubyworks. All rights reserved.
151
+
152
+ It is redistributable and modifiable in accordance with the terms of the
153
+ BSD-2-Clause license.
154
+
155
+
156
+ ## SEE ALSO
157
+
158
+ ruby(1)
159
+
metadata CHANGED
@@ -1,115 +1,45 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubytest-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
5
- prerelease:
4
+ version: 0.2.0
6
5
  platform: ruby
7
6
  authors:
8
7
  - trans
9
8
  autorequire:
10
9
  bindir: bin
11
10
  cert_chain: []
12
- date: 2013-02-18 00:00:00.000000000 Z
11
+ date: 2014-07-19 00:00:00.000000000 Z
13
12
  dependencies:
14
13
  - !ruby/object:Gem::Dependency
15
14
  name: rubytest
16
15
  requirement: !ruby/object:Gem::Requirement
17
- none: false
18
16
  requirements:
19
- - - ! '>='
17
+ - - '>='
20
18
  - !ruby/object:Gem::Version
21
- version: 0.7.0
19
+ version: 0.8.0
22
20
  type: :runtime
23
21
  prerelease: false
24
22
  version_requirements: !ruby/object:Gem::Requirement
25
- none: false
26
23
  requirements:
27
- - - ! '>='
24
+ - - '>='
28
25
  - !ruby/object:Gem::Version
29
- version: 0.7.0
26
+ version: 0.8.0
30
27
  - !ruby/object:Gem::Dependency
31
28
  name: ansi
32
29
  requirement: !ruby/object:Gem::Requirement
33
- none: false
34
30
  requirements:
35
- - - ! '>='
31
+ - - '>='
36
32
  - !ruby/object:Gem::Version
37
33
  version: '0'
38
34
  type: :runtime
39
35
  prerelease: false
40
36
  version_requirements: !ruby/object:Gem::Requirement
41
- none: false
42
37
  requirements:
43
- - - ! '>='
38
+ - - '>='
44
39
  - !ruby/object:Gem::Version
45
40
  version: '0'
46
- - !ruby/object:Gem::Dependency
47
- name: fire
48
- requirement: !ruby/object:Gem::Requirement
49
- none: false
50
- requirements:
51
- - - ! '>='
52
- - !ruby/object:Gem::Version
53
- version: '0'
54
- type: :development
55
- prerelease: false
56
- version_requirements: !ruby/object:Gem::Requirement
57
- none: false
58
- requirements:
59
- - - ! '>='
60
- - !ruby/object:Gem::Version
61
- version: '0'
62
- - !ruby/object:Gem::Dependency
63
- name: detroit
64
- requirement: !ruby/object:Gem::Requirement
65
- none: false
66
- requirements:
67
- - - ! '>='
68
- - !ruby/object:Gem::Version
69
- version: '0'
70
- type: :development
71
- prerelease: false
72
- version_requirements: !ruby/object:Gem::Requirement
73
- none: false
74
- requirements:
75
- - - ! '>='
76
- - !ruby/object:Gem::Version
77
- version: '0'
78
- - !ruby/object:Gem::Dependency
79
- name: qed
80
- requirement: !ruby/object:Gem::Requirement
81
- none: false
82
- requirements:
83
- - - ! '>='
84
- - !ruby/object:Gem::Version
85
- version: '0'
86
- type: :development
87
- prerelease: false
88
- version_requirements: !ruby/object:Gem::Requirement
89
- none: false
90
- requirements:
91
- - - ! '>='
92
- - !ruby/object:Gem::Version
93
- version: '0'
94
- - !ruby/object:Gem::Dependency
95
- name: ae
96
- requirement: !ruby/object:Gem::Requirement
97
- none: false
98
- requirements:
99
- - - ! '>='
100
- - !ruby/object:Gem::Version
101
- version: '0'
102
- type: :development
103
- prerelease: false
104
- version_requirements: !ruby/object:Gem::Requirement
105
- none: false
106
- requirements:
107
- - - ! '>='
108
- - !ruby/object:Gem::Version
109
- version: '0'
110
- description: ! 'Rubytest CLI is a command-line interface for running tests for
111
-
112
- Rubytest-based test frameworks.'
41
+ description: Rubytest CLI is a command-line interface for running tests for Rubytest-based
42
+ test frameworks.
113
43
  email:
114
44
  - transfire@gmail.com
115
45
  executables:
@@ -118,42 +48,44 @@ executables:
118
48
  extensions: []
119
49
  extra_rdoc_files:
120
50
  - LICENSE.txt
121
- - HISTORY.md
122
51
  - README.md
52
+ - HISTORY.md
123
53
  files:
124
54
  - .index
125
55
  - .yardopts
126
56
  - bin/ruby-test
127
57
  - bin/rubytest
128
- - lib/rubytest-cli.rb
129
58
  - lib/rubytest-cli.yml
130
- - LICENSE.txt
131
- - HISTORY.md
59
+ - lib/rubytest-cli.rb
60
+ - man/rubytest.1.html
61
+ - man/rubytest.1
62
+ - man/rubytest.1.ronn
132
63
  - README.md
64
+ - HISTORY.md
65
+ - LICENSE.txt
133
66
  homepage: http://rubyworks.github.com/rubytest-cli
134
67
  licenses:
135
68
  - BSD-2-Clause
69
+ metadata: {}
136
70
  post_install_message:
137
71
  rdoc_options: []
138
72
  require_paths:
139
73
  - lib
140
74
  required_ruby_version: !ruby/object:Gem::Requirement
141
- none: false
142
75
  requirements:
143
- - - ! '>='
76
+ - - '>='
144
77
  - !ruby/object:Gem::Version
145
78
  version: '0'
146
79
  required_rubygems_version: !ruby/object:Gem::Requirement
147
- none: false
148
80
  requirements:
149
- - - ! '>='
81
+ - - '>='
150
82
  - !ruby/object:Gem::Version
151
83
  version: '0'
152
84
  requirements: []
153
85
  rubyforge_project:
154
- rubygems_version: 1.8.24
86
+ rubygems_version: 2.0.3
155
87
  signing_key:
156
- specification_version: 3
157
- summary: CLI for Ruby Universal Test Harness
88
+ specification_version: 4
89
+ summary: Command line interface for Ruby Universal Test Harness
158
90
  test_files: []
159
91
  has_rdoc: