page_object_wrapper 1.2.0 → 1.3.0

data/README.md

@@ -70,7 +70,6 @@ where required attributes are marked with (*)
 
           checkbox(:cb){ locator :id => 'f5' }
           radio(:rb){ locator :id => 'f3' }
-
         end
 
         action(:press_cool_button, :test_page_with_table) do
@@ -78,7 +77,7 @@ where required attributes are marked with (*)
         end
 
         action(:fill_textarea, :some_test_page) do |fill_with|
-          data = (fill_with.empty?)? 'Default data' : fill_with
+          data = (fill_with.nil?)? 'Default data' : fill_with
           textarea(:id => 'f2').set data
         end
 
@@ -96,25 +95,33 @@ where required attributes are marked with (*)
         pagination(:some_pagination) do
           locator :xpath => ''
         end
+
+        validator(:textarea_value) do |expected|
+          textarea(:id => 'f2').value == expected
+        end
       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  
 - all defined elements have labels
-- action and action_alias defined with labels and next_pages
+- action and action\_alias defined with labels and next\_pages
+- validator defined with label
 
 #### openning the page
 *preconditions*  
 There is a directory, where we've defined a page\_object inside a \*\_page.rb file
 
 1. specify browser to be used by PageObjectWrapper  
-     @b = Watir::Browser.new  
-     PageObjectWrapper.use_browser @b  
+  
+       @b = Watir::Browser.new  
+       PageObjectWrapper.use_browser @b  
 2. load defined pages  
-     PageObjectWrapper.load("path/to/pages/directory")  
+  
+       PageObjectWrapper.load("path/to/pages/directory")  
 3. open page in browser  
-     test_page = PageObjectWrapper.open_page(:some_test_page)  
+  
+       test_page = PageObjectWrapper.open_page(:some_test_page)  
 
 *comments*
 - it's possible to use any Watir::Browser with any profile
@@ -124,11 +131,10 @@ 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)
-- 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'
+- it's possible to set dynamic urls for pages, e.g.  
+  
+        PageObjectWrapper.define_page(:google){ locator 'www.google.com/:some_param' }  
+        PageObjectWrapper.open_page(:google, :some_param => 'advanced_search') # => 'http://google.com/advanced_search'  
 
 #### page\_object.xxx 
 *parameters*  
@@ -173,12 +179,17 @@ current\_page
         tp = PageObjectWrapper.open_page(:some_test_page)
         tp.feed_test_elements(:missing_food)
 
-    context "xxx is alias":
-      it "executes corresponding action":
-        tp = PageObjectWrapper.open_page(:some_test_page)
-        tp.fire_fill_textarea_alias
-        @b.textarea(:id => 'f2').value.should eq('Default data')
+#### xxx\_fresh\_food, xxx\_missing\_food  
+*parameters*  
+no  
+*returns*  
+fresh or missinf food value from page definition  
+  
+*preconditions*  
+**tp** is a :some\_test\_page object opened in the browser  
 
+    tp.tf_fresh_food # => 'some fresh food' 
+    tp.ta_fresh_food # => 'default fresh food'
 
 #### fire\_xxx 
 *parameters*  
@@ -205,7 +216,24 @@ next\_page from xxx action
       it "executes corresponding action":
         tp = PageObjectWrapper.open_page(:some_test_page)
         tp.fire_fill_textarea_alias
-        @b.textarea(:id => 'f2').value.should eq('Default data')
+
+#### validate\_xxx 
+*parameters*  
+optional arguments defined inside action  
+*returns*  
+anything block inside xxx validator returns
+it's expected that validator returns true | false
+  
+*preconditions*  
+**tp** is a :some\_test\_page object opened in the browser
+
+      tp = PageObjectWrapper.open_page(:some_test_page)
+      tp.fire_fill_textarea
+      tp.validate_textarea_value('Default data').should be(true)
+
+      tp = PageObjectWrapper.current_page
+      tp.fire_fill_textarea('User defined data')
+      tp.validate_textarea_value('User defined data').should be(true)
 
 #### select\_from\_xxx  
 *parameters*  
@@ -244,6 +272,14 @@ correct arguments are:
           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 "next_page specified":
+        context "found by String":
+          it "returns found cells":
+            tp.select_from_table_without_header(:column_0, {:column_1 => '103,000'}, :some_test_page).should eq PageObjectWrapper.receive_page(:some_test_page)
+        context "not found by String":
+          it "returns nil":
+            tp.select_from_table_without_header(:column_0, {:column_1 => '123'}, :some_test_page).should eq nil
+
 #### each\_xxx
 TODO
 #### open\_xxx

data/bad_pages/bad_page.rb

@@ -21,6 +21,9 @@ PageObjectWrapper.define_page('some_page_with_lost_of_errors') do
   action('',nil) do
   end
 
+  validator('') do
+  end
+
   action_alias('',nil){ action 'unknown action'}
 
   table('') do

data/good_pages/some_test_page.rb

@@ -33,7 +33,7 @@ PageObjectWrapper.define_page(:some_test_page) do
   end
 
   action(:fill_textarea, :some_test_page) do |fill_with|
-    data = (fill_with.empty?)? 'Default data' : fill_with
+    data = (fill_with.nil?)? 'Default data' : fill_with
     textarea(:id => 'f2').set data
   end
 
@@ -51,4 +51,8 @@ PageObjectWrapper.define_page(:some_test_page) do
   pagination(:some_pagination) do
     locator :xpath => ''
   end
+
+  validator(:textarea_value) do |expected|
+    textarea(:id => 'f2').value == expected
+  end
 end

data/lib/page_object_wrapper/PageObject.rb

@@ -6,12 +6,13 @@ require 'ElementsSet'
 require 'Element'
 require 'Action'
 require 'Alias'
+require 'Validator'
 require 'Table'
 require 'Pagination'
 require 'known_elements'
 
 class PageObject < DslElementWithLocator
-  attr_reader :esets, :elements, :actions, :aliases, :tables, :paginations, :uniq_element_type, :uniq_element_hash
+  attr_reader :esets, :elements, :actions, :aliases, :validators, :tables, :paginations, :uniq_element_type, :uniq_element_hash
   @@browser = nil
   @@pages = []
   @@current_page = nil
@@ -24,6 +25,7 @@ class PageObject < DslElementWithLocator
   SELECT_FROM = Regexp.new(/^select_from_([\w_]+)$/)
   PAGINATION_EACH = Regexp.new(/^([\w_]+)_each$/)
   PAGINATION_OPEN = Regexp.new(/^([\w_]+)_open$/)
+  VALIDATE = Regexp.new(/^validate_([\w_]+)$/)
     
   def initialize(label)
     super label
@@ -33,6 +35,7 @@ class PageObject < DslElementWithLocator
     @elements = []
     @actions = []
     @aliases = []
+    @validators = []
     @tables = []
     @paginations = []
   end
@@ -67,6 +70,10 @@ class PageObject < DslElementWithLocator
         # page_object.fire_some_action
         a = alias_for($1)
         fire_action(a, *args)
+      when (VALIDATE.match(method_name) and has_validator?($1))
+        # page_object.validate_something
+        v = validator_for($1)
+        run_validator(v, *args)
       when (SELECT_FROM.match(method_name) and has_table?($1))
         # page_object.select_from_some_table(:header_column, {:column => 'value'})
         table = table_for($1)
@@ -109,6 +116,9 @@ class PageObject < DslElementWithLocator
       when (FIRE_ACTION.match(method_name) and has_alias?($1))
         # page_object.fire_some_action
         true
+      when (VALIDATE.match(method_name) and has_action?($1))
+        # page_object.validate_xxx
+        true
       when (SELECT_FROM.match(method_name) and has_table?($1))
         # page_object.select_from_some_table(:header_column, {:column => 'value'})
         true
@@ -201,6 +211,12 @@ class PageObject < DslElementWithLocator
     a
   end
 
+  def validator(label, &block)
+    v = Validator.new(label, &block)
+    @validators << v
+    v
+  end
+
   def table(label, &block)
     t = Table.new(label)
     t.instance_eval(&block)
@@ -257,6 +273,14 @@ class PageObject < DslElementWithLocator
       alias_output.unshift "alias(#{a.label_value.inspect}):\n" if not alias_output.empty?
       output += alias_output
     }
+    @validators.each{|v|
+      validator_output = []
+      validator_output << "\tvalidator #{v.label_value.inspect} already defined\n" if labeled(@validators).count(v.label_value) > 1
+      validator_output << "\tlabel #{v.label_value.inspect} not a Symbol\n" if not v.label_value.is_a?(Symbol)
+      validator_output << "\tvalidation block is not a Proc\n" if not v.validate_block_value.is_a?(Proc)
+      validator_output.unshift "validator(#{v.label_value.inspect}):\n" if not validator_output.empty?
+      output += validator_output
+    }
     @tables.each{|t|
       table_output = []
       table_output << "\ttable #{t.label_value.inspect} already defined\n" if labeled(@tables).count(t.label_value) > 1
@@ -329,11 +353,16 @@ private
   def fire_action(a, *args)
     raise PageObjectWrapper::BrowserNotFound if @@browser.nil? or not @@browser.exist?
     block = (a.is_a? Action)? a.fire_block_value : action_for(a.action_value).fire_block_value
-    @@browser.instance_exec args, &block
+    @@browser.instance_exec *args, &block
     self.class.map_current_page a.next_page_value
     @@current_page
   end
 
+  def run_validator(v, *args)
+    raise PageObjectWrapper::BrowserNotFound if @@browser.nil? or not @@browser.exist?
+    @@browser.instance_exec *args, &v.validate_block_value
+  end
+
   def select_from_table(table, header, *args)
     where = args[0]
     next_page = args[1]
@@ -414,6 +443,10 @@ private
     labeled(@actions).include?(label.to_sym)
   end
 
+  def has_validator?(label)
+    labeled(@validators).include?(label.to_sym)
+  end
+
   def has_alias?(label)
     labeled(@aliases).include?(label.to_sym)
   end
@@ -438,6 +471,10 @@ private
     @actions[labeled(@actions).index(label.to_sym)]
   end
 
+  def validator_for(label)
+    @validators[labeled(@validators).index(label.to_sym)]
+  end
+
   def alias_for(label)
     @aliases[labeled(@aliases).index(label.to_sym)]
   end

data/lib/page_object_wrapper/Validator.rb

@@ -0,0 +1,11 @@
+require 'Dsl'
+class Validator < DslElement
+  attr_reader :validate_block_value
+
+  def initialize(label, &block)
+    super label
+    @validate_block_value = block
+  end
+end
+
+

data/lib/page_object_wrapper/version.rb

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

data/spec/define_page_object_spec.rb

@@ -127,6 +127,21 @@ describe "define_page_object" do
     end
   end
 
+  context "validator" do
+    subject { page_object.validators[page_object.validators.collect(&:label_value).index(:textarea_value)] }
+
+    it { should be_a(Validator) }
+
+    describe "validator label" do
+      it_should_behave_like "a label"
+    end
+
+    describe "validator attributes" do
+      it { should respond_to(:validate_block_value) }
+      its(:validate_block_value) { should be_a Proc }
+    end
+  end
+
   context "table" do
     subject { page_object.tables[page_object.tables.collect(&:label_value).index(:table_without_header)] }
 

data/spec/{fire_event_spec.rb → fire_event_and_validate_spec.rb}

@@ -18,7 +18,7 @@ describe "page_object.fire_xxx" do
     it "executes fire_block in Watir::Browser context" do
       tp = PageObjectWrapper.open_page(:some_test_page)
       tp.fire_fill_textarea
-      @b.textarea(:id => 'f2').value.should eq('Default data')
+      tp.validate_textarea_value('Default data').should be(true)
     end
 
     context "xxx not found among current_page actions" do
@@ -31,14 +31,14 @@ describe "page_object.fire_xxx" do
     it "can be invoked with parameters" do
       tp = PageObjectWrapper.current_page
       tp.fire_fill_textarea('User defined data')
-      @b.textarea(:id => 'f2').value.should eq('User defined data')
+      tp.validate_textarea_value('User defined data').should be(true)
     end
 
     context "xxx is alias" do
       it "executes corresponding action" do
         tp = PageObjectWrapper.open_page(:some_test_page)
         tp.fire_fill_textarea_alias
-        @b.textarea(:id => 'f2').value.should eq('Default data')
+        tp.validate_textarea_value('Default data').should be(true)
       end
     end
 

data/spec/load_spec.rb

@@ -35,6 +35,8 @@ alias(""):
 	next_page nil not a Symbol
 	next_page nil unknown page_object
 	action "unknown action" not known Action
+validator(""):
+	label "" not a Symbol
 table(""):
 	label "" not a Symbol
 	locator nil not a meaningful Hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_object_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-12-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &8430060 !ruby/object:Gem::Requirement
+  requirement: &20975200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8430060
+  version_requirements: *20975200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8455200 !ruby/object:Gem::Requirement
+  requirement: &20999680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *8455200
+  version_requirements: *20999680
 description: Wraps watir-webdriver with convenient testing interface, based on PageObjects
   automation testing pattern. Simplifies resulting automated test understanding.
 email:
@@ -65,6 +65,7 @@ files:
 - lib/page_object_wrapper/PageObject.rb
 - lib/page_object_wrapper/Pagination.rb
 - lib/page_object_wrapper/Table.rb
+- lib/page_object_wrapper/Validator.rb
 - lib/page_object_wrapper/known_elements.rb
 - lib/page_object_wrapper/version.rb
 - page_object_wrapper.gemspec
@@ -72,7 +73,7 @@ files:
 - spec/defined_elements_spec.rb
 - spec/each_page.rb
 - spec/feed_elements_spec.rb
-- spec/fire_event_spec.rb
+- spec/fire_event_and_validate_spec.rb
 - spec/generate_spec.rb
 - spec/get_food_spec.rb
 - spec/load_spec.rb
@@ -110,7 +111,7 @@ test_files:
 - spec/defined_elements_spec.rb
 - spec/each_page.rb
 - spec/feed_elements_spec.rb
-- spec/fire_event_spec.rb
+- spec/fire_event_and_validate_spec.rb
 - spec/generate_spec.rb
 - spec/get_food_spec.rb
 - spec/load_spec.rb