rspec-example_steps 0.2.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 560058d2eeca41408e0cc1bf55c6b179b6373dc9
-  data.tar.gz: 3840525830d82be9f0ba1195ab9ee35d60bb8af3
+  metadata.gz: c7115307b34165ae0ecd94334e446522262ed4ac
+  data.tar.gz: 0d463def26a2172e776ea63a5fd33c7563544189
 SHA512:
-  metadata.gz: 4b1e922a5b487ed69466a392c642ffb6fcc08e2a011bfded641b575669adde8191677d6b8b8208caeb52639cc246ce722724cb72b67fac518cda65c1227a611f
-  data.tar.gz: 9d86dff6f94cb42bd9ab53a208f7356e01c282f9796026eb18a172c59037286ec0e14d39072a5970d37a84155cb5108ef9cf00ef8e12ed8a4a5dc1006509e761
+  metadata.gz: 24ce0f375bf74970c8ad4310b0a07534200183664aaca22dd1f448a291cea69721513079fe4017eba5943073215f6ae8dabb2fb8170dfb603997e370963f41a1
+  data.tar.gz: cd911247e763fae0a5cd2b5d65a2a74fdb716cd949ed8a8b4eb0cabeeba2fa9fd46dd93001c03571f7b7baa0080d49af639fedffea467178ea035c913c65a215

data/Gemfile

@@ -2,4 +2,4 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'rspec', '2.14.0'
+gem 'rspec', '3.0.0.rc1'

data/README.md

@@ -2,6 +2,13 @@
 
 Given/When/Then/And/But steps for RSpec examples
 
+### Installation
+
+* For rspec v2 use gem v0.2.x or branch rspec2
+* For rspec v3 user gem v3.x.x or master
+
+    gem 'rspec-example_steps'
+
 ### Example
 
     require 'rspec/example_steps'
@@ -121,12 +128,12 @@ Simular to Example :pending behavior:
 
       # 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
 

data/lib/rspec/example_steps.rb

@@ -1,26 +1,27 @@
 require 'rspec/core'
-require 'rspec/core/formatters/base_formatter'
+require 'rspec/core/formatters'
+require 'rspec/core/formatters/console_codes'
 require 'rspec/core/formatters/documentation_formatter'
 require 'rspec/core/example_group'
 require 'rspec/core/reporter'
 require 'rspec/core/world'
 
-require 'rspec/example_steps/base_formatter'
 require 'rspec/example_steps/documentation_formatter'
 require 'rspec/example_steps/example_group'
+require 'rspec/example_steps/notification'
 require 'rspec/example_steps/reporter'
 require 'rspec/example_steps/world'
 
-RSpec::Core::Formatters::BaseFormatter.send          :include, RSpec::ExampleSteps::BaseFormatter
 RSpec::Core::Formatters::DocumentationFormatter.send :include, RSpec::ExampleSteps::DocumentationFormatter
 RSpec::Core::ExampleGroup.send                       :include, RSpec::ExampleSteps::ExampleGroup
 RSpec::Core::Reporter.send                           :include, RSpec::ExampleSteps::Reporter
 RSpec::Core::World.send                              :include, RSpec::ExampleSteps::World
 
-if RSpec::Core::ExampleGroup.singleton_class.respond_to?(:define_example_method, true)
-  RSpec::Core::ExampleGroup.singleton_class.define_example_method :Steps, :with_steps => true
-else
-  RSpec::Core::ExampleGroup.define_example_method :Steps, :with_steps => true
+RSpec::Core::ExampleGroup.define_example_method :Steps, with_steps: true
+
+if formatter = RSpec.world.reporter.find_registered_formatter(RSpec::Core::Formatters::DocumentationFormatter)
+ RSpec.world.reporter.register_listener formatter,
+   :example_started, :example_step_passed, :example_step_pending, :example_step_failed
 end
 
 require 'rspec/example_steps/shared_steps'

data/lib/rspec/example_steps/documentation_formatter.rb

@@ -14,55 +14,42 @@ module RSpec
       end
 
       module InstanceMethods
-        def example_started_with_steps(example)
-          example_started_without_steps(example)
+        def example_started(notification)
+        end
+
+        def example_started_with_steps(notification)
+          example_started_without_steps(notification)
 
-          if example.options[:with_steps]
-            full_message = "#{current_indentation}#{example.description}"
-            if respond_to?(:default_color, true)
-              output.puts default_color(full_message)
-            else
-              output.puts white(full_message)
-            end
+          if notification.example.metadata[:with_steps]
+            full_message = "#{current_indentation}#{notification.example.description}"
+            output.puts Core::Formatters::ConsoleCodes.wrap(full_message, :default)
           end
         end
 
-        def example_passed_with_steps(example)
-          example_passed_without_steps(example) unless example.options[:with_steps]
+        def example_passed_with_steps(notification)
+          example_passed_without_steps(notification.example) unless notification.example.metadata[:with_steps]
         end
 
-        def example_step_passed(example_group, type, message, options)
-          full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message}"
-          if respond_to?(:success_color, true)
-            output.puts success_color(full_message)
-          else
-            output.puts green(full_message)
-          end
+        def example_step_passed(notification)
+          full_message = "#{current_indentation}  #{notification.type.to_s.capitalize} #{notification.message}"
+          output.puts Core::Formatters::ConsoleCodes.wrap(full_message, :success)
         end
 
-        def example_step_pending(example_group, type, message, options)
-          full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message}"
+        def example_step_pending(notification)
+          full_message = "#{current_indentation}  #{notification.type.to_s.capitalize} #{notification.message}"
 
-          if options[:pending] && options[:pending] != true
-            full_message << " (PENDING: #{options[:pending]})"
+          if notification.options[:pending] && notification.options[:pending] != true
+            full_message << " (PENDING: #{notification.options[:pending]})"
           else
             full_message << " (PENDING)"
           end
 
-          if respond_to?(:pending_color, true)
-            output.puts pending_color(full_message)
-          else
-            output.puts yellow(full_message)
-          end
+          output.puts Core::Formatters::ConsoleCodes.wrap(full_message, :pending)
         end
 
-        def example_step_failed(example_group, type, message, options)
-          full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message} (FAILED)"
-          if respond_to?(:failure_color, true)
-            output.puts failure_color(full_message)
-          else
-            output.puts red(full_message)
-          end
+        def example_step_failed(notification)
+          full_message = "#{current_indentation}  #{notification.type.to_s.capitalize} #{notification.message} (FAILED)"
+          output.puts Core::Formatters::ConsoleCodes.wrap(full_message, :failure)
         end
       end
     end

data/lib/rspec/example_steps/example_group.rb

@@ -2,85 +2,30 @@ module RSpec
   module ExampleSteps
     module ExampleGroup
       def include_steps(*args)
-        name = args.shift 
+        name = args.shift
         shared_block = RSpec.world.shared_example_steps[name]
         shared_block or raise ArgumentError, "Could not find shared steps #{name.inspect}"
-        instance_eval_with_args(*args, &shared_block)
+        instance_exec(*args, &shared_block)
       end
 
-      def Given(message, options = {})
-        RSpec.world.reporter.example_step_started(self, :given, message, options)
-        if block_given? && !options[:pending]
-          begin
-            yield
-          rescue Exception => e
-            RSpec.world.reporter.example_step_failed(self, :given, message, options)
-            raise e
-          end
-          RSpec.world.reporter.example_step_passed(self, :given, message, options)
-        else
-          RSpec.world.reporter.example_step_pending(self, :given, message, options)
-        end
+      def Given(message, options = {}, &block)
+        RSpec.world.reporter.process_example_step(self, :given, message, options, &block)
       end
 
-      def When(message, options = {})
-        RSpec.world.reporter.example_step_started(self, :when, message, options)
-        if block_given? && !options[:pending]
-          begin
-            yield
-          rescue Exception => e
-            RSpec.world.reporter.example_step_failed(self, :when, message, options)
-            raise e
-          end
-          RSpec.world.reporter.example_step_passed(self, :when, message, options)
-        else
-          RSpec.world.reporter.example_step_pending(self, :when, message, options)
-        end
+      def When(message, options = {}, &block)
+        RSpec.world.reporter.process_example_step(self, :when, message, options, &block)
       end
 
-      def Then(message, options = {})
-        RSpec.world.reporter.example_step_started(self, :then, message, options)
-        if block_given? && !options[:pending]
-          begin
-            yield
-          rescue Exception => e
-            RSpec.world.reporter.example_step_failed(self, :then, message, options)
-            raise e
-          end
-          RSpec.world.reporter.example_step_passed(self, :then, message, options)
-        else
-          RSpec.world.reporter.example_step_pending(self, :then, message, options)
-        end
+      def Then(message, options = {}, &block)
+        RSpec.world.reporter.process_example_step(self, :then, message, options, &block)
       end
 
-      def And(message, options = {})
-        RSpec.world.reporter.example_step_started(self, :and, message, options)
-        if block_given? && !options[:pending]
-          begin
-            yield
-          rescue Exception => e
-            RSpec.world.reporter.example_step_failed(self, :and, message, options)
-            raise e
-          end
-          RSpec.world.reporter.example_step_passed(self, :and, message, options)
-        else
-          RSpec.world.reporter.example_step_pending(self, :and, message, options)
-        end
+      def And(message, options = {}, &block)
+        RSpec.world.reporter.process_example_step(self, :and, message, options, &block)
       end
 
-      def But(message, options = {})
-        RSpec.world.reporter.example_step_started(self, :but, message, options)
-        if block_given? && !options[:pending]
-          begin
-            yield
-          rescue Exception => e
-            RSpec.world.reporter.example_step_failed(self, :but, message, options)
-            raise e
-          end
-          RSpec.world.reporter.example_step_passed(self, :but, message, options)
-        else
-          RSpec.world.reporter.example_step_pending(self, :but, message, options)
-        end
+      def But(message, options = {}, &block)
+        RSpec.world.reporter.process_example_step(self, :but, message, options, &block)
       end
 
     end

data/lib/rspec/example_steps/notification.rb

@@ -0,0 +1,6 @@
+module RSpec
+  module ExampleSteps
+    class Notification < Struct.new(:example, :type, :message, :options)
+    end
+  end
+end

data/lib/rspec/example_steps/reporter.rb

@@ -1,29 +1,44 @@
 module RSpec
   module ExampleSteps
     module Reporter
-      def self.included(base)
-        base::NOTIFICATIONS.push(
-          :example_step_started,
-          :example_step_passed,
-          :example_step_pending,
-          :example_step_failed
-        ) if base.constants.include?(:NOTIFICATIONS)
+      def process_example_step(example, type, message, options)
+        example_step_started(self, type, message, options)
+
+        if block_given? && !options[:pending]
+          begin
+            yield
+          rescue Exception => e
+            example_step_failed(self, type, message, options)
+            raise e
+          end
+          example_step_passed(self, type, message, options)
+        else
+          example_step_pending(self, type, message, options)
+        end
       end
 
       def example_step_started(example, type, message, options)
-        notify :example_step_started, example, type, message, options
+        notify :example_step_started, Notification.new(example, type, message, options)
       end
 
       def example_step_passed(example, type, message, options)
-        notify :example_step_passed, example, type, message, options
+        notify :example_step_passed, Notification.new(example, type, message, options)
       end
 
       def example_step_pending(example, type, message, options)
-        notify :example_step_pending, example, type, message, options
+        notify :example_step_pending, Notification.new(example, type, message, options)
       end
 
       def example_step_failed(example, type, message, options)
-        notify :example_step_failed, example, type, message, options
+        notify :example_step_failed, Notification.new(example, type, message, options)
+      end
+
+      def registered_formatters
+        @listeners.values.map(&:to_a).flatten.uniq
+      end
+
+      def find_registered_formatter(klass)
+        registered_formatters.detect { |formatter| formatter.class == klass }
       end
     end
   end

data/lib/rspec/example_steps/shared_steps.rb

@@ -6,7 +6,7 @@ module RSpec
         ensure_shared_example_steps_name_not_taken(name)
         RSpec.world.shared_example_steps[name] = block
       end
-      
+
       private
 
       def ensure_shared_example_steps_name_not_taken(name)

data/rspec-example_steps.gemspec

@@ -2,19 +2,20 @@
 $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "rspec-example_steps"
-  s.version     = "0.2.5"
-  s.authors     = ["Andriy Yanko"]
-  s.email       = ["andriy.yanko@gmail.com"]
-  s.homepage    = "https://github.com/railsware/rspec-example_steps"
+  s.name        = 'rspec-example_steps'
+  s.version     = '3.0.0'
+  s.authors     = ['Andriy Yanko']
+  s.email       = ['andriy.yanko@gmail.com']
+  s.homepage    = 'https://github.com/railsware/rspec-example_steps'
   s.summary     = %q{Given/When/Then steps for RSpec examples}
+  s.license     = 'MIT'
 
-  s.rubyforge_project = "rspec_example_steps"
+  s.rubyforge_project = 'rspec_example_steps'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_runtime_dependency "rspec-core", ">2.0.0"
+  s.add_runtime_dependency 'rspec-core', '3.0.0.rc1'
 end

data/spec/example_steps_spec.rb

@@ -25,11 +25,11 @@ describe "example steps" do
         @but = "But value"
       end
 
-      @thing.should  == "Given value"
-      @action.should == "When value"
-      @result.should == "Then value"
-      @and.should == "And value"
-      @but.should == "But value"
+      expect(@thing).to eq("Given value")
+      expect(@action).to eq("When value")
+      expect(@result).to eq("Then value")
+      expect(@and).to eq("And value")
+      expect(@but).to eq("But value")
     end
   end
 
@@ -113,7 +113,7 @@ describe "example steps" do
 
     Steps "When fails" do
       When "action" do
-        (2*2).should == 5
+        expect(2*2).to eq(5)
       end
 
       Then "I should see error" do

data/spec/shared_steps_spec.rb

@@ -10,7 +10,7 @@ shared_steps "push steps" do
   end
 
   Then "pipe should have data" do
-    pipe.items.should == ["hello"]
+    expect(pipe.items).to eq(["hello"])
   end
 end
 
@@ -26,7 +26,7 @@ shared_steps "pull steps" do
   end
 
   Then "pipe should be empty" do
-    pipe.items.should == []
+    expect(pipe.items).to eq([])
   end
 end
 
@@ -65,14 +65,14 @@ describe "shared steps" do
   Steps "push, count and pull" do
     include_steps "push steps"
     Then "pipe should have 1 item" do
-      pipe.items.size.should == 1
+      expect(pipe.items.size).to eq(1)
     end
     include_steps "pull steps"
   end
 
   Steps "push with arguments and pull" do
     include_steps "push with arguments steps", "hi"
-    pipe.items.should == ["hi"]
+    expect(pipe.items).to eq(["hi"])
     include_steps "pull steps"
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-example_steps
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Andriy Yanko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0.rc1
 description: 
 email:
 - andriy.yanko@gmail.com
@@ -31,15 +31,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/rspec/example_steps.rb
-- lib/rspec/example_steps/base_formatter.rb
 - lib/rspec/example_steps/documentation_formatter.rb
 - lib/rspec/example_steps/example_group.rb
+- lib/rspec/example_steps/notification.rb
 - lib/rspec/example_steps/reporter.rb
 - lib/rspec/example_steps/shared_steps.rb
 - lib/rspec/example_steps/world.rb
@@ -48,7 +48,8 @@ files:
 - spec/shared_steps_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/railsware/rspec-example_steps
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -56,17 +57,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rspec_example_steps
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Given/When/Then steps for RSpec examples

data/lib/rspec/example_steps/base_formatter.rb

@@ -1,17 +0,0 @@
-module RSpec
-  module ExampleSteps
-    module BaseFormatter
-      def example_step_started(example, type, message, options)
-      end
-
-      def example_step_passed(example, type, message, options)
-      end
-
-      def example_step_pending(example, type, message, options)
-      end
-
-      def example_step_failed(example, type, message, options)
-      end
-    end
-  end
-end