rspec-example_steps 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd97af8e8b76d12ec7434c4eb854aa651555c42c
-  data.tar.gz: e4449872a1ec8ae034d9136682f52f4594d71d40
+  metadata.gz: 489096c9a1854033941f9011671224109ba01512
+  data.tar.gz: 3e60360c4d30279ed99788e14155957ffb9c90ca
 SHA512:
-  metadata.gz: 777bc5d0fc4d8ce11f571cf9bb1735e8f3bd3344409080073f4a3678481304d1ac6a8a7b284ceadc7c35cc17b5342731a4e11a7cee9273506a61cc0e45f42b88
-  data.tar.gz: 3a76f6f840f06048ee69def67e3a2d2003ce06afc43bbb3c07145f592f4904a6e0f4fd84ee045014b77f3cac1ca13222823e1c400a223edf8602c8138fe9d4fb
+  metadata.gz: 27690c06fa608053e3667440b604f5f9fab8170a5c98284e649f19759f4a731af287359c636ca532dfe58b688974ac264c0d3c76d389537a81d89a874a8b5d19
+  data.tar.gz: a83438d88b9168dad1fcb861ed5dafb50ea25d8d8a459ffde849e4a8b5da157630b766e160160e52d82fc4e0bfc70b5a8a418e38b5fed76bb3cc18d61196594e

data/README.md

@@ -2,45 +2,63 @@
 
 Given/When/Then/And/But steps for RSpec examples
 
+### Description
+
+This gem brings two major functionality to your `spec/features`
+
+* Verbosity for rspec documentation formatter.
+* Ability to comment or describe set of actions in example into some step.
+
 ### Installation
 
-* For rspec v2 use gem v0.2.x or branch rspec2
-* For rspec v3 user gem v3.x.x or master
+* For rspec v2 use gem **v0.2.x** or rspec2 branch
+* For rspec v3 user gem **v3.x.x** or master branch
 
-<pre>
-    gem 'rspec-example_steps'
-</pre>
+```ruby
+gem 'rspec-example_steps'
+```
+
+Add to `spec/spec_helper.rb`
+
+```ruby
+require 'rspec/example_steps'
+```
 
 ### Example
 
-    require 'rspec/example_steps'
+`spec/features/search_spec.rb`
 
-    context "Searching" do
-      Steps "Result found" do
-        Given "I am on search page" do
-          page.visit("/search")
-          page.should have_content("Search")
-        end
+```ruby
+context 'Searching' do
+  Steps 'Result found' do
+    Given 'I am on search page' do
+      visit '/search'
+      expect(page).to have_content('Search')
+    end
 
-        When "I search something" do
-          page.fill_in('Search', :with => 'John')
-          page.click_button "Go"
-        end
+    When 'I search something' do
+      fill_in 'Search', with: 'John'
+      click_button 'Go'
+    end
 
-        Then "I should see result" do
-          page.should have_content("Result")
-        end
-      end
+    Then 'I should see result' do
+      expect(page).to have_content('Result')
     end
+  end
+end
+```
 
 ### Documentation formatting output:
 
-    Searching
-      User succesfully replaces device
-        Given I am on search page
-        When I search something
-        Then I should see result
+`rspec -fd spec/features/search_spec.rb`
 
+<pre>
+Searching
+  User succesfully replaces device
+    Given I am on search page
+    When I search something
+    Then I should see result
+</pre>
 
 ### Shared steps
 
@@ -50,42 +68,43 @@ Shared _steps_ behavior is simular to shared _example_ but context is example no
 
 ### Example with shared steps
 
-    shared_steps "login" do
-      When "I go to login page" do
-        page.visit '/login'
-      end
-      When "I put credentials" do
-        page.fill_in 'Login', :with => 'jack@example.com'
-        page.fill_in 'Password', :with => 'password''
-      end
-      Then "I should be logged in" do
-        page.status_code.should == 200
-        page.should have_content("Welcome jack@example.com")
-      end
-    end
-
-    shared_steps "logout" do
-      page.visit '/logout'
-      page.status_code.should == 200
+```ruby
+shared_steps 'login' do
+  When 'I go to login page' do
+    visit '/login'
+  end
+  When 'I put credentials' do
+    fill_in 'Login', with: 'jack@example.com'
+    fill_in 'Password', with: 'password'
+  end
+  Then 'I should be logged in' do
+    expect(page).to have_content('Welcome jack@example.com')
+  end
+end
+
+shared_steps 'logout' do
+  visit '/logout'
+  expect(page.status_code).to eq(200)
+end
+
+context 'user flow'
+  Steps 'User updates profile description' do
+    include_steps 'login'
+    When 'I update profile description' do
+      ...
     end
+    include_steps 'logout'
+  end
 
-    context "user flow"
-      Steps "User updates profile description" do
-        include_steps "login"
-        When "I update profile description" do
-          ...
-        end
-        include_steps "logout"
-      end
-
-      Steps "User updates profile avatar" do
-        include_steps "login"
-        When "I update profile avatar" do
-          ...
-        end
-        include_steps "logout"
-      end
+  Steps 'User updates profile avatar' do
+    include_steps 'login'
+    When 'I update profile avatar' do
+      ...
     end
+    include_steps 'logout'
+  end
+end
+```
 
 ### Passing arguments to shared steps
 
@@ -93,51 +112,54 @@ It's possible to customize shared steps. See example
 
 ### Example with shared steps with arguments
 
-    shared_steps "login" do |email, password|
-      When "I go to login page" do
-        page.visit '/login'
-      end
-      When "I put credentials" do
-        page.fill_in 'Login', :with => email
-        page.fill_in 'Password', :with => password
-      end
-    end
-
-    shared_steps "invalid login" do
-      Then "I should see login error" do
-      ...
-      end
-    end
-
-    Steps "User provides wrong email" do
-      include_steps "login", 'jack', 'qwerty'
-      include_steps "invalid login"
-    end
-
-    Steps "User provides wrong password" do
-      include_steps "login", 'jack@example.com', 'bla'
-      include_steps "invalid login"
-    end
-
+```ruby
+shared_steps 'login' do |email, password|
+  When 'I go to login page' do
+    page.visit '/login'
+  end
+  When 'I put credentials' do
+    fill_in 'Login', with: email
+    fill_in 'Password', with: password
+  end
+end
+
+shared_steps 'invalid login' do
+  Then 'I should see login error' do
+  ...
+  end
+end
+
+Steps 'User provides wrong email' do
+  include_steps 'login', 'jack', 'qwerty'
+  include_steps 'invalid login'
+end
+
+Steps 'User provides wrong password' do
+  include_steps 'login', 'jack@example.com', 'bla'
+  include_steps 'invalid login'
+end
+```
 
 ### Pending steps
 
 Simular to Example :pending behavior:
 
-    Steps "User login" do
-      # just skip block
-      When "I go to login"
-
-      # pass :pending => true option
-      Then "I should see welcome", :pending => true do
-      ...
-      end
-
-      # pass :pending => "some pending message"
-      Then "I should see last login IP", :pending => "WIP" do
-      ...
-      end
-    end
+```ruby
+Steps 'User login' do
+  # just skip block
+  When 'I go to login'
+
+  # pass pending: true option
+  Then 'I should see welcome', pending: true do
+  ...
+  end
+
+  # pass pending: 'some pending message'
+  Then 'I should see last login IP', pending: 'WIP' do
+  ...
+  end
+end
+```
 
 ## Authors
 

data/lib/rspec/example_steps/documentation_formatter.rb

@@ -27,7 +27,7 @@ module RSpec
         end
 
         def example_passed_with_steps(notification)
-          example_passed_without_steps(notification.example) unless notification.example.metadata[:with_steps]
+          example_passed_without_steps(notification) unless notification.example.metadata[:with_steps]
         end
 
         def example_step_passed(notification)

data/rspec-example_steps.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'rspec-example_steps'
-  s.version     = '3.0.1'
+  s.version     = '3.0.2'
   s.authors     = ['Andriy Yanko']
   s.email       = ['andriy.yanko@gmail.com']
   s.homepage    = 'https://github.com/railsware/rspec-example_steps'

data/spec/regression_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'Usual example' do
+  subject { 2 + 2 }
+
+  context 'success' do
+    specify { expect(subject).to eq(4) }
+  end
+
+  context 'failed' do
+    specify { expect(subject).to eq(5) }
+  end
+
+  context 'pending' do
+    it 'should be pending'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-example_steps
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Andriy Yanko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -45,6 +45,7 @@ files:
 - lib/rspec/example_steps/world.rb
 - rspec-example_steps.gemspec
 - spec/example_steps_spec.rb
+- spec/regression_spec.rb
 - spec/shared_steps_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/railsware/rspec-example_steps
@@ -73,5 +74,6 @@ specification_version: 4
 summary: Given/When/Then steps for RSpec examples
 test_files:
 - spec/example_steps_spec.rb
+- spec/regression_spec.rb
 - spec/shared_steps_spec.rb
 - spec/spec_helper.rb