site_prism 0.9.3 → 0.9.4

data/LICENSE

@@ -25,4 +25,5 @@ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/lib/site_prism.rb

@@ -1,8 +1,10 @@
 module SitePrism
-  
+
 end
 
 require 'site_prism/exceptions'
 require 'site_prism/element_container'
+require 'site_prism/element_checker'
 require 'site_prism/page'
-require 'site_prism/section'
+require 'site_prism/section'
+

data/lib/site_prism/element_checker.rb

@@ -0,0 +1,6 @@
+module SitePrism::ElementChecker
+  def all_there?
+    !self.class.element_names.map {|element| self.send "has_#{element}?" }.include? false
+  end
+end
+

data/lib/site_prism/element_container.rb

@@ -1,7 +1,7 @@
 # Contains methods applicable to both {SitePrism::Page}s and {SitePrism::Section}s. Note that they are mixed into the {SitePrism::Page}
 # and {SitePrism::Section} classes so the methods below are used as class methods.
 module SitePrism::ElementContainer
-  
+
   # Creates two methods; the first method has the same name as the element_name parameter and returns the capybara element
   # located by the element_locator parameter when the method is called. The second method generated has a name with a format
   # of: 'has_#\{element_name}?' which returns true if the element as located by the element_locator parameter exists, false
@@ -13,22 +13,23 @@ module SitePrism::ElementContainer
   #     element :search_link, 'div.search > a'
   #   end
   #   home = HomePage.new
-  #   
+  #
   #   #the element method created 2 methods...
   #   home.search_link #=> returns the capybara element located by the element_locator parameter
   #   home.has_search_link? #=> returns true if the capybara element as located by the element_locator exists, false if it doesn't
-  #   
+  #
   #   #The has_search_link? method allows use of magic matchers in rspec/cucumber:
   #   home.should have_search_link
   #   home.should_not have_search_link
   def element element_name, element_locator
+    add_element_name element_name
     create_existence_checker element_name, element_locator
     create_waiter element_name, element_locator
     define_method element_name.to_s do
       find_one element_locator
     end
   end
-  
+
   # Works in the same way as {SitePrism::Page.element} in that it will generate two methods; one to check existence of
   # the element (in the format 'has_#\{element_name}?'), and another to return not a single element, but an array of elements
   # found by the css locator
@@ -39,11 +40,12 @@ module SitePrism::ElementContainer
   #     elements :app_links, '.title-links > a'
   #   end
   #   home = HomePage.new
-  #   
+  #
   #   home.should have_app_links
   #   home.app_links #=> [#<Capybara::Element tag="a">, #<Capybara::Element tag="a">, #<Capybara::Element tag="a">]
   #   home.app_links.map {|link| link.text}.should == ['Finance', 'Maps', 'Blogs']
   def elements collection_name, collection_locator
+    add_element_name collection_name
     create_existence_checker collection_name, collection_locator
     create_waiter collection_name, collection_locator
     define_method collection_name.to_s do
@@ -61,32 +63,34 @@ module SitePrism::ElementContainer
   #     element :search_field, '.q'
   #     element :search_button, '.btnK'
   #   end
-  # 
+  #
   # ...then that section could be added to any page as follows:
-  # 
+  #
   #   class SearchPage < SitePrism::Page
   #     section :search_area, SearchArea, '.tsf-p'
   #   end
-  #   
+  #
   #   class SearchResultsPage < SitePrism::Page
   #     section :search_again, SearchArea, '.tsf-p table'
   #   end
-  # 
+  #
   # The SearchArea section appears on both pages, but can be invoked by methods specific to the page (eg: 'search_area' and 'search_again')
   # and the root element for the section can be different on the page (eg: '.tsf-p' and '.tsf-p table').
   # @param [Symbol] the method name to be called against this page or section to return an instance of the {SitePrism::Section} class
   # @param [Class] the class that models this area of the page
   # @param [String] the CSS locator for the root element of the section on this page/section
   def section section_name, section_class, section_locator
+    add_element_name section_name
     create_existence_checker section_name, section_locator
     create_waiter section_name, section_locator
     define_method section_name do
       section_class.new find_one section_locator
     end
   end
-  
+
   # Works in the same way as {SitePrism::Page.section} but instead of it returning one section, it returns an array of them. 
   def sections section_collection_name, section_class, section_collection_locator
+    add_element_name section_collection_name
     create_existence_checker section_collection_name, section_collection_locator
     create_waiter section_collection_name, section_collection_locator
     define_method section_collection_name do
@@ -95,9 +99,9 @@ module SitePrism::ElementContainer
       end
     end
   end
-  
+
   private
-  
+
   # Creates a method used to check for the existence of the element whose details are passed to it
   # @param
   def create_existence_checker element_name, element_locator
@@ -105,11 +109,12 @@ module SitePrism::ElementContainer
       element_exists? element_locator
     end
   end
-  
+
   # Creates a method used to wait for an element to appear - uses the default capybara wait time
   def create_waiter element_name, element_locator
     define_method "wait_for_#{element_name.to_s}" do
       element_waiter element_locator
     end
   end
-end
+end
+

data/lib/site_prism/exceptions.rb

@@ -4,4 +4,5 @@ module SitePrism
   class NoUrlForPage < StandardError; end
   # Raised if you check to see if a page is displayed but it hasn't had its url matcher set
   class NoUrlMatcherForPage < StandardError; end
-end
+end
+

data/lib/site_prism/page.rb

@@ -2,7 +2,7 @@ module SitePrism
   # Subclasses of {SitePrism::Page} represent pages in your app.
   #   class Home < SitePrism::Page
   #   end
-  # 
+  #
   # The above is an example of how to make a class representing the home page. There are a number of properties that can be
   # set on a page - here is an example of a more fully spec'ed out page:
   #   class Home < SitePrism::Page
@@ -11,15 +11,16 @@ module SitePrism
   #   end
   class Page
     include Capybara::DSL
+    include ElementChecker
     extend ElementContainer
-    
+
     # Visits the url associated with this page
     # @raise [SitePrism::NoUrlForPage] To load a page the url must be set using {.set_url}
     def load
       raise SitePrism::NoUrlForPage if url.nil?
       visit url
     end
-    
+
     # Checks to see if we're on this page or not
     # @return true if the browser's current url matches the {.url_matcher} that has been set, false if it doesn't
     # @raise [SitePrism::NoUrlMatcherForPage] To check whether we're on this page or not the url matcher must be set using {.set_url_matcher}
@@ -35,7 +36,7 @@ module SitePrism
       raise SitePrism::NoUrlMatcherForPage if url_matcher.nil?
       !(page.current_url =~ url_matcher).nil?
     end
-    
+
     # Set the url associated with this page
     # @param [String] page_url the portion of the url that identifies this page when appended onto Capybara's app_host. Calling {SitePrism::Page#load} causes Capybara to visit this page.
     # @example
@@ -45,7 +46,7 @@ module SitePrism
     def self.set_url page_url
       @url = page_url
     end
-    
+
     # Set the url matcher associated with this page
     # @param [Regexp] page_url_matcher a regular expression that when compared to the current browser url will match if we're on this page or not match if we're not on this page
     # @example
@@ -55,60 +56,70 @@ module SitePrism
     def self.set_url_matcher page_url_matcher
       @url_matcher = page_url_matcher
     end
-    
+
     # Get the url associated with this page
     # @see SitePrism::Page#url
     # @return [String] the url originally set in {.set_url}
     def self.url
       @url
     end
-    
+
     # Get the url matcher associated with this page
     # @see SitePrism::Page#url_matcher
     # @return [Regexp] the url matcher originally set in {.set_url_matcher}
     def self.url_matcher
       @url_matcher
     end
-    
+
     # Get the url associated with this page
     # @see SitePrism::Page.url
     def url
       self.class.url
     end
-    
+
     # Get the url matcher associated with this page
     # @see SitePrism::Page.url_matcher
     def url_matcher
       self.class.url_matcher
     end
-    
+
     # Gets the title of the current page
     # @return [String, nil] the text value of the title element within the page's head block
     def title
       title_selector = 'html > head > title'
       using_wait_time(0) { page.find(title_selector).text if page.has_selector?(title_selector) }
     end
-    
+
     private
-    
+
     # Page specific element finder
     def find_one locator
       find locator
     end
-    
+
     # Page specific elements finder
     def find_all locator
       all locator
     end
-    
+
     # Page specific element existence check
     def element_exists? locator
       has_selector? locator
     end
-    
+
     # Page specific element waiter
     def element_waiter locator
       wait_until { element_exists? locator }
     end
+
+    def self.add_element_name element_name
+      @element_names ||= []
+      @element_names << element_name
+    end
+
+    def self.element_names
+      @element_names
+    end
   end
-end
+end
+

data/lib/site_prism/section.rb

@@ -1,9 +1,10 @@
 module SitePrism
   class Section
+    include ElementChecker
     extend ElementContainer
-    
+
     attr_reader :root_element
-    
+
     def initialize root_element
       @root_element = root_element
     end
@@ -11,14 +12,14 @@ module SitePrism
     def visible?
       @root_element.visible?
     end
-    
+
     private
-    
+
     # Section specific element finder
     def find_one locator
       @root_element.find locator
     end
-    
+
     # Section specific elements finder
     def find_all locator
       @root_element.all locator
@@ -33,5 +34,15 @@ module SitePrism
     def element_waiter locator
       wait_until { element_exists? locator }
     end
+
+    def self.add_element_name element_name
+      @element_names ||= []
+      @element_names << element_name
+    end
+
+    def self.element_names
+      @element_names
+    end
   end
 end
+

metadata

@@ -2,7 +2,7 @@
 name: site_prism
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Nat Ritmeyer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-11 00:00:00 Z
+date: 2012-03-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capybara
@@ -44,6 +44,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/site_prism/element_checker.rb
 - lib/site_prism/element_container.rb
 - lib/site_prism/exceptions.rb
 - lib/site_prism/page.rb