bdd 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4d91a1514792fd624df3de6f45e1a4d5491b7f7
-  data.tar.gz: 928c1fd5a8d6774004f6ef13eff6f9e028b4630f
+  metadata.gz: 7b3071c8c5074b6bca6bdd82ba09c81b9db354e5
+  data.tar.gz: 45901f145dd5e74fa4afed0dd81e921211068b59
 SHA512:
-  metadata.gz: d6f14a84d66eb8a9f9fe002b15e9b6abb81cba9b4a32041c56aced89dc2cac6be6907e1d741d379a8ad22ff9ef958e5e8d5588bdc98415a0c0c0037c43b85985
-  data.tar.gz: f9a75ec22a3407dcd45b4e10ad4bf74d0cce51d42e499e2e728f5e8a7b524fbae3918e59c3a9857d02536a4be61fda5fcc01d5073c429bcff4bbfe0550d1f13c
+  metadata.gz: f75dff103d304b7113f40aee32b9ed767e5665ea1f729a6bea763a5122566e865098f357fc0dd95a7472fec66fb74bffcc25b65c82238782367ce58bcc0425f1
+  data.tar.gz: 472fdb4a93f13e82a6c3f7ee396f091f180f6c8ac590027232406d8cd453ad9fddef2cba6fadd442692506fbc919460e0ee76970aef44dde496235367b8ffe20

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## IN PROGRESS
 
+### June 17th 2015
+
+> @rafaelsales
+-   Does not force BDD formatting when gem is included in Gemfile
+    To use BDD Formatter follow steps in installation section of README
+-   Remove monkey patch of RSpec documentation formatter
+
 ### May 19th 2015
 
 > @thejamespinto

data/README.md

@@ -4,8 +4,16 @@ Bdd brings cucumber-style Given/When/Then/And/But steps for RSpec examples
 
 ### Status
 
-[![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)
+| 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) |
+
+
+[![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)
+
+
 
 ### Description
 
@@ -16,21 +24,34 @@ This gem brings two major functionality to your tests
 
 
 
-### Installation
+## Installation
+
+Include in your Gemfile:
 
 ```ruby
-gem 'bdd'
+group :test do
+  gem 'bdd'
+end
 ```
 
-Add to `spec/spec_helper.rb`
+### RSpec
 
-```ruby
-require 'bdd'
-```
+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
+```
 
-### Example
+## Output Example
 
 `spec/features/search_spec.rb`
 

data/lib/bdd/rspec/example_group.rb

@@ -2,13 +2,13 @@ module Bdd
   module RSpec
     module ExampleGroup
 
-      
       def step(array, &block)
-        m = ::RSpec.current_example.metadata
-        step_messages = m[:step_messages]
-        
+        unless using_bdd_formatter?
+          yield if block_given?
+          return
+        end
+
         if block_given?
-          # m[:step_messages] << array #if m[:step_messages]
           if @is_during_rspec_step
             yield
           else
@@ -74,6 +74,15 @@ module Bdd
       # end
 
 
+      private
+
+      def step_messages
+        ::RSpec.current_example.metadata[:step_messages]
+      end
+
+      def using_bdd_formatter?
+        !step_messages.nil?
+      end
     end
   end
 end

data/lib/bdd/rspec/formatter.rb

@@ -0,0 +1,63 @@
+RSpec::Support.require_rspec_core "formatters/documentation_formatter"
+
+module Bdd
+  module RSpec
+    class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
+
+      ::RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished,
+                                         :example_started, :example_passed,
+                                         :example_pending, :example_failed
+
+      def example_started(notification)
+        notification.example.metadata[:step_messages] = []
+      end
+
+      def example_passed(passed)
+        super
+        output.puts read_steps(passed.example)
+      end
+
+      def example_pending(pending)
+        super
+        output.puts read_steps(pending.example, :yellow)
+      end
+
+      def example_failed(failure)
+        super
+        output.puts read_steps(failure.example, :red)
+      end
+
+    private
+
+      def read_steps(example, color2=nil)
+        last_step_title = ""
+        example.metadata[:step_messages].map do |hash|
+          msg   = hash[:msg]
+          color = hash[:color] || color2 || :light_black
+          if msg.is_a? Array
+            msg0 =  if msg[0] == last_step_title
+                      blank_step_title
+                    else
+                      msg[0].light_white.bold
+                    end
+            last_step_title = msg[0]
+
+            msg = [msg0, msg[1].colorize(color)].join(' ')
+          end
+          # light_black doesn't really get used because the test failure prevents other messages from being added
+          r = [next_indentation, msg]
+          r.join(' ')
+        end
+      end
+
+      def blank_step_title
+        "     "
+      end
+
+      def next_indentation
+        '  ' * (@group_level+1)
+      end
+
+    end
+  end
+end

data/lib/bdd/rspec.rb

@@ -1,37 +1,3 @@
-require 'bdd/rspec/reporter'
 require 'bdd/rspec/example_group'
-require 'bdd/rspec/documentation_formatter'
 
-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.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bdd
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - James Pinto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -56,9 +56,8 @@ files:
 - bin/setup
 - lib/bdd.rb
 - lib/bdd/rspec.rb
-- lib/bdd/rspec/documentation_formatter.rb
 - lib/bdd/rspec/example_group.rb
-- lib/bdd/rspec/reporter.rb
+- lib/bdd/rspec/formatter.rb
 - lib/bdd/version.rb
 homepage: https://github.com/thejamespinto/bdd
 licenses: []

data/lib/bdd/rspec/documentation_formatter.rb

@@ -1,88 +0,0 @@
-# https://raw.githubusercontent.com/rspec/rspec-core/v3.2.2/lib/rspec/core/formatters/documentation_formatter.rb
-
-RSpec::Support.require_rspec_core "formatters/base_text_formatter"
-
-module RSpec
-  module Core
-    module Formatters
-      
-      # @private
-      class DocumentationFormatter < BaseTextFormatter
-
-        def initialize(output)
-          super
-          @group_level = 0
-        end
-
-
-        def example_started(notification)
-          notification.example.metadata[:step_messages] = []
-        end
-
-        def example_group_started(notification)
-          output.puts if @group_level == 0
-          output.puts "#{current_indentation}#{notification.group.description.strip}"
-
-          @group_level += 1
-        end
-
-        def example_group_finished(_notification)
-          @group_level -= 1
-        end
-
-        def example_passed(passed)
-          output.puts passed_output(passed.example)
-          output.puts read_steps(passed.example)
-        end
-
-        def example_pending(pending)
-          output.puts pending_output(pending.example,
-                                     pending.example.execution_result.pending_message)
-          output.puts read_steps(pending.example, :yellow)
-        end
-
-        def example_failed(failure)
-          output.puts failure_output(failure.example,
-                                     failure.example.execution_result.exception)
-          output.puts read_steps(failure.example, :red)
-        end
-
-      private
-
-        def read_steps(example, color2=nil)
-          last_step_title = ""
-          example.metadata[:step_messages].map do |hash|
-            msg   = hash[:msg]
-            color = hash[:color] || color2 || :light_black
-            if msg.is_a? Array
-              msg0 =  if msg[0] == last_step_title
-                        blank_step_title
-                      else
-                        msg[0].light_white.bold
-                      end
-              last_step_title = msg[0]
-              
-              msg = [msg0, msg[1].colorize(color)].join(' ')
-            end
-            # light_black doesn't really get used because the test failure prevents other messages from being added
-            r = [next_indentation, msg]
-            r.join(' ')
-          end
-        end
-
-        def blank_step_title
-          "     "
-        end
-
-        def current_indentation
-          '  ' * @group_level
-        end
-
-        def next_indentation
-          '  ' * (@group_level+1)
-        end
-
-      end
-    end
-  end
-end

data/lib/bdd/rspec/reporter.rb

@@ -1,15 +0,0 @@
-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