Module: SiteObject

Includes:
SiteObjectExceptions
Defined in:
lib/site-object/site.rb,
lib/site-object/version.rb

Overview

Usage:

require 'site-object'
class MySite
  include SiteObject
end

Constant Summary collapse

VERSION = 
'0.3.0'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object

In cases where the site object doesn’t recognize a method it will try to delegate the method call to the page that’s currently being displayed in the browser, assuming that the site object recognizes the page by its URL. If the page is the last visited page and method is unique, (i.e., doesn’t belong to any other page object) then the site object won’t attempt to regenerate the page when calling the method.



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
 
# File 'lib/site-object/site.rb', line 124

def method_missing(sym, *args, &block)
  if @unique_methods.include?(sym) && @most_recent_page.respond_to?(sym)
    if args && block
      @most_recent_page.send(sym, *args, &block)
    elsif args
      @most_recent_page.send(sym, *args)
    elsif block
      @most_recent_page.send(sym, &block)
    else
      @most_recent_page.send sym
    end
  elsif p = page
    if p.respond_to?(sym)
      if args && block
         p.send(sym, *args, &block)
      elsif args
        p.send(sym, *args)
      elsif block
        p.send(sym, &block)
      else
        p.send sym
      end
    else
      super
    end
  else
    super
  end
end

Instance Attribute Details

#arguments ⇒ Object

Returns the value of attribute arguments.



8
9
10
 
# File 'lib/site-object/site.rb', line 8

def arguments
  @arguments
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



7
8
9
 
# File 'lib/site-object/site.rb', line 7

def base_url
  @base_url
end

#browser ⇒ Object

Returns the value of attribute browser.



8
9
10
 
# File 'lib/site-object/site.rb', line 8

def browser
  @browser
end

#most_recent_page ⇒ Object

Returns the value of attribute most_recent_page.



8
9
10
 
# File 'lib/site-object/site.rb', line 8

def most_recent_page
  @most_recent_page
end

#pages ⇒ Object

Returns the value of attribute pages.



8
9
10
 
# File 'lib/site-object/site.rb', line 8

def pages
  @pages
end

#unique_methods ⇒ Object (readonly)

Returns the value of attribute unique_methods.



7
8
9
 
# File 'lib/site-object/site.rb', line 7

def unique_methods
  @unique_methods
end

Class Method Details

.included(base) ⇒ Object

Sets up a Page class when the SiteObject module is included in the class you’re using to model your site.



14
15
16
17
18
19
 
# File 'lib/site-object/site.rb', line 14

def self.included(base)
  klass = Class.new
  base.const_set('Page', klass)
  base::Page.send(:extend,  PageObject::PageClassMethods)
  base::Page.send(:include, PageObject::PageInstanceMethods)
end

Instance Method Details

#close_browser ⇒ Object

Closes the site object’s browser



22
23
24
 
# File 'lib/site-object/site.rb', line 22

def close_browser
  @browser.close # Same for watir-webdriver and selenium-webdriver.
end

#expect_page(page_arg) ⇒ Object

Helper method designed to assist with complex workflows. Basically, if you’re navigating and expect a certain page to be displayed you can use this method to confirm that the page you want is displayed and then get a page object for it.

This method just checks to see if the right class of page is being displayed. If you have defined a templated value in the URL of the page object getting checked it doesn’t check the values of the arguments. It only confirms whether or not the arguments are present.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/site-object/site.rb', line 33

def expect_page(page_arg)
  p = page

  if p
    if p.class.name == page_arg.class.name  # Do this if it looks like an instance of a page.
      return p
    elsif p.class == page_arg               # Do this if it looks like a page class name.
      return p
    elsif page_arg.is_a?(Symbol) && p.class.name.underscore.to_sym == page_arg
      return p
    else
      raise SiteObject::WrongPageError, "Expected #{page_arg} page to be displayed but the URL doesn't look right. \n\n#{caller.join("\n")}"
    end
  else
    raise SiteObject::WrongPageError, "Expected #{page_arg} page to be displayed but the URL doesn't appear to match the URL template of any known page. \n\n#{caller.join("\n")}"
  end
end

#initialize(args = {}) ⇒ Object

Creates a site object, which will have accessor methods for all pages that have been defined for the site. This object takes a hash argument. There is only one required value (the base_url for the site.) Example:

class MySite
  include SiteObject
end

site = MySite.new(base_url: "http://foo.com")

You can also specify any other arguments that you want for later use:

site = MySite.new(
  base_url: "http://foo.com",
  foo:      true
  bar:      1
)
site.foo
=> true
site.bar
=> 1



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
 
# File 'lib/site-object/site.rb', line 72

def initialize(args={})
  unless args.is_a?(Hash)
    raise SiteObject::SiteInitError, "You must provide hash arguments when initializing a site object. At a minimum you must specify a base_url. Example:\ns = SiteObject.new(base_url: 'http://foo.com')"
  end

  @arguments   = args.with_indifferent_access
  @base_url    = @arguments[:base_url]
  @browser     = @arguments[:browser]
  @pages       = self.class::Page.descendants

  # Set up accessor methods for each page and page checking methods..
  @pages.each do |current_page|
    current_page.set_url_template(@base_url)

    if current_page.url_matcher
      unless current_page.url_matcher.is_a? Regexp
        raise SiteObject::PageConfigError, "A url_matcher was defined for the #{current_page} page but it was not a regular expression. Check the value provided to the set_url_matcher method in the class definition for this page. Object provided was a #{current_page.url_matcher.class.name}"
      end
    end

    self.class.class_eval do
      define_method(current_page.to_s.underscore) do |args={}, block=nil|
        current_page.new(self, args)
      end

      define_method("#{current_page.to_s.underscore}?") do
        on_page? current_page
      end
    end
  end

  visited = Set.new
  tmp = @pages.map {|p| p.instance_methods }.flatten
  tmp.each do |element|
    if visited.include?(element)
     else
      visited << element
    end
  end
  @unique_methods = visited
end

#inspect ⇒ Object

Custom inspect method so that console output doesn’t get in the way when debugging.



115
116
117
 
# File 'lib/site-object/site.rb', line 115

def inspect
  "#<#{self.class.name}:0x#{object_id}\n @base_url=\"#{@base_url}\"\n @most_recent_page=#{@most_recent_page}>"
end

#on_page?(page_arg) ⇒ Boolean

Returns true or false depending on whether the specified page is displayed. You can use a page object or a PageObject class name to identify the page you are looking for. Examples:

page = site.
=>#<AccountSummaryPage:70341126478080 ...>
site.on_page? page
=>true

site.on_page? AccountSummaryPage
=>true

Returns:

  • (Boolean) 


164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/site-object/site.rb', line 164

def on_page?(page_arg)
  url = @browser.url

  if page_arg.url_matcher && page_arg.url_matcher =~ url
    return true
  elsif page_arg.url_template.match url
    return true
  else
    return false
  end
end

#open_browser(platform, browser_type, args = {}) ⇒ Object

Can be used to open a browser for the site object if the user did not pass one in when it was initialized. The arguments used here get passed down to Watir when starting the browser. Example:

s = SomeSite.new(hash)
s.open_browser :watir, :firefox



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/site-object/site.rb', line 180

def open_browser(platform, browser_type, args={})
  case platform
  when :watir
    @browser = Watir::Browser.new(browser_type, args)
  when :selenium
    @browser = Selenium::WebDriver::Driver.for(browser_type, args)
  else
    raise ArgumentError "Platform argument must be either :watir or :selenium."
  end
end

#page ⇒ Object

Looks at the page currently being displayed in the browser and tries to return a page object for it. Does this by looking at the currently displayed URL in the browser. The first page that gets checked is the page that was most recently accessed. After that it will cycle through all available pages looking for a match. Returns nil if it can’t find a matching page object.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/site-object/site.rb', line 195

def page
  return @most_recent_page if @most_recent_page && @most_recent_page.on_page?

  url = @browser.url
  found_page = nil

  @pages.each do |p|
    if p.url_template.match url
      found_page = p
    elsif p.url_matcher && p.url_matcher =~ url
      found_page = p
    end

    break if found_page
  end

  if found_page && !found_page.required_arguments.empty?
    return found_page.new(self, found_page.url_template.extract(url))
  elsif found_page
    return found_page.new(self)
  else
    return nil
  end
end