sw2at-capybara 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e1ec747896b153771a6e937ad57d81b1005c07
-  data.tar.gz: 612f7089c773f1c253d343b007c5dda26a1e5a82
+  metadata.gz: 38a6cb7cfe558fa94a1658c1259c6cba185cf30e
+  data.tar.gz: ddeb05e519afe2f1d30e27ae8100e17c6ff6f5f8
 SHA512:
-  metadata.gz: 2adb397119002086ee71cbfbbe269865f36c1f2f9f17197f59e4cd6f4e684bd0aae828b05b41e78eea391c0da1313268fb66b912ecb1bbbad7c7b03503a647dd
-  data.tar.gz: 88ae551c9482a7793abfc8c5215b873b5491042f4b6858f16458812420f15d22d566126441565f8acc227c388de68cdcc746b63da577ccb5d6aa3178bb22302c
+  metadata.gz: 849596d3a0ef435f75bb5452cd3bf021485f94e9b6fdd16f71a39a41644fb04623ddb899d75e3c9e5394e6dbf324267b51a0bea00e68ef79e4d5e0695f2762ec
+  data.tar.gz: 9b9732b1750c00813c740be93112ab1bc47fdeabb3711c231aaabc782bc6f79b8479cbd41855d7442382b00be825d9ed812a33940e630878ee83986f63200945

data/README.md

@@ -1,13 +1,130 @@
-sw2at-capybara
-==============
+# sw2at-capybara
+## SWAT(Simple Way to Automate Tests) - Capybara Extension
 
-sw2at-capybara is a suite of methods, which help to make test automation easier, faster and more stable.
+sw2at-capybara is a suite of helpers, which help to make test automation easier and faster, improve their maintenance and stability.
+
+A little about sw2at-capybara
+-----------------
+
+sw2at-capybara has steps like Cucumber does, but here it's not something mandatory, it's up to you.
+Why do we use steps? The answer is simple, it helps us to print a good console output what helps us to debug issues better, and it allows you to understand what's happening when you look at the console and browser window. On the other hand the steps can be written by someone who knows nothing about programming, it might be a QA or even customer (see an example below).
+
+```ruby
+
+it 'should do its job' do
+
+  step 'Go somewhere' do
+    # pending
+  end
+
+  step 'Click some button' do
+    # pending
+  end
+
+  step 'Type some value' do
+    # pending
+  end
+  
+  step 'Save the value' do
+    # pending
+  end
+  
+  step 'Ensure that the result is saved' do
+    # pending
+  end
+end  
+```
 
 Installation
 -----------------
 
-    gem install sw2at-capybara
+Add to your Gemfile
+```ruby
+gem 'sw2at-capybara'
+```
+    
+Run bundle install
+    
+    bundle install
+    
+Using
+-----------------
+
+Add the following to your spec_helper.rb
+```ruby
+require 'capybara'
+require 'rspec/core/formatters/base_text_formatter'
+config.formatter = RSpec::Core::Formatters::BaseTextFormatter # if you don't use any custom formatters.
+
+Swat::Capybara.setup(config, { default_pause: 0.5,
+   min_pause: 0.3,
+   tries: 10,
+   default_selector: 'body',
+   output: { enabled: true, started: ?>, step: ?. }
+})
+```
+So your spec_helper.rb might look like the following:
+
+```ruby
+ENV['RAILS_ENV'] = 'test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'pry'
+require 'capybara'
+
+RSpec.configure do |config|
+
+  Capybara.default_driver = :selenium
+  config.include Capybara::DSL, type: :feature
+
+  Swat::Capybara.setup(config, { 
+       tries: 10,
+       default_selector: 'body',
+   })
+end
+```
+
+Examples
+-----------------
+See a simple swat-capybara example[ here](https://github.com/tw4qa/swat-capybara-example).
+
+How it looks
+-----------------
+```ruby
+describe 'Google Search', type: :feature do
+
+  before :all do
+    @google_url = 'http://google.com'
+    @key_to_search_by = 'swat-capybara'
+    @results_we_should_see = ['sw2at/swat.gemspec at master', 'The Capybara Cave', 'https://github.com/tw4qa/sw2at']
+  end
 
+  it 'should show us a good search result' do
+
+    step 'Go to Google' do
+      visit @google_url
+    end
+
+    step 'Type key string' do
+      safe_find('#lst-ib').set(@key_to_search_by)
+    end
+
+    step 'Click Search button' do
+      safe_click('button[type="submit"]')
+    end
+
+    step 'Ensure that the page contains all those results' do
+      @results_we_should_see.each do |text|
+        sub_step "Check '#{text}' presence" do
+          check_text text
+        end
+      end
+    end
+  end
+end
+```
+
+![alt tag](https://github.com/tw4qa/swat-capybara-example/blob/master/console_log.png)
+    
 Contributing to sw2at-capybara
 -----------------
  
@@ -23,4 +140,3 @@ Copyright
 -----------------
 Copyright (c) 2015 Vitaly Tarasenko. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/swat/capybara/rspec_setup.rb

@@ -13,9 +13,12 @@ module Swat
         RSpec::Core::Formatters.register self, :example_started, :example_passed, :example_failed, :start, :stop
 
         START_MESSAGE = <<STM
--------------------------------
- [ SW2AT-CAPYBARA initialized ]
--------------------------------
+
+   _|_|_|  _|          _|    _|_|    _|_|_|_|_|
+ _|        _|          _|  _|    _|      _|
+   _|_|    _|    _|    _|  _|_|_|_|      _|
+       _|    _|  _|  _|    _|    _|      _|
+ _|_|_|        _|  _|      _|    _|      _|
 STM
 
         def initialize(arg)
@@ -31,7 +34,8 @@ STM
 
         def example_started(notification)
           @started = Time.now
-          @swat_logger.puts "\n[FEATURE] #{notification.example.description}".yellow
+          example_type = notification.example.metadata[:type].to_s.upcase
+          @swat_logger.puts "\n[#{example_type}] #{notification.example.description}".yellow
         end
 
         def example_passed(notification)

data/sw2at-capybara.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: sw2at-capybara 0.0.2 ruby lib
+# stub: sw2at-capybara 0.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "sw2at-capybara"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Vitaly Tarasenko"]
-  s.date = "2015-06-22"
+  s.date = "2015-06-26"
   s.description = " Gem helps to create capybara tests for pages with a very dynamic content.  "
   s.email = "vetal.tarasenko@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sw2at-capybara
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Vitaly Tarasenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec