bdd 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26bc9edd12abbfb44efd8697966b255f6c899347
-  data.tar.gz: 8a9572f9e28559163428f23f78bb0a060f2512f3
+  metadata.gz: a4d91a1514792fd624df3de6f45e1a4d5491b7f7
+  data.tar.gz: 928c1fd5a8d6774004f6ef13eff6f9e028b4630f
 SHA512:
-  metadata.gz: d7100c8e7cbfe604d8b15fe0a5db80008240e0ec32a163b79efd25e288657da4321052972f547eedae3655c7cae34bf6c468a777bf9866cf26839e708e65bdca
-  data.tar.gz: 196f90b2f5b424220cbffe9e4a4cb490946b1a66b867b232168f82f546a300d760a5d8c41453399a5da29892203f97a59bdcd4ffc6b1ca596766282f2e671fda
+  metadata.gz: d6f14a84d66eb8a9f9fe002b15e9b6abb81cba9b4a32041c56aced89dc2cac6be6907e1d741d379a8ad22ff9ef958e5e8d5588bdc98415a0c0c0037c43b85985
+  data.tar.gz: f9a75ec22a3407dcd45b4e10ad4bf74d0cce51d42e499e2e728f5e8a7b524fbae3918e59c3a9857d02536a4be61fda5fcc01d5073c429bcff4bbfe0550d1f13c

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
   - 2.2.1
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# CHANGELOG BY VERSION
+
+## IN PROGRESS
+
+### May 19th 2015
+
+> @thejamespinto
+- Removing dependency 'rspec-example_steps'
+- No more need to have a .rspec with color and documentation format
+
+### May 20th 2015
+
+> @thejamespinto
+- renaming feature
+
+
+
+
+
+## v0.0.1
+
+### May 18th 2015
+
+> @thejamespinto
+- Renaming gem to 'bdd'
+

data/README.md

@@ -1,43 +1,270 @@
-# Bdd
+## Bdd
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bdd`. To experiment with that code, run `bin/console` for an interactive prompt.
+Bdd brings cucumber-style Given/When/Then/And/But steps for RSpec examples
 
-TODO: Delete this and the text above, and describe your gem
+### Status
 
-## Installation
+[![Gem Version](https://badge.fury.io/rb/bdd.svg)](http://badge.fury.io/rb/bdd)
+[![Build Status](https://travis-ci.org/thejamespinto/bdd.svg)](https://travis-ci.org/thejamespinto/bdd)
 
-Add this line to your application's Gemfile:
+### Description
+
+This gem brings two major functionality to your tests
+
+* Verbosity for rspec documentation formatter.
+* Ability to comment or describe set of actions in example into some step.
+
+
+
+### Installation
 
 ```ruby
 gem 'bdd'
 ```
 
-And then execute:
+Add to `spec/spec_helper.rb`
 
-    $ bundle
+```ruby
+require 'bdd'
+```
 
-Or install it yourself as:
 
-    $ gem install bdd
 
-## Usage
+### Example
 
-Add this to your spec_helper.rb file
+`spec/features/search_spec.rb`
 
 ```ruby
-require 'bdd'
+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 with shared steps
+
+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>
+
+
+
+
+
+
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+Currently we only support __RSpec__
+
+__minitest__ and __test_unit__ pull requests are wanted.
+
+__internationalization__ pull requests are wanted.
+
+
+## Authors
+
+* [James Pinto](http://github.com/thejamespinto)
+
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/bdd/fork )
+1. Fork it ( https://github.com/thejamespinto/bdd/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Alternatives and Inspiration
+
+* [rspec-steps](https://github.com/LRDesign/rspec-steps)
+* [rspec-given](https://github.com/jimweirich/rspec-given)
+* [rspec-example_steps](https://github.com/railsware/rspec-example_steps)
+* [cucumber](https://github.com/cucumber/cucumber)
+
+<pre>
+  <b>rspec-steps</b>, <b>rspec-given</b> and <b>rspec-example_steps</b> run <i>AS</i> examples.
+  <b>bdd</b> and <b>cucumber</b> run <i>INSIDE</i> examples, running tests faster.
+</pre>

data/bdd.gemspec

@@ -21,13 +21,12 @@ Gem::Specification.new do |spec|
   # 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-example_steps'
+  
   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 "bundler", "~> 1.9"
+  # spec.add_development_dependency "rake", "~> 10.0"
   # spec.add_development_dependency 'rspec'
 end

data/lib/bdd/rspec/{code.rb → documentation_formatter.rb}

@@ -1,83 +1,13 @@
 # https://raw.githubusercontent.com/rspec/rspec-core/v3.2.2/lib/rspec/core/formatters/documentation_formatter.rb
-# require "rspec/core/formatters/documentation_formatter"
 
 RSpec::Support.require_rspec_core "formatters/base_text_formatter"
 
-class RSpec::Core::ExampleGroup
-  def step(msg)
-    m = RSpec.current_example.metadata
-    
-    if block_given?
-      # m[:step_messages] << msg #if m[:step_messages]
-      if @is_during_rspec_step
-        yield
-      else
-        m[:step_messages] << hash = {msg: msg}
-        @is_during_rspec_step = true
-        yield
-        # apply green color if example passes
-        hash[:color] = :green
-        @is_during_rspec_step = false
-      end
-    else
-      m[:step_messages] << {msg: "SKIPPED #{msg}"}
-    end
-  end
-
-  def Given(msg, &block)
-    step(["Given", msg], &block)
-  end
-
-  def When(msg, &block)
-    step([" When", msg], &block)
-  end
-
-  def Then(msg, &block)
-    step([" Then", msg], &block)
-  end
-
-  def And(msg, &block)
-    step(["  And", msg], &block)
-  end
-
-  def But(msg, &block)
-    step(["  But", msg], &block)
-  end
-
-  # def AndGiven(msg, &block)
-  #   step("And Given #{msg}", &block)
-  # end
-
-  # def AndWhen(msg, &block)
-  #   step(" And When #{msg}", &block)
-  # end
-
-  # def AndThen(msg, &block)
-  #   step(" And Then #{msg}", &block)
-  # end
-
-  # def ButGiven(msg, &block)
-  #   step("But Given #{msg}", &block)
-  # end
-
-  # def ButWhen(msg, &block)
-  #   step(" But When #{msg}", &block)
-  # end
-
-  # def ButThen(msg, &block)
-  #   step(" But Then #{msg}", &block)
-  # end
-end
-
-
 module RSpec
   module Core
     module Formatters
+      
       # @private
       class DocumentationFormatter < BaseTextFormatter
-        Formatters.register self
-        # , :example_group_started, :example_group_finished,
-        #                     :example_passed, :example_pending, :example_failed
 
         def initialize(output)
           super
@@ -130,7 +60,6 @@ module RSpec
                       else
                         msg[0].light_white.bold
                       end
-                      # msg0 = msg[0].white.bold
               last_step_title = msg[0]
               
               msg = [msg0, msg[1].colorize(color)].join(' ')
@@ -138,8 +67,6 @@ module RSpec
             # light_black doesn't really get used because the test failure prevents other messages from being added
             r = [next_indentation, msg]
             r.join(' ')
-            # r = [next_indentation, "-".colorize(color), msg]
-            # r.join(' ').colorize(color)
           end
         end
 
@@ -147,12 +74,6 @@ module RSpec
           "     "
         end
 
-
-        def next_failure_index
-          @next_failure_index ||= 0
-          @next_failure_index += 1
-        end
-
         def current_indentation
           '  ' * @group_level
         end
@@ -161,9 +82,6 @@ module RSpec
           '  ' * (@group_level+1)
         end
 
-        def example_group_chain
-          example_group.parent_groups.reverse
-        end
       end
     end
   end

data/lib/bdd/rspec/example_group.rb

@@ -0,0 +1,79 @@
+module Bdd
+  module RSpec
+    module ExampleGroup
+
+      
+      def step(array, &block)
+        m = ::RSpec.current_example.metadata
+        step_messages = m[:step_messages]
+        
+        if block_given?
+          # m[:step_messages] << array #if m[:step_messages]
+          if @is_during_rspec_step
+            yield
+          else
+            step_messages << hash = {msg: array}
+            @is_during_rspec_step = true
+            yield
+            # apply green color if example passes
+            hash[:color] = :green
+            @is_during_rspec_step = false
+          end
+
+        elsif array.last == :bdd
+          a = step_messages.last[:msg]
+          a[0] = array[0]
+        else
+          step_messages << {msg: "SKIPPED #{array}"}
+        end
+        return :bdd
+      end
+
+      def Given(msg, &block)
+        step(["Given", msg], &block)
+      end
+
+      def When(msg, &block)
+        step([" When", msg], &block)
+      end
+
+      def Then(msg, &block)
+        step([" Then", msg], &block)
+      end
+
+      def And(msg, &block)
+        step(["  And", msg], &block)
+      end
+
+      def But(msg, &block)
+        step(["  But", msg], &block)
+      end
+
+      # def AndGiven(msg, &block)
+      #   step("And Given #{msg}", &block)
+      # end
+
+      # def AndWhen(msg, &block)
+      #   step(" And When #{msg}", &block)
+      # end
+
+      # def AndThen(msg, &block)
+      #   step(" And Then #{msg}", &block)
+      # end
+
+      # def ButGiven(msg, &block)
+      #   step("But Given #{msg}", &block)
+      # end
+
+      # def ButWhen(msg, &block)
+      #   step(" But When #{msg}", &block)
+      # end
+
+      # def ButThen(msg, &block)
+      #   step(" But Then #{msg}", &block)
+      # end
+
+
+    end
+  end
+end

data/lib/bdd/rspec/reporter.rb

@@ -0,0 +1,15 @@
+module Bdd
+  module RSpec
+    module Reporter
+
+      def __bdd_registered_formatters
+        @listeners.values.map(&:to_a).flatten.uniq
+      end
+
+      def __bdd_find_registered_formatter(klass)
+        __bdd_registered_formatters.detect { |formatter| formatter.class == klass }
+      end
+
+    end
+  end
+end

data/lib/bdd/rspec.rb

@@ -1,8 +1,37 @@
-require "rspec/example_steps"
-require "bdd/rspec/code"
+require 'bdd/rspec/reporter'
+require 'bdd/rspec/example_group'
+require 'bdd/rspec/documentation_formatter'
 
-module Bdd
-  module RSpec
-    # Your code goes here...
-  end
+RSpec::Core::Reporter.send     :include, Bdd::RSpec::Reporter
+RSpec::Core::ExampleGroup.send :include, Bdd::RSpec::ExampleGroup
+
+
+
+#
+# CONFIGURE
+#
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
 end
+
+
+
+#
+# REGISTER
+#
+
+# if formatter = RSpec.world.reporter.__bdd_find_registered_formatter(RSpec::Core::Formatters::DocumentationFormatter)
+#   RSpec.world.reporter.register_listener formatter, :example_started
+#   RSpec::Core::Formatters.register       formatter
+# end
+
+formatter = RSpec::Core::Formatters::DocumentationFormatter.new($stdout)
+RSpec.world.reporter.register_listener formatter, :example_started
+RSpec::Core::Formatters.register       formatter

data/lib/bdd/version.rb

@@ -1,3 +1,3 @@
 module Bdd
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/bdd.rb

@@ -4,7 +4,7 @@ require "colorize"
 
 
 
-require "bdd/rspec" # if defined? ::RSpec
+require "bdd/rspec" if defined? RSpec
 # TODO: require "bdd/test_unit" # if 
 # TODO: require "bdd/minitest"  # if 
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bdd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Pinto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec-example_steps
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 description: Cucumber style in your RSpec tests
 email:
 - thejamespinto@gmail.com
@@ -88,8 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -98,7 +56,9 @@ files:
 - bin/setup
 - lib/bdd.rb
 - lib/bdd/rspec.rb
-- lib/bdd/rspec/code.rb
+- lib/bdd/rspec/documentation_formatter.rb
+- lib/bdd/rspec/example_group.rb
+- lib/bdd/rspec/reporter.rb
 - lib/bdd/version.rb
 homepage: https://github.com/thejamespinto/bdd
 licenses: []

data/.rspec

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