page_object_wrapper 1.0.0 → 1.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in page_object_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ekhatko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -34,7 +34,9 @@ Or install it yourself as:
 - a label identifies the object
 
 Here in the structure of PageObjectWrapper:
-![PageObjectWrapper scheme](page_object_wrapper/blob/master/img/scheme.png)
+![PageObjectWrapper scheme](https://raw.github.com/evgeniy-khatko/page_object_wrapper/master/img/scheme.png)
+
+where required attributes are marked with (*)
 
 ### Examples
 
@@ -117,10 +119,25 @@ There is a directory, where we've defined a page\_object inside a \*\_page.rb fi
 - it's possible to define several page objects in one file
 - .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
+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  
+
+*preconditions*  
+**tp** is a :some\_test\_page object opened in the browser
+
+      tp.tf # => Watir::TextField
+      tp.rb # => Watir::Radio
+      tp.test_elements # => Array of Watir elements
+
+
 
 #### feed\_xxx
 *preconditions*  
-tp is a :some\_test\_page object opened in the browser
+**tp** is a :some\_test\_page object opened in the browser
 
     context "argument = :fresh_food" do
       it "populates all xxx elements with :fresh_food" do
@@ -146,7 +163,7 @@ tp is a :some\_test\_page object opened in the browser
 
 #### fire\_xxx
 *preconditions*  
-tp is a :some\_test\_page object opened in the browser
+**tp** is a :some\_test\_page object opened in the browser
 
     it "executes fire_block in Watir::Browser context" do
       tp = PageObjectWrapper.open_page(:some_test_page)
@@ -165,7 +182,7 @@ tp is a :some\_test\_page object opened in the browser
 
 #### select\_from\_xxx
 *preconditions*  
-tp is a :some\_test\_page object opened in the browser  
+**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'*     
       page\_object.select\_from\_xxx( :column1, :column2 => 'string\_or\_regexp' )    
 correct arguments are:  
@@ -213,8 +230,7 @@ TODO
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-page\_object\_wrapper
-===================
+5. Create new Pull Request  
 
+##page\_object\_wrapper
 Wraps watir-webdriver with convenient testing interface, based on PageObjects automation testing pattern. Simplifies resulting automated test understanding.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bad_pages/bad_page.rb

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

data/good_pages/some_test_page.rb

@@ -38,6 +38,8 @@ PageObjectWrapper.define_page(:some_test_page) do
     textarea(:id => 'f2').set data
   end
 
+  action_alias(:fill_textarea_alias, :some_test_page){ action :fill_textarea }
+
   table(:table_without_header) do
     locator :summary => 'Each row names a Nordic country and specifies its total area and land area, in square kilometers'
   end

data/lib/page_object_wrapper/Alias.rb

@@ -0,0 +1,12 @@
+require 'Dsl'
+class Alias < DslElement
+  attr_reader :next_page_value
+  dsl_attr_accessor :action
+
+  def initialize(label, next_page)
+    super label
+    @next_page_value = next_page
+  end
+end
+
+

data/lib/page_object_wrapper/PageObject.rb

@@ -5,12 +5,13 @@ include PageObjectWrapper
 require 'ElementsSet'
 require 'Element'
 require 'Action'
+require 'Alias'
 require 'Table'
 require 'Pagination'
 require 'known_elements'
 
 class PageObject < DslElementWithLocator
-  attr_reader :esets, :elements, :actions, :tables, :paginations, :uniq_element_type, :uniq_element_hash
+  attr_reader :esets, :elements, :actions, :aliases, :tables, :paginations, :uniq_element_type, :uniq_element_hash
   @@browser = nil
   @@pages = []
   @@current_page = nil
@@ -30,6 +31,7 @@ class PageObject < DslElementWithLocator
     @esets = []
     @elements = []
     @actions = []
+    @aliases = []
     @tables = []
     @paginations = []
   end
@@ -60,6 +62,10 @@ class PageObject < DslElementWithLocator
         # page_object.fire_some_action
         a = action_for($1)
         fire_action(a, *args)
+      when (FIRE_ACTION.match(method_name) and has_alias?($1))
+        # page_object.fire_some_action
+        a = alias_for($1)
+        fire_action(a, *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)
@@ -99,6 +105,9 @@ class PageObject < DslElementWithLocator
       when (FIRE_ACTION.match(method_name) and has_action?($1))
         # page_object.fire_some_action
         true
+      when (FIRE_ACTION.match(method_name) and has_alias?($1))
+        # page_object.fire_some_action
+        true
       when (SELECT_FROM.match(method_name) and has_table?($1))
         # page_object.select_from_some_table(:header_column, {:column => 'value'})
         true
@@ -162,6 +171,13 @@ class PageObject < DslElementWithLocator
     a
   end
 
+  def action_alias(label, next_page, &block)
+    a = Alias.new(label, next_page)
+    a.instance_eval(&block)
+    @aliases << a
+    a
+  end
+
   def table(label, &block)
     t = Table.new(label)
     t.instance_eval(&block)
@@ -208,6 +224,16 @@ class PageObject < DslElementWithLocator
       action_output.unshift "action(#{a.label_value.inspect}):\n" if not action_output.empty?
       output += action_output
     }
+    @aliases.each{|a|
+      alias_output = []
+      alias_output << "\talias #{a.label_value.inspect} already defined\n" if labeled(@aliases).count(a.label_value) > 1
+      alias_output << "\tlabel #{a.label_value.inspect} not a Symbol\n" if not a.label_value.is_a?(Symbol)
+      alias_output << "\tnext_page #{a.next_page_value.inspect} not a Symbol\n" if not a.next_page_value.is_a? Symbol
+      alias_output << "\tnext_page #{a.next_page_value.inspect} unknown page_object\n" if not labeled(@@pages).include?(a.next_page_value)
+      alias_output << "\taction #{a.action_value.inspect} not known Action\n" if not labeled(@actions).include? a.action_value
+      alias_output.unshift "alias(#{a.label_value.inspect}):\n" if not alias_output.empty?
+      output += alias_output
+    }
     @tables.each{|t|
       table_output = []
       table_output << "\ttable #{t.label_value.inspect} already defined\n" if labeled(@tables).count(t.label_value) > 1
@@ -280,7 +306,8 @@ private
 
   def fire_action(a, *args)
     raise PageObjectWrapper::BrowserNotFound if @@browser.nil?
-    @@browser.instance_exec args, &a.fire_block_value
+    block = (a.is_a? Action)? a.fire_block_value : action_for(a.action_value).fire_block_value
+    @@browser.instance_exec args, &block
     self.class.map_current_page a.next_page_value
     @@current_page
   end
@@ -349,6 +376,10 @@ private
     labeled(@actions).include?(label.to_sym)
   end
 
+  def has_alias?(label)
+    labeled(@aliases).include?(label.to_sym)
+  end
+
   def eset_for(label)
     @esets[labeled(@esets).index(label.to_sym)]
   end
@@ -368,4 +399,8 @@ private
   def action_for(label)
     @actions[labeled(@actions).index(label.to_sym)]
   end
+
+  def alias_for(label)
+    @aliases[labeled(@aliases).index(label.to_sym)]
+  end
 end

data/lib/page_object_wrapper/version.rb

@@ -1,3 +1,3 @@
 module PageObjectWrapper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/page_object_wrapper.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'page_object_wrapper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "page_object_wrapper"
+  gem.version       = PageObjectWrapper::VERSION
+  gem.authors       = ["Evgeniy Khatko"]
+  gem.email         = ["evgeniy.khatko@gmail.com"]
+  gem.description   = %q{Wraps watir-webdriver with convenient testing interface, based on PageObjects automation testing pattern. Simplifies resulting automated test understanding.}
+  gem.summary       = %q{Wraps watir-webdriver with convenient testing interface.}
+  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) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib","lib/page_object_wrapper"]
+end

data/spec/define_page_object_spec.rb

@@ -39,6 +39,9 @@ describe "define_page_object" do
     specify { subject.actions.collect(&:label_value).should include(:press_cool_button)}
     it { should respond_to(:fire_press_cool_button) }
 
+    specify { subject.aliases.collect(&:label_value).should include(:fill_textarea_alias)}
+    it { should respond_to(:fire_fill_textarea_alias) }
+
     specify { subject.tables.collect(&:label_value).should include(:table_without_header)}
     it { should respond_to(:select_from_table_without_header) }
     it { should respond_to(:select_from_table_with_header) }
@@ -101,7 +104,7 @@ describe "define_page_object" do
       it_should_behave_like "a label"
     end
 
-    describe "action next_page" do
+    describe "action attributes" do
       it { should respond_to(:next_page_value) }
       it { should respond_to(:fire_block_value) }
 
@@ -110,6 +113,24 @@ describe "define_page_object" do
     end
   end
 
+  context "action alias" do
+    subject { page_object.aliases[page_object.aliases.collect(&:label_value).index(:fill_textarea_alias)] }
+
+    it { should be_a(Alias) }
+
+    describe "alias label" do
+      it_should_behave_like "a label"
+    end
+
+    describe "alias attributes" do
+      it { should respond_to(:next_page_value) }
+      it { should respond_to(:action_value) }
+
+      its(:next_page_value){ should eq :some_test_page }
+      its(:action_value) { should eq :fill_textarea }
+    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

@@ -17,25 +17,22 @@ describe "page_object.fire_xxx" do
     before(:all){
       @b = Watir::Browser.new
       PageObjectWrapper.use_browser @b
-      begin
         PageObjectWrapper.load('./good_pages')
-      rescue
-      end
     }
     after(:all){ PageObjectWrapper.browser.close }
 
+    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')
+    end
+
     context "xxx not found among current_page actions" do
       it "raises NoMethodError" do
         tp = PageObjectWrapper.current_page
         expect{tp.fire_nonexistent_action}.to raise_error(NoMethodError)
       end
     end
-    
-    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')
-    end
 
     it "can be invoked with parameters" do
       tp = PageObjectWrapper.current_page
@@ -43,11 +40,20 @@ describe "page_object.fire_xxx" do
       @b.textarea(:id => 'f2').value.should eq('User defined data')
     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')
+      end
+    end
+
     it "returns next_page" do
       tp = PageObjectWrapper.current_page
       np = tp.fire_press_cool_button
       np.should be_a(PageObject)
       np.label_value.should eq(:test_page_with_table)
     end
+
   end
 end

data/spec/load_spec.rb

@@ -30,6 +30,11 @@ action(""):
 	label "" not a Symbol
 	next_page nil not a Symbol
 	next_page nil unknown page_object
+alias(""):
+	label "" not a Symbol
+	next_page nil not a Symbol
+	next_page nil unknown page_object
+	action "unknown action" not known Action
 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.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2012-12-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &11659160 !ruby/object:Gem::Requirement
+  requirement: &5265420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11659160
+  version_requirements: *5265420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11658620 !ruby/object:Gem::Requirement
+  requirement: &5243480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *11658620
+  version_requirements: *5243480
 description: Wraps watir-webdriver with convenient testing interface, based on PageObjects
   automation testing pattern. Simplifies resulting automated test understanding.
 email:
@@ -42,7 +42,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
+- LICENSE.txt
 - README.md
+- Rakefile
 - bad_pages/bad_page.rb
 - good_pages/another_test_page.rb
 - good_pages/some_test_page.rb
@@ -50,6 +53,7 @@ files:
 - img/scheme.png
 - lib/page_object_wrapper.rb
 - lib/page_object_wrapper/Action.rb
+- lib/page_object_wrapper/Alias.rb
 - lib/page_object_wrapper/Dsl.rb
 - lib/page_object_wrapper/Element.rb
 - lib/page_object_wrapper/ElementsSet.rb
@@ -59,6 +63,7 @@ files:
 - lib/page_object_wrapper/Table.rb
 - lib/page_object_wrapper/known_elements.rb
 - lib/page_object_wrapper/version.rb
+- page_object_wrapper.gemspec
 - spec/define_page_object_spec.rb
 - spec/defined_elements_spec.rb
 - spec/feed_elements_spec.rb