public
Description: Webrat - Ruby Acceptance Testing for Web applications
Homepage: http://gitrdoc.com/brynary/webrat/tree/master/
Clone URL: git://github.com/brynary/webrat.git
webrat / lib / webrat / core / elements / field.rb
100644 412 lines (322 sloc) 8.718 kb
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
require "cgi"
require "webrat/core_extensions/blank"
require "webrat/core_extensions/nil_to_param"
 
require "webrat/core/elements/element"
 
module Webrat
  # Raised when Webrat is asked to manipulate a disabled form field
  class DisabledFieldError < WebratError
  end
 
  class Field < Element #:nodoc:
    attr_reader :value
 
    def self.xpath_search
      [".//button", ".//input", ".//textarea", ".//select"]
    end
 
    def self.xpath_search_excluding_hidden
      [".//button", ".//input[ @type != 'hidden']", ".//textarea", ".//select"]
    end
 
    def self.field_classes
      @field_classes || []
    end
 
    def self.inherited(klass)
      @field_classes ||= []
      @field_classes << klass
      # raise args.inspect
    end
 
    def self.load(session, element)
      return nil if element.nil?
      session.elements[Webrat::XML.xpath_to(element)] ||= field_class(element).new(session, element)
    end
 
    def self.field_class(element)
      case element.name
      when "button" then ButtonField
      when "select" then SelectField
      when "textarea" then TextareaField
      else
        case Webrat::XML.attribute(element, "type")
        when "checkbox" then CheckboxField
        when "hidden" then HiddenField
        when "radio" then RadioField
        when "password" then PasswordField
        when "file" then FileField
        when "reset" then ResetField
        when "submit" then ButtonField
        when "button" then ButtonField
        when "image" then ButtonField
        else TextField
        end
      end
    end
 
    def initialize(*args)
      super
      @value = default_value
    end
 
    def label_text
      return nil if labels.empty?
      labels.first.text
    end
 
    def id
      Webrat::XML.attribute(@element, "id")
    end
 
    def disabled?
      @element.attributes.has_key?("disabled") && Webrat::XML.attribute(@element, "disabled") != 'false'
    end
 
    def raise_error_if_disabled
      return unless disabled?
      raise DisabledFieldError.new("Cannot interact with disabled form element (#{self})")
    end
 
    def to_param
      return nil if disabled?
 
      case Webrat.configuration.mode
      when :rails
        parse_rails_request_params("#{name}=#{escaped_value}")
      when :merb
        ::Merb::Parse.query("#{name}=#{escaped_value}")
      when :mechanize
        { name => value }
      else
        { name => escaped_value }
      end
    end
 
    def set(value)
      @value = value
    end
 
    def unset
      @value = default_value
    end
 
  protected
 
    def parse_rails_request_params(params)
      if defined?(ActionController::AbstractRequest)
        ActionController::AbstractRequest.parse_query_parameters(params)
      elsif defined?(ActionController::UrlEncodedPairParser)
        # For Rails > 2.2
        ActionController::UrlEncodedPairParser.parse_query_parameters(params)
      else
        # For Rails > 2.3
        Rack::Utils.parse_nested_query(params)
      end
    end
 
    def form
      Form.load(@session, form_element)
    end
 
    def form_element
      parent = @element.parent
 
      while parent.respond_to?(:parent)
        return parent if parent.name == 'form'
        parent = parent.parent
      end
    end
 
    def name
      Webrat::XML.attribute(@element, "name")
    end
 
    def escaped_value
      CGI.escape([*@value].first.to_s)
    end
 
    def labels
      @labels ||= label_elements.map do |element|
        Label.load(@session, element)
      end
    end
 
    def label_elements
      return @label_elements unless @label_elements.nil?
      @label_elements = []
 
      parent = @element.parent
      while parent.respond_to?(:parent)
        if parent.name == 'label'
          @label_elements.push parent
          break
        end
        parent = parent.parent
      end
 
      unless id.blank?
        @label_elements += Webrat::XML.xpath_search(form.element, ".//label[@for = '#{id}']")
      end
 
      @label_elements
    end
 
    def default_value
      Webrat::XML.attribute(@element, "value")
    end
 
    def replace_param_value(params, oval, nval)
      output = Hash.new
      params.each do |key, value|
        case value
        when Hash
          value = replace_param_value(value, oval, nval)
        when Array
          value = value.map { |o| o == oval ? nval : oval }
        when oval
          value = nval
        end
        output[key] = value
      end
      output
    end
  end
 
  class ButtonField < Field #:nodoc:
 
    def self.xpath_search
      [".//button", ".//input[@type = 'submit']", ".//input[@type = 'button']", ".//input[@type = 'image']"]
    end
 
    def to_param
      return nil if @value.nil?
      super
    end
 
    def default_value
      nil
    end
 
    def click
      raise_error_if_disabled
      set(Webrat::XML.attribute(@element, "value")) unless Webrat::XML.attribute(@element, "name").blank?
      form.submit
    end
 
  end
 
  class HiddenField < Field #:nodoc:
 
    def self.xpath_search
      ".//input[@type = 'hidden']"
    end
 
    def to_param
      if collection_name?
        super
      else
        checkbox_with_same_name = form.field_named(name, CheckboxField)
 
        if checkbox_with_same_name.to_param.blank?
          super
        else
          nil
        end
      end
    end
 
  protected
 
    def collection_name?
      name =~ /\[\]/
    end
 
  end
 
  class CheckboxField < Field #:nodoc:
 
    def self.xpath_search
      ".//input[@type = 'checkbox']"
    end
 
    def to_param
      return nil if @value.nil?
      super
    end
 
    def check
      raise_error_if_disabled
      set(Webrat::XML.attribute(@element, "value") || "on")
    end
 
    def checked?
      Webrat::XML.attribute(@element, "checked") == "checked"
    end
 
    def uncheck
      raise_error_if_disabled
      set(nil)
    end
 
  protected
 
    def default_value
      if Webrat::XML.attribute(@element, "checked") == "checked"
        Webrat::XML.attribute(@element, "value") || "on"
      else
        nil
      end
    end
 
  end
 
  class PasswordField < Field #:nodoc:
 
    def self.xpath_search
      ".//input[@type = 'password']"
    end
 
  end
 
  class RadioField < Field #:nodoc:
 
    def self.xpath_search
      ".//input[@type = 'radio']"
    end
 
    def to_param
      return nil if @value.nil?
      super
    end
 
    def choose
      raise_error_if_disabled
      other_options.each do |option|
        option.set(nil)
      end
 
      set(Webrat::XML.attribute(@element, "value") || "on")
    end
 
    def checked?
      Webrat::XML.attribute(@element, "checked") == "checked"
    end
 
  protected
 
    def other_options
      form.fields.select { |f| f.name == name }
    end
 
    def default_value
      if Webrat::XML.attribute(@element, "checked") == "checked"
        Webrat::XML.attribute(@element, "value") || "on"
      else
        nil
      end
    end
 
  end
 
  class TextareaField < Field #:nodoc:
 
    def self.xpath_search
      ".//textarea"
    end
 
  protected
 
    def default_value
      Webrat::XML.inner_html(@element)
    end
 
  end
 
  class FileField < Field #:nodoc:
 
    def self.xpath_search
      ".//input[@type = 'file']"
    end
 
    attr_accessor :content_type
 
    def set(value, content_type = nil)
      super(value)
      @content_type = content_type
    end
 
    def to_param
      if @value.nil?
        super
      else
        replace_param_value(super, @value, test_uploaded_file)
      end
    end
 
  protected
 
    def test_uploaded_file
      case Webrat.configuration.mode
      when :rails
        if content_type
          ActionController::TestUploadedFile.new(@value, content_type)
        else
          ActionController::TestUploadedFile.new(@value)
        end
      when :merb
        # TODO: support content_type
        File.new(@value)
      end
    end
 
  end
 
  class TextField < Field #:nodoc:
    def self.xpath_search
      [".//input[@type = 'text']", ".//input[not(@type)]"]
    end
  end
 
  class ResetField < Field #:nodoc:
    def self.xpath_search
      ".//input[@type = 'reset']"
    end
  end
 
  class SelectField < Field #:nodoc:
 
    def self.xpath_search
      ".//select"
    end
 
    def options
      @options ||= SelectOption.load_all(@session, @element)
    end
 
  protected
 
    def default_value
      selected_options = Webrat::XML.xpath_search(@element, ".//option[@selected = 'selected']")
      selected_options = Webrat::XML.xpath_search(@element, ".//option[position() = 1]") if selected_options.empty?
 
      selected_options.map do |option|
        return "" if option.nil?
        Webrat::XML.attribute(option, "value") || Webrat::XML.inner_html(option)
      end.uniq
    end
 
  end
end