site_prism 2.2 → 2.3

data/README.md

@@ -15,7 +15,7 @@ Here's an overview of how SitePrism is designed to be used:
 # define our site's pages
 
 class Home < SitePrism::Page
-  set_url "http://www.google.com"
+  set_url "/index.htm"
   set_url_matcher /google.com\/?/
 
   element :search_field, "input[name='q']"
@@ -159,10 +159,39 @@ class Home < SitePrism::Page
 end
 ```
 
+If you've set Capybara's `app_host` then you can set the URL as follows:
+
+```ruby
+class Home < SitePrism::Page
+  set_url "/home.htm"
+end
+```
+
 Note that setting a URL is optional - you only need to set a url if you want to be able to navigate
 directly to that page. It makes sense to set the URL for a page model of a home
 page or a login page, but probably not a search results page.
 
+#### Parameterized URLs
+
+SitePrism uses the Addressable gem and therefore allows for parameterized URLs. Here is
+a simple example:
+
+```ruby
+class UserProfile < SitePris::Page
+  set_url "/users{/username}"
+end
+```
+
+...and a more complex example:
+
+```ruby
+class Search < SitePris::Page
+  set_url "/search{?query*}"
+end
+```
+
+See https://github.com/sporkmonger/addressable for more details on parameterized URLs.
+
 ### Navigating to the Page
 
 Once the URL has been set (using `set_url`), you can navigate directly
@@ -173,9 +202,37 @@ to the page using `#load`:
 @home_page.load
 ```
 
+#### Navigating to a page with a parameterized URL
+
+The `#load` method takes parameters and will apply them to the URL. Using the examples above:
+
+```ruby
+class UserProfile < SitePris::Page
+  set_url "/users{/username}"
+end
+
+@user_profile = UserProfile.new
+@user_profile.load #=> /users
+@user_profile.load(username: 'bob') #=> loads /users/bob
+```
+
+...and...
+
+```ruby
+class Search < SitePris::Page
+  set_url "/search{?query*}"
+end
+
+@search = Search.new
+@search.load(query: 'simple') #=> loads /search?query=simple
+@search.load(query: {'color'=> 'red', 'text'=> 'blue'}) #=> loads /search?color=red&text=blue
+```
+
 This will tell whichever capybara driver you have configured to
 navigate to the URL set against that page's class.
 
+See https://github.com/sporkmonger/addressable for more details on parameterized URLs.
+
 ### Verifying that a particular page is displayed
 
 Automated tests often need to verify that a particular page is

data/lib/site_prism.rb

@@ -1,3 +1,4 @@
+require 'addressable/template'
 require 'site_prism/version'
 require 'site_prism/exceptions'
 require 'site_prism/element_container'

data/lib/site_prism/element_container.rb

@@ -1,6 +1,6 @@
 module SitePrism::ElementContainer
 
-  def element element_name, *find_args
+  def element(element_name, *find_args)
     build element_name, *find_args do
       define_method element_name.to_s do
         find_first *find_args
@@ -8,7 +8,7 @@ module SitePrism::ElementContainer
     end
   end
 
-  def elements collection_name, *find_args
+  def elements(collection_name, *find_args)
     build collection_name, *find_args do
       define_method collection_name.to_s do
         find_all *find_args
@@ -17,7 +17,7 @@ module SitePrism::ElementContainer
   end
   alias :collection :elements
 
-  def section section_name, section_class, *find_args
+  def section(section_name, section_class, *find_args)
     build section_name, *find_args do
       define_method section_name do
         section_class.new self, find_first(*find_args)
@@ -25,7 +25,7 @@ module SitePrism::ElementContainer
     end
   end
 
-  def sections section_collection_name, section_class, *find_args
+  def sections(section_collection_name, section_class, *find_args)
     build section_collection_name, *find_args do
       define_method section_collection_name do
         find_all(*find_args).collect do |element|
@@ -35,7 +35,7 @@ module SitePrism::ElementContainer
     end
   end
 
-  def iframe iframe_name, iframe_page_class, iframe_id
+  def iframe(iframe_name, iframe_page_class, iframe_id)
     add_to_mapped_items iframe_name
     create_existence_checker iframe_name, iframe_id
     create_waiter iframe_name, iframe_id
@@ -46,7 +46,7 @@ module SitePrism::ElementContainer
     end
   end
 
-  def add_to_mapped_items item
+  def add_to_mapped_items(item)
     @mapped_items ||= []
     @mapped_items << item.to_s
   end
@@ -57,34 +57,34 @@ module SitePrism::ElementContainer
 
   private
 
-  def build name, *find_args
+  def build(name, *find_args)
     if find_args.empty?
       create_no_selector name
     else
       add_to_mapped_items name
       yield
     end
-    add_checkers_and_waiters name, *find_args
+    add_helper_methods name, *find_args
   end
 
-  def add_checkers_and_waiters name, *find_args
+  def add_helper_methods(name, *find_args)
     create_existence_checker name, *find_args
     create_waiter name, *find_args
     create_visibility_waiter name, *find_args
     create_invisibility_waiter name, *find_args
   end
 
-  def build_checker_or_waiter element_name, proposed_method_name, *find_args
+  def create_helper_method(proposed_method_name, *find_args)
     if find_args.empty?
-      create_no_selector element_name, proposed_method_name
+      create_no_selector proposed_method_name
     else
       yield
     end
   end
 
-  def create_existence_checker element_name, *find_args
+  def create_existence_checker(element_name, *find_args)
     method_name = "has_#{element_name.to_s}?"
-    build_checker_or_waiter element_name, method_name, *find_args do
+    create_helper_method method_name, *find_args do
       define_method method_name do
         Capybara.using_wait_time 0 do
           element_exists? *find_args
@@ -93,9 +93,9 @@ module SitePrism::ElementContainer
     end
   end
 
-  def create_waiter element_name, *find_args
+  def create_waiter(element_name, *find_args)
     method_name = "wait_for_#{element_name.to_s}"
-    build_checker_or_waiter element_name, method_name, *find_args do
+    create_helper_method method_name, *find_args do
       define_method method_name do |timeout = Capybara.default_wait_time|
         Capybara.using_wait_time timeout do
           element_exists? *find_args
@@ -104,9 +104,9 @@ module SitePrism::ElementContainer
     end
   end
 
-  def create_visibility_waiter element_name, *find_args
+  def create_visibility_waiter(element_name, *find_args)
     method_name = "wait_until_#{element_name.to_s}_visible"
-    build_checker_or_waiter element_name, method_name, *find_args do
+    create_helper_method method_name, *find_args do
       define_method method_name do |timeout = Capybara.default_wait_time|
         Capybara.using_wait_time timeout do
           element_exists? *find_args
@@ -118,9 +118,9 @@ module SitePrism::ElementContainer
     end
   end
 
-  def create_invisibility_waiter element_name, *find_args
+  def create_invisibility_waiter(element_name, *find_args)
     method_name = "wait_until_#{element_name.to_s}_invisible"
-    build_checker_or_waiter element_name, method_name, *find_args do
+    create_helper_method method_name, *find_args do
       define_method method_name do |timeout = Capybara.default_wait_time|
         Timeout.timeout timeout, SitePrism::TimeOutWaitingForElementInvisibility do
           Capybara.using_wait_time 0 do
@@ -131,10 +131,9 @@ module SitePrism::ElementContainer
     end
   end
 
-  def create_no_selector element_name, method_name = nil
-    no_selector_method_name = method_name.nil? ? element_name : method_name
-    define_method no_selector_method_name do
-      raise SitePrism::NoSelectorForElement.new("#{self.class.name} => :#{element_name} needs a selector")
+  def create_no_selector(method_name)
+    define_method method_name do
+      raise SitePrism::NoSelectorForElement.new("#{self.class.name} => :#{method_name} needs a selector")
     end
   end
 end

data/lib/site_prism/page.rb

@@ -4,9 +4,10 @@ module SitePrism
     include ElementChecker
     extend ElementContainer
 
-    def load
-      raise SitePrism::NoUrlForPage if url.nil?
-      visit url
+    def load(expansion = {})
+      expanded_url = url(expansion)
+      raise SitePrism::NoUrlForPage if expanded_url.nil?
+      visit expanded_url
     end
 
     def displayed?
@@ -30,8 +31,9 @@ module SitePrism
       @url_matcher
     end
 
-    def url
-      self.class.url
+    def url(expansion = {})
+      return nil if self.class.url.nil?
+      Addressable::Template.new(self.class.url).expand(expansion).to_s
     end
 
     def url_matcher

data/lib/site_prism/version.rb

@@ -1,4 +1,4 @@
 module SitePrism
-  VERSION = "2.2"
+  VERSION = "2.3"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '2.2'
+  version: '2.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -49,6 +49,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
 description: SitePrism gives you a simple, clean and semantic DSL for describing your
   site using the Page Object Model pattern, for use with Capybara
 email: nat@natontesting.com
@@ -85,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Page Object Model DSL for Capybara