File: fixture.rb

package info (click to toggle)
ruby-test-unit 3.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 928 kB
  • ctags: 1,759
  • sloc: ruby: 12,818; makefile: 6
file content (227 lines) | stat: -rw-r--r-- 7,497 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
module Test
  module Unit
    module Fixture
      class << self
        def included(base)
          base.extend(ClassMethods)

          [:setup, :cleanup, :teardown].each do |fixture|
            observer = lambda do |test_case, _, _, value, callback|
              if value.nil?
                test_case.send("unregister_#{fixture}_callback", callback)
              else
                test_case.send("register_#{fixture}_callback", callback, value)
              end
            end
            base.register_attribute_observer(fixture, &observer)
          end
        end
      end

      module ClassMethods
        def setup(*method_names, &callback)
          register_fixture(:setup, *method_names, &callback)
        end

        def unregister_setup(*method_names_or_callbacks)
          unregister_fixture(:setup, *method_names_or_callbacks)
        end

        def cleanup(*method_names, &callback)
          register_fixture(:cleanup, *method_names, &callback)
        end

        def unregister_cleanup(*method_names_or_callbacks)
          unregister_fixture(:cleanup, *method_names_or_callbacks)
        end

        def teardown(*method_names, &callback)
          register_fixture(:teardown, *method_names, &callback)
        end

        def unregister_teardown(*method_names_or_callbacks)
          unregister_fixture(:teardown, *method_names_or_callbacks)
        end

        def register_setup_callback(method_name_or_callback, options)
          register_fixture_callback(:setup, method_name_or_callback,
                                    options, :after, :append)
        end

        def unregister_setup_callback(method_name_or_callback)
          unregister_fixture_callback(:setup, method_name_or_callback)
        end

        def register_cleanup_callback(method_name_or_callback, options)
          register_fixture_callback(:cleanup, method_name_or_callback,
                                    options, :before, :prepend)
        end

        def unregister_cleanup_callback(method_name_or_callback)
          unregister_fixture_callback(:cleanup, method_name_or_callback)
        end

        def register_teardown_callback(method_name_or_callback, options)
          register_fixture_callback(:teardown, method_name_or_callback,
                                    options, :before, :prepend)
        end

        def unregister_teardown_callback(method_name_or_callback)
          unregister_fixture_callback(:teardown, method_name_or_callback)
        end

        def before_setup_callbacks
          collect_fixture_callbacks(:setup, :before)
        end

        def after_setup_callbacks
          collect_fixture_callbacks(:setup, :after)
        end

        def before_cleanup_callbacks
          collect_fixture_callbacks(:cleanup, :before)
        end

        def after_cleanup_callbacks
          collect_fixture_callbacks(:cleanup, :after)
        end

        def before_teardown_callbacks
          collect_fixture_callbacks(:teardown, :before)
        end

        def after_teardown_callbacks
          collect_fixture_callbacks(:teardown, :after)
        end

        private
        def register_fixture(fixture, *method_names, &callback)
          options = {}
          options = method_names.pop if method_names.last.is_a?(Hash)
          callbacks = method_names
          callbacks << callback if callback
          attribute(fixture, options, *callbacks)
        end

        def unregister_fixture(fixture, *method_names_or_callbacks)
          attribute(fixture, nil, *method_names_or_callbacks)
        end

        def valid_register_fixture_options?(options)
          return true if options.empty?
          return false if options.size > 1

          key = options.keys.first
          [:before, :after].include?(key) and
            [:prepend, :append].include?(options[key])
        end

        def add_fixture_callback(how, variable_name, method_name_or_callback)
          callbacks = instance_eval("#{variable_name} ||= []")

          if how == :prepend
            callbacks = [method_name_or_callback] | callbacks
          else
            callbacks = callbacks | [method_name_or_callback]
          end
          instance_variable_set(variable_name, callbacks)
        end

        def registered_callbacks_variable_name(fixture, order)
          "@#{order}_#{fixture}_callbacks"
        end

        def unregistered_callbacks_variable_name(fixture)
          "@unregistered_#{fixture}_callbacks"
        end

        def register_fixture_callback(fixture, method_name_or_callback, options,
                                      default_order, default_how)
          unless valid_register_fixture_options?(options)
            message = "must be {:before => :prepend}, " +
              "{:before => :append}, {:after => :prepend} or " +
              "{:after => :append}: #{options.inspect}"
            raise ArgumentError, message
          end

          if options.empty?
            order, how = default_order, default_how
          else
            order, how = options.to_a.first
          end
          variable_name = registered_callbacks_variable_name(fixture, order)
          add_fixture_callback(how, variable_name, method_name_or_callback)
        end

        def unregister_fixture_callback(fixture, method_name_or_callback)
          variable_name = unregistered_callbacks_variable_name(fixture)
          add_fixture_callback(:append, variable_name, method_name_or_callback)
        end

        def collect_fixture_callbacks(fixture, order)
          callbacks_variable = registered_callbacks_variable_name(fixture, order)
          unregistered_callbacks_variable =
            unregistered_callbacks_variable_name(fixture)

          base_index = ancestors.index(Fixture)
          interested_ancestors = ancestors[0, base_index].reverse
          interested_ancestors.inject([]) do |result, ancestor|
            if ancestor.is_a?(Class)
              ancestor.class_eval do
                callbacks = instance_eval("#{callbacks_variable} ||= []")
                unregistered_callbacks =
                  instance_eval("#{unregistered_callbacks_variable} ||= []")
                (result | callbacks) - unregistered_callbacks
              end
            else
              result
            end
          end
        end
      end

      private
      def run_fixture(fixture, options={})
        [
         self.class.send("before_#{fixture}_callbacks"),
         fixture,
         self.class.send("after_#{fixture}_callbacks")
        ].flatten.each do |method_name_or_callback|
          run_fixture_callback(method_name_or_callback, options)
        end
      end

      def run_fixture_callback(method_name_or_callback, options)
        if method_name_or_callback.respond_to?(:call)
          callback = lambda do
            instance_eval(&method_name_or_callback)
          end
        else
          return unless respond_to?(method_name_or_callback, true)
          callback = lambda do
            send(method_name_or_callback)
          end
        end

        begin
          callback.call
        rescue Exception
          raise unless options[:handle_exception]
          raise unless handle_exception($!)
        end
      end

      def run_setup
        run_fixture(:setup)
      end

      def run_cleanup
        run_fixture(:cleanup)
      end

      def run_teardown
        run_fixture(:teardown, :handle_exception => true)
      end
    end
  end
end