domkey 0.1.0 → 0.2.0

data/lib/domkey/view/page_object_collection.rb

@@ -2,45 +2,36 @@ module Domkey
 
   module View
 
+    # PageObjectCollection see PageObject for detailes.
+    # Compose PageObjectCollection with package and container
+    #
+    # What is a container? see PageObject container
+    #
+    # What is package? see PageObject package except the following:
+    # package can be one of the following:
+    #   - definition of watir elements collection i.e. `-> { text_fields(:class, /^foo/)}`
+    #   - a pageobject i.e. previously instantiated definition watir elements collection
+    #   - hash where key defines subelement and value a definition or pageobject
+    # Usage:
+    # Clients would not usually instantate this class.
+    # A client class which acts as a View would use a :doms factory method to create PageObjectCollection
+    # TODO Example:
     class PageObjectCollection
-      include Enumerable
-
-      attr_accessor :watirproc, :container
-
-      # PageObjectCollection see PageObject for detailes.
-      # Compose PageObjectCollection with watirproc and container
-      #
-      # What is a container? see PageObject container
-      #
-      # What is watirproc? see PageObject watirproc except the following:
-      # watirproc can be one of the following:
-      #   - definition of watir elements collection i.e. `-> { text_fields(:class, /^foo/)}`
-      #   - a pageobject i.e. previously instantiated definition watir elements collection
-      #   - hash where key defines subelement and value a definition or pageobject
-      # Usage:
-      # Clients would not usually instantate this class.
-      # A client class which acts as a View would use a :doms factory method to create PageObjectCollection
-      # Example:
-      #
-      def initialize watirproc, container=lambda { Domkey.browser }
-        @container = container
-        @watirproc = initialize_this watirproc
-      end
 
-      def element(key=false)
-        return instantiator unless watirproc.respond_to?(:each_pair)
-        return watirproc.fetch(key).element if key
-        Hash[watirproc.map { |key, watirproc| [key, watirproc.element] }]
-      end
+      include WidgetryPackage
+      include Enumerable
 
+      # @return [PageObject, Hash{Symbol => PageObjectCollection}]
       def each(&blk)
-        if watirproc.respond_to?(:each_pair)
-          watirproc.map { |k, v| [k, PageObjectCollection.new(lambda { v }, @container)] }.each { |k, v| yield Hash[k, v] }
+        if package.respond_to?(:each_pair)
+          package.map { |k, v| [k, PageObjectCollection.new(lambda { v }, @container)] }.each { |k, v| yield Hash[k, v] }
         else
           instantiator.each { |e| yield PageObject.new(lambda { e }, @container) }
         end
       end
 
+      # @param [Fixnum]
+      # @return [PageObject, Hash{Symbol => PageObjectCollection}]
       def [] idx
         to_a[idx]
       end
@@ -49,30 +40,21 @@ module Domkey
 
       private
 
-      # --
-      # recursive
-      def initialize_this watirproc
-        if watirproc.respond_to?(:each_pair) #hash
-          Hash[watirproc.map { |key, watirproc| [key, PageObjectCollection.new(watirproc, container)] }]
+      # @api private
+      # Recursive. Examines each packages and turns each Proc into PageObject
+      def initialize_this package
+        if package.respond_to?(:each_pair) #hash
+          Hash[package.map { |key, package| [key, PageObjectCollection.new(package, container)] }]
         else
-          if watirproc.respond_to?(:call) #proc
-            watirproc
-          elsif watirproc.respond_to?(:watirproc)
-            watirproc.watirproc
+          if package.respond_to?(:call) #proc
+            package
+          elsif package.respond_to?(:package)
+            package.package
           else
-            fail Exception::Error, "watirproc must be kind of hash, watirelement or pageobject but I got this: #{watirproc}"
+            fail Exception::Error, "package must be kind of hash, watirelement or pageobject but I got this: #{package}"
           end
         end
       end
-
-      def instantiator
-        container_at_runtime.instance_exec(&watirproc)
-      end
-
-      def container_at_runtime
-        container.respond_to?(:call) ? container.call : container.send(:instantiator)
-      end
-
     end
   end
 end

data/lib/domkey/view/radio_group.rb

@@ -0,0 +1,70 @@
+require 'domkey/view/labeled_group'
+module Domkey
+
+  module View
+
+    # RadioGroup allows you to interact with PageObjectCollection of radios as a single PageObject
+    # Radios collection is constrained by the same name attribute and behaves like one object.
+    # It behaves like a single Select list.
+    # When one radio is selected in the collection the others become unselected.
+    class RadioGroup < PageObjectCollection
+
+      # @param [String] match text in value attribute and set that radio
+      def set value
+        validate_scope
+        return unless value
+        [*value].each do |v|
+          e = case v
+              when String
+                element.find { |e| e.value == v }
+              when Regexp
+                element.find { |e| e.value.match(v) }
+              end
+          e ? e.set : fail(Exception::Error, "RadioGroup value not found: #{v.inspect}")
+        end
+      end
+
+      # @return [String] text in value attribute of currently set
+      def value
+        validate_scope
+        element.find_all { |r| r.set? }.map { |e| e.value }
+      end
+
+      def options
+        validate_scope
+        element.map { |e| e.value }
+      end
+
+      # convert to LabeledGroup settable by corresponding label text
+      def to_labeled
+        LabeledGroup.new(self)
+      end
+
+      # @yield [PageObject]
+      def each(&blk)
+        validate_scope
+        super(&blk)
+      end
+
+      # @return [Array<PageObject>]
+      def to_a
+        validate_scope
+        super
+      end
+
+      private
+
+      # precondition on acting on this collection
+      # @return [true] when all radios in collection share the same name attribute
+      # @raise [Exception::Error] when where is more than one unique name attribute
+      # --
+      # returns true on subsequent unless magically more radios show up after initial validation
+      def validate_scope
+        return if @validated
+        groups = element.map { |e| e.name }.uniq
+        fail(Exception::Error, "RadioGroup definition scope too broad: Found #{groups.count} radio groups with names: #{groups}") unless (groups.size == 1)
+        @validated = true
+      end
+    end
+  end
+end

data/lib/domkey/view/watir_widget.rb

@@ -0,0 +1,106 @@
+module Domkey
+
+  module View
+
+    # @api private
+    class WatirWidget
+
+      def initialize(object)
+        @object           = object
+        object_class_name = @object.class.name.split('::').last
+        @set_method       = "set_%s" % object_class_name
+        @value_method     = "value_%s" % object_class_name
+        @options_method   = "options_%s" % object_class_name
+      end
+
+      def set value
+        return __send__(@set_method, value) if respond_to?(@set_method, true)
+        @object.set value
+      end
+
+      def value
+        return __send__(@value_method) if respond_to?(@value_method, true)
+        @object.value
+      end
+
+      def options
+        return __send__(@options_method) if respond_to?(@options_method, true)
+        opts = @object.options
+        opts.count == 0 ? [] : opts
+      end
+
+      private
+
+      def options_Select
+        @object.options.map do |o|
+          {text:  o.text,
+           value: o.value}
+        end
+      end
+
+      # for Watir::Select
+      # @param [String] text or label to be selected. Text visible to the user on the page
+      # @param [Array<String>] collection for multiselect to select
+      def set_Select value
+        @object.clear if @object.multiple?
+        set_Select_strategy value
+      end
+
+      def set_Select_strategy value
+        case value
+        when String
+          @object.select value
+        when Array
+          value.each { |v| set_Select_strategy v }
+        when Hash
+          value.each_pair do |how, what|
+
+            #-- select by option position: can be one or many index: 0, index: [0,1,2,3]
+            if how == :index
+              case what
+              when Fixnum
+                @object.options[what].select
+              when Array
+                what.each do |i|
+                  @object.options[i].select
+                end
+              end
+            end
+
+            #-- select by option value: attribute (invisible to the user)
+            if how == :value
+              case what
+              when String
+                @object.select_value what
+              when Array
+                what.each { |v| @object.select_value v }
+              end
+            end
+
+            #-- select by text visible to the user. This is the same as default set 'Text' behavior
+            if how == :text
+              case what
+              when String
+                set_Select_strategy what
+              when Array
+                what.each { |v| set_Select_strategy v }
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+      # @return [String] text or label from Select, not actual 'value' attribute?
+      # @return [Array<String>] collection for multiselect list
+      # @return [False] when nothing selected in multiselect list
+      def value_Select
+        @object.selected_options.map { |o| o.text }
+      end
+
+
+    end
+  end
+end

data/lib/domkey/view/widgetry_package.rb

@@ -0,0 +1,48 @@
+module Domkey
+
+  module View
+
+    module WidgetryPackage
+
+      attr_accessor :package, :container
+
+      # initialize PageObject or PageObjectCollection
+      # for PageObject expects WebdriverElement a single element definition i.e text_field, checkbox
+      # for PageObjectCollection expects WebdriverElement a collection definition i.e. text_fields, checkboxes
+      # @param package [Proc(WebdriverElement)]
+      # @param package [PageObject]
+      # @param package [Hash{Symbol => Proc(WebdriverElement)]
+      # @param package [Hash{Symbol => PageObject]
+      def initialize package, container=lambda { Domkey.browser }
+        @container = container
+        @package   = initialize_this package
+      end
+
+      # access widgetry of watir elements composing this page object
+      # @param [Symbol] (false)
+      # @return [Hash{Symbol => WebdriverElement}]
+      # @return [WebdriverElement]
+      def element(key=false)
+        return instantiator unless package.respond_to?(:each_pair)
+        return package.fetch(key).element if key
+        Hash[package.map { |key, package| [key, package.element] }]
+      end
+
+      private
+
+      # talks to the browser
+      # returns runtime element in a specified container
+      # @return [WebdriverElement]
+      def instantiator
+        container_instantiator.instance_exec(&package)
+      end
+
+      # talks to the browser
+      # returns runtime container element in a browser/driver
+      # @return [WebdriverElement]
+      def container_instantiator
+        container.respond_to?(:call) ? container.call : container.send(:instantiator)
+      end
+    end
+  end
+end

data/spec/checkbox_group_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Domkey::View::CheckboxGroup do
+
+  class CollectionAsPageObjectCheckboxGroupView
+    include Domkey::View
+
+    def group
+      CheckboxGroup.new -> { checkboxes(name: 'fruit') }
+    end
+
+    def groups
+      CheckboxGroup.new -> { checkboxes(name: /^fruit/) }
+    end
+  end
+
+  before :all do
+    goto_html("test.html")
+  end
+
+  it 'two groups example' do
+    v = CollectionAsPageObjectCheckboxGroupView.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 multi" 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 = CollectionAsPageObjectCheckboxGroupView.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 array of value attribute' do
+      @v.group.set 'tomato'
+      @v.group.value.should eql ['tomato']
+      @v.group.set /^othe/
+      @v.group.value.should eql ['other']
+    end
+
+    it 'set array of value attribute. value returns array of value attribute' do
+      @v.group.set ['tomato']
+      @v.group.value.should eql ['tomato']
+
+      @v.group.set ['other', /tomat/]
+      @v.group.value.should eql ['tomato', 'other']
+    end
+
+    it 'set false clears all. value is empty array' do
+      @v.group.set false
+      @v.group.value.should eql []
+    end
+
+    it 'set empty array clears all. value is empty array' do
+      @v.group.set []
+      @v.group.value.should eql []
+    end
+
+    it 'set value string not found error' do
+      expect { @v.group.set 'toma' }.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/html/test.html

@@ -17,15 +17,15 @@
 <br/>
 
 <div id='feature_1' class='pageobject'>
-    <label for='feature_checkbox1'>Nude Beach</label>
+    <label for='feature_checkbox1'>Enable Checkbox for TextArea</label>
     <input id="feature_checkbox1" type="checkbox" class="check" onclick="featureEnabler('feature_checkbox1','feature_textarea1');"/><br/>
-    <textarea id='feature_textarea1' readonly disabled>CheckboxTextField 1</textarea>
+    <textarea id='feature_textarea1' cols="30" readonly disabled style="background-color:#eee">CheckboxTextField 1</textarea>
 </div>
 
 <div id='feature_2' class='pageobject'>
     <label for='feature_checkbox2'>Golf Course</label>
     <input id='feature_checkbox2' type='checkbox' class="check" onclick="featureEnabler('feature_checkbox2','feature_textarea2');"/><br/>
-    <textarea id='feature_textarea2' readonly disabled>CheckboxTextField 2</textarea>
+    <textarea id='feature_textarea2' cols="30" readonly disabled style="background-color:#eee">CheckboxTextField 2</textarea>
 </div>
 
 <script type="text/javascript">
@@ -33,14 +33,18 @@
         var cb = document.getElementById(cbe);
         var txt = document.getElementById(txte);
         if (cb.checked == true) {
-            txt.readOnly = "";
-            txt.disabled = "";
+            txt.readOnly = '';
+            txt.disabled = '';
+            txt.style = 'background-color: #fff';
         } else {
             txt.readOnly = 'readonly';
             txt.disabled = 'disabled';
+            txt.value = '';
+            txt.style = 'background-color: #eee';
         }
     }
 </script>
+<br/>
 
 <div>
     <p>DateSelector</p>
@@ -49,5 +53,57 @@
     <input type='text' id="year_field" class="city"/>
 </div>
 
+<div>
+    <p>RadioGroup named tool</p>
+    <label for='tool1'>Cucumber</label>
+    <input type='radio' name="tool" value="cucumber" id="tool1"/>
+    <label for='tool2'>Tomato</label>
+    <input type='radio' name="tool" value="tomato" id="tool2"/>
+    <label for='tool3'>Other</label>
+    <input type='radio' name="tool" value="other" id="tool3" checked/>
+</div>
+
+<div>
+    <p>RadioGroup named toolkey</p>
+    <input type='radio' name="toolkey" value="a cucumber"/><label for=""
+    <input type='radio' name="toolkey" value="a tomato"/>
+    <input type='radio' name="toolkey" value="some other" checked/>
+</div>
+
+<div>
+    <p>CheckboxGroup named fruit</p>
+    <label for='fruit1'>Cucumberama</label>
+    <input type='checkbox' name="fruit" value="cucumber" id="fruit1"/>
+    <label for='fruit2'>Tomatorama</label>
+    <input type='checkbox' name="fruit" value="tomato" id="fruit2"/>
+    <label for='fruit3'>Other</label>
+    <input type='checkbox' name="fruit" value="other" id="fruit3" checked/>
+</div>
+
+<div>
+    <p>CheckboxGroup named fruitkey</p>
+    <input type='checkbox' name="fruitkey" value="a cucumberama"/>
+    <input type='checkbox' name="fruitkey" value="a tomatorama"/>
+    <input type='checkbox' name="fruitkey" value="some otherama" checked/>
+</div>
+
+<div>
+    <select id="fruit_list">
+        <option value="tomato">Tomato</option>
+        <option value="gurken">Cucumber</option>
+        <option label="Other"/>
+        <option selected>Default</option>
+    </select>
+</div>
+
+<div>
+    <select multiple size="5" name="multiselect" id="multiselect">
+        <option value="1">Danish</option>
+        <option selected="selected" value="2">English</option>
+        <option selected value="3">Norwegian</option>
+        <option label='Polish'/>
+        <option>Swedish</option>
+    </select>
+</div>
 </body>
 </html>