scenario 0.2.0 → 0.3.0

data/README.markdown

@@ -1,92 +1,97 @@
 Scenario
 ========
 
-Scenario brings basic "scenarios" to RSpec. You can define scenarios with a
-block or by passing in a Module (or even both).
+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.
 
-Block:
+Examples
+--------
 
 ```ruby
-describe_scenario :admin do
-  define :setup_user do |name|
-    User.create( :name => name, :admin => true )
-  end
-end
+# Describe your scenarios:
 
-describe "Admin pages" do
-  scenario :admin
+describe_scenario :user do
+  before :all do
+    @user = User.create( :name => "Bob", :password => "foo", :admin => false )
+  end
   
-  ...
-end
-```
-
-Module:
-
-```ruby
-module AdminMethods
-  def setup_user( name )
-    User.create( :name => name, :admin => true )
+  def login
+    visit( url( :login ) )
+    fill_in :name, :with => "Bob"
+    fill_in :password, :with => "foo"
+    click_button "Login"
+    response
   end
 end
 
-describe_scenario :admin, AdminMethods
-
-describe "Admin pages" do
-  scenario :admin
+describe_scenario :admin do
+  before :all do
+    @user = User.create( :name => "Sally", :password => "bar", :admin => true )
+  end
   
-  ...
-end
-```
-
-Both:
-
-```ruby
-module AdminMethods
-  def setup_user( name )
-    User.create( :name => name, :admin => true )
+  def login
+    visit( url( :login ) )
+    fill_in :name, :with => "Sally"
+    fill_in :password, :with => "bar"
+    click_button "Login"
+    response
   end
 end
 
-describe_scenario :admin, AdminMethods do
-  define :admin?( user )
-    user.admin == true
-  end
-end
+# Write your specs:
 
-describe "Admin pages" do
-  scenario :admin
+describe "Logging in" do
+  describe "as an user" do
+    scenario :user
+    
+    it "should log them in" do
+      login.should be_successful
+    end
+  end
   
-  ...
+  describe "as an admin" do
+    scenario :admin
+    
+    it "should log them in" do
+      login.should be_successful
+    end
+  end
 end
 ```
 
-Because scenarios are just Modules, you can use as many as you want:
+Because scenarios are simply blocks that are run in the context where they are included, you can use as many as you want:
 
 ```ruby
-describe "Admin pages" do
-  scenario :users
-  scenario :admin
+describe "GET /message/new when database is down" do
+  scenario :user
+  scenario :database_down
   
-  ...
+  it "should show fail whale" do
+    visit( "/message/new" )
+    response.should contain( "fail whale" )
+  end
 end
 ```
 
 And you can nest them:
 
 ```ruby
-describe "Login" do
-  scenario :login
+describe "GET /message/new" do
+  scenario :user
   
-  describe "as an admin" do
-    scenario :admin
-    
-    ...
+  describe "when database is up" do
+    it "should not show fail whale" do
+      visit( "/message/new" )
+      response.should_not contain( "fail whale" )
+    end
   end
   
-  describe "as a regular user" do
-    scenario :user
+  describe "when database is down" do
+    scenario :database_down
     
-    ...
+    it "should show fail whale" do
+      visit( "/message/new" )
+      response.should contain( "fail whale" )
+    end
   end
 end
 ```
@@ -100,8 +105,7 @@ version. Feel free to open a pull request or just monkey patch the `root()`
 method.
 
 ```ruby
-Scenario::Fixtures['html/sample.html'] # Returns contents of the fixture as
-                                       # a string
+Scenario::Fixtures['html/sample.html'] # Returns contents of the fixture as a string
 ```
 
 `Scenario::Fixtures` caches the contents of the file so that the file only needs 
@@ -110,8 +114,10 @@ to be read once.
 Version History
 ===============
 
-0.2.0 - Add support for RSpec 1.3+
-0.1.0 - Initial release with support for RSpec 2.x
+* 0.3.0 - Remove support for module-based scenarios, allow calling RSpec hooks
+  in scenarios.
+* 0.2.0 - Add support for RSpec 1.3+
+* 0.1.0 - Initial release with support for RSpec 2.x
 
 Contributing to Scenario
 ========================

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/scenario/rspec.rb

@@ -7,9 +7,11 @@ module Scenario
   private
   
   begin
-    RSpecExampleGroup = RSpec::Core::ExampleGroup
+    # 2.x
+    ExampleGroup = RSpec::Core::ExampleGroup
   rescue NameError
-    RSpecExampleGroup = Spec::Example::ExampleGroup
+    # 1.x
+    ExampleGroup = Spec::Example::ExampleGroup
   end
   
   module RSpecExtensions
@@ -17,34 +19,26 @@ module Scenario
     # ExampleGroup methods
     module ExampleGroupExtensions
       
-      # Tell Scenario which scenario you want to use
+      # Load a given scenario
       def scenario( name, &block )
-        modul = Scenario::Scenarios.for( name )
-        modul.module_exec( &block ) if block_given?
-        self.send( :include, modul )
+        @_scenario_context = name.to_sym
+        scenario = Scenario::Scenarios.for( name )
+        self.module_eval( &scenario )
       end
       
     end
-    RSpecExampleGroup.send :extend, Scenario::RSpecExtensions::ExampleGroupExtensions
+    ExampleGroup.send :extend, ExampleGroupExtensions
     
     # Global methods.
     module ObjectExtensions
       
-      # Set up a new scenario and add to the collection of scenarios.
-      def describe_scenario( name, base=nil, &block )
-        modul = base ? base.dup : Module.new
-        modul.module_exec( &block ) if block_given?
-        Scenario::Scenarios.register( name, modul )
-      end
-      
-      # Syntax sugar for defining a scenario method inside a `describe_scenario`
-      # block.
-      def define( method_name, &block )
-        self.send( :define_method, method_name, &block )
+      def describe_scenario( name, &block )
+        raise "Scenario #{name} has already been defined." if Scenario::Scenarios.for( name )
+        Scenario::Scenarios.add( name, block )
       end
       
     end
-    Object.send :include, Scenario::RSpecExtensions::ObjectExtensions
+    Object.send :include, ObjectExtensions
     
   end
   

data/lib/scenario/scenario.rb

@@ -4,15 +4,17 @@ module Scenario
   
   class Scenarios
     
+    @@scenarios = {}
+    
     # Add a new scenario.
-    def self.register( name, modul )
-      @@scenarios ||= {}
-      @@scenarios[name.to_sym] = modul
+    def self.add( name, block )
+      @@scenarios[name.to_sym] = block
     end
     
-    # Get the scenario module for the given name.
+    # Get the scenario block for the given name.
     def self.for( name )
-      @@scenarios[name.to_sym] || ( raise "No scenario named #{name.inspect}." )
+      name = name.to_sym
+      @@scenarios[name]
     end
     
   end

data/scenario.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{scenario}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tyson Tate"]
-  s.date = %q{2011-05-20}
+  s.date = %q{2011-05-21}
   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/scenario_spec.rb

@@ -1,52 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require "scenarios/test_scenarios"
 
-describe "Example with no scenario" do
-  it "shouldn't have any scenario methods" do
-    lambda { lol }.should raise_error
-    lambda { zomg }.should raise_error
-    lambda { rad_params }.should raise_error
-  end
-end
-
-describe "Example with block-defined scenario" do
-  scenario :block_defined
+describe "Example with one scenario" do
+  scenario :simple
   
-  it "should have scenario methods" do
+  it "should have a scenario" do
+    @zomg_all.should( be_true )
+    @zomg_each.should( be_true )
     lol.should == "lol"
-    zomg && @zomg.should( be_true )
-    rad_params( "super" ).should == "This is super rad!"
-  end
-end
-
-describe "Example with block-defined scenario in before hook" do
-  scenario :block_defined
-  
-  before :each do
-    lol.should == "lol"
-    zomg && @zomg.should( be_true )
-    rad_params( "super" ).should == "This is super rad!"
-  end
-  
-  it "should have scenario methods" do
-    @zomg.should be_true
-  end
-end
-
-describe "Example with module-defined scenario" do
-  scenario :module_defined
-  
-  it "should have scenario methods" do
-    lol.should == "for reals"
-  end
-end
-
-describe "Example with mixed-defined scenario" do
-  scenario :mixed_defined
-  
-  it "should have scenario methods" do
-    lol.should == "overridden"
-    omg.should == "added"
   end
 end
 
@@ -54,7 +15,7 @@ describe "Example with multiple scenarios" do
   scenario :scenario_one
   scenario :scenario_two
   
-  it "should have scenario methods" do
+  it "should have both scenarios" do
     one.should == "present"
     two.should == "also present"
     zero_cool?.should be_true
@@ -89,3 +50,8 @@ describe "Nested Examples" do
   end
 end
 
+describe "Example with no scenario" do
+  it "shouldn't have any scenario methods" do
+    lambda { lol }.should raise_error
+  end
+end

data/spec/scenarios/test_scenarios.rb

@@ -1,51 +1,33 @@
-describe_scenario :block_defined do
-  define :lol do
-    "lol"
+describe_scenario :simple do
+  before :each do
+    @zomg_each = true
   end
   
-  define :zomg do
-    @zomg = true
+  before :all do
+    @zomg_all = true
   end
   
-  define :rad_params do |how_rad|
-    "This is #{how_rad} rad!"
-  end
-end
-
-module ModuleDefined
-  def lol
-    "for reals"
-  end
-end
-
-describe_scenario :module_defined, ModuleDefined
-
-describe_scenario :mixed_defined, ModuleDefined do
   def lol
-    "overridden"
-  end
-  
-  def omg
-    "added"
+    "lol"
   end
 end
 
 describe_scenario :scenario_one do
-  define :one do
+  def one
     "present"
   end
   
-  define "zero_cool?" do
+  def zero_cool?
     false
   end
 end
 
 describe_scenario :scenario_two do
-  define :two do
+  def two
     "also present"
   end
   
-  define "zero_cool?" do
+  def zero_cool?
     true
   end
 end

metadata

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