rspec-example_steps 0.1.0 → 0.1.1

data/README.md

@@ -110,6 +110,26 @@ It's possible to customize shared steps. See example
       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
+
 ## Alternatives
 
 * [rspec-steps](https://github.com/LRDesign/rspec-steps)

data/lib/rspec/example_steps/base_formatter.rb

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

data/lib/rspec/example_steps/documentation_formatter.rb

@@ -27,10 +27,22 @@ module RSpec
           example_passed_without_steps(example) unless example.options[:with_steps]
         end
 
-        def example_step_passed(example_group, type, message)
+        def example_step_passed(example_group, type, message, options)
           full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message}"
           output.puts green(full_message)
         end
+
+        def example_step_pending(example_group, type, message, options)
+          full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message}"
+
+          if options[:pending] && options[:pending] != true
+            full_message << " (PENDING: #{options[:pending]})"
+          else
+            full_message << " (PENDING)"
+          end
+
+          output.puts yellow(full_message)
+        end
       end
     end
   end

data/lib/rspec/example_steps/example_group.rb

@@ -8,23 +8,36 @@ module RSpec
         instance_eval_with_args(*args, &shared_block)
       end
 
-      def Given(message)
-        RSpec.world.reporter.example_step_started(self, :given, message)
-        yield
-        RSpec.world.reporter.example_step_passed(self, :given, message)
+      def Given(message, options = {})
+        RSpec.world.reporter.example_step_started(self, :given, message, options)
+        if block_given? && !options[:pending]
+          yield
+          RSpec.world.reporter.example_step_passed(self, :given, message, options)
+        else
+          RSpec.world.reporter.example_step_pending(self, :given, message, options)
+        end
       end
 
-      def When(message)
-        RSpec.world.reporter.example_step_started(self, :when, message)
-        yield
-        RSpec.world.reporter.example_step_passed(self, :when, message)
+      def When(message, options = {})
+        RSpec.world.reporter.example_step_started(self, :when, message, options)
+        if block_given? && !options[:pending]
+          yield
+          RSpec.world.reporter.example_step_passed(self, :when, message, options)
+        else
+          RSpec.world.reporter.example_step_pending(self, :when, message, options)
+        end
       end
 
-      def Then(message)
-        RSpec.world.reporter.example_step_started(self, :then, message)
-        yield
-        RSpec.world.reporter.example_step_passed(self, :then, message)
+      def Then(message, options = {})
+        RSpec.world.reporter.example_step_started(self, :then, message, options)
+        if block_given? && !options[:pending]
+          yield
+          RSpec.world.reporter.example_step_passed(self, :then, message, options)
+        else
+          RSpec.world.reporter.example_step_pending(self, :then, message, options)
+        end
       end
+
     end
   end
 end

data/lib/rspec/example_steps/reporter.rb

@@ -1,20 +1,20 @@
 module RSpec
   module ExampleSteps
     module Reporter
-      def example_step_started(example, type, message)
-        notify :example_step_started, example, type, message
+      def example_step_started(example, type, message, options)
+        notify :example_step_started, example, type, message, options
       end
 
-      def example_step_passed(example, type, message)
-        notify :example_step_passed, example, type, message
+      def example_step_passed(example, type, message, options)
+        notify :example_step_passed, example, type, message, options
       end
 
-      def example_step_pending(example, type, message)
-        notify :example_step_pending, example, type, message
+      def example_step_pending(example, type, message, options)
+        notify :example_step_pending, example, type, message, options
       end
 
-      def example_step_failed(example, type, message)
-        notify :example_step_failed, example, type, message
+      def example_step_failed(example, type, message, options)
+        notify :example_step_failed, example, type, message, options
       end
     end
   end

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     = "0.1.0"
+  s.version     = "0.1.1"
   s.authors     = ["Andriy Yanko"]
   s.email       = ["andriy.yanko@gmail.com"]
   s.homepage    = "https://github.com/railsware/rspec-example_steps"

data/spec/example_steps_spec.rb

@@ -23,4 +23,53 @@ describe "example steps" do
     end
   end
 
+
+  describe "Steps without blocks" do
+    Steps "they should be pending" do
+      Given "given step without block"
+      Then "then step without block"
+      When "when step without block"
+    end
+  end
+
+  describe "Steps with :pending option" do
+    Steps "they should be pending when :pending => true" do
+      Given "given step with :pending option", :pending => true do
+        raise "Should not be evaluated"
+      end
+
+      When "when step with :pending option", :pending => true do
+        raise "Should not be evaluated"
+      end
+
+      Then "then step with :pending option", :pending => true do
+        raise "Should not be evaluated"
+      end
+    end
+
+    Steps "they should be pending when :pending => STRING" do
+      Given "given step with :pending option", :pending => "WIP" do
+        raise "Should not be evaluated"
+      end
+
+      When "when step with :pending option", :pending => "POSTPONED" do
+        raise "Should not be evaluated"
+      end
+
+      Then "then step with :pending option", :pending => "DELAYED" do
+        raise "Should not be evaluated"
+      end
+    end
+
+    Steps "they should NOT be pending when :pending => false" do
+      Given "given step with :pending option", :pending => false do
+      end
+
+      When "when step with :pending option", :pending => false do
+      end
+
+      Then "then step with :pending option", :pending => false do
+      end
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-example_steps
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andriy Yanko