scenario 0.3.0 → 0.3.1

data/README.markdown

@@ -3,6 +3,8 @@ Scenario
 
 Scenarios is a super-simple way to move common setup and helper methods into cohesive "scenarios" that can be included easily in your specs. The advantage of a scenario over regular mixin modules is that you can use RSpec hooks (eg. `before :each {}`) to do the setup instead of having redundant, copy-pasted setup littering your specs.
 
+Scenario also includes a basic DSL for performing setup atomically. That is, instead of doing expensive setup in a `before :all` block that is always run, you can run only the setup that you need in a given `describe` with the Scenario DSL.
+
 Examples
 --------
 
@@ -96,6 +98,77 @@ describe "GET /message/new" do
 end
 ```
 
+Setup
+-----
+
+Setup is executed `before :all`.
+
+```ruby
+describe_scenario :user do
+  setup_for :user do |name, password|
+    name ||= "Bob"
+    password ||= "foo"
+    @user = User.create( :name => name, :password => password )
+  end
+  
+  setup_for :admin do |name, password|
+    name ||= "Sally"
+    password ||= "bar"
+    @user = User.create( :name => name, :password => password, :admin => true )
+  end
+  
+  def login
+    visit( url( :login ) )
+    fill_in :name, :with => "Bob"
+    fill_in :password, :with => "foo"
+    click_button "Login"
+    response
+  end
+end
+
+# Pass a hash:
+
+describe "One user" do
+  scenario :user, :setup => :user
+  
+  it "has one user" do
+    User.count.should == 1
+  end
+end
+
+describe "Two users" do
+  scenario :user, :setup => [:user, :admin]
+  
+  it "has two users" do
+    User.count.should == 2
+  end
+end
+
+# Or pass a block:
+
+describe "One user" do
+  scenario :user do
+    setup_user( "Sam" )
+  end
+  
+  it "has one user" do
+    User.count.should == 1
+  end
+end
+
+# Or both!
+
+describe "Two users" do
+  scenario :user, :setup => :user do
+    setup_admin( "Steph" )
+  end
+  
+  it "has two users" do
+    User.count.should == 2
+  end
+end
+```
+
 Fixtures
 --------
 
@@ -114,6 +187,7 @@ to be read once.
 Version History
 ===============
 
+* 0.3.1 - Add "setup" syntax.
 * 0.3.0 - Remove support for module-based scenarios, allow calling RSpec hooks
   in scenarios.
 * 0.2.0 - Add support for RSpec 1.3+

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/scenario/rspec.rb

@@ -20,10 +20,26 @@ module Scenario
     module ExampleGroupExtensions
       
       # Load a given scenario
-      def scenario( name, &block )
+      def scenario( name, opts={}, &block )
         @_scenario_context = name.to_sym
         scenario = Scenario::Scenarios.for( name )
+        
+        # Load scenario
         self.module_eval( &scenario )
+        
+        # Set up
+        Array( opts[:setup] ).each do |subject|
+          self.module_eval do
+            before :all do
+              self.send "setup_#{subject}"
+            end
+          end
+        end
+        self.module_eval { before( :all, &block ) } if block_given?
+      end
+      
+      def setup_for( name, &block )
+        self.send( :define_method, "setup_#{name}", block )
       end
       
     end

data/scenario.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{scenario}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tyson Tate"]
-  s.date = %q{2011-05-21}
+  s.date = %q{2011-05-23}
   s.description = %q{Basic spec scenarios for RSpec. Also includes basic fixtures support.}
   s.email = %q{tyson@tysontate.com}
   s.extra_rdoc_files = [

data/spec/fixtures_spec.rb

@@ -4,4 +4,8 @@ describe Scenario::Fixtures do
   it "provides text" do
     Scenario::Fixtures["basic.text"].should =~ /squeeze/
   end
+  
+  it "bombs out on non-existant files" do
+    lambda { Scenario::Fixtures["lol.text"] }.should raise_error( RuntimeError )
+  end
 end

data/spec/scenario_spec.rb

@@ -1,57 +1,170 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require "scenarios/test_scenarios"
 
-describe "Example with one scenario" do
+# =========
+# = Basic =
+# =========
+
+describe "describe with one scenario" do
   scenario :simple
   
   it "should have a scenario" do
-    @zomg_all.should( be_true )
-    @zomg_each.should( be_true )
-    lol.should == "lol"
+    @scenario_all.should( be_true )
+    @scenario_each.should( be_true )
+    let_block.should == 1
+    scenario_method.should == "present"
   end
 end
 
-describe "Example with multiple scenarios" do
+describe "describe with multiple scenarios" do
   scenario :scenario_one
   scenario :scenario_two
   
   it "should have both scenarios" do
     one.should == "present"
     two.should == "also present"
-    zero_cool?.should be_true
+    scenario_method?.should be_true
+  end
+end
+
+describe "describe without a scenario" do
+  it "shouldn't have a scenario" do
+    @scenario_all.should be_nil
+    @scenario_each.should be_nil
+    lambda { lol }.should raise_error
   end
 end
 
-describe "Nested Examples" do
+# ===========
+# = Nesting =
+# ===========
+
+describe "Nested describes" do
   scenario :scenario_one
   
-  it "has scenario methods, but not those of descendant examples" do
+  it "don't leak nested scenarios to the parent describe" do
     one.should == "present"
     lambda { two }.should raise_error
-    zero_cool?.should be_false
+    scenario_method?.should be_false
+    @scenario_one_present.should be_true
+    @scenario_two_present.should be_nil
+  end
+  
+  describe "in nested describe with an added scenario" do
+    scenario :scenario_two
+    
+    it "has all scenarios" do
+      one.should == "present"
+      two.should == "also present"
+      scenario_method?.should be_true
+      @scenario_one_present.should be_true
+      @scenario_two_present.should be_true
+    end
   end
   
-  describe "(one deeper)" do
+  context "in nested context with an added scenario" do
     scenario :scenario_two
     
-    it "has scenario (local and parent example) methods" do
+    it "has all scenarios" do
       one.should == "present"
       two.should == "also present"
-      zero_cool?.should be_true
+      scenario_method?.should be_true
+      @scenario_one_present.should be_true
+      @scenario_two_present.should be_true
     end
   end
   
-  describe "(one deeper, without extra scenario)" do
-    it "has parent scenario methods" do
+  describe "in nested example without an additional scenario" do
+    it "has parent scenario" do
       one.should == "present"
       lambda { two }.should raise_error
-      zero_cool?.should be_false
+      scenario_method?.should be_false
+      @scenario_one_present.should be_true
+      @scenario_two_present.should be_nil
     end
   end
 end
 
-describe "Example with no scenario" do
-  it "shouldn't have any scenario methods" do
-    lambda { lol }.should raise_error
+# ==========
+# = Shared =
+# ==========
+
+shared_examples_for "without scenario in the shared group" do
+  it "should inherit scenario" do
+    @scenario_all.should( be_true )
+    @scenario_each.should( be_true )
+    let_block.should == 1
+    scenario_method.should == "present"
+  end
+end
+
+shared_examples_for "with scenario in the shared group" do
+  scenario :simple
+  
+  it "should have a scenario" do
+    @scenario_all.should( be_true )
+    @scenario_each.should( be_true )
+    let_block.should == 1
+    scenario_method.should == "present"
+  end
+end
+
+describe "Shared example groups" do
+  context "without scenario in shared group" do
+    scenario :simple
+    it_should_behave_like "without scenario in the shared group"
+  end
+  
+  context "with scenario in shared group" do
+    it_should_behave_like "with scenario in the shared group"
+    
+    it "shouldn't leak" do
+      @scenario_all.should be_nil
+      @scenario_each.should be_nil
+      lambda { scenario_method }.should raise_error
+    end
+  end
+end
+
+# ==================
+# = Scenario setup =
+# ==================
+
+describe "scenario with setup methods" do
+  describe "without calling setup" do
+    scenario :setup_scenario
+    
+    it "shouldn't do any setup" do
+      thing1.should be_nil
+    end
+  end
+  
+  describe "calling setup via opts hash" do
+    scenario :setup_scenario, :setup => :thing1
+    
+    it "sets up" do
+      thing1.should == "set up"
+    end
+  end
+  
+  describe "calling setup via block" do
+    scenario :setup_scenario do
+      setup_thing2( "a", "b" )
+    end
+    
+    it "sets up" do
+      thing2.should == ["a", "b"]
+    end
+  end
+  
+  describe "calling setup via opts hash and block" do
+    scenario :setup_scenario, :setup => [:thing1] do
+      setup_thing2( "a", "b" )
+    end
+    
+    it "works" do
+      thing1.should == "set up"
+      thing2.should == ["a", "b"]
+    end
   end
 end

data/spec/scenarios/test_scenarios.rb

@@ -1,33 +1,65 @@
 describe_scenario :simple do
+  before :all do
+    @scenario_all = true
+  end
+  
   before :each do
-    @zomg_each = true
+    @scenario_each = true
   end
   
-  before :all do
-    @zomg_all = true
+  let :let_block do
+    @let_block ||= 0
+    @let_block += 1
   end
   
-  def lol
-    "lol"
+  def scenario_method
+    "present"
   end
 end
 
 describe_scenario :scenario_one do
+  before :each do
+    @scenario_one_present = true
+  end
+  
   def one
     "present"
   end
   
-  def zero_cool?
+  def scenario_method?
     false
   end
 end
 
 describe_scenario :scenario_two do
+  before :each do
+    @scenario_two_present = true
+  end
+  
   def two
     "also present"
   end
   
-  def zero_cool?
+  def scenario_method?
     true
   end
 end
+
+describe_scenario :setup_scenario do
+  
+  setup_for :thing1 do
+    @thing1 = "set up"
+  end
+  
+  setup_for :thing2 do |*params|
+    @thing2 = params
+  end
+  
+  def thing1
+    @thing1
+  end
+  
+  def thing2
+    @thing2
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scenario
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Tyson Tate
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-21 00:00:00 -07:00
+date: 2011-05-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency