Class: Parfait::Page

Inherits:
ParfaitArtifact show all
Defined in:
lib/parfait/page.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ParfaitArtifact

#add_check, #add_generic_present, #add_present, #check, #is_present_defined?, #present, #verify_presence

Constructor Details

#initialize(opts = {}) ⇒ Page

Create a Parfait page

Options

name

specifies the name of the page

aliases

specifies an array of aliases for the page

Example

Parfait::Page.new(
  :name => "Prescription New", 
  :aliases => ["New Prescription", "New Rx", "Rx New"]
)



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/parfait/page.rb', line 22

def initialize(opts = {})
  o = {
    :name => nil,
    :aliases => []
  }.merge(opts)

  @name = o[:name]
  raise "Parfait::Page requires a name to be defined" unless @name
  raise "Parfait::Page requires name to be a string" unless @name.is_a?(String)

  @aliases = o[:aliases]
  if @aliases
    raise "Parfait::Page requires aliases to be an array" unless @aliases.is_a?(Array)
    @aliases.each do |my_alias|
      raise "Parfait::Page requires each alias in the array to be a string" unless my_alias.is_a?(String)
    end
  end
  
  @controls = Hash.new
  @regions = Hash.new
  @page_test = nil
  super
end

Instance Attribute Details

#aliases ⇒ Object (readonly)

Returns the value of attribute aliases.



5
6
7
 
# File 'lib/parfait/page.rb', line 5

def aliases
  @aliases
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/parfait/page.rb', line 5

def name
  @name
end

Instance Method Details

#add_control(control) ⇒ Object

Add a Control to the current Page

Options

control

specifies the Control object to be added

Example

page = Parfait::Page.new(
  :name => "Prescription New", 
  :aliases => ["New Prescription", "New Rx", "Rx New"]
)
control = Parfait::Control.new(
  :name => "Prescriber Name",
  :text => "prescriber full name"
)
page.add_control(control)



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/parfait/page.rb', line 178

def add_control(control)

  if control
    if control.is_a?(Parfait::Control)
      @controls[control.name] = control
      if control.aliases
        control.aliases.each do |my_alias|
          @controls[my_alias] = control
        end
      end
    else
      raise "Control must be a Parfait::Control when being adding to a Page"
    end
  else
    raise "Control must be specified when adding a Control to an Page"
  end
  self
end

#add_navigation(&block) ⇒ Object

Method description

Options

option

specifies something

Example

$$$ Need an example $$$



235
236
237
 
# File 'lib/parfait/page.rb', line 235

def add_navigation(&block)
  @navigate_method = block
end

#add_page_test(&block) ⇒ Object

Method description

Options

option

specifies something

Example

$$$ Need an example $$$



207
208
209
 
# File 'lib/parfait/page.rb', line 207

def add_page_test(&block)
  @page_test = block
end

#add_region(region) ⇒ Object

Add a Region to the current Page

Options

region

specifies the Region object to be added

Example

myregion = Parfait::Region.new(
  :name => "User List"
)
page.add_region(myregion)



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/parfait/page.rb', line 97

def add_region(region)

  if region
    if region.is_a?(Parfait::Region)
      @regions[region.name] = region
      if region.aliases
        region.aliases.each do |my_alias|
          @regions[my_alias] = region
        end
      end
    else
      raise "Region must be a Parfait::Region when being added to a Page"
    end
  else
    raise "Region must be specified when adding a Region to a Page"
  end
  self
end

#add_to_application(application) ⇒ Object

Add this Page to an Application

If the specified application does not exist, it will be added

Options

application

specifies the Application to add this page to, either via the String name or the Parfait::Application object

Example

mypage = Parfait::Page.new(
  :name => "Edit User" 
)
mypage.add_to_application("Blogger")



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/parfait/page.rb', line 62

def add_to_application(application)

  if application
    case
    when application.is_a?(String)
      app = Parfait::Application.find(application)
      unless app
        app = Parfait::Application.new(:name => application)
      end
      app.add_page(self)
    when application.is_a?(Parfait::Application)
      application.add_page(self)
    else
      raise "Input value must be a String or an Application object when adding this Page to an Application"
    end
  else
    raise "Input value cannot be nil when when adding this Page to an Application"
  end
  self
end

#control(requested_name) ⇒ Object

Retrieve a Control object by name or alias.

Under the covers, if there is an existence directive defined for this control, it will be run on the current browser to confirm that it is indeed present.

Options

name

specifies the name or alias of the control

Example

mypage.control("User ID")



267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/parfait/page.rb', line 267

def control(requested_name)
  control = @controls[requested_name] 
  if control

    # Confirm that we are on the expected page
    verify_presence "Cannot navigate to control \"#{requested_name}\" because page presence check failed"

    return control
  else
    raise "Invalid control name requested: \"#{requested_name}\""
  end
end

#navigate(opts = {}) ⇒ Object

Method description

Options

option

specifies something

Example

$$$ Need an example $$$



249
250
251
 
# File 'lib/parfait/page.rb', line 249

def navigate(opts = {})
  @navigate_method.call(opts)
end

#page_test(&block) ⇒ Object

Method description

Options

option

specifies something

Example

$$$ Need an example $$$



221
222
223
 
# File 'lib/parfait/page.rb', line 221

def page_test(&block)
  @page_test.call()
end

#region(opts = {}) ⇒ Object

Retrieve a Region object by name or alias.

Under the covers, if there is an existence directive defined for this region, it will be run on the current browser to confirm that it is indeed present.

Options

opts

is either a hash with a key specifying the name of the region and a value

specifying the filter search value OR is a value specifying the name of the region

Example

myregion.region("User List" => username)
myregion.region("Chat Box")



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
 
# File 'lib/parfait/page.rb', line 133

def region(opts = {})
  if opts.is_a?(Hash)
    region_name = opts.first[0]
  else
    region_name = opts
  end
  region = @regions[region_name]

  if region

    # Confirm that we are on the expected page
    verify_presence "Cannot navigate to region \"#{region_name}\" because page presence check failed"

    # Apply the filter method
    if opts.is_a?(Hash)
      region.filter(opts.first[1])
    else
      region.filter(opts)
    end

    return region
  else
    raise "Invalid region name requested: \"#{opts.first[0]}\""
  end
end