site_prism 1.3 → 1.4

data/README.md

@@ -127,7 +127,7 @@ queried (is it enabled? visible?).
 
 SitePrism is based around this concept, but goes further as you'll see
 below by also allowing modelling of repeated sections that appear on
-muliple pages, or many times on a page using the concept of sections.
+multiple pages, or many times on a page using the concept of sections.
 
 ## Pages
 
@@ -171,7 +171,7 @@ to the page using `#load`:
 @home_page.load
 ```
 
-This will tell which ever capybara driver you have configured to
+This will tell whichever capybara driver you have configured to
 navigate to the URL set against that page's class.
 
 ### Verifying that a particular page is displayed
@@ -591,7 +591,7 @@ SitePrism provides the Section class for this task.
 
 In the same way that SitePrism provides `element` and `elements`, it
 provides `section` and `sections`. The first returns an instance of a
-page section, the secont returns an array of section instances, one for
+page section, the second returns an array of section instances, one for
 each capybara element found by the supplied css selector. What follows
 is an explanation of `section`.
 
@@ -807,9 +807,9 @@ how they're used:
 
 ```ruby
 @home = Home.new
-@home.wait_for_menu_visible
+@home.wait_until_menu_visible
 # and...
-@home.wait_for_menu_invisible
+@home.wait_until_menu_invisible
 ```
 
 Again, as for an element, it is possible to give a specific amount of
@@ -817,9 +817,9 @@ time to wait for visibility/invisibility of a section. Here's how:
 
 ```ruby
 @home = Home.new
-@home.wait_for_menu_visible(5)
+@home.wait_until_menu_visible(5)
 # and...
-@home.wait_for_menu_invisible(3)
+@home.wait_until_menu_invisible(3)
 ```
 
 #### Sections within sections
@@ -1005,7 +1005,7 @@ end
 
 SitePrism allows you to interact with iframes. An iframe is declared as
 a `SitePrism::Page` class, and then referenced by the page or section it
-is embeded into. Like a section, it is possible to test for the
+is embedded into. Like a section, it is possible to test for the
 existence of the iframe, wait for it to exist as well as interact with
 the page it contains.
 

data/lib/site_prism/element_checker.rb

@@ -1,7 +1,7 @@
 module SitePrism::ElementChecker
   def all_there?
     Capybara.using_wait_time(0) do
-      self.class.element_names.all? {|element| send "has_#{element}?" }
+      self.class.mapped_items.all? {|element| send "has_#{element}?" }
     end
   end
 end

data/lib/site_prism/element_container.rb

@@ -1,62 +1,42 @@
 module SitePrism::ElementContainer
 
-  def element element_name, element_locator = nil
-    if element_locator.nil?
-      create_no_locator element_name
-    else
-      add_element_name element_name.to_s
+  def element element_name, element_selector = nil
+    build element_name, element_selector do
       define_method element_name.to_s do
-        find_one element_locator
+        find_one element_selector
       end
     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
-    if collection_locator.nil?
-      create_no_locator collection_name
-    else
-      add_element_name collection_name
+  def elements collection_name, collection_selector = nil
+    build collection_name, collection_selector do
       define_method collection_name.to_s do
-        find_all collection_locator
+        find_all collection_selector
       end
     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
 
-  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
-    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
+  def section section_name, section_class, section_selector
+    build section_name, section_selector do
+      define_method section_name do
+        section_class.new find_one section_selector
+      end
     end
   end
 
-  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
-    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
+  def sections section_collection_name, section_class, section_collection_selector
+    build section_collection_name, section_collection_selector do
+      define_method section_collection_name do
+        find_all(section_collection_selector).collect do |element|
+          section_class.new element
+        end
       end
     end
   end
 
   def iframe iframe_name, iframe_page_class, iframe_id
-    add_element_name iframe_name
+    add_to_mapped_items iframe_name
     create_existence_checker iframe_name, iframe_id
     create_waiter iframe_name, iframe_id
     define_method iframe_name do |&block|
@@ -66,57 +46,76 @@ module SitePrism::ElementContainer
     end
   end
 
-  def add_element_name element_name
-    @element_names ||= []
-    @element_names << element_name
+  def add_to_mapped_items item
+    @mapped_items ||= []
+    @mapped_items << item.to_s
   end
 
-  def element_names
-    @element_names
+  def mapped_items
+    @mapped_items
   end
 
   private
+  
+  def build name, selector
+    if selector.nil?
+      create_no_selector name
+    else
+      add_to_mapped_items name
+      yield
+    end
+    add_checkers_and_waiters name, selector
+  end
+  
+  def add_checkers_and_waiters name, selector
+    create_existence_checker name, selector
+    create_waiter name, selector
+    create_visibility_waiter name, selector
+    create_invisibility_waiter name, selector
+  end
+  
+  def build_checker_or_waiter element_name, proposed_method_name, selector
+    if selector.nil?
+      create_no_selector element_name, proposed_method_name
+    else
+      yield
+    end
+  end
 
-  def create_existence_checker element_name, element_locator
+  def create_existence_checker element_name, element_selector
     method_name = "has_#{element_name.to_s}?"
-    if element_locator.nil?
-      create_no_locator element_name, method_name
-    else
+    build_checker_or_waiter element_name, method_name, element_selector do
       define_method method_name do
         Capybara.using_wait_time 0 do
-          element_exists? element_locator
+          element_exists? element_selector
         end
       end
     end
   end
 
-  def create_waiter element_name, element_locator
+  def create_waiter element_name, element_selector
     method_name = "wait_for_#{element_name.to_s}"
-    if element_locator.nil?
-      create_no_locator element_name, method_name
-    else
+    build_checker_or_waiter element_name, method_name, element_selector do
       define_method method_name do |*args| #used to use block args, but they don't work under ruby 1.8 :(
         timeout = args.shift || Capybara.default_wait_time
         Capybara.using_wait_time timeout do
-          element_waiter element_locator
+          element_waiter element_selector
         end
       end
     end
   end
 
-  def create_visibility_waiter element_name, element_locator
+  def create_visibility_waiter element_name, element_selector
     method_name = "wait_until_#{element_name.to_s}_visible"
-    if element_locator.nil?
-      create_no_locator element_name, method_name
-    else
+    build_checker_or_waiter element_name, method_name, element_selector do
       define_method method_name do |*args|
         timeout = args.shift || Capybara.default_wait_time
         Capybara.using_wait_time timeout do
-          element_waiter element_locator
+          element_waiter element_selector
         end
         begin
           Timeout.timeout(timeout) do
-            sleep 0.1 until find_one(element_locator).visible?
+            sleep 0.1 until find_one(element_selector).visible?
           end
         rescue Timeout::Error
           raise SitePrism::TimeOutWaitingForElementVisibility.new("#{element_name} did not become visible")
@@ -125,16 +124,14 @@ module SitePrism::ElementContainer
     end
   end
 
-  def create_invisibility_waiter element_name, element_locator
+  def create_invisibility_waiter element_name, element_selector
     method_name = "wait_until_#{element_name.to_s}_invisible"
-    if element_locator.nil?
-      create_no_locator element_name, method_name
-    else
+    build_checker_or_waiter element_name, method_name, element_selector do
       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?
+            sleep 0.1 while element_exists?(element_selector) && find_one(element_selector).visible?
           end
         rescue Timeout::Error
           raise SitePrism::TimeOutWaitingForElementInvisibility.new("#{element_name} did not become invisible")
@@ -143,11 +140,10 @@ module SitePrism::ElementContainer
     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
-      raise SitePrism::NoLocatorForElement.new("#{self.class.name} => :#{element_name} needs a locator")
+  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")
     end
   end
 end

data/lib/site_prism/exceptions.rb

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

data/lib/site_prism/page.rb

@@ -49,20 +49,20 @@ module SitePrism
 
     private
 
-    def find_one locator
-      find locator
+    def find_one selector
+      find selector
     end
 
-    def find_all locator
-      all locator
+    def find_all selector
+      all selector
     end
 
-    def element_exists? locator
-      has_selector? locator
+    def element_exists? selector
+      has_selector? selector
     end
 
-    def element_waiter locator
-      wait_until { element_exists? locator }
+    def element_waiter selector
+      wait_until { element_exists? selector }
     end
   end
 end

data/lib/site_prism/section.rb

@@ -24,20 +24,20 @@ module SitePrism
 
     private
 
-    def find_one locator
-      root_element.find locator
+    def find_one selector
+      root_element.find selector
     end
 
-    def find_all locator
-      root_element.all locator
+    def find_all selector
+      root_element.all selector
     end
 
-    def element_exists? locator
-      root_element.has_selector? locator
+    def element_exists? selector
+      root_element.has_selector? selector
     end
 
-    def element_waiter locator
-      Capybara.current_session.wait_until { element_exists? locator }
+    def element_waiter selector
+      Capybara.current_session.wait_until { element_exists? selector }
     end
   end
 end

data/lib/site_prism/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-29 00:00:00.000000000 Z
+date: 2012-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.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: