pickles 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f33295e4575421e5d5fd0d643395d666e31acf4
-  data.tar.gz: a19ac5ac4bd3c1525ec5132521a58c920baf53aa
+  metadata.gz: 288501fe87bdcd1723a59483ff8763255fdc6ad5
+  data.tar.gz: 8d9b503a3a2b71786f5e4c9ef19febbb1af32357
 SHA512:
-  metadata.gz: f32f96c2a0f9acf15d2c7d7ca2423394eb15ce9340e937820bcf0be9a1f0b519344d6807799add03aa2bd787eb70023ab83a7d77cbce6e934ba396cdd0d0f85e
-  data.tar.gz: 6f63f831c3dfc9209bf2b2c39b6eaee030f0dc23efd0b33cbdfef2317dd89e37989cd6d6f16b52bb4f8f69685b32fd816ee5e2e78bfb9f01e2e85f85ecb8a2a0
+  metadata.gz: f0cdd2cdd431aeb9fefb68ca162f2ff56357a68417e6461be78d4e0b9491b55f247ccc7f989067caef87008ed02fb9a88704b334d9d9e12c078f6a342c207efa
+  data.tar.gz: 4ab2bba90221cbc0da00ebfe784c7505434565b76532ae5f7cf5bf024716023468ebdf9ca95c6e5aca62f6b453e7d571a58a3998d071bd12060758fe6235c5ab

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/README.md

@@ -7,7 +7,7 @@ This gem contains some helpers to simplify testing with capybara along with afew
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pickles'
+gem 'pickles', require: false
 ```
 
 And then execute:
@@ -18,15 +18,136 @@ Or install it yourself as:
 
     $ gem install pickles
 
-# Usage
+```rb
+require 'cucumber/pickles/helpers' # require only helpers without steps
+# or
+require 'cucumber/pickles' # require everything alltogether
+```
+
+## Configure
+
+```rb
+Pickles.configure do |c|
+
+  #
+  # Usually referring to elements on page as .some-css-class is a bad practice.
+  #
+  # You can provide a map with aliases pointing to that stuff in this config 
+  #   Ex: c.css_node_map = { some_block: '.some-css-class' }
+  #
+  # And refer to it across within blocks in every predefined step or by manually using detect_node_helper
+  # 
+  c.css_node_map = {} 
+  # Same as above but shouled be aliased to xpath selector
+  c.xpath_node_map = {} 
+
+  #
+  # Log xhr error response to browser console, 
+  # 
+  # You can configure capybara to log this to your console: ( For example if example failed )
+  #
+  # puts page.driver.browser.manage.logs.get('browser').select { |log| log.level == 'SEVERE' }.map(&:message).map(&:red)
+  #
+  c.log_xhr_response = false 
+  
+  # 
+  # In some table steps you can provide '(...)' identifier to override how that step should be handled
+  # 
+  # See 'I fill in the following:' for explaination
+  #
+  c.fill_tag_steps_map = { 'select' => Select }
+
+  #
+  # Same as above for 'fields are filled with:' step
+  #
+  c.check_tag_steps_map = { 'text' => Text }
+
+end
+```
+
+### Capybara test helpers
+
+Bunch of usefull helpers for everyday testing with capybara.
+
+Mostly usefull if you're building a SPA app or just have tons of javascript and standard Capybara helper methods isnt enough.
+
+#### Start with:
+ If you're using cucumber you may want to:
+ ```rb
+ World(Pickles)
+ ```
+
+ Or you can use it through:
+ ```rb
+ Pickles.helper_name
+ ```
+
+### Index:
+
+1. [wait_for_ajax](#wait_for_ajax)
+2. [Locator string](#locator-string-text2)
+3. [find_node](#find_nodelocator-within-nil)
+4. [detect_node](#detect_nodeel_alias-locator--nil-within-nil)
+5. [find_input](#find_inputlocator-within-nil)
+6. [blur](#blurnode)
+7. [select_input](#select_inputinput-value--nil)
+8. [attach_file](#attach_fileinput-file_name)
+
++ ####  Locator string: `Ex: "=Text[2]"`:
+  + 'Text' - required - text to look up by
+  + '='    - optional - lookup exact text in node if given
+  + '[2]'  - optional - index of element on page. If found 4 elements than 3rd will be selected - indexed from 0. 
+
++ #### find_node(locator, within: nil)
+  
+  Find node on page by [Locator string](#locator-string-text2)
+
+  within - capybara node to limit lookup
+
+  returns: capybara node
+
++ #### find_input(locator, within: nil)
 
-## Supported cucumber steps:
+  Find `input | textarea | [contenteditable]` on page identified by [Locator string](#locator-string-text2)
+
++ #### detect_node(el_alias, locator = nil, within: nil)
+
+  Does lookup based on provided in config maps
+
+  if within.present? => limit search to within
+  if locator.present? => use locator in step location
+
+  Use el_alias to find needed xpath / css in maps provided to config.
+  Priority xpath_map => css_map => el_alias as it is
+
+  locator and el_alias can use index configuration from [Locator string](#locator-string-text2)
+
++ #### wait_for_ajax
+  
+  Waits for ajax requests to end before proceeding further.
+  Terminated with `Capybara::ElementNotFound` after `Capybara.default_wait_time` seconds
+
++ #### blur(node)
+  
+  Triggers *node* blur event and clicks on body to perform blur
+
++ #### select_input(input, value = nil)
+
+  Selects *input*[type="checkbox"] OR *input*[type="radio"] on form
+
+  Triggers click after selection to trigger javascript events ( may change in future )
+
++ #### attach_file(input, file_name)
+
+  Attaches file with *file_name* to *input*[type="file"]
+
+  *file_name* is fetched from `features/support/attachments/*file_name*` and raises RuntimeError if file not found
+
+### Supported cucumber steps:
 
 + Navigation 
 
-  1. ```rb  
-      When I (?:click|navigate) "([^"]*)"( within (?:.*))? 
-      ```
+  1.  `When I (?:click|navigate) "([^"]*)"( within (?:.*))?`
 
       ##### Examples:
       ```rb
@@ -52,30 +173,27 @@ Or install it yourself as:
       ##### Description:
         + for within checkout docs
 
-  2. ```rb 
-     I (?:click|navigate):( within (?:.*))?
-     ```
+  2.  `When I (?:click|navigate):( within (?:.*))?`
 
      ##### Examples:
-       ```rb
-       I navigate:
-         | click | My button   |
-         | hover | My span     |
-         | hover | Your span   |
-         | click | Your button |
-       ```
+     ```rb
+     When I navigate:
+       | click | My button   |
+       | hover | My span     |
+       | hover | Your span   |
+       | click | Your button |
+         
+     When I navigate: within form "User data"
+       | click | Submit   |
+     ```
 
      ##### Description:
-       + alias for previous, but accepts table as argument to allow multiple arguments.
-       + note ':' in definition
-       + for within checkout docs
-
+     + Same as previous, but allows table as argument.
+     + note ` : ` in the definition
 
 + Forms:
   + Fill:
-     1. ```rb 
-        When (?:|I )fill in the following:( within (?:.*))?
-        ```
+     1. `When (?:|I )fill in the following:( within (?:.*))?`
 
         ##### Examples:
          ```rb
@@ -95,96 +213,92 @@ Or install it yourself as:
          ##### Description:
            + Fills form fields identified by second column.
            + First column is optional and defines 'within block' - see docs for within
-           + Add custom (...) block for second column to define your own form fill steps
+           + Add custom (...) block for second column to define your own form fill steps in `config.fill_tag_steps_map`
              supported by default:
-               (select) - uses 'I select ".." from ".."' under the hood. Check it out
-
-     2.  ```rb
-         When (?:|I ) select "([^"]*)" from "([^"]*)"( within (?:.*))?
-         ```
+               (select) - uses `When I select ".." with ".."` under the hood.
+               Ex:
+               ```rb
+               class FillDatepicker
+
+                 def initialize(label, value, within)
+                   # label = 'Date of birth'
+                   @label = label
+                   # value = '23.12.1998'
+                   @value = Date.parse(value)
+                   # within = detect_node("form", "User profile", within: page)
+                   @within = within
+                 end
+                 
+                 def call
+                    # implement datepicker selecting logic
+                 end
+               end
+
+               Pickles.configure do |c|
+                 c.fill_tag_steps_map = { datepicker: FillDatepicker }
+               end
+
+               When I fill in the following:
+                 | form "User profile" | Date of birth (datepicker) | 23.12.1998 |
+               ```
+
+
+     2.  `When (?:|I )attach the file "([^"]*)" to "([^"]*)"( within (?:.*))?`
 
          ##### Examples:
            ```rb
-            When I select "Male" from "sex" within "User data"
+            When I attach the file "test.png" to "Avatar" within "User data"
            ```
 
          ##### Description:
-           + Fills javascript-like custom selectors(inputs with blocks)
+           + Attaches given file to identified fields
            + Params:
-             1. value to select identifier for block with select result( see [find_node](#find_nodelocator-within-nil) ) 
-             2. field identifier ( used by [find_node](#find_nodelocator-within-nil) )
+             1. `features/support/attachments/` + `file_name` is used to identify file
+             2. Input identifier. see `find_input` helper for searching details
              3. within block identifier
-     3.  ```rb
-         When (?:|I )(?:select|unselect) "([^"]*)"( within (?:.*))?
-         ```
+          + within part is optional
+            
+     4.  `When (?:|I )(?:fill|select)(?: "([^"]*)")?(?: with "([^"]*)")?( within (?:.*))?`
 
          ##### Examples:
            ```rb
-            When I select "Male" within "User data"
-           ```
+            When I fill "Name" with "Peter" within "User data" # input[type="text"]
+            When I fill "Avatar" with "test.png" within "User data" # input[type="file"]
 
-         ##### Description:
-           + Fills checkboxes/radio buttons
-           + Params:
-             1. identifier for block with selected select ( see [find_node](#find_nodelocator-within-nil) ) 
-     4.  ```rb
-         When (?:|I )attach the file "([^"]*)" to "([^"]*)"( within (?:.*))?
-         ```
-
-         ##### Examples:
-           ```rb
-            When I attach the file "test.png" to "Avatar" within "User data"
-           ```
+            When I fill "Male" within "User data" # input[type="checkbox"] || input[type="radio"]
+            When I select "Male" 
 
-         ##### Description:
-           + Attaches given file to identified fields
-           + Params:
-             1. relative file name. see attach_file
-             2. file input identifier. see [find_node](#find_nodelocator-within-nil)
-             3. within block identifier. see [find_node](#find_nodelocator-within-nil)
-            
-     5.  ```rb
-         When (?:|I )(?:fill|select|unselect)(select)?(?: "([^"]*)")?(?: with "([^"]*)")?( within (?:.*))?
-         ```
+            When I select "sex" with "Male" # selector
 
-         ##### Examples:
-           ```rb
-            When I fill "Name" with "Peter" within "User data"
-            When I fill "Avatar" with "test.png" within "User data"
-            When I fill "Male" within "User data"
-            When I fill "sex" with "Male" within "User data"
            ```
 
          ##### Description:
            + Tries to fill data by guessing field type from found input type(text|checkbox|radio|etc)
            + There MUST always be an input identified by identifier
+           + within part is optional
        
  + Check
-   1.  ```rb
-       Then fields are filled with:( within (?:.*))?
-       ```
 
-       ##### Examples: 
-         ```rb
-           Then fields are filled with:
-             | Account Number       | 5002       |
-             | Expiry date          | 2009-11-01 |
-             | Note                 | Nice guy   |
-             | Wants Email?         | true       |
-             | Sex                  | Male       |
-             | Accept user agrement | true       |
-             | Send me letters      | false      |
-             | radio 1              | true       |
-             | Avatar               | avatar.png |
-             | Due date             | 12:35      |
-         ```
-
-       ##### Description:
-         + Check fields filled by 'I fill in the folllwing'
-         + Supports exact same table syntax and optional column
-
-## Development
+   `Then fields are filled with:( within (?:.*))?`
+
+   ##### Examples: 
+     ```rb
+     Then fields are filled with:
+       | Account Number       | 5002       |
+       | Expiry date          | 2009-11-01 |
+       | Note                 | Nice guy   |
+       | Wants Email?         | true       |
+       | Sex                  | Male       |
+       | Accept user agrement | true       |
+       | Send me letters      | false      |
+       | radio 1              | true       |
+       | Avatar               | avatar.png |
+       | Due date             | 12:35      |
+     ```
 
+   ##### Description:
+     + Check fields filled by `I fill in the folllwing`
+     + Supports exact same table syntax and optional column
 
 ## Contributing
 

data/lib/cucumber/pickles/steps.rb

@@ -12,7 +12,7 @@ module Pickles::StepDef
   module_function
 
   def define_table_step(allowed_table_cols)
-    -> do |within, table|
+    -> ( within, table ) do
 
       Waiter.wait_for_ajax
 

data/lib/cucumber/pickles/steps/fill.rb

@@ -57,7 +57,7 @@ end)
 #   FillIN::Select.new(label, value, within).call
 # end
 
-When /^(?:|I )(fill|select|unselect)(?: "([^"]*)")?(?: with "([^"]*)")?( within (?:.*))?$/ do |type, labels, value, within|
+When /^(?:|I )(fill|select)(?: "([^"]*)")?(?: with "([^"]*)")?( within (?:.*))?$/ do |type, labels, value, within|
   if type == 'select' && value.present?
     FillIN::Select.new(labels, value, within).call
   else

data/lib/cucumber/pickles/version.rb

@@ -1,3 +1,3 @@
 module Pickles
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pickles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - vs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara