scenarios 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Starr Horne
+
+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.rdoc

@@ -0,0 +1,17 @@
+= scenarios
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Starr Horne. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "scenarios"
+    gem.summary = %Q{Manage scenarios for testing}
+    gem.description = %Q{Factories on steroids.}
+    gem.email = "starr@chromahq.com"
+    gem.homepage = "http://github.com/starrhorne/scenarios"
+    gem.authors = ["Starr Horne"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scenarios #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/scenarios.rb

@@ -0,0 +1,45 @@
+module Scenarios
+
+  #
+  # Register a Scenario instance with the module.
+  # Scenarios are stored inside of scenario groups.
+  # 
+  # When multple scenarios are registerd in a single
+  # group, it looks like this:
+  #
+  #   { :user_scenarios => { :no_users => [Scenario], :admin_users => [Scenario] }}
+  #
+  # @param [String, Symbol] group_name 
+  # @param [Scenarios::Scenario] obj 
+  #
+  def self.register(group_name, obj)
+    ( store[group_name.to_sym] ||= {} )[obj.name.to_sym] = obj
+  end
+
+  #
+  # @return [Hash] the hash of scenario groups
+  #
+  def self.store
+    @store ||= {}
+  end
+
+  #
+  # @param [String, Symbol] k the name of the scenario group to get
+  # @return [Hash] a particular scenario group
+  #
+  def self.[](k)
+    self.store[k.to_sym]
+  end
+
+  #
+  # Remove all scenario groups
+  #
+  def self.clear
+    @store = {}
+  end
+
+end
+
+require 'scenarios/proc_extensions.rb'
+require 'scenarios/scenario.rb'
+require 'scenarios/base.rb'

data/lib/scenarios/base.rb

@@ -0,0 +1,36 @@
+module Scenarios
+
+  #
+  # The base class is the one you'll subclass in order 
+  # to create a "scenario group"
+  #
+  class Base
+
+    class << self
+
+      #
+      # Define the name for this scenario group
+      # 
+      # @param [String, Symbol] group_name
+      #
+      def name(group_name)
+        @group_name = group_name
+      end
+
+      #
+      # Create a new instance of `Scenario` and register it.
+      # 
+      # @param [String, Symbol] name The scenario's name
+      # @param [Proc] block A block to be executed within the new scenario's scope
+      # @return [Scenairos::Scenario] the new scenario
+      #
+      def scenario(name, &block)
+        raise "You must call `name` before you can call `scenario`" unless @group_name
+
+        obj = Scenario.new(name, &block)
+        Scenarios.register(@group_name.to_sym, obj)
+        obj
+      end
+    end
+  end
+end

data/lib/scenarios/proc_extensions.rb

@@ -0,0 +1,14 @@
+# Stolen straight from ActiveSupport
+
+class Proc #:nodoc:
+  def bind(object)
+    block, time = self, Time.now
+    (class << object; self end).class_eval do
+      method_name = "__bind_#{time.to_i}_#{time.usec}"
+      define_method(method_name, &block)
+      method = instance_method(method_name)
+      remove_method(method_name)
+      method
+    end.bind(object)
+  end
+end

data/lib/scenarios/scenario.rb

@@ -0,0 +1,72 @@
+module Scenarios
+
+  class Scenario
+
+    attr_reader :name, :definitions
+
+    #
+    # Initialize the new instance using the block
+    #
+    # @param [String, Symbol] name
+    # @param [Proc] block
+    #
+    def initialize(name, &block)
+      @name = name
+      @definitions = {}
+      block.bind(self).call if block_given?
+    end
+
+    #
+    # Save a setup block to be called later
+    #
+    # Example:
+    #
+    #   setup do
+    #     @resorce = User.create(...)
+    #   end
+    #
+    # @param [Proc] block
+    #
+    def setup(&block)
+      @setup_block = block
+    end
+
+    #
+    # Call the setup block
+    #
+    def setup!
+      @setup_block.call if @setup_block.is_a?(Proc)
+    end
+
+    #
+    # Save a block that will be used later to
+    # create a particular dataset.
+    #
+    # Example:
+    #
+    #   define :params do
+    #     { :valid_id => @resource.id }
+    #   end
+    #
+    # @param [String, Symbol] key
+    # @param [Proc] block
+    #
+    def define(key, &block)
+      @definitions[key.to_sym] = block
+    end
+
+
+    #
+    # Evaluate a particular definition and
+    # return the results
+    #
+    # @param [String, Symbol] key Name of definition to eval
+    #
+    def [](key)
+      d = @definitions[key.to_sym]
+      d.is_a?(Proc) ? d.call : nil
+    end
+
+  end
+
+end

data/test/base_test.rb

@@ -0,0 +1,76 @@
+require 'helper'
+
+class TestBase < Test::Unit::TestCase
+
+  context "no name" do
+
+    setup do
+      Scenarios.clear
+      Scenarios::Base.name(nil)
+    end
+
+    should "raise an exception when `scenario` called" do
+      assert_raise RuntimeError do
+        Scenarios::Base.scenario("X"){}
+      end
+    end
+
+  end
+
+  context "a name" do
+
+    setup do
+      Scenarios.clear
+      Scenarios::Base.name(:sample)
+    end
+
+    should "not raise an exception when `scenario` called" do
+      Scenarios::Base.scenario("X"){}
+    end
+
+  end
+
+  context "a few empty scenarios" do
+
+    setup do
+      Scenarios.clear
+      Scenarios::Base.name(:sample)
+      @one = Scenarios::Base.scenario(:one){}
+      @two = Scenarios::Base.scenario(:two){}
+    end
+
+    should "register group with Scenarios module" do
+      assert Scenarios[:sample].kind_of?(Hash)
+    end
+
+    should "register both scenarios" do
+      assert_equal 2, Scenarios[:sample].size
+    end
+
+    should "register correct scenarios" do
+      assert_equal({@one.name.to_sym => @one, @two.name.to_sym => @two}, Scenarios[:sample])
+    end
+
+  end
+
+  context "a scenario with a definition" do
+    setup do
+      Scenarios.clear
+      Scenarios::Base.name(:sample)
+      @one = Scenarios::Base.instance_eval %[
+        scenario(:one) do
+          define :foo do
+            { :bar => :baz }
+          end
+        end
+      ]
+    end
+
+    should "add definition to scenerio object" do
+      assert_equal 1, @one.definitions.size
+      assert_equal({ :bar => :baz }, @one.definitions[:foo].call)
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'scenarios'
+
+class Test::Unit::TestCase
+end

data/test/scenario_test.rb

@@ -0,0 +1,76 @@
+require 'helper'
+
+class TestScenario < Test::Unit::TestCase
+
+  context "an empty scenario" do
+
+    setup do
+      @resource = Scenarios::Scenario.new("test")
+    end
+
+    should "have name set" do
+      assert_equal('test', @resource.name)
+    end
+
+    should "have an empty definitions" do
+      assert_equal({}, @resource.definitions)
+    end
+
+    should "return nil on setup" do
+      assert_equal nil, @resource.setup!
+    end
+
+  end
+
+  context "a scenario with a setup block" do
+
+    setup do
+      @resource = Scenarios::Scenario.new("test")
+      @resource.setup do 
+        @setup_called = true
+      end
+    end
+
+    should "not call setup block automatically" do
+      assert !@setup_called
+    end
+
+    should "call setup block manually, in scope of caller" do
+      @resource.setup!
+      assert @setup_called
+    end
+
+  end
+
+  context "a scenario with a definition" do
+
+    setup do
+      @resource = Scenarios::Scenario.new("test")
+      @resource.define(:params) do
+        @definition_called = true
+        {}
+      end
+      @resource.define(:other) do
+        {}
+      end
+    end
+
+    should "not call definition block automatically" do
+      assert !@definition_called
+    end
+
+    should "call definition block when referenced" do
+      assert_equal({}, @resource[:params])
+      assert @definition_called
+    end
+
+    should "return nil when referencing an invalid definition" do
+      assert_equal(nil, @resource[:winny])
+    end
+
+  end
+
+
+
+
+end

data/test/scenarios_test.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestScenarios < Test::Unit::TestCase
+
+  context "nothing registered" do
+
+    setup do
+      Scenarios.clear
+    end
+
+    should "return an empty hash" do
+      assert_equal({}, Scenarios.store)
+    end
+
+    should "return nil for all keys" do
+      assert_equal nil, Scenarios['one']
+      assert_equal nil, Scenarios['two']
+    end
+
+  end
+
+  context "a few things registered" do
+
+    setup do
+      Scenarios.clear
+      @world = stub(:name => :world)
+      @baz = stub(:name => :baz)
+      @foo = stub(:name => :foo)
+      Scenarios.register("foo", @foo)
+      Scenarios.register("foo", @baz)
+      Scenarios.register("hello", @world)
+    end
+
+    should "return correct store" do
+      assert_equal({:foo => {:foo => @foo, :baz => @baz}, :hello => {:world => @world}}, Scenarios.store)
+    end
+
+    should "return correct vals for keys" do
+      assert_equal({:foo => @foo, :baz => @baz}, Scenarios[:foo])
+      assert_equal({:world => @world}, Scenarios[:hello])
+    end
+
+  end
+
+end

data/test/system_test.rb

@@ -0,0 +1,74 @@
+require 'helper'
+
+
+
+class TestSystem < Test::Unit::TestCase
+
+  context "A scenarios subclass" do
+
+    setup do
+      Scenarios.clear
+
+      class SampleScenarios < Scenarios::Base
+        name "sample"
+        
+        scenario :one do
+          setup do
+            @foo = :bar
+          end
+
+          define :params do
+            { :foo => @foo }
+          end
+
+          define :env do
+            { :one => 1, :two => 2, :three => 3 }
+          end
+
+        end.setup!
+
+        scenario :two do
+          setup do
+            @foo = :baz
+          end
+
+          define :params do
+            { :foo => @foo }
+          end
+
+        end.setup!
+      end
+
+      class MoreScenarios < Scenarios::Base
+        name "more"
+        
+        scenario :three do
+          setup do
+            @foo = :what
+          end
+
+          define :params do
+            { :foo => @foo }
+          end
+        end.setup!
+      end
+
+    end
+
+    should "register group with module" do
+      assert Scenarios[:sample]
+    end
+
+    should "register scenarios with module" do
+      assert_equal 2, Scenarios[:sample].size
+    end
+
+    should "have scenarios return correct values " do
+      assert_equal({:foo => :bar}, Scenarios[:sample][:one][:params])
+      assert_equal({ :one => 1, :two => 2, :three => 3 }, Scenarios[:sample][:one][:env])
+      assert_equal({:foo => :baz}, Scenarios[:sample][:two][:params])
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: scenarios
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Starr Horne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Factories on steroids.
+email: starr@chromahq.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/scenarios.rb
+- lib/scenarios/base.rb
+- lib/scenarios/proc_extensions.rb
+- lib/scenarios/scenario.rb
+- test/base_test.rb
+- test/helper.rb
+- test/scenario_test.rb
+- test/scenarios_test.rb
+- test/system_test.rb
+has_rdoc: true
+homepage: http://github.com/starrhorne/scenarios
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Manage scenarios for testing
+test_files: 
+- test/base_test.rb
+- test/helper.rb
+- test/scenario_test.rb
+- test/scenarios_test.rb
+- test/system_test.rb