web4cucumber 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f346adcd86c3ad7eff394c03156b59692c8e8db
-  data.tar.gz: 71c9a0b050b23567d2b07a8af0d741aeb9cd7b0a
+  metadata.gz: 73cd68b1548d1653412dac11675eff0e1f47c50c
+  data.tar.gz: 3be0f48e3462862711fa4d473ea9fe6d1141d47e
 SHA512:
-  metadata.gz: dcc2c2fead7f9badf5355eeab310adfc0e37c36f0a00dfe208296f85fc327ab90229bfbe29a92e0f6460094e44c0accff676c74a5c4587d15434b0d3844f0e7d
-  data.tar.gz: b2f14a77b67113cc65e4abd1d14bea8deb4195bf1d307c8f306c7f78800114ac68ec94684e51c30aa02b2b0396b514091d19cb33c13db96c26b10e6ff47a7083
+  metadata.gz: bdf0b758d5dfc32be4d32c44104b7f5ddea281cfdf06cdc01234ad3d5b82b4c8306676f2be907cea3f93d2e2c6e5d78ef0f4041b30b57c3eee71f15f640fcf1c
+  data.tar.gz: 032a4a7c1bd560fdd6da51d61abebbb9d035a4cf1f9949ff3c7603df23b4126e58e776c7f89590b29d2df3c5b4099629c48ec1399fa544b60df6cde51c1d6ed9

data/README.md

@@ -250,3 +250,60 @@ Different elemet types get treated differently by webdriver, textfields can not
 - filefield - provide a full path to the file you would upload here
 - a  -link
 - element any element that can be simply clicked. No need to provide the type in this case, it will be implied by default.
+
+### Tips and tricks
+
+1. Sometimes a web element may or may not be present on a page depending on the
+   user workflow. Say, depending on whether a user is freshly registered or
+   not, he may be presented with the checkbox to accept license agreement. If
+   you describe this element in the page and it will not be there, an action
+   will fail although it really passes. To make it pass, then, you need to mark
+   an element optional. This is done through *may_absent* keyword, like this:
+   ```
+   expected_fields:
+     field_one:
+       type: textfield
+       selector: 
+         id: 'i-always-exist'
+    field_two:
+      type: checkbox
+      selector:
+        id 'i-am-optional'
+      may_absent: true
+
+   ```
+
+2. Sometimes you need a way to stop the action execution at some point to
+   perform some unusual actions, like clicking "Cancel" button or anything
+   else. This is possible through passing *:stop_at* key with the name of the
+   page as a value in options passed to the *run_action* method. Imagine you
+   have an action that involves accessing three pages and you want to stop at
+   the last page to click some unusual button:
+
+   ```
+   my_beautiful_action:
+     expected_pages:
+       - 'page_one'
+       - 'page_two'
+       - 'page_three'
+   ```
+   Then in you step definition construct the option hash like this:
+   ```
+   options = {
+     :some_field => 'value'
+     :some_other_field => 'other_value'
+     :stop_at => :third_page
+     }
+     @result = @web.run_action(:my_beautiful_action, options)
+   ```
+   then in the next step you can explicitly access whatever element you like on
+   the third page of your action
+
+3. Similarly, sometimes you need a way to stop the execution and drop into a
+   ruby shell to try some low-level interaction with the webdriver. Well, this
+   is easily achieved, just pass 
+   ```
+   :debug_at => :page_three
+   ```
+   in the options and yo will be dropped into a shell right after page three is
+   loaded in the browser window.

data/examples/testproject/Gemfile

@@ -1,9 +1,4 @@
 source 'https://rubygems.org'
-gem 'json'
 gem 'cucumber'
-gem 'watir-webdriver'
 gem 'web4cucumber'
 gem 'rspec-expectations'
-gem 'byebug'
-gem 'headless'
-gem 'pry'

data/lib/web4cucumber.rb

@@ -185,7 +185,7 @@ class Web4Cucumber
       # some point to have a human control over the webdriver instance. Then
       # in the same way stick the :debug_at keyword with the page name as a value 
       # into the options hash. The webdriver is available via @@b clas variable
-      if options.has_key?(:debug_at) and options[:stop_at] == page
+      if options.has_key?(:debug_at) and options[:debug_at] == page
         require "byebug"
         byebug
       end
@@ -196,6 +196,16 @@ class Web4Cucumber
       if page_rules.has_key? :expected_fields
         page_rules[:expected_fields].each_pair { |name, prop|
           # Beginning of page fields
+          # The following allows you to put <value> as a selector value
+          # :select_item:
+          #   :selector:
+          #     :text: 'Some text <value>'
+          # and then pass the value in options
+          prop[:selector].each do |propkey, propval|
+            if propval.match Regexp.new("<value>")
+              prop[:selector][propkey] = propval.gsub('<value>', options[name])
+            end
+          end          
           possible_elements = {
             # There could be more than one element with the same
             # properties and only one would be visible. As an example:
@@ -362,7 +372,7 @@ class Web4Cucumber
             button.click
           rescue Exception => e
             @result[:result]=false
-            @result[:error_message] = e.message
+            @result[:errors] << e.message
             screenshot_save
           end
         elsif page_rules[:commit].has_key?(:type) and page_rules[:commit][:type] == 'alert'

data/lib/web4cucumber/version.rb

@@ -1,3 +1,3 @@
 module Web4Cucumber
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web4cucumber
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Oleg Fayans