scenario 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tyson Tate
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,117 @@
+Scenario
+========
+
+Scenario brings basic "scenarios" to RSpec. You can define scenarios with a
+block or by passing in a Module (or even both).
+
+Block:
+
+    describe_scenario :admin do |scenario|
+      define :setup_user do |name|
+        User.create( :name => name, :admin => true )
+      end
+    end
+    
+    describe "Admin pages" do
+      scenario :admin
+      
+      ...
+    end
+
+Module:
+
+    module AdminMethods
+      def setup_user( name )
+        User.create( :name => name, :admin => true )
+      end
+    end
+    
+    describe_scenario :admin, AdminMethods
+    
+    describe "Admin pages" do
+      scenario :admin
+      
+      ...
+    end
+
+Both:
+
+    module AdminMethods
+      def setup_user( name )
+        User.create( :name => name, :admin => true )
+      end
+    end
+    
+    describe_scenario :admin, AdminMethods do
+      define :admin?( user )
+        user.admin == true
+      end
+    end
+    
+    describe "Admin pages" do
+      scenario :admin
+      
+      ...
+    end
+
+Because scenarios are just Modules, you can use as many as you want:
+
+    describe "Admin pages" do
+      scenario :users
+      scenario :admin
+      
+      ...
+    end
+
+And you can nest them:
+
+    describe "Login" do
+      scenario :login
+      
+      describe "as an admin" do
+        scenario :admin
+        
+        ...
+      end
+      
+      describe "as a regular user" do
+        scenario :user
+        
+        ...
+      end
+    end
+
+Fixtures
+--------
+
+Basic fixture support is also included. (Please note that fixtures are currently 
+hard-coded to `spec/scenarios/fixtures`. It will be configurable in a future
+version. Feel free to open a pull request or just monkey patch the `root()`
+method.
+
+    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 
+to be read once.
+
+Contributing to Scenario
+========================
+ 
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it 
+  and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a 
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to 
+  have your own version, or is otherwise necessary, that is fine, but please 
+  isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+=========
+
+Copyright (c) 2011 Tyson Tate. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "scenario"
+  gem.homepage = "http://github.com/tysontate/scenario"
+  gem.license = "MIT"
+  gem.summary = %Q{Basic spec scenarios for RSpec.}
+  gem.description = %Q{Basic spec scenarios for RSpec. Also includes basic fixtures support.}
+  gem.email = "tyson@tysontate.com"
+  gem.authors = ["Tyson Tate"]
+  gem.add_development_dependency "rspec", "~> 2.3.0"
+  gem.add_development_dependency "yard", "~> 0.6.0"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/scenario.rb

@@ -0,0 +1,5 @@
+$: << File.expand_path( File.dirname( __FILE__ ) )
+
+require 'scenario/fixtures'
+require 'scenario/scenario'
+require 'scenario/rspec'

data/lib/scenario/fixtures.rb

@@ -0,0 +1,27 @@
+module Scenario
+  
+  # Easy access to fixture files (HTML, CSS, JSON, etc.)
+  class Fixtures
+    
+    def self.[]( rel_path )
+      @content_cache ||= {}
+      
+      unless @content_cache.key?( rel_path )
+        path = "#{self.root}/#{rel_path}"
+        raise "#{path} doesn't exist or is not a file." unless File.file?( path )
+        @content_cache[rel_path] = File.open( path, 'r' ).read
+      end
+      
+      @content_cache[rel_path]
+    end
+    
+    protected
+    
+    def self.root
+      # TODO: Use spec root (?)
+      "#{Dir.pwd}/spec/scenarios/fixtures"
+    end
+    
+  end
+  
+end

data/lib/scenario/rspec.rb

@@ -0,0 +1,45 @@
+# ===================
+# = RSpec additions =
+# ===================
+
+module Scenario
+  
+  private
+  
+  module RSpecExtensions
+    
+    # ExampleGroup methods
+    module ExampleGroupExtensions
+      
+      # Tell Scenario which scenario you want to use
+      def scenario( name, &block )
+        modul = Scenario::Scenarios.for( name )
+        modul.module_exec( &block ) if block_given?
+        self.send( :include, modul )
+      end
+      
+    end
+    RSpec::Core::ExampleGroup.send :extend, Scenario::RSpecExtensions::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 )
+      end
+      
+    end
+    Object.send :include, Scenario::RSpecExtensions::ObjectExtensions
+    
+  end
+  
+end

data/lib/scenario/scenario.rb

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

data/spec/fixtures_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Scenario::Fixtures do
+  it "provides text" do
+    Scenario::Fixtures["basic.text"].should =~ /squeeze/
+  end
+end

data/spec/scenario_spec.rb

@@ -0,0 +1,91 @@
+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
+  
+  it "should have scenario methods" do
+    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
+
+describe "Example with multiple scenarios" do
+  scenario :scenario_one
+  scenario :scenario_two
+  
+  it "should have scenario methods" do
+    one.should == "present"
+    two.should == "also present"
+    zero_cool?.should be_true
+  end
+end
+
+describe "Nested Examples" do
+  scenario :scenario_one
+  
+  it "has scenario methods, but not those of descendant examples" do
+    one.should == "present"
+    lambda { two }.should raise_error
+    zero_cool?.should be_false
+  end
+  
+  describe "(one deeper)" do
+    scenario :scenario_two
+    
+    it "has scenario (local and parent example) methods" do
+      one.should == "present"
+      two.should == "also present"
+      zero_cool?.should be_true
+    end
+  end
+  
+  describe "(one deeper, without extra scenario)" do
+    it "has parent scenario methods" do
+      one.should == "present"
+      lambda { two }.should raise_error
+      zero_cool?.should be_false
+    end
+  end
+end
+

data/spec/scenarios/fixtures/basic.text

@@ -0,0 +1,4 @@
+There comes a time in every man's life
+When he's got to handle shit up on his own
+Can't depend on friends to help you in a squeeze
+Believe me they got problems of they own

data/spec/scenarios/test_scenarios.rb

@@ -0,0 +1,51 @@
+describe_scenario :block_defined do
+  define :lol do
+    "lol"
+  end
+  
+  define :zomg do
+    @zomg = 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"
+  end
+end
+
+describe_scenario :scenario_one do
+  define :one do
+    "present"
+  end
+  
+  define "zero_cool?" do
+    false
+  end
+end
+
+describe_scenario :scenario_two do
+  define :two do
+    "also present"
+  end
+  
+  define "zero_cool?" do
+    true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift( File.join( File.dirname( __FILE__ ), '..', 'lib' ) )
+
+require 'rspec'
+require 'scenario'

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification 
+name: scenario
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tyson Tate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: yard
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: yard
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
+description: Basic spec scenarios for RSpec. Also includes basic fixtures support.
+email: tyson@tysontate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/scenario.rb
+- lib/scenario/fixtures.rb
+- lib/scenario/rspec.rb
+- lib/scenario/scenario.rb
+- spec/fixtures_spec.rb
+- spec/scenario_spec.rb
+- spec/scenarios/fixtures/basic.text
+- spec/scenarios/test_scenarios.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tysontate/scenario
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Basic spec scenarios for RSpec.
+test_files: 
+- spec/fixtures_spec.rb
+- spec/scenario_spec.rb
+- spec/scenarios/test_scenarios.rb
+- spec/spec_helper.rb