site_prism 1.2 → 1.3

data/README.md

@@ -318,7 +318,7 @@ end
 ... the following shows how to get hold of the search field:
 
 ```ruby
-@home_page = Home.new
+@home = Home.new
 @home.load
 
 @home.search_field #=> will return the capybara element found using the selector
@@ -342,7 +342,7 @@ end
 ... you can test for the existence of the element on the page like this:
 
 ```ruby
-@home_page = Home.new
+@home = Home.new
 @home.load
 @home.has_search_field? #=> returns true if it exists, false if it doesn't
 ```
@@ -355,9 +355,9 @@ Then /^the search field exists$/ do
 end
 ```
 
-#### Waiting for an element to appear on a page
+#### Waiting for an element to exist on a page
 
-The final method added by calling `element` is the `wait_for_<element_name>` method.
+Another method added by calling `element` is the `wait_for_<element_name>` method.
 Calling the method will cause the test to wait for the Capybara's
 default wait time for the element to exist. It is also possible to use a
 custom amount of time to wait. Using the same example as above:
@@ -373,13 +373,42 @@ end
 ... you can wait for the search field to exist like this:
 
 ```ruby
-@home_page = Home.new
+@home = Home.new
 @home.load
 @home.wait_for_search_field
 # or...
 @home.wait_for_search_field(10) #will wait for 10 seconds for the search field to appear
 ```
 
+#### Waiting for an element to become visible
+
+Another method added by calling `element` is the
+`wait_until_<element_name>_visible` method. Calling this method will
+cause the test to wait for Capybara's default wait time for the element
+to become visible (*not* the same as existence!). You can customise the
+wait time be supplying a number of seconds to wait. Using the above
+example:
+
+```ruby
+@home.wait_until_search_field_visible
+# or...
+@home.wait_until_search_field_visible(10)
+```
+
+#### Waiting for an element to become invisible
+
+Another method added by calling `element` is the
+`wait_until_<element_name>_invisible` method. Calling this method will
+cause the test to wait for Capybara's default wait time for the element
+to become invisible. You can customise the wait time be supplying a number
+of seconds to wait. Using the above example:
+
+```ruby
+@home.wait_until_search_field_invisible
+# or...
+@home.wait_until_search_field_invisible(10)
+```
+
 #### Summary of what the element method provides:
 
 Given:
@@ -397,6 +426,11 @@ end
 @home.has_search_field?
 @home.wait_for_search_field
 @home.wait_for_search_field(10)
+@home.wait_until_search_field_visible
+@home.wait_until_search_field_visible(10)
+@home.wait_until_search_field_invisible
+@home.wait_until_search_field_invisible(10)
+
 ```
 
 ### Element Collections
@@ -445,6 +479,7 @@ arrays:
 @friends_page.names.each {|name| puts name.text}
 @friends_page.names.map {|name| name.text}.should == ["Alice", "Bob", "Fred"]
 @friends_page.names.size.should == 3
+@friends_page.should have(3).names
 ```
 
 #### Testing for the existence of the element collection
@@ -503,6 +538,29 @@ to wait for:
 @friends_page.wait_for_names(10)
 ```
 
+#### Waiting for the elements to be visible or invisible
+
+Like the individual elements, calling the `elements` method will create
+two methods: `wait_until_<elements_name>_visible` and
+`wait_until_<elements_name>_invisible`. Calling these methods will cause
+your test to wait for the elements to become visible or invisibe. Using
+the above example:
+
+```ruby
+@friends_page.wait_until_names_visible
+# and...
+@friends_page.wait_until_names_invisible
+```
+
+It is possible to wait for a specific amount of time instead of using
+the default Capybara wait time:
+
+```ruby
+@friends_page.wait_until_names_visible(5)
+# and...
+@friends_page.wait_until_names_invisible(7)
+```
+
 ### Checking that all mapped elements are present on the page
 
 Throughout my time in test automation I keep getting asked to provide the
@@ -711,9 +769,9 @@ Again, this allows pretty test code:
 @home.should_not have_menu
 ```
 
-#### Waiting for a section to appear
+#### Waiting for a section to exist
 
-The final method added to the page or section by the `section` method is
+Another method added to the page or section by the `section` method is
 `wait_for_<section name>`. Similar to what `element` does, this method
 waits for the section to appear - the test will wait up to capybara's
 default wait time until the root node of the element exists on the
@@ -738,6 +796,32 @@ end
 @home.wait_for_menu(10) # waits for 10 seconds instead of capybara's default timeout
 ```
 
+#### Waiting for a section to become visible or invisible
+
+Like an element, it is possible to wait for a section to become visible
+or invisible. Calling the `section` method creates two methods on the
+relevant page or section:
+`wait_until_<section_name>_visible` and
+`wait_until_<section_name>_invisible`. Using the above example, here's
+how they're used:
+
+```ruby
+@home = Home.new
+@home.wait_for_menu_visible
+# and...
+@home.wait_for_menu_invisible
+```
+
+Again, as for an element, it is possible to give a specific amount of
+time to wait for visibility/invisibility of a section. Here's how:
+
+```ruby
+@home = Home.new
+@home.wait_for_menu_visible(5)
+# and...
+@home.wait_for_menu_invisible(3)
+```
+
 #### Sections within sections
 
 You are not limited to adding sections only to pages; you can nest

data/lib/site_prism/element_container.rb

@@ -11,6 +11,8 @@ module SitePrism::ElementContainer
     end
     create_existence_checker element_name, element_locator
     create_waiter element_name, element_locator
+    create_visibility_waiter element_name, element_locator
+    create_invisibility_waiter element_name, element_locator
   end
 
   def elements collection_name, collection_locator = nil
@@ -24,6 +26,8 @@ module SitePrism::ElementContainer
     end
     create_existence_checker collection_name, collection_locator
     create_waiter collection_name, collection_locator
+    create_visibility_waiter collection_name, collection_locator
+    create_invisibility_waiter collection_name, collection_locator
   end
   alias :collection :elements
 
@@ -31,6 +35,8 @@ module SitePrism::ElementContainer
     add_element_name section_name
     create_existence_checker section_name, section_locator
     create_waiter section_name, section_locator
+    create_visibility_waiter section_name, section_locator
+    create_invisibility_waiter section_name, section_locator
     define_method section_name do
       section_class.new find_one section_locator
     end
@@ -40,6 +46,8 @@ module SitePrism::ElementContainer
     add_element_name section_collection_name
     create_existence_checker section_collection_name, section_collection_locator
     create_waiter section_collection_name, section_collection_locator
+    create_visibility_waiter section_collection_name, section_collection_locator
+    create_invisibility_waiter section_collection_name, section_collection_locator
     define_method section_collection_name do
       find_all(section_collection_locator).collect do |element|
         section_class.new element
@@ -96,6 +104,46 @@ module SitePrism::ElementContainer
     end
   end
 
+  def create_visibility_waiter element_name, element_locator
+    method_name = "wait_until_#{element_name.to_s}_visible"
+    if element_locator.nil?
+      create_no_locator element_name, method_name
+    else
+      define_method method_name do |*args|
+        timeout = args.shift || Capybara.default_wait_time
+        Capybara.using_wait_time timeout do
+          element_waiter element_locator
+        end
+        begin
+          Timeout.timeout(timeout) do
+            sleep 0.1 until find_one(element_locator).visible?
+          end
+        rescue Timeout::Error
+          raise SitePrism::TimeOutWaitingForElementVisibility.new("#{element_name} did not become visible")
+        end
+      end
+    end
+  end
+
+  def create_invisibility_waiter element_name, element_locator
+    method_name = "wait_until_#{element_name.to_s}_invisible"
+    if element_locator.nil?
+      create_no_locator element_name, method_name
+    else
+      define_method method_name do |*args|
+        timeout = args.shift || Capybara.default_wait_time
+        begin
+          Timeout.timeout(timeout) do
+            sleep 0.1 while element_exists?(element_locator) && find_one(element_locator).visible?
+          end
+        rescue Timeout::Error
+          raise SitePrism::TimeOutWaitingForElementInvisibility.new("#{element_name} did not become invisible")
+        end
+      end
+    end
+  end
+
+
   def create_no_locator element_name, method_name = nil
     no_locator_method_name = method_name.nil? ? element_name : method_name
     define_method no_locator_method_name do

data/lib/site_prism/exceptions.rb

@@ -2,5 +2,7 @@ module SitePrism
   class NoUrlForPage < StandardError; end
   class NoUrlMatcherForPage < StandardError; end
   class NoLocatorForElement < StandardError; end
+  class TimeOutWaitingForElementVisibility < StandardError; end
+  class TimeOutWaitingForElementInvisibility < StandardError; end
 end
 

data/lib/site_prism/section.rb

@@ -11,7 +11,7 @@ module SitePrism
     end
 
     def visible?
-      @root_element.visible?
+      root_element.visible?
     end
 
     def execute_script input
@@ -25,15 +25,15 @@ module SitePrism
     private
 
     def find_one locator
-      @root_element.find locator
+      root_element.find locator
     end
 
     def find_all locator
-      @root_element.all locator
+      root_element.all locator
     end
 
     def element_exists? locator
-      @root_element.has_selector? locator
+      root_element.has_selector? locator
     end
 
     def element_waiter locator

data/lib/site_prism/version.rb

@@ -1,4 +1,4 @@
 module SitePrism
-  VERSION = "1.2"
+  VERSION = "1.3"
 end
 

metadata

@@ -1,59 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: site_prism
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  version: "1.2"
+version: !ruby/object:Gem::Version
+  version: '1.3'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Nat Ritmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-02 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: capybara
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 1
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
-  version_requirements: *id002
-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: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+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
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/site_prism/element_checker.rb
 - lib/site_prism/element_container.rb
 - lib/site_prism/exceptions.rb
@@ -63,35 +60,29 @@ files:
 - lib/site_prism.rb
 - LICENSE
 - README.md
-has_rdoc: true
 homepage: http://github.com/natritmeyer/site_prism
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Page Object Model DSL for Capybara
 test_files: []
-
+has_rdoc: