bdd 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a73861eaae60c9c300da0022a697fbdcffc59882
-  data.tar.gz: d386090a5cdfe7b6bb243a56b87437ce43d30e45
+  metadata.gz: 1bbba94ca8816485d96068bc62f9fb67718f7398
+  data.tar.gz: 77460d66dffe6fede33b6ac1f6d682845f772a46
 SHA512:
-  metadata.gz: d189b18b77943cf11878920d44a191112eb8a73512403a06ce148e54bb96d8f17a0b7deff81370830fc9b62dc12348d07d441599f081ab78754c7a0fbc4088b3
-  data.tar.gz: 7f48aa1010cb8cbc26bdc3dc132c0acad3faadfce729c451b90a01428584792f01eb87ad40b65c9c4ab8a5d16215860b20a3a44ebbfa9b533920e6b194ec6576
+  metadata.gz: 592c999c12b91ac8e6ecfa662671ec2a2db8af1b33401f2ba7413212a12c5df7b72949610c41f72490e712a4ffac165d0d06b79c4fdc69f8e1647b1a47d19e3a
+  data.tar.gz: a730d892831dd0074ff7467512dd9efe60e8109f7ccf16e75097e90bdaf4eb54be2942982c2df2e1901290a24b1d495e4f14e9053feb7a39f7bfc83b8b3e9d6a

data/.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.1
-script: bundle exec rspec spec
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.1
+  - ruby-head
+script: bundle exec rspec spec
+cache:
+  - bundler
+  - apt

data/README.md

@@ -1,17 +1,15 @@
 ## Bdd
 
-Bdd brings cucumber-style Given/When/Then/And/But steps for RSpec examples
+Bdd brings you cucumber-style Given/When/Then/And/But test reports
 
 ### Status
 
-| Master | Gem Version |
-| :----: | :----: |
-| [![Master Build Status](https://img.shields.io/travis/thejamespinto/bdd.svg)](https://travis-ci.org/thejamespinto/bdd) | [![Gem Version](https://img.shields.io/gem/v/bdd.svg)](https://rubygems.org/gems/bdd) |
-
+| Our Tests | Latest Version | # of Downloads | Contribute |
+| :----: | :----: | :----: | :----: |
+| [![Master Build Status](https://travis-ci.org/thejamespinto/bdd.svg?branch=master)](https://travis-ci.org/thejamespinto/bdd) | [![Gem Version](https://img.shields.io/gem/v/bdd.svg)](https://rubygems.org/gems/bdd) | [![Downloads](http://img.shields.io/gem/dt/bdd.svg)](https://rubygems.org/gems/bdd) | [![GitHub Issues](https://img.shields.io/github/issues/thejamespinto/bdd.svg)](https://rubygems.org/gems/bdd) |
 
 [![GitHub License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://rubygems.org/gems/bdd)
-[![Gem Downloads](http://img.shields.io/gem/dt/bdd.svg)](https://rubygems.org/gems/bdd)
-[![GitHub Issues](https://img.shields.io/github/issues/thejamespinto/bdd.svg)](https://rubygems.org/gems/bdd)
+
 
 
 
@@ -24,289 +22,139 @@ This gem brings two major functionality to your tests
 
 
 
+
+
+
+
+
 ## Installation
 
 Include in your Gemfile:
 
 ```ruby
 group :test do
-  gem 'bdd'
+  # pick one
+  gem 'bdd', require: 'bdd/rspec'
+  gem 'bdd', require: 'bdd/minitest'
 end
 ```
 
-### RSpec
-
-Run specs with custom format specified inline:
 
-`
-rspec --format Bdd::RSpec::Formatter --color spec
-`
 
-Or, if you want to use as your default formatter, simply put the options in your .rspec file:
 
-`.rspec`
-
-```yml
---format Bdd::RSpec::Formatter
---color
-```
-
-## Output Example
-
-`spec/features/search_spec.rb`
+### Installation For RSpec
 
 ```ruby
-context 'Searching' do
-  it 'Result is found' do
-    Given 'I am on the search page' do
-      visit '/search'
-      expect(page).to have_content('Search')
-    end
-
-    When 'I search something' do
-      fill_in 'Search', with: 'John'
-      click_button 'Go'
-    end
-
-    Then 'I should see the word result' do
-      expect(page).to have_content('Result')
-    end
-  end
+group :test do
+  gem 'rspec'
+  gem 'bdd', require: 'bdd/rspec'
 end
 ```
 
-
-### Documentation formatting output:
-
-`rspec -fd spec/features/search_spec.rb`
-
-<pre>
-<b>Searching</b>
-  <b>Result is found</b>
-    <b>Given</b> I am on the search page
-    <b> When</b> I search something
-    <b> Then</b> I should see the word result
-</pre>
-
-
-### Shared Steps
-
-### Basic Example with shared steps
-
-You can refactor steps into methods using plain Ruby syntax.
+Add this to your `spec/spec_helper.rb` file.
 
 ```ruby
-def given_I_log_in
-  Given "I log in" do
-    visit '/login'
-    fill_in 'Login', with: 'jack@example.com'
-    fill_in 'Password', with: 'password'
-    click_button "Log in"
-    expect(page).to have_content('Welcome jack@example.com')
-  end
+RSpec.configure do |config|
+  config.color = true
+  config.default_formatter = Bdd::RSpec::Formatter
 end
 
-def then_I_should_see_a_confirmation_message
-  Then "I should see a confirmation message" do
-    expect(page).to have_content('Your profile was updated successfully')
-  end
-end
+# optionally, define methods in your own language
 
-context 'User Flow' do
-  it 'User updates profile description' do
-    given_I_log_in
-    When 'I update profile description' do
-      ...
-    end
-    then_I_should_see_a_confirmation_message
-  end
-
-  it 'User updates profile avatar' do
-    given_I_log_in
-    When 'I update profile avatar' do
-      ...
-    end
-    then_I_should_see_a_confirmation_message
-  end
-end
+Bdd.define(%w[Dado], %w[Quando Entao], %w[E Mas]) # Portuguese
+Bdd.define(%w[Zakładając], %w[Jeśli To], %w[Także Ale]) # Polish
 ```
-Output:
-<pre>
-<b>User Flow</b>
-  <b>User updates profile description</b>
-    <b>Given</b> I log in
-    <b> When</b> I update profile description
-    <b> Then</b> I should see a confirmation message
-</pre>
 
 
 
-### Nested Example 1
 
-Outside of the scope
-
-Given is automatically inserted as a before
-Then is automatically inserted as an after
+### Installation For Minitest
 
 ```ruby
-Given "I log in" do
-  visit '/login'
-  fill_in 'Login', with: 'jack@example.com'
-  fill_in 'Password', with: 'password'
-  click_button "Log in"
-  expect(page).to have_content('Welcome jack@example.com')
+group :test do
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'bdd', require: 'bdd/minitest'
 end
+```
 
-Then "I should see a confirmation message" do
-  expect(page).to have_content('Your profile was updated successfully')
-end
+Add this to your `test/test_helper.rb` file.
 
-context 'User Flow' do
-  it 'User updates profile description' do
-    When 'I update profile description' do
-      ...
-    end
-  end
+```ruby
+Minitest::Reporters.use!(Bdd::Minitest::Reporter.new)
 
-  it 'User updates profile avatar' do
-    When 'I update profile avatar' do
-      ...
-    end
-  end
-end
+# optionally, add methods in your own language
+
+Bdd.define(%w[Dado], %w[Quando Entao], %w[E Mas]) # Portuguese
+Bdd.define(%w[Zakładając], %w[Jeśli To], %w[Także Ale]) # Polish
 ```
-Output:
-<pre>
-<b>User Flow</b>
-  <b>User updates profile description</b>
-    <b>Given</b> I log in
-    <b> When</b> I update profile description
-    <b> Then</b> I should see a confirmation message
-</pre>
 
 
 
-### Nested Example 2
 
-Nesting will silence any output from the internal steps
 
-```ruby
-def given_I_am_on_the_log_in_page
-  Given 'I am on the login page' do
-    visit '/login'
-  end
-end
 
-def when_I_submit_the_log_in_form
-  When 'I put credentials' do
-    fill_in 'Login', with: 'jack@example.com'
-    fill_in 'Password', with: 'password'
-    click_button "Log in"
-  end
-end
+## Usage
 
-def then_I_should_be_logged_in
-  Then 'I should be logged in' do
-    expect(page).to have_content('Welcome jack@example.com')
-  end
-end
+File `spec/features/search_spec.rb`
 
-def given_I_log_in
-  Given "I log in" do
-    given_I_am_on_the_log_in_page
-    when_I_submit_the_log_in_form
-    then_I_should_be_logged_in
-  end
-end
+```ruby
+context 'Searching' do
+  it 'Result is found' do
+    Given 'I am on the search page' do
+      visit '/search'
+      expect(page).to have_content('Search')
+    end
 
-context 'User Flow' do
-  it 'User updates profile description' do
-    given_I_log_in
-    When 'I update profile description' do
-      ...
+    When 'I search something' do
+      fill_in 'Search', with: 'John'
+      click_button 'Go'
     end
-    then_I_should_see_a_confirmation_message
-  end
 
-  it 'User updates profile avatar' do
-    given_I_log_in
-    When 'I update profile avatar' do
-      ...
+    Then 'I should see the word result' do
+      expect(page).to have_content('Result')
     end
-    then_I_should_see_a_confirmation_message
   end
 end
 ```
-Output:
-<pre>
-<b>User Flow</b>
-  <b>User updates profile description</b>
-    <b>Given</b> I log in
-    <b> When</b> I update profile description
-    <b> Then</b> I should see a confirmation message
-</pre>
-
 
-### Renaming
+Run tests
 
-Useful for refactored nesting, you can change a step's name
+`rspec -fd spec/features/search_spec.rb`
 
-```ruby
-def when_I_log_in
-  When "I log in" do
-    visit '/login'
-    fill_in 'Login', with: 'jack@example.com'
-    fill_in 'Password', with: 'password'
-    click_button "Log in"
-    expect(page).to have_content('Welcome jack@example.com')
-  end
-end
+Output
 
+<pre>
+<b>Searching</b>
+  <b>Result is found</b>
+    <b>Given</b> I am on the search page
+    <b> When</b> I search something
+    <b> Then</b> I should see the word result
+</pre>
 
-def given_I_log_in
-  Given when_I_log_in
-end
 
-context 'User Flow'
-  it 'User updates profile description' do
-    given_I_log_in
-    When 'I update profile description' do
-      ...
-    end
-    then_I_should_see_a_confirmation_message
-  end
+### More Examples
 
-  it 'User updates profile avatar' do
-    given_I_log_in
-    When 'I update profile avatar' do
-      ...
-    end
-    then_I_should_see_a_confirmation_message
-  end
-end
-```
-Output:
-<pre>
-<b>User Flow</b>
-  <b>User updates profile description</b>
-    <b>Given</b> I log in
-    <b> When</b> I update profile description
-    <b> Then</b> I should see a confirmation message
-</pre>
+* [READ ALL EXAMPLES](http://github.com/thejamespinto/bdd/tree/master/examples)
 
+<br><br><br><br>
 
 
 
 
+## Defining custom steps
 
+In case your flow is different and you would like to define your own wording.
 
-## Development
+You can add more English words, or add an entirely new language:
 
-Currently we only support __RSpec__
+```ruby
+Bdd.define(%w[Given], %w[When Then], %w[And But]) # English
+Bdd.define(%w[Dado], %w[Quando Entao], %w[E Mas]) # Portuguese
+Bdd.define(%w[Zakładając], %w[Jeśli To], %w[Także Ale]) # Polish
+```
 
-__minitest__ and __test_unit__ pull requests are wanted.
 
-__internationalization__ pull requests are wanted.
 
 
 ## Authors

data/bdd.gemspec

@@ -9,24 +9,18 @@ Gem::Specification.new do |spec|
   spec.authors       = ["James Pinto"]
   spec.email         = ["thejamespinto@gmail.com"]
 
-  spec.summary       = %q{Cucumber style in your RSpec tests}
+  spec.summary       =
   spec.description   = %q{Cucumber style in your RSpec tests}
   spec.homepage      = "https://github.com/thejamespinto/bdd"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
-  # end
-  
-  spec.add_runtime_dependency 'rspec'
-  spec.add_runtime_dependency 'colorize'
-
-
   # spec.add_development_dependency "bundler", "~> 1.9"
   # spec.add_development_dependency "rake", "~> 10.0"
-  # spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters', '1.1.9'
 end

data/examples/README.md

@@ -0,0 +1,244 @@
+[Back to README](https://github.com/thejamespinto/bdd)
+
+## Output Example
+
+`spec/features/search_spec.rb`
+
+```ruby
+context 'Searching' do
+  it 'Result is found' do
+    Given 'I am on the search page' do
+      visit '/search'
+      expect(page).to have_content('Search')
+    end
+
+    When 'I search something' do
+      fill_in 'Search', with: 'John'
+      click_button 'Go'
+    end
+
+    Then 'I should see the word result' do
+      expect(page).to have_content('Result')
+    end
+  end
+end
+```
+
+
+### Documentation formatting output:
+
+`rspec -fd spec/features/search_spec.rb`
+
+<pre>
+<b>Searching</b>
+  <b>Result is found</b>
+    <b>Given</b> I am on the search page
+    <b> When</b> I search something
+    <b> Then</b> I should see the word result
+</pre>
+
+
+### Shared Steps
+
+### Basic Example with shared steps
+
+You can refactor steps into methods using plain Ruby syntax.
+
+```ruby
+def given_I_log_in
+  Given "I log in" do
+    visit '/login'
+    fill_in 'Login', with: 'jack@example.com'
+    fill_in 'Password', with: 'password'
+    click_button "Log in"
+    expect(page).to have_content('Welcome jack@example.com')
+  end
+end
+
+def then_I_should_see_a_confirmation_message
+  Then "I should see a confirmation message" do
+    expect(page).to have_content('Your profile was updated successfully')
+  end
+end
+
+context 'User Flow' do
+  it 'User updates profile description' do
+    given_I_log_in
+    When 'I update profile description' do
+      ...
+    end
+    then_I_should_see_a_confirmation_message
+  end
+
+  it 'User updates profile avatar' do
+    given_I_log_in
+    When 'I update profile avatar' do
+      ...
+    end
+    then_I_should_see_a_confirmation_message
+  end
+end
+```
+Output:
+<pre>
+<b>User Flow</b>
+  <b>User updates profile description</b>
+    <b>Given</b> I log in
+    <b> When</b> I update profile description
+    <b> Then</b> I should see a confirmation message
+</pre>
+
+
+
+### Nested Example 1
+
+Outside of the scope
+
+Given is automatically inserted as a before
+Then is automatically inserted as an after
+
+```ruby
+Given "I log in" do
+  visit '/login'
+  fill_in 'Login', with: 'jack@example.com'
+  fill_in 'Password', with: 'password'
+  click_button "Log in"
+  expect(page).to have_content('Welcome jack@example.com')
+end
+
+Then "I should see a confirmation message" do
+  expect(page).to have_content('Your profile was updated successfully')
+end
+
+context 'User Flow' do
+  it 'User updates profile description' do
+    When 'I update profile description' do
+      ...
+    end
+  end
+
+  it 'User updates profile avatar' do
+    When 'I update profile avatar' do
+      ...
+    end
+  end
+end
+```
+Output:
+<pre>
+<b>User Flow</b>
+  <b>User updates profile description</b>
+    <b>Given</b> I log in
+    <b> When</b> I update profile description
+    <b> Then</b> I should see a confirmation message
+</pre>
+
+
+
+### Nested Example 2
+
+Nesting will silence any output from the internal steps
+
+```ruby
+def given_I_am_on_the_log_in_page
+  Given 'I am on the login page' do
+    visit '/login'
+  end
+end
+
+def when_I_submit_the_log_in_form
+  When 'I put credentials' do
+    fill_in 'Login', with: 'jack@example.com'
+    fill_in 'Password', with: 'password'
+    click_button "Log in"
+  end
+end
+
+def then_I_should_be_logged_in
+  Then 'I should be logged in' do
+    expect(page).to have_content('Welcome jack@example.com')
+  end
+end
+
+def given_I_log_in
+  Given "I log in" do
+    given_I_am_on_the_log_in_page
+    when_I_submit_the_log_in_form
+    then_I_should_be_logged_in
+  end
+end
+
+context 'User Flow' do
+  it 'User updates profile description' do
+    given_I_log_in
+    When 'I update profile description' do
+      ...
+    end
+    then_I_should_see_a_confirmation_message
+  end
+
+  it 'User updates profile avatar' do
+    given_I_log_in
+    When 'I update profile avatar' do
+      ...
+    end
+    then_I_should_see_a_confirmation_message
+  end
+end
+```
+Output:
+<pre>
+<b>User Flow</b>
+  <b>User updates profile description</b>
+    <b>Given</b> I log in
+    <b> When</b> I update profile description
+    <b> Then</b> I should see a confirmation message
+</pre>
+
+
+### Renaming
+
+Useful for refactored nesting, you can change a step's name
+
+```ruby
+def when_I_log_in
+  When "I log in" do
+    visit '/login'
+    fill_in 'Login', with: 'jack@example.com'
+    fill_in 'Password', with: 'password'
+    click_button "Log in"
+    expect(page).to have_content('Welcome jack@example.com')
+  end
+end
+
+
+def given_I_log_in
+  Given when_I_log_in
+end
+
+context 'User Flow'
+  it 'User updates profile description' do
+    given_I_log_in
+    When 'I update profile description' do
+      ...
+    end
+    then_I_should_see_a_confirmation_message
+  end
+
+  it 'User updates profile avatar' do
+    given_I_log_in
+    When 'I update profile avatar' do
+      ...
+    end
+    then_I_should_see_a_confirmation_message
+  end
+end
+```
+Output:
+<pre>
+<b>User Flow</b>
+  <b>User updates profile description</b>
+    <b>Given</b> I log in
+    <b> When</b> I update profile description
+    <b> Then</b> I should see a confirmation message
+</pre>