watir-formhandler 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7872b31d757af03a3e28a3bc3f57fd37faba24c5
-  data.tar.gz: 41a89b39e932f12d1394628c88721d0cb4ffae7d
+  metadata.gz: b5e4b363f3156b19ab9d61c9fb72b1f3694b1cab
+  data.tar.gz: 21add3a253b471a36b37b7e6bf2fa2bed1b0de42
 SHA512:
-  metadata.gz: fd4e003626c969d6dbeea15c4981270f0ac181ba1545f6fc8ab8d11e3a7ae69012c3bcdb84970cc8394efcdb625c753c7d59c30fc11e267c5559748ee36dd89c
-  data.tar.gz: 164b621310c0d3f79e3e83dcbc509c5d10758aec47821e38552ded8f2f24061b07820818272e8d8b9370e168c547cd330ba9a098159e12f36475f0aafbb4f8cd
+  metadata.gz: 450eeb218b9120a69530ace025fe25951f2037cccd6483c2ba4e625096109e7af12cf31c39add13cb765bdcfe43a09de6619fb43f16c0084bba46fc6dc9e5f95
+  data.tar.gz: e08264e4cb7a1d32aa9eae54b6d78a55c6c8fbfe467d44f4a75c914f1e18211f3deb0360e75dbdcbb5d2bebfaae6875ba08efa7132e263e6d0ee23be450d7b47

data/README.md

@@ -14,6 +14,7 @@ Extends some Watir classes to provide a more comfortale handling for forms and t
  * [#field_value](#field_value)
  * [#field](#field)
  * [#fill_in](#fill_in)
+ * [#value_of](#value_of)
  * [OptionGroup](#optiongroup)
  * [:start_node](#start_node)
  * [Latest Changes](#latest-changes)
@@ -64,7 +65,7 @@ currently set value. But be prudent, the data type may vary, just like the custo
 
 ### #field
 
-All Containers now have a method to determine a form field by their labels or their placeholders,
+All Containers now have a method to determine a form field by its label, placeholders or ID,
 returning the appropriate Watir sub-type class.
 
     browser = Watir::Browser.new('example_site')
@@ -78,7 +79,8 @@ returning the appropriate Watir sub-type class.
 
 ### #fill_in
 
-All Containers now have a method to search a form field by its name or label and change its value.
+All Containers now have a method to search a form field by its label, placeholder or ID and
+change its value.
 
     browser = Watir::Browser.new('example_site')
     form = browser.form(id: 'my_form')
@@ -90,6 +92,20 @@ All Containers now have a method to search a form field by its name or label and
                                                                     # TextField with placeholder
                                                                     # 'Some Text Field'
 
+### #value_of
+
+All Containers now have a method to search a form field by its label, placeholder or ID and return
+its current value.
+
+    browser = Watir::Browser.new('example_site')
+    form = browser.form(id: 'my_form')
+
+    form.read_field('Some Text Field')                  # Reads the value of field labeled
+                                                        # 'Some Text Field'
+
+    form.fill_in('Some Text Field', placeholder: true)  # Reads the value of a TextField with
+                                                        # placeholder 'Some Text Field'
+
 
 ### OptionGroup
 
@@ -111,16 +127,27 @@ for these kind of groups, if the respective options has been activated.
 
 ### :start_node
 
-The new methods _#field_ and _#fill_in_ will start their search for the specified label with the
-given String on the Container on which it is called, by default. However, you may specify an
-arbitrary _start_node_ from which to start, which will probably be most useful when calling the
+The methods _#field_, _#fill_in_ and _#value_of_ will start their search for the specified label
+with the given String on the Container on which it is called, by default. However, you may specify
+an arbitrary _start_node_ from which to start, which will probably be most useful when calling the
 methods directly on your Watir::Browser instance.
 
-***
-***
+---
+
+---
 
 ### Latest Changes
 
+#### Version 2.6.0
+
+* Added #value_of method that works in the exact same way as #fill_in, but which returns the
+current value of a field.
+
+#### Version 2.5.0
+
+* Added option to find input fields by ID
+* Added option to fill input fields by ID
+
 #### Version 2.4.0
 
 * Renamed the files in such a way that the gem can now properly required with a hyphen like the

data/lib/watir-formhandler/container.rb

@@ -27,13 +27,13 @@ module Watir
     # Fills in the given value(s) to the passed attribute. It therefore accepts the same parameters
     # as the #field method.
     # @param [String, Watir::Label] label the label for which to find the form field.
-    # @param [Watir::Element] start_node the node where to start searching for the label.
     # @param [String, Boolean, Array] value to be set.
+    # @param [Watir::Element] start_node the node where to start searching for the label.
     # @param [Boolean] include_groups whether to detect the group of a given label.
     # @param [Boolean] placeholder whether to handle label as Watir::Label or as placeholder
     #                              attribute for an input field.
     # @param [Boolean] id          assumes the given label is an HTML ID and searches for it.
-    def fill_in(label, value, start_node: nil, include_groups: nil, placeholder: false, id: false)
+    def fill_in(label, value, start_node: nil, include_groups: false, placeholder: false, id: false)
       field(label,
             start_node:     start_node,
             include_groups: include_groups,
@@ -43,6 +43,25 @@ module Watir
     end
 
 
+    # Returns the current value of the specified form field. It therefore accepts the same
+    # parameters as the #field method.
+    # @param [String, Watir::Label] label the label for which to find the form field.
+    # @param [Watir::Element] start_node the node where to start searching for the label.
+    # @param [Boolean] include_groups whether to detect the group of a given label.
+    # @param [Boolean] placeholder whether to handle label as Watir::Label or as placeholder
+    #                              attribute for an input field.
+    # @param [Boolean] id          assumes the given label is an HTML ID and searches for it.
+    # @return [String, Boolean, Array] current value of the field.
+    def value_of(label, start_node: nil, include_groups: false, placeholder: false, id: false)
+      field(label,
+            start_node:     start_node,
+            include_groups: include_groups,
+            placeholder:    placeholder,
+            id:             id
+      ).field_value
+    end
+
+
     # Returns an OptionGroup
     # @return [OptionGroup] the selected OptionGroup
     def option_group(*args)

data/spec/container_spec.rb

@@ -139,6 +139,7 @@ module Watir
         end
       end
     end # #field
+    ################################################################################################
 
 
     describe '#fill_in' do
@@ -175,85 +176,82 @@ module Watir
         end
 
         it 'fills a Watir::Select with multiple select' do
-          browser.fill_in('Multi Select', %w(Option2 Option3))
+          options = %w(Option2 Option3)
+          browser.fill_in('Multi Select', options)
           multiselect = browser.select(id: 'multiselect')
           expect(multiselect.selected_options.count).to eq(2)
-          expect(multiselect.selected_options.map(&:text)).to eq(%w(Option2 Option3))
+          expect(multiselect.selected_options.map(&:text)).to eq(options)
         end
 
         it 'fills a Watir::OptionGroup' do
-          browser.fill_in('Checkbox5', %w(Checkbox5 Radio7), include_groups: true)
+          options = %w(Checkbox5 Radio7)
+          browser.fill_in('Checkbox5', options, include_groups: true)
           option_group = browser.option_group(id: 'radio_and_checkbox')
           expect(option_group.selected_options.count).to eq(2)
-          expect(option_group.selected_options).to eq(%w(Checkbox5 Radio7))
+          expect(option_group.selected_options).to eq(options)
         end
       end # desribe: without a start node
 
 
       describe 'with a start node' do
+        before(:all){ @browser.refresh }
         let(:start_node){ browser.element(id: 'main_content') }
 
         it 'fills a Watir::Checkbox from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Checkbox'))
-          expect(start_node).to receive(:label)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Checkbox'))
           browser.fill_in('Checkbox', true, start_node: start_node)
           expect(browser.checkboxes.first).to be_checked
         end
 
         it 'fills a Watir::Radio from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Radio'))
-          expect(start_node).to receive(:label)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Radio'))
           browser.fill_in('Radio', true, start_node: start_node)
           expect(browser.radios.first).to be_checked
         end
 
         it 'fills a Watir::Select  with single select from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Select'))
-          expect(start_node).to receive(:label)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Select'))
           browser.fill_in('Select', 'Test2', start_node: start_node)
           expect(browser.selects.first.selected_options.count).to eq(1)
           expect(browser.selects.first.selected_options.first.text).to eq('Test2')
         end
 
         it 'fills a Watir::Select with multiple select from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Multi Select'))
-          expect(start_node).to receive(:label)
-          browser.fill_in('Multi Select', %w(Option2 Option3), start_node: start_node)
+          options = %w(Option2 Option3)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Multi Select'))
+          browser.fill_in('Multi Select', options, start_node: start_node)
+
           multiselect = browser.select(id: 'multiselect')
           expect(multiselect.selected_options.count).to eq(2)
-          expect(multiselect.selected_options.map(&:text)).to eq(%w(Option2 Option3))
+          expect(multiselect.selected_options.map(&:text)).to eq(options)
         end
 
         it 'fills a Watir::TextField from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Text Field'))
-          expect(start_node).to receive(:label)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Text Field'))
           browser.fill_in('Text Field', 'test text', start_node: start_node)
           expect(browser.text_fields.first.value).to eq('test text')
         end
 
         it 'fills a Watir::TextArea from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Text Area'))
-          expect(start_node).to receive(:label)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Text Area'))
           browser.fill_in('Text Area', 'test text', start_node: start_node)
           expect(browser.textareas.first.value).to eq('test text')
         end
 
         it 'fills a Watir::FileField from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'File'))
-          expect(start_node).to receive(:label)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'File'))
           browser.fill_in('File', File.join(HTML_DIR, FORM_PAGE), start_node: start_node)
           expect(browser.file_fields.first.value).to eq(FORM_PAGE)
         end
 
         it 'fills a Watir::OptionGroup from start node' do
-          allow(start_node).to receive(:label).and_return(browser.label(text: 'Checkbox5'))
-          expect(start_node).to receive(:label)
-          browser.fill_in(
-            'Checkbox5', %w(Checkbox5 Radio7), include_groups: true, start_node: start_node
-          )
+          options = %w(Checkbox5 Radio7)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Checkbox5'))
+          browser.fill_in('Checkbox5', options, include_groups: true, start_node: start_node)
+
           option_group = browser.option_group(id: 'radio_and_checkbox')
           expect(option_group.selected_options.count).to eq(2)
-          expect(option_group.selected_options).to eq(%w(Checkbox5 Radio7))
+          expect(option_group.selected_options).to eq(options)
         end
       end # descibe: with a start node
 
@@ -273,7 +271,7 @@ module Watir
       end# with placeholder: true
 
 
-      describe 'using id: true', wip: true do
+      describe 'using id: true' do
         it 'fills field with specified id' do
           text_id = 'text'
           browser.fill_in(text_id, 'test', id: true)
@@ -281,6 +279,139 @@ module Watir
         end
       end# using id: true
     end # #fill_in
-  end
+    ################################################################################################
+
+
+    describe '#value_of' do
+      before(:all){ @browser.refresh }
+      describe 'without a start node' do
+        it 'returns value of Watir::Checkbox' do
+          browser.fill_in('Checkbox', true)
+          expect(browser.value_of('Checkbox')).to be true
+          browser.fill_in('Checkbox', false)
+          expect(browser.value_of('Checkbox')).to be false
+        end
+
+        it 'returns value of Watir::Radio' do
+          browser.fill_in('Radio', true)
+          expect(browser.value_of('Radio')).to be true
+        end
+
+        it 'returns value of Watir::FileField' do
+          browser.fill_in('File', File.join(HTML_DIR, FORM_PAGE))
+          expect(browser.value_of('File')).to eq(FORM_PAGE)
+        end
+
+        it 'returns value of Watir::TextField' do
+          browser.fill_in('Text Field', 'test text')
+          expect(browser.value_of('Text Field')).to eq('test text')
+        end
+
+        it 'returns value of Watir::TextArea' do
+          browser.fill_in('Text Area', 'test text')
+          expect(browser.value_of('Text Area')).to eq('test text')
+        end
+
+        it 'returns value of Watir::Select with single select' do
+          browser.fill_in('Select', 'Test2')
+          expect(browser.value_of('Select')).to eq('Test2')
+        end
+
+        it 'returns value of Watir::Select with multiple select' do
+          target_value = %w(Option2 Option3)
+          browser.fill_in('Multi Select', target_value)
+          expect(browser.value_of('Multi Select')).to eq(%w(Option2 Option3))
+        end
+
+        it 'returns value of Watir::OptionGroup' do
+          options = %w(Checkbox5 Radio7)
+          browser.fill_in('Checkbox5', options, include_groups: true)
+          expect(browser.value_of('Checkbox5', include_groups: true)).to eq(options)
+        end
+      end # desribe: without a start node
+
+
+      describe 'with a start node' do
+        before(:all){ @browser.refresh }
+        let(:start_node){ browser.element(id: 'main_content') }
+
+        it 'returns value of Watir::Checkbox from start node' do
+          browser.fill_in('Checkbox', true, start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Checkbox'))
+          expect(browser.value_of('Checkbox', start_node: start_node)).to be true
+        end
+
+        it 'returns value of Watir::Radio from start node' do
+          browser.fill_in('Radio', true, start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Radio'))
+          expect(browser.value_of('Radio', start_node: start_node)).to be true
+        end
+
+        it 'returns value of Watir::Select  with single select from start node' do
+          browser.fill_in('Select', 'Test2', start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Select'))
+          expect(browser.value_of('Select', start_node: start_node)).to eq('Test2')
+        end
+
+        it 'returns value of Watir::Select with multiple select from start node' do
+          options = %w(Option2 Option3)
+          browser.fill_in('Multi Select', options, start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Multi Select'))
+          expect(browser.value_of('Multi Select', start_node: start_node)).to eq(options)
+        end
+
+        it 'returns value of Watir::TextField from start node' do
+          browser.fill_in('Text Field', 'test text', start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Text Field'))
+          expect(browser.value_of('Text Field', start_node: start_node)).to eq('test text')
+        end
+
+        it 'returns value of Watir::TextArea from start node' do
+          browser.fill_in('Text Area', 'test text', start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Text Area'))
+          expect(browser.value_of('Text Area', start_node: start_node)).to eq('test text')
+        end
+
+        it 'returns value of Watir::FileField from start node' do
+          browser.fill_in('File', File.join(HTML_DIR, FORM_PAGE), start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'File'))
+          expect(browser.value_of('File', start_node: start_node)).to eq(FORM_PAGE)
+        end
+
+        it 'returns value of Watir::OptionGroup from start node' do
+          options = %w(Checkbox5 Radio7)
+          browser.fill_in('Checkbox5', options, include_groups: true, start_node: start_node)
+          expect(start_node).to receive(:label).and_return(browser.label(text: 'Checkbox5'))
+          expect(browser.value_of('Checkbox5',
+                                  start_node: start_node,
+                                  include_groups: true
+                                 )
+          ).to eq(options)
+        end
+      end # descibe: with a start node
+
+
+      describe 'with placeholder: true' do
+        it 'returns value of Watir::TextField with given text' do
+          browser.fill_in('Placeholder Text', 'Test Text', placeholder: true)
+          expect(browser.value_of('Placeholder Text', placeholder: true)).to eq('Test Text')
+        end
+
+        it 'returns value of Watir::TextArea with given text' do
+          browser.fill_in('Placeholder Area', 'Test Text', placeholder: true)
+          expect(browser.value_of('Placeholder Area', placeholder: true)).to eq('Test Text')
+        end
+      end# with placeholder: true
+
+
+      describe 'using id: true' do
+        it 'returns value of field with specified id' do
+          text_id = 'text'
+          browser.fill_in(text_id, 'test', id: true)
+          expect(browser.value_of(text_id, id: true)).to eq('test')
+        end
+      end# using id: true
+    end
+  end# Container
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-formhandler
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Yves Komenda
@@ -38,9 +38,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.6.11
-description: |-
-  Adds some convenience methods to fill out forms in Watir.
-  Latest changes: gem can now be correctly required with >require "watir-formhandler"<
+description: Adds some convenience methods to fill out forms in Watir.
 email:
 - b_d_v@web.de
 executables: []