page_object_wrapper 1.1.2 → 1.2.0

data/README.md

@@ -99,8 +99,10 @@ where required attributes are marked with (*)
       end
 
 here we have defined a page object with locator (url) = 'http://www.cs.tut.fi/~jkorpela/www/testel.html'  
-uniq\_xxx is used to define a uniq element on that page, which uniquely identifies the page from other pages  
-uniq\_xxx is being checked when openning the page with PageObjectWrapper.open\_page and when running an page\_object.action  
+- uniq\_xxx is used to define a uniq element on that page, which uniquely identifies the page from other pages  
+- uniq\_xxx is being checked when openning the page with PageObjectWrapper.open\_page and when running an page\_object.action  
+- all defined elements have labels
+- action and action_alias defined with labels and next_pages
 
 #### openning the page
 *preconditions*  
@@ -122,8 +124,18 @@ There is a directory, where we've defined a page\_object inside a \*\_page.rb fi
 - .open\_page method takes page label, directs browser to that page and returns corresponding page\_object
 - PageObjectWrapper.current\_page points to the opened page\_object
 - it's possible to set page\_object locator in 2 different ways: specifying full url (like in example) or specifying PageObjectWrapper.domain and page\_object local path (like in specs)
-
-#### page\_object.xxx
+- it's possible to set dynamic urls for pages, e.g.
+      PageObjectWrapper.define_page(:google) do
+        locator 'www.google.com/:some_param'
+      end
+      PageObjectWrapper.open_page(:google, :some_param => 'advanced_search') # => 'http://google.com/advanced_search'
+
+#### page\_object.xxx 
+*parameters*  
+no  
+*returns*  
+Watir::XXX element  
+  
 Defined elements can be accessed with their labels.
 - element from an element\_set is corresponds to real Watir::Element
 - elemets\_set corresponds to an Array of Watir::Element  
@@ -137,7 +149,12 @@ Defined elements can be accessed with their labels.
 
 
 
-#### feed\_xxx
+#### feed\_xxx 
+*parameters*  
+:fresh\_food, :missing\_food  
+*returns*  
+current\_page  
+  
 *preconditions*  
 **tp** is a :some\_test\_page object opened in the browser
 
@@ -163,7 +180,12 @@ Defined elements can be accessed with their labels.
         @b.textarea(:id => 'f2').value.should eq('Default data')
 
 
-#### fire\_xxx
+#### fire\_xxx 
+*parameters*  
+optional arguments defined inside action  
+*returns*  
+next\_page from xxx action  
+  
 *preconditions*  
 **tp** is a :some\_test\_page object opened in the browser
 
@@ -185,7 +207,13 @@ Defined elements can be accessed with their labels.
         tp.fire_fill_textarea_alias
         @b.textarea(:id => 'f2').value.should eq('Default data')
 
-#### select\_from\_xxx
+#### select\_from\_xxx  
+*parameters*  
+:column\_1, :column\_2 => search\_value, :optional\_next\_page  
+*returns*  
+Watir::TableCell if next\_page not specified  
+next\_page if it is specified  
+  
 *preconditions*  
 **tp** is a :some\_test\_page object opened in the browser  
 its syntax is close to SQL *'select column1 from page\_object.some\_table where column2 = string\_or\_regexp'*     

data/good_pages/dynamic_url_page.rb

@@ -0,0 +1,4 @@
+PageObjectWrapper.define_page(:dynamic_url_page) do
+  locator ':domain/:path'
+  uniq_text_field :name => 'as_q' 
+end

data/lib/page_object_wrapper.rb

@@ -57,8 +57,8 @@ module PageObjectWrapper
     PageObject.find_page_object(label)
   end
 
-  def self.open_page(label)
-    PageObject.open_page label
+  def self.open_page(label, *args)
+    PageObject.open_page label, *args
     PageObject.map_current_page label
   end
 end

data/lib/page_object_wrapper/Exceptions.rb

@@ -5,4 +5,5 @@ module PageObjectWrapper
   class UnmappedPageObject < StandardError; end
   class Load < StandardError; end
   class BrowserNotFound < StandardError; end
+  class DynamicUrl < StandardError; end
 end

data/lib/page_object_wrapper/PageObject.rb

@@ -123,13 +123,21 @@ class PageObject < DslElementWithLocator
     end
   end
 
-  def self.open_page label
+  def self.open_page label, optional_hash=nil
     raise PageObjectWrapper::BrowserNotFound if @@browser.nil?
     raise PageObjectWrapper::UnknownPageObject, label if not @@pages.collect(&:label_value).include?(label)
     page_object = PageObject.find_page_object(label)
     url = ''
     url += @@domain if page_object.locator_value[0]=='/'
     url += page_object.locator_value
+    if not (optional_hash.nil? or optional_hash.empty?)
+      optional_hash.each{|k,v|
+        raise ArgumentError, "#{k.inspect} not Symbol" if not k.is_a? Symbol
+        raise ArgumentError, "#{v.inspect} not meaningful String" if not v.is_a? String or v.empty?
+        raise PageObjectWrapper::DynamicUrl, "#{k.inspect} not known parameter" if not url.match(':'+k.to_s)
+        url.gsub!(/:#{k.to_s}/, v)
+      }
+    end
     @@browser.goto url
   end
 
@@ -168,6 +176,14 @@ class PageObject < DslElementWithLocator
     eset = ElementsSet.new(label)
     eset.instance_eval(&block)
     @esets << eset
+    eset.elements.each{|e|
+      PageObject.send :define_method, (e.label_value.to_s+'_fresh_food').to_sym do
+        e.fresh_food_value
+      end
+      PageObject.send :define_method, (e.label_value.to_s+'_missing_food').to_sym do
+        e.missing_food_value
+      end
+    }
     @elements += eset.elements
     eset
   end
@@ -318,7 +334,9 @@ private
     @@current_page
   end
 
-  def select_from_table(table, header, where=nil)
+  def select_from_table(table, header, *args)
+    where = args[0]
+    next_page = args[1]
     raise PageObjectWrapper::BrowserNotFound if @@browser.nil? or not @@browser.exist?
     t = @@browser.table(table.locator_value)
     raise ArgumentError, "#{header.inspect} not a Symbol" if not header.is_a? Symbol
@@ -326,6 +344,11 @@ private
     search_for_index = table.header_value.index(header)
     found = nil
 
+    if not next_page.nil?
+      raise ArgumentError, "#{next_page.inspect} not a Symbol" if not next_page.is_a? Symbol
+      raise ArgumentError, "#{next_page.inspect} not known Page" if not labeled(@@pages).include?(next_page)
+    end
+
     if not where.nil?
       raise ArgumentError, "#{where.inspect} not a meaningful Hash" if not where.is_a? Hash or where.empty?
       raise ArgumentError, "#{where.inspect} has more than 1 keys" if not where.keys.length == 1
@@ -346,7 +369,16 @@ private
     else # where == nil
       found = t.rows.last.cells[search_for_index]
     end
-    found
+
+    if not next_page.nil?
+      if not found.nil?
+        return PageObject.find_page_object(next_page)
+      else
+        return nil
+      end
+    else # next_page == nil
+      return found
+    end
   end
 
   def each_pagination

data/lib/page_object_wrapper/version.rb

@@ -1,3 +1,3 @@
 module PageObjectWrapper
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/page_object_wrapper.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/evgeniy-khatko/page_object_wrapper"
 	gem.add_dependency "watir-webdriver"
 	gem.add_development_dependency "rspec", ">= 2.0.0"
- 
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/get_food_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+describe "getting food specified for element" do
+  subject{ PageObjectWrapper.receive_page(:some_test_page) }
+
+  describe "page_object.xxx_fresh_food" do
+    it "raises NoMethodError if xxx is not known element" do
+      expect{ subject.unknown_fresh_food }.to raise_error(NoMethodError)  
+    end      
+
+    it{ should respond_to(:tf_fresh_food) }
+    its(:tf_fresh_food){ should eq 'some fresh food' }
+
+    it{ should respond_to(:ta_fresh_food) }
+    its(:ta_fresh_food){ should eq 'default fresh food' }
+  end
+
+  describe "page_object.xxx_missing_food" do
+    it "raises NoMethodError if xxx is not known element" do
+      expect{ subject.unknown_fresh_food }.to raise_error(NoMethodError)  
+    end      
+
+    it{ should respond_to(:tf_fresh_food) }
+    its(:tf_missing_food){ should eq 'some missing food' }
+
+    it{ should respond_to(:ta_fresh_food) }
+    its(:ta_missing_food){ should eq 'default missing food' }
+  end
+end

data/spec/open_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe "PageObjectWrapper.open_page" do
   context "browser is closed" do
-    it "raises Errno::ECONNREFUSED (I don't understand why here it behaves like this)" do
-      expect{ PageObjectWrapper.open_page(:google_page) }.to raise_error(Errno::ECONNREFUSED)
+    it "raises PageObjectWrapper::BrowserNotFound" do
+      expect{ PageObjectWrapper.open_page(:google_page) }.to raise_error(PageObjectWrapper::BrowserNotFound)
     end
   end
 
@@ -17,15 +17,49 @@ describe "PageObjectWrapper.open_page" do
     after(:all){ PageObjectWrapper.browser.quit }
 
     it "raises errors" do        
-      expect{ PageObjectWrapper.open_page(:first_arg, :second_arg) }.to raise_error(ArgumentError)
       expect{ PageObjectWrapper.open_page(:unknown_page) }.to raise_error(PageObjectWrapper::UnknownPageObject)
       expect{ PageObjectWrapper.open_page(:wrong_google_page) }.to raise_error(PageObjectWrapper::UnmappedPageObject)
     end
 
-    it "returns opened PageObject instance" do
-      p = PageObjectWrapper.open_page(:google_page)
-      p.should be_an_instance_of(PageObject)
-      p.label_value.should eq(:google_page)
+    context "no optional arguments" do
+      it "returns opened PageObject instance" do
+        p = PageObjectWrapper.open_page(:google_page)
+        p.should be_an_instance_of(PageObject)
+        p.label_value.should eq(:google_page)
+      end
+    end
+
+    context "with optional arguments" do
+      context "optional hash key not Symbol" do
+        it "raises ArgumentError" do
+          expect{ PageObjectWrapper.open_page(:dynamic_url_page, 'a string' => 'a string') }.to raise_error ArgumentError, '"a string" not Symbol'
+        end
+      end
+      context "optional hash value not meaningful String" do
+        it "raises ArgumentError" do
+          expect{ PageObjectWrapper.open_page(:dynamic_url_page, :param => '') }.to raise_error ArgumentError, '"" not meaningful String'
+        end
+      end
+      context "one optional parameter not known" do
+        it "raises PageObjectWrapper::DynamicUrl" do
+          expect{ PageObjectWrapper.open_page(:dynamic_url_page, :domain => 'google.com', :unknown_url_parameter => '123') }.to raise_error PageObjectWrapper::DynamicUrl, ":unknown_url_parameter not known parameter"
+        end
+      end
+      context "at least one dynamic parameter specified" do
+        it "opens page with all parameters replaced with specified" do
+          begin
+            PageObjectWrapper.open_page(:dynamic_url_page, :domain => 'google.com')
+          rescue PageObjectWrapper::UnmappedPageObject
+            PageObject.browser.url.should =~ /google.\w+\/:path/
+          end
+        end
+      end
+      context "all dynamic parameters specified" do
+        it "opens page with all parameters replaced with specified" do
+          PageObjectWrapper.open_page(:dynamic_url_page, :domain => 'google.com', :path => 'advanced_search')
+          PageObject.browser.url.should =~ /google.\w+\/advanced_search/
+        end
+      end
     end
 
     context "domain is not specified" do

data/spec/select_from_spec.rb

@@ -17,6 +17,7 @@ describe "page_object.select_from_xxx" do
     let!(:tp){ PageObjectWrapper.open_page(:some_test_page)}
 
     context "wrong arguments" do
+
       it "raises ArgumentError if first_arg not a Symbol" do
         expect{ tp.select_from_table_without_header(nil,{}) }.to raise_error ArgumentError, "nil not a Symbol"
       end
@@ -38,35 +39,73 @@ describe "page_object.select_from_xxx" do
       it "raises Watir::Exception::UnknownObjectException if requested for non existing column" do
         expect{ tp.select_from_table_without_header(:column_3).text }.to raise_error(Watir::Exception::UnknownObjectException)
       end
+      
+      context "next_page specified" do
+        it "raises ArgumentError if next_page not symbol" do
+          expect{ tp.select_from_table_without_header(:column_1, nil, 'a string') }.to raise_error ArgumentError, '"a string" not a Symbol'
+          expect{ tp.select_from_table_without_header(:column_1, {:column_1 => 'Ireland'}, 'a string') }.to raise_error ArgumentError, '"a string" not a Symbol'
+        end
+        it "raises ArgumentError if next_page not loaded" do
+          expect{ tp.select_from_table_without_header(:column_1, nil, :nonexistent_page) }.to raise_error ArgumentError, ':nonexistent_page not known Page'
+          expect{ tp.select_from_table_without_header(:column_1, {:column_1 => 'Ireland'}, :nonexistent_page) }.to raise_error ArgumentError, ':nonexistent_page not known Page'
+        end
+      end
     end
 
     context "where == nil" do
-      it "returns last row value from provided column" do
-        tp.select_from_table_without_header(:column_0).text.should eq 'Sweden'
-        tp.select_from_table_without_header(:column_1).text.should eq '449,964'
-        tp.select_from_table_without_header(:column_2).text.should eq '410,928'
+      context "next_page not specified" do
+        it "returns last row value from provided column" do
+          tp.select_from_table_without_header(:column_0).text.should eq 'Sweden'
+          tp.select_from_table_without_header(:column_1).text.should eq '449,964'
+          tp.select_from_table_without_header(:column_2).text.should eq '410,928'
+        end
+      end
+      context "next_page specified" do
+        it "returns last row value from provided column" do
+          tp.select_from_table_without_header(:column_0, nil, :some_test_page).should eq PageObjectWrapper.receive_page(:some_test_page)
+        end
       end
     end
 
     context "where not nil" do
-      context "found by String" do
-        it "returns found cells" do
-          tp.select_from_table_without_header(:column_0, :column_1 => '103,000').text.should eq 'Iceland'
-          tp.select_from_table_with_header(:country, :total_area => '337,030').text.should eq 'Finland'
+      context "next_page not specified" do
+        context "found by String" do
+          it "returns found cells" do
+            tp.select_from_table_without_header(:column_0, :column_1 => '103,000').text.should eq 'Iceland'
+            tp.select_from_table_with_header(:country, :total_area => '337,030').text.should eq 'Finland'
+          end
+          it "returns nil" do
+            tp.select_from_table_without_header(:column_0, :column_1 => '123').should eq nil
+            tp.select_from_table_with_header(:country, :total_area => '123').should eq nil
+          end
         end
-        it "returns nil" do
-          tp.select_from_table_without_header(:column_0, :column_1 => '123').should eq nil
-          tp.select_from_table_with_header(:country, :total_area => '123').should eq nil
+        context "found by Regexp" do
+          it "returns found cells" do
+            tp.select_from_table_without_header(:column_0, :column_1 => /103/).text.should eq 'Iceland'
+            tp.select_from_table_with_header(:country, :total_area => /337/).text.should eq 'Finland'
+          end
+          it "returns nil" do
+            tp.select_from_table_without_header(:column_0, :column_1 => /123/).should eq nil
+            tp.select_from_table_with_header(:country, :total_area => /123/).should eq nil
+          end
         end
       end
-      context "found by Regexp" do
-        it "returns found cells" do
-          tp.select_from_table_without_header(:column_0, :column_1 => /103/).text.should eq 'Iceland'
-          tp.select_from_table_with_header(:country, :total_area => /337/).text.should eq 'Finland'
+      context "next_page specified" do
+        context "found by String" do
+          it "returns found cells" do
+            tp.select_from_table_without_header(:column_0, {:column_1 => '103,000'}, :some_test_page).should eq PageObjectWrapper.receive_page(:some_test_page)
+          end
+          it "returns nil" do
+            tp.select_from_table_without_header(:column_0, {:column_1 => '123'}, :some_test_page).should eq nil
+          end
         end
-        it "returns nil" do
-          tp.select_from_table_without_header(:column_0, :column_1 => /123/).should eq nil
-          tp.select_from_table_with_header(:country, :total_area => /123/).should eq nil
+        context "found by Regexp" do
+          it "returns found cells" do
+            tp.select_from_table_without_header(:column_0, {:column_1 => /103/}, :some_test_page).should eq PageObjectWrapper.receive_page(:some_test_page)
+          end
+          it "returns nil" do
+            tp.select_from_table_without_header(:column_0, {:column_1 => /123/}, :some_test_page).should eq nil
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_object_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &22275160 !ruby/object:Gem::Requirement
+  requirement: &8430060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22275160
+  version_requirements: *8430060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22274620 !ruby/object:Gem::Requirement
+  requirement: &8455200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *22274620
+  version_requirements: *8455200
 description: Wraps watir-webdriver with convenient testing interface, based on PageObjects
   automation testing pattern. Simplifies resulting automated test understanding.
 email:
@@ -48,8 +48,9 @@ files:
 - Rakefile
 - bad_pages/bad_page.rb
 - good_pages/another_test_page.rb
+- good_pages/dynamic_url_page.rb
 - good_pages/google_page.rb
-- good_pages/google_wron_uniq_page.rb
+- good_pages/google_wrong_uniq_page.rb
 - good_pages/goole_as_page.rb
 - good_pages/some_test_page.rb
 - good_pages/test_table_page.rb
@@ -73,6 +74,7 @@ files:
 - spec/feed_elements_spec.rb
 - spec/fire_event_spec.rb
 - spec/generate_spec.rb
+- spec/get_food_spec.rb
 - spec/load_spec.rb
 - spec/open_spec.rb
 - spec/select_from_spec.rb
@@ -110,6 +112,7 @@ test_files:
 - spec/feed_elements_spec.rb
 - spec/fire_event_spec.rb
 - spec/generate_spec.rb
+- spec/get_food_spec.rb
 - spec/load_spec.rb
 - spec/open_spec.rb
 - spec/select_from_spec.rb