pickles 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f33295e4575421e5d5fd0d643395d666e31acf4
+  data.tar.gz: a19ac5ac4bd3c1525ec5132521a58c920baf53aa
+SHA512:
+  metadata.gz: f32f96c2a0f9acf15d2c7d7ca2423394eb15ce9340e937820bcf0be9a1f0b519344d6807799add03aa2bd787eb70023ab83a7d77cbce6e934ba396cdd0d0f85e
+  data.tar.gz: 6f63f831c3dfc9209bf2b2c39b6eaee030f0dc23efd0b33cbdfef2317dd89e37989cd6d6f16b52bb4f8f69685b32fd816ee5e2e78bfb9f01e2e85f85ecb8a2a0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pickles.gemspec
+gemspec
+
+group :development do
+  gem "spring"
+  gem 'spring-commands-rspec'
+  gem "spring-commands-cucumber"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 vs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,196 @@
+# Pickles
+
+This gem contains some helpers to simplify testing with capybara along with afew predefined cucumber steps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pickles'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pickles
+
+# Usage
+
+## Supported cucumber steps:
+
++ Navigation 
+
+  1. ```rb  
+      When I (?:click|navigate) "([^"]*)"( within (?:.*))? 
+      ```
+
+      ##### Examples:
+      ```rb
+      When I click "My button" # standard click by text
+
+      When I click "=Mo" # click node that has exact this text. i.e. ignore: Monday, Moth
+        
+      When I click ">Mo" # ajax wait requests done before clicking
+      When I click "Mo>" # ajax wait requests done after clicking
+        
+      When I click ">Mo>" # both of the above
+        
+      When I click "My button,=Mo" # chain clicks ( click My button then click exact Mo )
+
+      When I click "My button->=Mo" # same as above (-> is for chaining sequential clicks)
+        
+      When I click "My button>->=Mo>" # click My button, ajax wait then click Mo
+
+      When I navigate ... # alias
+
+      ```
+
+      ##### Description:
+        + for within checkout docs
+
+  2. ```rb 
+     I (?:click|navigate):( within (?:.*))?
+     ```
+
+     ##### Examples:
+       ```rb
+       I navigate:
+         | click | My button   |
+         | hover | My span     |
+         | hover | Your span   |
+         | click | Your button |
+       ```
+
+     ##### Description:
+       + alias for previous, but accepts table as argument to allow multiple arguments.
+       + note ':' in definition
+       + for within checkout docs
+
+
++ Forms:
+  + Fill:
+     1. ```rb 
+        When (?:|I )fill in the following:( within (?:.*))?
+        ```
+
+        ##### Examples:
+         ```rb
+         When I fill in the following:
+           |                 | Account Number       | 5002       |
+           |                 | Expiry date          | 2009-11-01 |
+           |                 | Note                 | Nice guy   |
+           |                 | Wants Email?         |            |
+           | User data       | Sex         (select) | Male       |
+           |                 | Avatar               | avatar.png |
+           |                 | Due date             | 12:35      |
+           | Additional data | Accept user agrement | true       |
+           |                 | Send me letters      | false      |
+           |                 | radio 1              | true       |
+         ```
+
+         ##### 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
+             supported by default:
+               (select) - uses 'I select ".." from ".."' under the hood. Check it out
+
+     2.  ```rb
+         When (?:|I ) select "([^"]*)" from "([^"]*)"( within (?:.*))?
+         ```
+
+         ##### Examples:
+           ```rb
+            When I select "Male" from "sex" within "User data"
+           ```
+
+         ##### Description:
+           + Fills javascript-like custom selectors(inputs with blocks)
+           + 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) )
+             3. within block identifier
+     3.  ```rb
+         When (?:|I )(?:select|unselect) "([^"]*)"( within (?:.*))?
+         ```
+
+         ##### Examples:
+           ```rb
+            When I select "Male" within "User data"
+           ```
+
+         ##### 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"
+           ```
+
+         ##### 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 (?:.*))?
+         ```
+
+         ##### 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
+       
+ + 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
+
+
+## Contributing
+
+     Bug reports and pull requests are welcome on GitHub at https://github.com/vshaveyko/pickles.
+
+
+## License
+
+     The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pickles"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/cucumber/pickles.rb

@@ -0,0 +1,6 @@
+# :nodoc:
+module Pickles
+end
+
+require_relative 'pickles/helpers'
+require_relative 'pickles/steps'

data/lib/cucumber/pickles/check_in.rb

@@ -0,0 +1,10 @@
+module CheckIn
+
+  _dir = 'cucumber/pickles/steps/check_in/'
+
+  autoload :Factory, _dir + 'factory'
+  autoload :Input, _dir + 'input'
+  autoload :Text, _dir + 'text'
+  autoload :ComplexInput, _dir + 'complex_input'
+
+end

data/lib/cucumber/pickles/config.rb

@@ -0,0 +1,61 @@
+module Pickles
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @_configuration ||= Pickles::Config.new
+    end
+  end
+
+end
+
+class Pickles::Config
+
+  using HashSymbolizeKeys
+
+  attr_accessor :css_node_map, :xpath_node_map, :log_xhr_response
+
+  def initialize
+    @css_node_map = {}
+    @log_xhr_response = false
+    @xpath_node_map = {}
+    @fill_tag_steps_map = { 'select' => FillIN::Select }
+    @check_tag_steps_map = { 'text' => CheckIn::Text }
+  end
+
+  def css_node_map=(map)
+    raise(ArgumentError, "Node map must be a hash") unless map.is_a?(Hash)
+
+    @css_node_map = map.symbolize_keys
+  end
+
+  def xpath_node_map=(map)
+    raise(ArgumentError, "Node map must be a hash") unless map.is_a?(Hash)
+
+    @xpath_node_map = map.symbolize_keys
+  end
+
+  def fill_tag_steps_map=(map)
+    raise(ArgumentError, "Node map must be a hash") unless map.is_a?(Hash)
+
+    @fill_tag_steps_map.merge!(map)
+  end
+
+  def check_tag_steps_map=(map)
+    raise(ArgumentError, "Node map must be a hash") unless map.is_a?(Hash)
+
+    @check_tag_steps_map.merge!(map)
+  end
+
+  def step_by_tag(tag)
+    @fill_tag_steps_map[tag]
+  end
+
+  def check_step_by_tag(tag)
+    @check_tag_steps_map[tag]
+  end
+
+end

data/lib/cucumber/pickles/errors/ambigious.rb

@@ -0,0 +1,27 @@
+class Pickles::Ambiguous < StandardError
+
+  def initialize(locator, within, search_params, message)
+    @search_params= search_params
+    @within = within
+    @locator = locator
+    @message = message.to_s
+  end
+
+  def message
+    "Ambiguous(locator: #{@locator}, count: #{_nodes.count}" \
+      + (@message != "" ? ", message: #@message" : "") \
+      + (@within.respond_to?(:path) ? "\n within: #{@within.path}" : "") \
+       + "): \n#{_inspect_nodes}"
+  end
+
+  private
+
+  def _inspect_nodes
+    _nodes.map(&:inspect).join("\n")
+  end
+
+  def _nodes
+    @nodes ||= @within.all(*@search_params)
+  end
+
+end

data/lib/cucumber/pickles/errors/node_find_error.rb

@@ -0,0 +1,37 @@
+class NodeFindError < Capybara::ElementNotFound
+
+  def initialize(text, index, nodes)
+    @text = text
+    @index = index
+    @nodes = nodes
+  end
+
+  def message
+    if @nodes.empty?
+      _not_found_at_all_message
+    else
+      if @index.present?
+        _not_found_by_index_message
+      else
+        if @nodes.length > 1
+          _need_index_message
+        end
+      end
+    end
+  end
+
+  def _not_found_by_index_message
+    "Element with text #{@text}[#{@index}] was not found on the page, " \
+    "but #{@text}[0] found; Maybe used incorrect index?"
+  end
+
+  def _not_found_at_all_message
+    "Element with text #{@text}[#{@index}] was not found on the page; " \
+    "Maybe used incorrect text?"
+  end
+
+  def _need_index_message
+
+  end
+
+end