rspec-example_steps 0.0.2 → 0.1.0

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem 'rspec', '2.7.0'

data/README.md

@@ -32,7 +32,85 @@ Given/When/Then steps for RSpec examples
         When I search something
         Then I should see result
 
-## References
+
+### Shared steps
+
+Use _shared_steps_ do define block that will be evaluated in the context of example using _include_steps_.
+
+Shared _steps_ behavior is simular to shared _example_ but context is example nor example_group.
+
+### Example with shared steps
+
+    shared_steps "login" do
+      When "I go to login page" do
+        page.visit '/login'
+      end
+      When "I put credentials" do
+        page.fill_in 'Login', :with => 'jack@example.com'
+        page.fill_in 'Password', :with => 'password''
+      end
+      Then "I should be logged in" do
+        page.status_code.should == 200
+        page.should have_content("Welcome jack@example.com")
+      end
+    end
+
+    shared_steps "logout" do
+      page.visit '/logout'
+      page.status_code.should == 200
+    end
+
+    context "user flow"
+      Steps "User updates profile description" do
+        include_steps "login"
+        When "I update profile description" do
+          ...
+        end
+        include_steps "logout"
+      end
+
+      Steps "User updates profile avatar" do
+        include_steps "login"
+        When "I update profile avatar" do
+          ...
+        end
+        include_steps "logout"
+      end
+    end
+
+### Passing arguments to shared steps
+
+It's possible to customize shared steps. See example
+
+### Example with shared steps with arguments
+
+    shared_steps "login" do |email, password|
+      When "I go to login page" do
+        page.visit '/login'
+      end
+      When "I put credentials" do
+        page.fill_in 'Login', :with => email
+        page.fill_in 'Password', :with => password
+      end
+    end
+
+    shared_steps "invalid login" do
+      Then "I should see login error" do
+      ...
+      end
+    end
+
+    Steps "User provides wrong email" do
+      include_steps "login", 'jack', 'qwerty'
+      include_steps "invalid login"
+    end
+
+    Steps "User provides wrong password" do
+      include_steps "login", 'jack@example.com', 'bla'
+      include_steps "invalid login"
+    end
+
+## Alternatives
 
 * [rspec-steps](https://github.com/LRDesign/rspec-steps)
 * [rspec-given](https://github.com/jimweirich/rspec-given)

data/lib/rspec/example_steps/example_group.rb

@@ -1,22 +1,29 @@
 module RSpec
   module ExampleSteps
     module ExampleGroup
+      def include_steps(*args)
+        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)
+      end
+
       def Given(message)
-        ::RSpec.configuration.reporter.example_step_started(self, :given, message)
+        RSpec.world.reporter.example_step_started(self, :given, message)
         yield
-        ::RSpec.configuration.reporter.example_step_passed(self, :given, message)
+        RSpec.world.reporter.example_step_passed(self, :given, message)
       end
 
       def When(message)
-        ::RSpec.configuration.reporter.example_step_started(self, :when, message)
+        RSpec.world.reporter.example_step_started(self, :when, message)
         yield
-        ::RSpec.configuration.reporter.example_step_passed(self, :when, message)
+        RSpec.world.reporter.example_step_passed(self, :when, message)
       end
 
       def Then(message)
-        ::RSpec.configuration.reporter.example_step_started(self, :then, message)
+        RSpec.world.reporter.example_step_started(self, :then, message)
         yield
-        ::RSpec.configuration.reporter.example_step_passed(self, :then, message)
+        RSpec.world.reporter.example_step_passed(self, :then, message)
       end
     end
   end

data/lib/rspec/example_steps/shared_steps.rb

@@ -0,0 +1,20 @@
+module RSpec
+  module ExampleSteps
+    module SharedSteps
+
+      def shared_steps(name, &block)
+        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)
+        if RSpec.world.shared_example_steps.has_key?(name)
+          raise ArgumentError.new("Shared example steps '#{name}' already exists")
+        end
+      end
+
+    end
+  end
+end

data/lib/rspec/example_steps/world.rb

@@ -0,0 +1,9 @@
+module RSpec
+  module ExampleSteps
+    module World
+      def shared_example_steps
+        @shared_example_steps ||= {}
+      end
+    end
+  end
+end

data/lib/rspec/example_steps.rb

@@ -2,15 +2,21 @@ require 'rspec/core/formatters/base_formatter'
 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/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
 
 RSpec::Core::ExampleGroup.define_example_method :Steps, :with_steps => true
+
+require 'rspec/example_steps/shared_steps'
+include RSpec::ExampleSteps::SharedSteps

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.0.2"
+  s.version     = "0.1.0"
   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

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe "example steps" do
+
+  describe "Given/When/Then" do
+
+    Steps "should execute blocks" do
+      Given "thing" do
+        @thing = "Given value"
+      end
+
+      When "action" do
+        @action = "When value"
+      end
+
+      Then "result" do
+        @result = "Then value"
+      end
+
+      @thing.should  == "Given value"
+      @action.should == "When value"
+      @result.should == "Then value"
+    end
+  end
+
+end

data/spec/shared_steps_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+shared_steps "push steps" do
+  Given "empty pipe" do
+    pipe.clear
+  end
+
+  When "push data" do
+    pipe.push "hello"
+  end
+
+  Then "pipe should have data" do
+    pipe.items.should == ["hello"]
+  end
+end
+
+shared_steps "push with arguments steps" do |value|
+  When "push data" do
+    pipe.push value
+  end
+end
+
+shared_steps "pull steps" do
+  When "pull data" do
+    pipe.pull
+  end
+
+  Then "pipe should be empty" do
+    pipe.items.should == []
+  end
+end
+
+describe "shared steps" do
+
+  let(:pipe) do
+    Class.new do
+      def initialize
+        @values = []
+      end
+
+      def items
+        @values
+      end
+
+      def clear
+        @values = []
+      end
+
+      def push(value)
+        @values << value
+      end
+
+      def pull
+        @values.shift
+      end
+
+    end.new
+  end
+
+  Steps "push and pull steps" do
+    include_steps "push steps"
+    include_steps "pull steps"
+  end
+
+  Steps "push, count and pull" do
+    include_steps "push steps"
+    Then "pipe should have 1 item" do
+      pipe.items.size.should == 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"]
+    include_steps "pull steps"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec/example_steps'

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Andriy Yanko
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-29 00:00:00 +02:00
+date: 2011-12-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,12 @@ files:
 - lib/rspec/example_steps/documentation_formatter.rb
 - lib/rspec/example_steps/example_group.rb
 - lib/rspec/example_steps/reporter.rb
+- lib/rspec/example_steps/shared_steps.rb
+- lib/rspec/example_steps/world.rb
 - rspec-example_steps.gemspec
+- spec/example_steps_spec.rb
+- spec/shared_steps_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/railsware/rspec-example_steps
 licenses: []
@@ -88,5 +93,7 @@ rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Given/When/Then steps for RSpec examples
-test_files: []
-
+test_files: 
+- spec/example_steps_spec.rb
+- spec/shared_steps_spec.rb
+- spec/spec_helper.rb