cairo 1.8.5 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of cairo might be problematic. Click here for more details.

Files changed (106) hide show
  1. data/NEWS +2 -2
  2. data/Rakefile +44 -7
  3. data/ext/cairo/cairo.def +28 -1
  4. data/ext/cairo/extconf.rb +14 -16
  5. data/ext/cairo/rb_cairo.c +4 -1
  6. data/ext/cairo/rb_cairo.h +65 -1
  7. data/ext/cairo/rb_cairo_constants.c +150 -3
  8. data/ext/cairo/rb_cairo_context.c +17 -0
  9. data/ext/cairo/rb_cairo_device.c +406 -0
  10. data/ext/cairo/rb_cairo_exception.c +83 -32
  11. data/ext/cairo/rb_cairo_io.c +166 -0
  12. data/ext/cairo/rb_cairo_io.h +44 -0
  13. data/ext/cairo/rb_cairo_matrix.c +1 -1
  14. data/ext/cairo/rb_cairo_private.h +3 -0
  15. data/ext/cairo/rb_cairo_region.c +385 -0
  16. data/ext/cairo/rb_cairo_surface.c +674 -199
  17. data/samples/blur.rb +2 -3
  18. data/samples/{pac2.rb → pac-nomralize.rb} +5 -6
  19. data/samples/pac-tee.rb +170 -0
  20. data/samples/pac.rb +2 -3
  21. data/samples/png.rb +2 -3
  22. data/samples/scalable.rb +2 -3
  23. data/samples/text-on-path.rb +2 -3
  24. data/samples/text2.rb +2 -3
  25. data/test/cairo-test-utils.rb +15 -0
  26. data/test/run-test.rb +5 -4
  27. data/test/test_context.rb +4 -4
  28. data/test/test_font_face.rb +34 -21
  29. data/test/test_recording_surface.rb +18 -0
  30. data/test/test_region.rb +102 -0
  31. data/test/test_script_device.rb +46 -0
  32. data/test/test_script_surface.rb +13 -0
  33. data/test/test_surface.rb +14 -4
  34. data/test/test_tee_surface.rb +32 -0
  35. data/test/test_xml_device.rb +22 -0
  36. data/test/test_xml_surface.rb +32 -0
  37. metadata +49 -77
  38. data/pkg-config.rb +0 -313
  39. data/test-unit/Rakefile +0 -30
  40. data/test-unit/bin/testrb +0 -5
  41. data/test-unit/lib/test/unit.rb +0 -280
  42. data/test-unit/lib/test/unit/assertionfailederror.rb +0 -14
  43. data/test-unit/lib/test/unit/assertions.rb +0 -722
  44. data/test-unit/lib/test/unit/attribute.rb +0 -125
  45. data/test-unit/lib/test/unit/autorunner.rb +0 -254
  46. data/test-unit/lib/test/unit/collector.rb +0 -43
  47. data/test-unit/lib/test/unit/collector/descendant.rb +0 -23
  48. data/test-unit/lib/test/unit/collector/dir.rb +0 -108
  49. data/test-unit/lib/test/unit/collector/load.rb +0 -135
  50. data/test-unit/lib/test/unit/collector/objectspace.rb +0 -34
  51. data/test-unit/lib/test/unit/color.rb +0 -61
  52. data/test-unit/lib/test/unit/diff.rb +0 -524
  53. data/test-unit/lib/test/unit/error.rb +0 -124
  54. data/test-unit/lib/test/unit/exceptionhandler.rb +0 -39
  55. data/test-unit/lib/test/unit/failure.rb +0 -110
  56. data/test-unit/lib/test/unit/fixture.rb +0 -185
  57. data/test-unit/lib/test/unit/notification.rb +0 -125
  58. data/test-unit/lib/test/unit/omission.rb +0 -143
  59. data/test-unit/lib/test/unit/pending.rb +0 -146
  60. data/test-unit/lib/test/unit/priority.rb +0 -146
  61. data/test-unit/lib/test/unit/runner/console.rb +0 -46
  62. data/test-unit/lib/test/unit/runner/emacs.rb +0 -8
  63. data/test-unit/lib/test/unit/testcase.rb +0 -281
  64. data/test-unit/lib/test/unit/testresult.rb +0 -89
  65. data/test-unit/lib/test/unit/testsuite.rb +0 -110
  66. data/test-unit/lib/test/unit/ui/console/outputlevel.rb +0 -14
  67. data/test-unit/lib/test/unit/ui/console/testrunner.rb +0 -195
  68. data/test-unit/lib/test/unit/ui/emacs/testrunner.rb +0 -49
  69. data/test-unit/lib/test/unit/ui/testrunner.rb +0 -20
  70. data/test-unit/lib/test/unit/ui/testrunnermediator.rb +0 -77
  71. data/test-unit/lib/test/unit/ui/testrunnerutilities.rb +0 -41
  72. data/test-unit/lib/test/unit/util/backtracefilter.rb +0 -41
  73. data/test-unit/lib/test/unit/util/observable.rb +0 -90
  74. data/test-unit/lib/test/unit/util/procwrapper.rb +0 -48
  75. data/test-unit/lib/test/unit/version.rb +0 -7
  76. data/test-unit/sample/adder.rb +0 -13
  77. data/test-unit/sample/subtracter.rb +0 -12
  78. data/test-unit/sample/tc_adder.rb +0 -18
  79. data/test-unit/sample/tc_subtracter.rb +0 -18
  80. data/test-unit/sample/ts_examples.rb +0 -7
  81. data/test-unit/test/collector/test_descendant.rb +0 -135
  82. data/test-unit/test/collector/test_dir.rb +0 -406
  83. data/test-unit/test/collector/test_load.rb +0 -333
  84. data/test-unit/test/collector/test_objectspace.rb +0 -98
  85. data/test-unit/test/run-test.rb +0 -13
  86. data/test-unit/test/test_assertions.rb +0 -693
  87. data/test-unit/test/test_attribute.rb +0 -86
  88. data/test-unit/test/test_color.rb +0 -37
  89. data/test-unit/test/test_diff.rb +0 -477
  90. data/test-unit/test/test_emacs_runner.rb +0 -60
  91. data/test-unit/test/test_error.rb +0 -26
  92. data/test-unit/test/test_failure.rb +0 -33
  93. data/test-unit/test/test_fixture.rb +0 -252
  94. data/test-unit/test/test_notification.rb +0 -33
  95. data/test-unit/test/test_omission.rb +0 -81
  96. data/test-unit/test/test_pending.rb +0 -70
  97. data/test-unit/test/test_priority.rb +0 -89
  98. data/test-unit/test/test_testcase.rb +0 -430
  99. data/test-unit/test/test_testresult.rb +0 -113
  100. data/test-unit/test/test_testsuite.rb +0 -129
  101. data/test-unit/test/testunit_test_util.rb +0 -14
  102. data/test-unit/test/ui/test_testrunmediator.rb +0 -20
  103. data/test-unit/test/util/test_backtracefilter.rb +0 -41
  104. data/test-unit/test/util/test_observable.rb +0 -102
  105. data/test-unit/test/util/test_procwrapper.rb +0 -36
  106. data/test/test_pkg_config.rb +0 -123
@@ -1,313 +0,0 @@
1
- # Copyright 2008-2009 Kouhei Sutou <kou@cozmixng.org>
2
- # This file is made available under the same terms as Ruby.
3
-
4
- require "rbconfig"
5
-
6
- require 'mkmf'
7
- require 'shellwords'
8
- require 'English'
9
- require 'pathname'
10
-
11
- class PackageConfig
12
- attr_accessor :msvc_syntax
13
- def initialize(name, path=nil, msvc_syntax=false)
14
- @name = name
15
- @path = path || ENV["PKG_CONFIG_PATH"]
16
- @path = [@path, guess_default_path].compact.join(separator)
17
- @msvc_syntax = msvc_syntax
18
- @variables = @declarations = nil
19
- override_variables = with_config("override-variables", "")
20
- @override_variables = parse_override_variables(override_variables)
21
- end
22
-
23
- def exist?
24
- not pc.nil?
25
- end
26
-
27
- def requires
28
- parse_requires(declaration("Requires"))
29
- end
30
-
31
- def requires_private
32
- parse_requires(declaration("Requires.private"))
33
- end
34
-
35
- def cflags
36
- path_flags, other_flags = collect_cflags
37
- (other_flags + path_flags).join(" ")
38
- end
39
-
40
- def cflags_only_I
41
- collect_cflags[0].join(" ")
42
- end
43
-
44
- def libs
45
- path_flags, other_flags = collect_libs
46
- (other_flags + path_flags).join(" ")
47
- end
48
-
49
- def libs_only_l
50
- collect_libs[1].find_all do |arg|
51
- if @msvc_syntax
52
- /\.lib\z/ =~ arg
53
- else
54
- /\A-l/ =~ arg
55
- end
56
- end.join(" ")
57
- end
58
-
59
- def version
60
- declaration("Version")
61
- end
62
-
63
- def variable(name)
64
- parse_pc if @variables.nil?
65
- expand_value(@override_variables[name] || @variables[name])
66
- end
67
-
68
- def declaration(name)
69
- parse_pc if @declarations.nil?
70
- expand_value(@declarations[name])
71
- end
72
-
73
- private
74
- def pc
75
- @path.split(separator).each do |path|
76
- pc_name = File.join(path, "#{@name}.pc")
77
- return pc_name if File.exist?(pc_name)
78
- end
79
- return nil
80
- end
81
-
82
- def separator
83
- File.expand_path(".").index(":") ? ";" : ":"
84
- end
85
-
86
- def collect_cflags
87
- all_cflags = (requires_private + requires.reverse).collect do |package|
88
- self.class.new(package, @path, @msvc_syntax).cflags
89
- end
90
- all_cflags = [declaration("Cflags")] + all_cflags
91
- all_cflags = all_cflags.join(" ").gsub(/-I /, '-I').split.uniq
92
- path_flags, other_flags = all_cflags.partition {|flag| /\A-I/ =~ flag}
93
- path_flags = path_flags.reject do |flag|
94
- flag == "-I/usr/include"
95
- end
96
- if @msvc_syntax
97
- path_flags = path_flags.collect do |flag|
98
- flag.gsub(/\A-I/, "/I")
99
- end
100
- end
101
- [path_flags, other_flags]
102
- end
103
-
104
- def collect_libs
105
- all_libs = requires.collect do |package|
106
- self.class.new(package, @path, @msvc_syntax).libs
107
- end
108
- all_libs = [declaration("Libs")] + all_libs
109
- all_libs = all_libs.join(" ").gsub(/-([Ll]) /, '\1').split.uniq
110
- path_flags, other_flags = all_libs.partition {|flag| /\A-L/ =~ flag}
111
- path_flags = path_flags.reject do |flag|
112
- /\A-L\/usr\/lib(?:64)?\z/ =~ flag
113
- end
114
- if @msvc_syntax
115
- path_flags = path_flags.collect do |flag|
116
- flag.gsub(/\A-L/, "/libpath:")
117
- end
118
- other_flags = other_flags.collect do |flag|
119
- if /\A-l/ =~ flag
120
- "#{$POSTMATCH}.lib"
121
- else
122
- flag
123
- end
124
- end
125
- end
126
- [path_flags, other_flags]
127
- end
128
-
129
- IDENTIFIER_RE = /[\w\d_.]+/
130
- def parse_pc
131
- raise ".pc for #{@name} doesn't exist." unless exist?
132
- @variables = {}
133
- @declarations = {}
134
- File.open(pc) do |input|
135
- input.each_line do |line|
136
- line = line.gsub(/#.*/, '').strip
137
- next if line.empty?
138
- case line
139
- when /^(#{IDENTIFIER_RE})=/
140
- @variables[$1] = $POSTMATCH.strip
141
- when /^(#{IDENTIFIER_RE}):/
142
- @declarations[$1] = $POSTMATCH.strip
143
- end
144
- end
145
- end
146
- end
147
-
148
- def parse_requires(requires)
149
- return [] if requires.nil?
150
- requires_without_version = requires.gsub(/[<>]?=\s*[\d.]+\s*/, '')
151
- requires_without_version.split(/[,\s]+/)
152
- end
153
-
154
- def parse_override_variables(override_variables)
155
- variables = {}
156
- override_variables.split(",").each do |variable|
157
- name, value = variable.split("=", 2)
158
- variables[name] = value
159
- end
160
- variables
161
- end
162
-
163
- def expand_value(value)
164
- return nil if value.nil?
165
- value.gsub(/\$\{(#{IDENTIFIER_RE})\}/) do
166
- variable($1)
167
- end
168
- end
169
-
170
- def search_pkg_config_from_path(pkg_config)
171
- (ENV["PATH"] || "").split(separator).each do |path|
172
- try_pkg_config = Pathname(path) + pkg_config
173
- return try_pkg_config if try_pkg_config.exist?
174
- end
175
- nil
176
- end
177
-
178
- def search_pkg_config_by_dln_find_exe(pkg_config)
179
- begin
180
- require "dl/import"
181
- rescue LoadError
182
- return nil
183
- end
184
- dln = Module.new
185
- dln.module_eval do
186
- if DL.const_defined?(:Importer)
187
- extend DL::Importer
188
- else
189
- extend DL::Importable
190
- end
191
- begin
192
- dlload RbConfig::CONFIG["LIBRUBY"]
193
- rescue RuntimeError
194
- return nil if $!.message == "unknown error"
195
- return nil if /: image not found\z/ =~ $!.message
196
- raise
197
- rescue DL::DLError
198
- return nil
199
- end
200
- extern "const char *dln_find_exe(const char *, const char *)"
201
- end
202
- path = dln.dln_find_exe(pkg_config.to_s, nil)
203
- if path.size.zero?
204
- nil
205
- else
206
- Pathname(path.to_s)
207
- end
208
- end
209
-
210
- def guess_default_path
211
- default_path = ["/usr/local/lib64/pkgconfig",
212
- "/usr/local/lib/pkgconfig",
213
- "/usr/local/libdata/pkgconfig",
214
- "/opt/local/lib/pkgconfig",
215
- "/usr/lib64/pkgconfig",
216
- "/usr/lib/pkgconfig",
217
- "/usr/X11/lib/pkgconfig/",
218
- "/usr/share/pkgconfig"].join(separator)
219
- libdir = ENV["PKG_CONFIG_LIBDIR"]
220
- default_path = [libdir, default_path].join(separator) if libdir
221
-
222
- pkg_config = with_config("pkg-config", ENV["PKG_CONFIG"] || "pkg-config")
223
- pkg_config = Pathname.new(pkg_config)
224
- unless pkg_config.absolute?
225
- found_pkg_config = search_pkg_config_from_path(pkg_config)
226
- pkg_config = found_pkg_config if found_pkg_config
227
- end
228
- unless pkg_config.absolute?
229
- found_pkg_config = search_pkg_config_by_dln_find_exe(pkg_config)
230
- pkg_config = found_pkg_config if found_pkg_config
231
- end
232
-
233
- return default_path unless pkg_config.absolute?
234
- [(pkg_config.parent.parent + "lib" + "pkgconfig").to_s,
235
- (pkg_config.parent.parent + "libdata" + "pkgconfig").to_s,
236
- default_path].join(separator)
237
- end
238
- end
239
-
240
- module PKGConfig
241
- module_function
242
- def msvc?
243
- /mswin32/.match(RUBY_PLATFORM) and /^cl\b/.match(Config::CONFIG['CC'])
244
- end
245
-
246
- def package_config(package)
247
- PackageConfig.new(package, nil, msvc?)
248
- end
249
-
250
- def exist?(pkg)
251
- package_config(pkg).exist?
252
- end
253
-
254
- def libs(pkg)
255
- package_config(pkg).libs
256
- end
257
-
258
- def libs_only_l(pkg)
259
- package_config(pkg).libs_only_l
260
- end
261
-
262
- def cflags(pkg)
263
- package_config(pkg).cflags
264
- end
265
-
266
- def cflags_only_I(pkg)
267
- package_config(pkg).cflags_only_I
268
- end
269
-
270
- def modversion(pkg)
271
- package_config(pkg).version
272
- end
273
-
274
- def check_version?(pkg, major = 0, minor = 0, micro = 0)
275
- return false unless exist?(pkg)
276
- ver = modversion(pkg).split(".").collect{|item| item.to_i}
277
- (0..2).each {|i| ver[i] = 0 unless ver[i]}
278
-
279
- (ver[0] > major ||
280
- (ver[0] == major && ver[1] > minor) ||
281
- (ver[0] == major && ver[1] == minor &&
282
- ver[2] >= micro))
283
- end
284
-
285
- def have_package(pkg, major = nil, minor = 0, micro = 0)
286
- if major.nil?
287
- STDOUT.print("checking for #{pkg}... ")
288
- else
289
- STDOUT.print("checking for #{pkg} version (>= #{major}.#{minor}.#{micro})... ")
290
- end
291
- major ||= 0
292
- STDOUT.flush
293
- if check_version?(pkg, major, minor, micro)
294
- STDOUT.print "yes\n"
295
- libraries = libs_only_l(pkg)
296
- dldflags = libs(pkg)
297
- dldflags = (Shellwords.shellwords(dldflags) -
298
- Shellwords.shellwords(libraries))
299
- dldflags = dldflags.map {|s| /\s/ =~ s ? "\"#{s}\"" : s }.join(' ')
300
- $libs += ' ' + libraries
301
- if /mswin32/ =~ RUBY_PLATFORM
302
- $DLDFLAGS += ' ' + dldflags
303
- else
304
- $LDFLAGS += ' ' + dldflags
305
- end
306
- $CFLAGS += ' ' + cflags(pkg)
307
- true
308
- else
309
- STDOUT.print "no\n"
310
- false
311
- end
312
- end
313
- end
@@ -1,30 +0,0 @@
1
- # -*- ruby -*-
2
-
3
- require 'rubygems'
4
- require 'hoe'
5
- require './lib/test/unit/version.rb'
6
-
7
- version = Test::Unit::VERSION
8
- ENV["VERSION"] = version
9
- Hoe.new('test-unit', version) do |p|
10
- p.developer('Kouhei Sutou', 'kou@cozmixng.org')
11
- p.developer('Ryan Davis', 'ryand-ruby@zenspider.com')
12
-
13
- # Ex-Parrot:
14
- # p.developer('Nathaniel Talbott', 'nathaniel@talbott.ws')
15
- end
16
-
17
- task :check_manifest => :clean_test_result
18
-
19
- task :clean_test_result do
20
- test_results = Dir.glob("**/.test-result")
21
- sh("rm", "-rf", *test_results) unless test_results.empty?
22
- end
23
-
24
- task :tag do
25
- message = "Released Test::Unit #{version}!"
26
- base = "svn+ssh://#{ENV['USER']}@rubyforge.org/var/svn/test-unit/"
27
- sh 'svn', 'copy', '-m', message, "#{base}trunk", "#{base}tags/#{version}"
28
- end
29
-
30
- # vim: syntax=Ruby
@@ -1,5 +0,0 @@
1
- #!/usr/bin/env ruby
2
- require 'test/unit'
3
- (r = Test::Unit::AutoRunner.new(true)).process_args(ARGV) or
4
- abort r.options.banner + " tests..."
5
- exit r.run
@@ -1,280 +0,0 @@
1
- require 'test/unit/testcase'
2
- require 'test/unit/autorunner'
3
-
4
- module Test # :nodoc:
5
- #
6
- # = Test::Unit - Ruby Unit Testing Framework
7
- #
8
- # == Introduction
9
- #
10
- # Unit testing is making waves all over the place, largely due to the
11
- # fact that it is a core practice of XP. While XP is great, unit testing
12
- # has been around for a long time and has always been a good idea. One
13
- # of the keys to good unit testing, though, is not just writing tests,
14
- # but having tests. What's the difference? Well, if you just _write_ a
15
- # test and throw it away, you have no guarantee that something won't
16
- # change later which breaks your code. If, on the other hand, you _have_
17
- # tests (obviously you have to write them first), and run them as often
18
- # as possible, you slowly build up a wall of things that cannot break
19
- # without you immediately knowing about it. This is when unit testing
20
- # hits its peak usefulness.
21
- #
22
- # Enter Test::Unit, a framework for unit testing in Ruby, helping you to
23
- # design, debug and evaluate your code by making it easy to write and
24
- # have tests for it.
25
- #
26
- #
27
- # == Notes
28
- #
29
- # Test::Unit has grown out of and superceded Lapidary.
30
- #
31
- #
32
- # == Feedback
33
- #
34
- # I like (and do my best to practice) XP, so I value early releases,
35
- # user feedback, and clean, simple, expressive code. There is always
36
- # room for improvement in everything I do, and Test::Unit is no
37
- # exception. Please, let me know what you think of Test::Unit as it
38
- # stands, and what you'd like to see expanded/changed/improved/etc. If
39
- # you find a bug, let me know ASAP; one good way to let me know what the
40
- # bug is is to submit a new test that catches it :-) Also, I'd love to
41
- # hear about any successes you have with Test::Unit, and any
42
- # documentation you might add will be greatly appreciated. My contact
43
- # info is below.
44
- #
45
- #
46
- # == Contact Information
47
- #
48
- # A lot of discussion happens about Ruby in general on the ruby-talk
49
- # mailing list (http://www.ruby-lang.org/en/ml.html), and you can ask
50
- # any questions you might have there. I monitor the list, as do many
51
- # other helpful Rubyists, and you're sure to get a quick answer. Of
52
- # course, you're also welcome to email me (Nathaniel Talbott) directly
53
- # at mailto:testunit@talbott.ws, and I'll do my best to help you out.
54
- #
55
- #
56
- # == Credits
57
- #
58
- # I'd like to thank...
59
- #
60
- # Matz, for a great language!
61
- #
62
- # Masaki Suketa, for his work on RubyUnit, which filled a vital need in
63
- # the Ruby world for a very long time. I'm also grateful for his help in
64
- # polishing Test::Unit and getting the RubyUnit compatibility layer
65
- # right. His graciousness in allowing Test::Unit to supercede RubyUnit
66
- # continues to be a challenge to me to be more willing to defer my own
67
- # rights.
68
- #
69
- # Ken McKinlay, for his interest and work on unit testing, and for his
70
- # willingness to dialog about it. He was also a great help in pointing
71
- # out some of the holes in the RubyUnit compatibility layer.
72
- #
73
- # Dave Thomas, for the original idea that led to the extremely simple
74
- # "require 'test/unit'", plus his code to improve it even more by
75
- # allowing the selection of tests from the command-line. Also, without
76
- # RDoc, the documentation for Test::Unit would stink a lot more than it
77
- # does now.
78
- #
79
- # Everyone who's helped out with bug reports, feature ideas,
80
- # encouragement to continue, etc. It's a real privilege to be a part of
81
- # the Ruby community.
82
- #
83
- # The guys at RoleModel Software, for putting up with me repeating, "But
84
- # this would be so much easier in Ruby!" whenever we're coding in Java.
85
- #
86
- # My Creator, for giving me life, and giving it more abundantly.
87
- #
88
- #
89
- # == License
90
- #
91
- # Test::Unit is copyright (c) 2000-2003 Nathaniel Talbott. It is free
92
- # software, and is distributed under the Ruby license. See the COPYING
93
- # file in the standard Ruby distribution for details.
94
- #
95
- #
96
- # == Warranty
97
- #
98
- # This software is provided "as is" and without any express or
99
- # implied warranties, including, without limitation, the implied
100
- # warranties of merchantibility and fitness for a particular
101
- # purpose.
102
- #
103
- #
104
- # == Author
105
- #
106
- # Nathaniel Talbott.
107
- # Copyright (c) 2000-2003, Nathaniel Talbott
108
- #
109
- # ----
110
- #
111
- # = Usage
112
- #
113
- # The general idea behind unit testing is that you write a _test_
114
- # _method_ that makes certain _assertions_ about your code, working
115
- # against a _test_ _fixture_. A bunch of these _test_ _methods_ are
116
- # bundled up into a _test_ _suite_ and can be run any time the
117
- # developer wants. The results of a run are gathered in a _test_
118
- # _result_ and displayed to the user through some UI. So, lets break
119
- # this down and see how Test::Unit provides each of these necessary
120
- # pieces.
121
- #
122
- #
123
- # == Assertions
124
- #
125
- # These are the heart of the framework. Think of an assertion as a
126
- # statement of expected outcome, i.e. "I assert that x should be equal
127
- # to y". If, when the assertion is executed, it turns out to be
128
- # correct, nothing happens, and life is good. If, on the other hand,
129
- # your assertion turns out to be false, an error is propagated with
130
- # pertinent information so that you can go back and make your
131
- # assertion succeed, and, once again, life is good. For an explanation
132
- # of the current assertions, see Test::Unit::Assertions.
133
- #
134
- #
135
- # == Test Method & Test Fixture
136
- #
137
- # Obviously, these assertions have to be called within a context that
138
- # knows about them and can do something meaningful with their
139
- # pass/fail value. Also, it's handy to collect a bunch of related
140
- # tests, each test represented by a method, into a common test class
141
- # that knows how to run them. The tests will be in a separate class
142
- # from the code they're testing for a couple of reasons. First of all,
143
- # it allows your code to stay uncluttered with test code, making it
144
- # easier to maintain. Second, it allows the tests to be stripped out
145
- # for deployment, since they're really there for you, the developer,
146
- # and your users don't need them. Third, and most importantly, it
147
- # allows you to set up a common test fixture for your tests to run
148
- # against.
149
- #
150
- # What's a test fixture? Well, tests do not live in a vacuum; rather,
151
- # they're run against the code they are testing. Often, a collection
152
- # of tests will run against a common set of data, also called a
153
- # fixture. If they're all bundled into the same test class, they can
154
- # all share the setting up and tearing down of that data, eliminating
155
- # unnecessary duplication and making it much easier to add related
156
- # tests.
157
- #
158
- # Test::Unit::TestCase wraps up a collection of test methods together
159
- # and allows you to easily set up and tear down the same test fixture
160
- # for each test. This is done by overriding #setup and/or #teardown,
161
- # which will be called before and after each test method that is
162
- # run. The TestCase also knows how to collect the results of your
163
- # assertions into a Test::Unit::TestResult, which can then be reported
164
- # back to you... but I'm getting ahead of myself. To write a test,
165
- # follow these steps:
166
- #
167
- # * Make sure Test::Unit is in your library path.
168
- # * require 'test/unit' in your test script.
169
- # * Create a class that subclasses Test::Unit::TestCase.
170
- # * Add a method that begins with "test" to your class.
171
- # * Make assertions in your test method.
172
- # * Optionally define #setup and/or #teardown to set up and/or tear
173
- # down your common test fixture.
174
- # * You can now run your test as you would any other Ruby
175
- # script... try it and see!
176
- #
177
- # A really simple test might look like this (#setup and #teardown are
178
- # commented out to indicate that they are completely optional):
179
- #
180
- # require 'test/unit'
181
- #
182
- # class TC_MyTest < Test::Unit::TestCase
183
- # # def setup
184
- # # end
185
- #
186
- # # def teardown
187
- # # end
188
- #
189
- # def test_fail
190
- # assert(false, 'Assertion was false.')
191
- # end
192
- # end
193
- #
194
- #
195
- # == Test Runners
196
- #
197
- # So, now you have this great test class, but you still need a way to
198
- # run it and view any failures that occur during the run. This is
199
- # where Test::Unit::UI::Console::TestRunner (and others, such as
200
- # Test::Unit::UI::GTK::TestRunner) comes into play. The console test
201
- # runner is automatically invoked for you if you require 'test/unit'
202
- # and simply run the file. To use another runner, or to manually
203
- # invoke a runner, simply call its run class method and pass in an
204
- # object that responds to the suite message with a
205
- # Test::Unit::TestSuite. This can be as simple as passing in your
206
- # TestCase class (which has a class suite method). It might look
207
- # something like this:
208
- #
209
- # require 'test/unit/ui/console/testrunner'
210
- # Test::Unit::UI::Console::TestRunner.run(TC_MyTest)
211
- #
212
- #
213
- # == Test Suite
214
- #
215
- # As more and more unit tests accumulate for a given project, it
216
- # becomes a real drag running them one at a time, and it also
217
- # introduces the potential to overlook a failing test because you
218
- # forget to run it. Suddenly it becomes very handy that the
219
- # TestRunners can take any object that returns a Test::Unit::TestSuite
220
- # in response to a suite method. The TestSuite can, in turn, contain
221
- # other TestSuites or individual tests (typically created by a
222
- # TestCase). In other words, you can easily wrap up a group of
223
- # TestCases and TestSuites like this:
224
- #
225
- # require 'test/unit/testsuite'
226
- # require 'tc_myfirsttests'
227
- # require 'tc_moretestsbyme'
228
- # require 'ts_anothersetoftests'
229
- #
230
- # class TS_MyTests
231
- # def self.suite
232
- # suite = Test::Unit::TestSuite.new
233
- # suite << TC_MyFirstTests.suite
234
- # suite << TC_MoreTestsByMe.suite
235
- # suite << TS_AnotherSetOfTests.suite
236
- # return suite
237
- # end
238
- # end
239
- # Test::Unit::UI::Console::TestRunner.run(TS_MyTests)
240
- #
241
- # Now, this is a bit cumbersome, so Test::Unit does a little bit more
242
- # for you, by wrapping these up automatically when you require
243
- # 'test/unit'. What does this mean? It means you could write the above
244
- # test case like this instead:
245
- #
246
- # require 'test/unit'
247
- # require 'tc_myfirsttests'
248
- # require 'tc_moretestsbyme'
249
- # require 'ts_anothersetoftests'
250
- #
251
- # Test::Unit is smart enough to find all the test cases existing in
252
- # the ObjectSpace and wrap them up into a suite for you. It then runs
253
- # the dynamic suite using the console TestRunner.
254
- #
255
- #
256
- # == Questions?
257
- #
258
- # I'd really like to get feedback from all levels of Ruby
259
- # practitioners about typos, grammatical errors, unclear statements,
260
- # missing points, etc., in this document (or any other).
261
- #
262
-
263
- module Unit
264
- # If set to false Test::Unit will not automatically run at exit.
265
- def self.run=(flag)
266
- @run = flag
267
- end
268
-
269
- # Automatically run tests at exit?
270
- def self.run?
271
- @run ||= false
272
- end
273
- end
274
- end
275
-
276
- at_exit do
277
- unless $! || Test::Unit.run?
278
- exit Test::Unit::AutoRunner.run
279
- end
280
- end