domkey 0.1.0 → 0.2.0

data/spec/page_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
-module DomkeyExample
-  class DomIsWatirproc
+
+describe Domkey::View do
+
+  class DomIspackage
     include Domkey::View
-    #pageobject is watirproc
+    #pageobject is package
     dom(:street) { text_field(id: 'street1') }
     dom(:city) { text_field(id: 'city1') }
   end
@@ -37,16 +39,14 @@ module DomkeyExample
     #  dom(:city) { text_field(id: 'city') }
     #end
   end
-end
 
-describe Domkey::View do
 
   before :all do
-    Domkey.browser.goto("file://" + __dir__ + "/html/test.html")
+    goto_html("test.html")
   end
 
-  it 'domw is watirproc' do
-    view = DomkeyExample::DomIsWatirproc.new
+  it 'dom is package' do
+    view = DomIspackage.new
     view.should respond_to(:street)
     view.street.should be_kind_of(Domkey::View::PageObject)
 
@@ -56,14 +56,14 @@ describe Domkey::View do
   end
 
   it 'dom is hash of dom' do
-    view = DomkeyExample::DomIsHashOfDom.new
+    view = DomIsHashOfDom.new
 
     view.should respond_to(:address)
 
-    view.address.watirproc.should respond_to(:each_pair)
-    view.address.watirproc.should_not be_empty
+    view.address.package.should respond_to(:each_pair)
+    view.address.package.should_not be_empty
 
-    view.address.watirproc.each_pair do |k, v|
+    view.address.package.each_pair do |k, v|
       k.should be_kind_of(Symbol)
       v.should be_kind_of(Domkey::View::PageObject) #should respond to set and value
     end

data/spec/radio_group_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Domkey::View::RadioGroup do
+
+  class CollectionAsPageObjectRadioGroupView
+    include Domkey::View
+
+    # one named radio group
+    def group
+      RadioGroup.new -> { radios(name: 'tool') }
+    end
+
+    # no good. collection resolves to more than one coherent group
+    def groups
+      RadioGroup.new -> { radios(name: /^group/) }
+    end
+  end
+
+  before :all do
+    goto_html("test.html")
+  end
+
+  it 'two groups example' do
+    v = CollectionAsPageObjectRadioGroupView.new
+    expect { v.groups.to_a.size }.to raise_error
+    expect { v.groups.map { |e| e } }.to raise_error
+    expect { v.groups.count }.to raise_error
+  end
+
+  context "OptionSelectable object single" do
+    # OptionSelectable object is an object that responds to options and is selectable by its optioins;
+    # RadioGroup, Select, CheckboxGroup. CheckboxGroup acts like Multi Select, RadioGroup acts like Single Select
+
+    before :each do
+      goto_html("test.html")
+
+      @v = CollectionAsPageObjectRadioGroupView.new
+      @v.group.count.should == 3
+      @v.group.to_a.each { |e| e.should be_kind_of(Domkey::View::PageObject) }
+    end
+
+    it 'initial value on test page' do
+      @v.group.value.should eql ['other']
+    end
+
+    it 'set value attribute by default. value returns that value attribute' do
+      @v.group.set 'tomato'
+      @v.group.value.should eql ['tomato']
+      @v.group.set /^oth/
+      @v.group.value.should eql ['other']
+    end
+
+    it 'set array of value attribute. last value wins' do
+      @v.group.set ['tomato']
+      @v.group.value.should eql ['tomato']
+
+      @v.group.set ['other', 'tomato', /cucu/]
+      @v.group.value.should eql ['cucumber']
+    end
+
+    it 'set false has no effect. value is initial value on the page' do
+      @v.group.set false
+      @v.group.value.should eql ['other']
+    end
+
+    it 'set empty array clears all. value is empty array' do
+      @v.group.set []
+      @v.group.value.should eql ['other']
+    end
+
+    it 'set value string not found error' do
+      expect { @v.group.set 'foobar' }.to raise_error
+    end
+
+    it 'set value regexp not found error' do
+      expect { @v.group.set /balaba/ }.to raise_error
+    end
+
+    it 'options' do
+      @v.group.options.should eql ["cucumber", "tomato", "other"]
+    end
+
+  end
+
+end

data/spec/selenium_webdriver_api_example.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+# Watir API is the Bee's Knees
+# but you can use lower level Selenium::WebDriver API for container and package definitions
+# you will need to override set and value methods to delegate to Selenium::WebDriver::Element
+
+describe 'Selenium::WebDriver API Example' do
+
+  before :all do
+    Domkey.browser.goto("file://" + __dir__ + "/../html/test.html")
+    @driverpackage = -> { Domkey.browser.driver }
+  end
+
+  context 'when container is selenium webdriver and' do
+
+    it 'package is package' do
+      package = lambda { find_element(id: 'street1') }
+      street  = Domkey::View::PageObject.new package, @driverpackage
+
+      street.package.should be_kind_of(Proc)
+      street.element.should be_kind_of(Selenium::WebDriver::Element) #one default element
+
+      street.element.send_keys 'Lamar'
+      street.element.attribute('value').should eql 'Lamar'
+    end
+
+    it 'package is pageobject' do
+      # setup
+      webdriver_element = lambda { find_element(id: 'street1') }
+
+      pageobject = Domkey::View::PageObject.new webdriver_element, @driverpackage
+      street     = Domkey::View::PageObject.new pageobject, @driverpackage
+
+      street.package.should be_kind_of(Proc)
+      street.element.should be_kind_of(Selenium::WebDriver::Element)
+
+      street.element.clear
+      street.element.send_keys 'zooom'
+      street.element.attribute('value').should eql 'zooom'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,7 +7,24 @@ end
 require 'domkey'
 SimpleCov.command_name "test:units"
 
+module DomkeySpecHelper
+
+  def goto_watirspec file
+    goto("file://" + __dir__ + "/watirspec/html/#{file}")
+  end
+
+  def goto_html file
+    goto("file://" + __dir__ + "/html/#{file}")
+  end
+
+  def goto path
+    Domkey.browser.goto path
+  end
+
+end
+
 RSpec.configure do |config|
+  config.include DomkeySpecHelper
   config.after :all do
     Domkey.browser.close
   end

data/spec/view_cargo_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Domkey::View::Cargo do
+
+  class AddressView
+    include Domkey::View
+    dom(:city) { text_field(id: 'city1') }
+    dom(:street) { text_field(id: 'street1') }
+
+    # semantic descriptor that returns another view
+    # the other view has PageObjects that participate in this view
+    def shipping
+      ShippingAddressView.new
+    end
+
+    # semantic descriptor that returns PageObject
+    def fruit
+      CheckboxGroup.new -> { checkboxes(name: 'fruit') }
+    end
+
+  end
+
+  class ShippingAddressView
+    include Domkey::View
+    dom(:city) { text_field(id: 'city2') }
+    dom(:street) { text_field(id: 'street2') }
+
+    def delivery_date
+      DateView.new
+    end
+  end
+
+  class DateView
+    include Domkey::View
+    dom(:month) { text_field(id: 'month_field') }
+  end
+
+  before :each do
+    goto_html("test.html")
+  end
+
+  it 'view within pageobject' do
+    model = {city:   'Austin',
+             street: 'Lamar'}
+
+    cargo = Domkey::View::Cargo.new model: model, view: AddressView.new
+    cargo.set
+    extracted = cargo.value
+    extracted.should eql model
+  end
+
+  it 'view within view' do
+    model = {city:     'Austin',
+             street:   'Lamar',
+             shipping: {city:   'Georgetown',
+                        street: 'Austin'}
+    }
+
+    cargo = Domkey::View::Cargo.new model: model, view: AddressView.new
+    cargo.set
+    extracted = cargo.value
+    extracted.should eql model
+  end
+
+  it 'view view view' do
+    model = {city:     'Austin',
+             street:   'Lamar',
+             shipping: {city:          'Georgetown',
+                        street:        'Austin',
+                        # this is view within a view within original view
+                        delivery_date: {month: 'delivery thing'}}
+    }
+
+    cargo = Domkey::View::Cargo.new model: model, view: AddressView.new
+    cargo.set
+    extracted = cargo.value
+    extracted.should eql model
+  end
+
+  it 'cargo' do
+    model = {city: 'Mordor'}
+
+    view  = AddressView.new
+    cargo = Domkey::View::Cargo.new view: view, model: model
+    cargo.set
+    scraped_model = cargo.value
+
+    scraped_model.should eql model
+  end
+
+  it 'pageobject' do
+
+    model               = {city: 'Austin', fruit: ['tomato', 'other']}
+    cargo               = AddressView.cargo model
+
+    # default values when page loads before setting the values
+    default_page_values = {:city=>"id city class city", :fruit=>["other"]}
+    cargo.value.should eql default_page_values
+    cargo.set
+
+    extracted_model = cargo.value
+    extracted_model.should eql model
+
+  end
+
+end

data/spec/view_dom_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
-module DomkeyExample
+
+describe Domkey::View do
 
   class SingleDom
     include Domkey::View
@@ -15,32 +16,65 @@ module DomkeyExample
     dom(:street) { text_field(class: 'street1') }
   end
 
-end
-
-describe Domkey::View do
-
   before :all do
-    Domkey.browser.goto("file://" + __dir__ + "/html/test.html")
+    goto_html("test.html")
   end
 
-  it 'dom single element' do
-    view = DomkeyExample::SingleDom.new
-    view.should respond_to(:street)
-    view.street.should be_kind_of(Domkey::View::PageObject)
-    view.street.value.should == ''
-    view.street.set 'bla'
-    view.street.value.should == 'bla'
-    view.container.street.value.should == ''
-    view
+  context 'dom for single element' do
+
+    before :all do
+      @view = SingleDom.new
+    end
+
+    it 'view responds to dom' do
+      @view.should respond_to(:street)
+    end
+
+    it 'dom returns PageObject' do
+      @view.street.should be_kind_of(Domkey::View::PageObject)
+    end
+
+    it 'dom set and value' do
+      @view.street.value.should == ''
+      @view.street.set 'bla'
+      @view.street.value.should == 'bla'
+    end
   end
 
+  context 'view method returns view that acts like pageobject' do
+    before :all do
+      @view = SingleDom.new
+    end
+
+    it 'view semantic descriptor returns view' do
+      @view.container.should be_kind_of(Domkey::View)
+    end
+
+    it 'view within view is a page object' do
+      @view.container.street.should be_kind_of(Domkey::View::PageObject)
+    end
+
+    it 'value requires args' do
+      expect { @view.container.value }.to raise_error
+    end
+
+    it 'setting and value args' do
+      @view.container.set street: 'Nowy Świat'
+
+      v = @view.container.value :street
+      v.should eql({:street=>"Nowy Świat"})
+
+      v = @view.container.value [:street]
+      v.should eql({:street=>"Nowy Świat"})
+    end
+  end
 end
 
 #require 'benchmark'
 #Benchmark.bm do |bm|
 #  howmany = 50
 #  # setup browser
-#  Domkey.browser.goto("file://" + __dir__ + "/html/test.html")
+#  goto_html("test.html")
 #  view = DomkeyExample::SingleDom.new Domkey.browser
 #  bm.report('domkey') do
 #    howmany.times do

data/spec/view_doms_spec.rb

@@ -1,19 +1,19 @@
 require 'spec_helper'
-module DomkeyExample
-  class Doms
+
+describe Domkey::View do
+
+  class DomsExample
     include Domkey::View
     doms(:streets) { text_fields(class: 'street1') }
   end
-end
 
-describe Domkey::View do
 
   before :all do
-    Domkey.browser.goto("file://" + __dir__ + "/html/test.html")
+    goto_html("test.html")
   end
 
   it 'doms collection' do
-    view = DomkeyExample::Doms.new
+    view = DomsExample.new
     view.should respond_to(:streets)
     view.streets.should be_kind_of(Domkey::View::PageObjectCollection)
     view.streets.each { |e| e.should be_kind_of(Domkey::View::PageObject) }
@@ -32,7 +32,7 @@ end
 #Benchmark.bm do |bm|
 #  howmany = 50
 #  # setup browser
-#  Domkey.browser.goto("file://" + __dir__ + "/html/test.html")
+#  goto_html("test.html")
 #  view = DomkeyExample::Doms.new Domkey.browser
 #  bm.report('domkey') do
 #    howmany.times do

data/spec/watir_widget_select_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe Domkey::View::WatirWidget do
+
+  context Watir::Select do
+
+    context "Multi" do
+
+      before :all do
+        @object = Domkey.browser.select(id: 'multiselect')
+        @widget = Domkey::View::WatirWidget.new(@object)
+      end
+
+      before :each do
+        goto_html("test.html")
+      end
+
+      it 'initial value on the test page' do
+        @widget.value.should eql ["English", "Norwegian"]
+      end
+
+      it 'set array of strings clears all. sets text items provided. value is array of visible texts' do
+        # texts are items visible to the user [text or label of select list option]
+        @widget.set ['Polish', 'Norwegian']
+        @widget.value.should eql ["Norwegian", "Polish"]
+      end
+
+      it 'set false clears all. value is empty array' do
+        @widget.set false
+        @widget.value.should eql []
+      end
+
+      it 'set empty array clears all. value is empty array' do
+        @widget.set []
+        @widget.value.should eql []
+      end
+
+      it 'set string clears all. sets one text item. value is one item' do
+        @widget.set 'Polish'
+        @widget.value.should eql ["Polish"]
+      end
+
+      it 'set by text' do
+        @widget.set text: 'Polish'
+        @widget.value.should eql ["Polish"]
+      end
+
+      it 'set by array of texts' do
+        # client would not usually do this.
+        # Client would simply call set ['Polish', 'Norwegian']
+        # becuase text: qualifer is a default way of setting select list by visible text
+        @widget.set text: ['Polish', 'Norwegian']
+        @widget.value.should eql ["Norwegian", "Polish"]
+      end
+
+      it 'set index by option position' do
+        @widget.set index: 1
+        @widget.value.should eql ['English']
+      end
+
+      it 'set index array of option positions' do
+        @widget.set index: [0, 2]
+        @widget.value.should eql ["Danish", "Norwegian"]
+      end
+
+      it 'set value attribute string' do
+        @widget.set value: '2'
+        @widget.value.should eql ['English']
+      end
+
+      it 'set value attribute array of strings' do
+        @widget.set value: ['2', '1']
+        @widget.value.should eql ["Danish", "English"]
+      end
+
+      it 'set by many qualifiers at once' do
+        @widget.set value: ['2', '1'],
+                    text:  'Swedish',
+                    index: 3
+        @widget.value.should eql ['Danish', 'English', 'Polish', 'Swedish']
+      end
+
+      it 'options' do
+        @widget.options.should eql [{:text=>"Danish", :value=>"1"},
+                                    {:text=>"English", :value=>"2"},
+                                    {:text=>"Norwegian", :value=>"3"},
+                                    {:text=>"Polish", :value=>""},
+                                    {:text=>"Swedish", :value=>"Swedish"}]
+      end
+
+    end
+
+    context "Single" do
+
+      before :all do
+        object  = Domkey.browser.select(id: 'fruit_list')
+        @widget = Domkey::View::WatirWidget.new(object)
+      end
+
+      before :each do
+        goto_html("test.html")
+      end
+
+      it 'initial value on the test page visible text to the user' do
+        @widget.value.should eql ['Default']
+      end
+
+      it 'set string selects visible text. value is visible text to the user' do
+        # option text
+        @widget.set 'Tomato'
+        @widget.value.should eql ['Tomato'] # not value attribute, visible text [text, label]
+
+        # option label attribute text
+        @widget.set 'Other'
+        @widget.value.should eql ['Other']
+      end
+
+      it 'set array of text or label' do
+        @widget.set ['Other', 'Tomato'] #cycle on single select list
+        @widget.value.should eql ['Tomato'] # the last one set
+      end
+
+      it 'set by array of text' do
+        @widget.set text: ['Other', 'Tomato']
+        @widget.value.should eql ['Tomato']
+      end
+
+      it 'set false has no effect. value is selected item text' do
+        @widget.set false
+        @widget.value.should eql ['Default']
+      end
+
+      it 'set empty array has no effect. value is selected item text' do
+        @widget.set []
+        @widget.value.should eql ['Default']
+      end
+
+      it 'set index position' do
+        @widget.set index: 1
+        @widget.value.should eql ['Cucumber']
+      end
+
+      it 'set index array' do
+        @widget.set index: [0, 2]
+        @widget.value.should eql ['Other'] # the last one wins
+      end
+
+      it 'set value attribute string' do
+        @widget.set value: 'tomato'
+        @widget.value.should eql ['Tomato']
+      end
+
+      it 'set value attribute array of strings' do
+        @widget.set value: ['tomato', 'gurken']
+        @widget.value.should eql ['Cucumber']
+      end
+
+      it 'set by many qualifiers at once' do
+        @widget.set value: ['gurken'],
+                    text:  'Tomato',
+                    index: 2
+        @widget.value.should eql ['Other']
+      end
+
+      it 'options' do
+        @widget.options.should eql [{:text=>"Tomato", :value=>"tomato"},
+                                    {:text=>"Cucumber", :value=>"gurken"},
+                                    {:text=>"Other", :value=>""},
+                                    {:text=>"Default", :value=>"Default"}]
+      end
+
+    end
+
+  end
+
+end