eol_scenarios 0.3.3

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,51 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and 
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and 
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and 
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

data/README.rdoc

@@ -0,0 +1,58 @@
+= scenarios
+
+The idea behind 'scenarios' is simple.  Scenarions are basically just organized bits of arbitrary ruby code.
+
+== why?
+
+Here's why scenarios were originally written ... you may use them however you wish!
+
+I had a Rails application and I wanted to be able to do something like this:
+
+    $ rake scenarios:load SCENARIO=one_thousand_users
+
+... which would put 1,000 users in the database.
+
+Sometimes, while testing out my application's functionality in a browser, I would 
+want to setup some scenario to test.  Maybe I'm working on X feature and it would 
+be helpful if I had Y data in the database to work with.  Typically, I would 
+open up `script/console` and create abunchof Y data manually.  But ... wouldn't it 
+be useful if we could automate that?
+
+Also, our application requires *some* data to be in the database for the app to 
+load properly.  So we created a scenario that loads up the minimum amount of 
+data required to run the app!
+
+== documentation
+
+Read the RDoc[http://openrain.github.com/scenarios]
+
+== how?
+
+    $ sudo gem install remi-scenarios -s http://gems.github.com
+
+then, if you're in a Rails project ...
+
+    $ ./script/generate scenario Foo
+
+to see all defined scenarios ...
+
+    $ rake scenarios
+
+to load a particular scenario ...
+
+    $ rake scenarios:load NAME=my_scenario
+    $ rake scenarios:load NAME=my_scenario,and_some_more_scenarios
+
+== what else?
+
+more documentation to come soon!
+
+== TODO
+
+- add a 'scenario' bin script so you don't necessarily have to use rake?  potentially?  maybe check for local .scenariorc?
+- should be able to 'show' a full, long description of what a scenario does (*full* header comment)
+- document the context that scenarios are loaded within ... right now we're using #load, which is nice because it gets line numbers for exceptions ... altho eval'ing the code gives us more control over the context its loaded in
+- add dependencies so one scenario can call another one
+- make the scenario directory for the generator configurable (and that dir should always be included in the Scenario loadpath
+- make all scenarios load within a specific context and add hooks so people can update/modify that context
+- write a spec to make sure that the load paths work properly and multiple directories can have scenarios with the same name ... the directories added last should override the previous ones.  also make sure paths are uniq ... if i add 'foo' and 'foo' is already there, it should make foo the last path (move it to the end)

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "eol_scenarios"
+    gem.summary = %Q{Execute arbitrary blocks of ruby code for loading testing scenarios}
+    gem.description = %Q{Based on openrain-scenarios, q.v.  Depends on hard-to-find gems at the moment: remi-indifferent-variable-hash and remi-simplecli}
+    gem.email = "jrice.blue@gmail.com"
+    gem.homepage = "http://github.com/JRice/eol_scenarios"
+    gem.authors = ["Jeremy Rice"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem.add_dependency 'remi-indifferent-variable-hash'
+    # gem.add_dependency 'remi-simplecli'
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "eol_scenarios #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.3

data/examples/additional_scenarios/load_me.rb

@@ -0,0 +1 @@
+$set_by_load_me = 'I was set by load_me'

data/examples/additional_scenarios/load_me_too.rb

@@ -0,0 +1 @@
+$set_by_load_me_too = 'I was set by load_me_too!'

data/examples/more_scenarios/foo.rb

@@ -0,0 +1,2 @@
+# foo!
+$set_by_foo = 'hello from foo!'

data/examples/scenarios/first.rb

@@ -0,0 +1,9 @@
+# i am the summary
+#
+#   only the first line
+#   should be included in the summary
+#
+#no space here
+#
+$set_by_first_scenario = 'hello from first scenario!'
+# i'm a comment after some code, i am NOT part of the header

data/examples/testing_dependencies/load_more_stuff.rb

@@ -0,0 +1,10 @@
+# loads more stuff
+#
+#   does this
+#   and that
+#
+# ---
+# dependencies: [ :load_stuff ]
+#
+$times_loads_more_stuff_has_been_run ||= 0
+$times_loads_more_stuff_has_been_run += 1

data/examples/testing_dependencies/load_stuff.rb

@@ -0,0 +1,3 @@
+# loads stuff
+$times_loads_stuff_has_been_run ||= 0
+$times_loads_stuff_has_been_run += 1

data/examples/yaml_frontmatter/yaml_in_header.rb

@@ -0,0 +1,10 @@
+# i have some yaml
+#
+#   hi there
+#   indeed i do
+#
+# ---
+# foo: x
+# bar: that
+#
+puts "i am the source code"

data/lib/eol_scenarios/eol_scenario.rb

@@ -0,0 +1,222 @@
+# a Scenario is some set of data/logic that can be loaded up easily 
+# to run an application against.
+#
+# if you need to enter abunchof data manually into the a website 
+# to test something you're working on, this is a good candidate for
+# a scenario.
+#
+# we can also use scenarios for loading up the base foundation of 
+# data that's required to load the web application
+#
+# TODO define what is public/private and document public API in README and
+#      actually give private methods a private visibility
+#
+class EolScenario
+  include IndifferentVariableHash
+
+  attr_accessor :file_path
+
+  def initialize file_path
+    @file_path = file_path
+    source_code # does some parsing ... eager load this!  otherwise Scenario[:first].some_var won't work
+  end
+
+  def name
+    File.basename(file_path).sub(/\.rb$/, '')
+  end
+  alias to_s name
+
+  # returns a formatted string, showing information 
+  # about this current scenario
+  def info
+    str = <<INFO
+Scenario: #{ name }
+Summary: #{ summary }
+Description: #{ description_without_summary }
+INFO
+    variables.each do |key, value|
+      str << "#{ key }: #{ value.inspect }\n"
+    end
+    str
+  end
+
+  # if the first line of the scenario's source code 
+  # is a comment, we use it as the scenario's summary
+  #
+  # ideally, all scenarios should have a short simple summary
+  #
+  def summary
+    if first_line =~ /^#/
+      first_line.sub(/^#*/, '').strip
+    else
+      ''
+    end
+  end
+
+  def first_line
+    header.split("\n").first #.gsub(/^#* ?/, '')
+  end
+
+  def source_code
+    unless @source_code
+      # the first time we read in the source code, 
+      # see if there are any variables in the header 
+      # and, if so, set them via IndifferentVariableHash
+      @source_code = File.read file_path
+      yaml_frontmatter = header.gsub(/^#* ?/, '')[/^---.*/m]
+      if yaml_frontmatter
+        require 'yaml'
+        header_variables = YAML::load(yaml_frontmatter)
+        variables.merge!(header_variables) if header_variables
+      end
+    end
+    @source_code
+  end
+
+  def description
+    header.gsub(/^#* ?/, '').gsub(/^---.*/m, '').strip # gets rid of comment hashes and yaml
+  end
+
+  def description_without_summary
+    parts = description.split("\n")
+    parts.shift
+    parts.join("\n")
+  end
+
+  # evaluates the code of the scenario
+  def load
+    self.class.load self # pass the loading off to the class
+  end
+
+  # Comment header, any comments at the top of the source code
+  def header
+    source_code.gsub /\n^[^#].*/m, ''
+  end
+
+  class << self
+
+    # an array of the paths where scenarios can be found
+    #
+    # any .rb file found in these directories is assumed to 
+    # be a scenario
+    #
+    attr_accessor :load_paths, :verbose, :before_blocks
+
+    # returns all Scenarios found using Scenario#load_paths
+    def all
+      load_paths.inject([]) do |all_scenarios, load_path|
+        Dir[ File.join(load_path, '**', '*.rb') ].each do |found_scenario_file|
+          all_scenarios << EolScenario.new(found_scenario_file)
+        end
+        all_scenarios
+      end
+    end
+
+    def verbose= value
+      if value == true && @verbose != true
+        puts "Scenario verbose enable."
+        puts "Scenario load_paths => #{ EolScenario.load_paths.inspect }"
+        puts "#{ EolScenario.all.length } scenario(s) found"
+      end
+      @verbose = value
+    end
+
+    # run some block of code before any scenarios run
+    #
+    # good for last-minute require statements and whatnot
+    #
+    def before &block
+      @before_blocks ||= []
+      @before_blocks << block if block
+    end
+
+    # returns a scenario by name, eg. Scenario[:foo]
+    #
+    # if 1 name is passed in, we'll return that scenario or nil
+    #
+    # if more than 1 name is passed in, we'll return an array of 
+    # scenarios (or an empty array)
+    #
+    def [] *names
+      # puts "Scenario#{ names.inspect }" if Scenario.verbose
+      if names.length == 1
+        all.find {|scenario| scenario.name.downcase == names.first.to_s.downcase }
+      else
+        names.map {|name| self[ name ] }.compact
+      end
+    end
+
+    # loads a Scenario, evaluating its code
+    #
+    # we do this here so we can easily eval in a certain context, 
+    # if we want to add a context later
+    #
+    #   Scenario.load @scenario1, @scenario2
+    #   Scenario.load :names, 'work', :too
+    #
+    def load *scenarios
+    puts "EolScenario.load(#{ scenarios.map {|s| s.to_s }.join(', ') })" if EolScenario.verbose
+      @before_blocks.each { |b| b.call } if @before_blocks and not @before_blocks.empty?
+      
+      # TODO should be able to define some block that scenarios get evaluated in!
+      #      or some things that scenarios might want to require or ...
+
+      options = ( scenarios.last.is_a?(Hash) ) ? scenarios.pop : { }
+      options[:unique] ||= true # whether each scenario passed has to be unique ... will likely change this to be true by default
+      options[:whiny] = true if options[:whiny].nil?
+
+      # make sure everything is actually a Scenario object
+      #
+      # after this, we can safely assume that everything is a scenario!
+      #
+      scenarios.map! do |scenario|
+        scenario.is_a?(EolScenario) ? scenario : self[scenario]
+      end
+      scenarios.compact!
+
+      scenarios = scenarios.inject([]) do |all, scenario|
+        all += EolScenario[ nil, *scenario.dependencies ] if scenario.dependencies
+        all << scenario
+        all
+      end
+      scenarios.compact!
+
+      puts "[ after dependencies, scenarios => #{ scenarios.map {|s| s.to_s }.join(', ') } ]" if EolScenario.verbose
+
+      scenarios = scenarios.inject([]) do |all, scenario|
+        existing_scenario = all.find {|s| s.name == scenario.name }
+        if existing_scenario
+          # the last scenario with the given name "wins" (but we need to persist order)
+          index_of_existing_scenario = all.index existing_scenario
+          all.delete_at index_of_existing_scenario
+          all.insert index_of_existing_scenario, scenario
+        else
+          all << scenario
+        end
+        all
+      end if options[:unique]
+
+      puts "scenarios to load: #{ scenarios.map {|s| s.to_s }.join(', ') }" if EolScenario.verbose
+      scenarios.each do |scenario|
+        scenario = self[scenario] unless scenario.is_a?EolScenario # try getting using self[] if not a scenario
+        puts "... loading #{ scenario.name } (#{ scenario.summary })" if EolScenario.verbose
+        begin
+          if scenario.is_a? EolScenario
+            puts "loading scenario: #{ scenario.file_path }" if EolScenario.verbose
+
+            # TODO update to eval ... should load in a custom context ...
+            #      the eval should also catch exceptions and print the 
+            #      line number that threw the exception, etc etc
+            Kernel::load scenario.file_path
+          else
+            puts "Unsure how to load scenario: #{ scenario.inspect }" if options[:whiny]
+          end
+        rescue => ex
+          puts "An Exception was thrown by scenario: #{ scenario.name }" if options[:whiny]
+          raise ex
+        end
+      end
+    end
+  end  
+
+end

data/lib/eol_scenarios/eol_scenarios.rb

@@ -0,0 +1,34 @@
+# Top-level namespace for EolScenarios
+#
+# Holds configuration for EolScenarios 
+# and acts as a bit of a utility class, 
+# holding lots of methods / logic
+# used by EolScenarios.
+#
+class EolScenarios
+  class << self
+
+    # include IndifferentVariableHash in EolScenarios so we can 
+    # get/set easily configuration settings for EolScenarios
+    include IndifferentVariableHash
+
+    # alias config to variables attribute provided by 
+    # IndifferentVariableHash so we can say:
+    #   
+    #   # these all return the value of configuration 
+    #   # setting 'foo'
+    #   EolScenarios.config.foo
+    #   EolScenarios.config[:foo]
+    #   EolScenarios[:foo]
+    #   EolScenarios.foo
+    #
+    alias config variables
+
+    # returns a formatted string displaying 
+    # information about the current EolScenarios 
+    # environment and conifuguration, etc etc.
+    def info
+      "hello from EolScenarios#info"
+    end
+  end
+end

data/lib/eol_scenarios/spec.rb

@@ -0,0 +1,43 @@
+class EolScenario
+
+  # scenario helpers that can be used in your specs
+  #
+  # specifically, a #scenarios method for easily loading scenarios
+  #
+  module Spec
+
+    # scenarios to load in a spec
+    #
+    #   scenario  :foo
+    #   scenarios :foo, :bar
+    #   scenarios :foo, :bar, :before => :all
+    #   scenarios :foo, :bar, :before => :each
+    #
+    # defaults to before each
+    #
+    # to use this in your own specs, in your spec_helper.rb
+    #
+    #   require 'eol_scenarios'
+    #
+    #   Spec::Runner.configure do |config|
+    #     include EolScenario::Spec
+    #   end
+    #
+    # is RSpec is loaded, we'll load up the EolScenario::Spec for 
+    # you automatically.  if you need to manually load this:
+    #
+    #   require 'eol_scenarios/spec'
+    #
+    def scenario *scenarios
+      puts "EolScenario::Spec::Helper.scenario #{ scenarios.inspect }" if EolScenario.verbose
+      options = (scenarios.last.is_a?Hash) ? scenarios.pop : { }
+      options[:before] ||= :each
+      before options[:before] do
+        EolScenario.load *scenarios
+      end
+    end
+    alias scenarios scenario
+
+  end
+
+end

data/lib/eol_scenarios/tasks.rb

@@ -0,0 +1,80 @@
+# here be rake tasks for scenarios
+#
+# you can get them in your Rakefile by:
+#   require 'eol_scenarios/tasks'
+#   EolScenario.load_paths = [ 'path/to/my/scenarios/**/*' ]
+
+require 'eol_scenarios'
+
+desc 'Print all available scenarios'
+task :scenarios do
+  if EolScenario.all.empty?
+    puts "there are no scenarios.  add some to one of the EolScenario.load_paths: #{ EolScenario.load_paths.inspect }"
+  else
+    EolScenario.all.each do |scenario|
+      puts "#{ scenario.name }: #{ scenario.summary }"
+    end  
+  end
+end
+
+namespace :scenarios do
+
+  desc 'scenarios:load NAME=foo OR NAME=a,b,c'
+  task :load => ( (defined?RAILS_ENV) ? :environment : nil ) do
+    puts "called scenarios:load" if EolScenario.verbose
+    if ENV['NAME']
+      names = ENV['NAME'].split(',')
+      EolScenario.load *names
+    else
+      puts "you need to pass NAME=scenario_name to load a scenario"
+    end
+  end
+
+  desc 'scenarios:show NAME=foo OR NAME=a,b,c'
+  task :show do
+    if ENV['NAME']
+      names = ENV['NAME'].split(',')
+      names.each do |scenario_name|
+        if scenario = EolScenario[scenario_name]
+          puts scenario.info
+          puts ('-' * 40)
+        else
+          puts "Scenario not found: #{ scenario_name }"
+        end
+      end
+    else
+      puts "you need to pass NAME=scenario_name to load a scenario"
+    end
+  end
+
+end
+
+=begin
+  if defined?RAILS_ENV
+    # rails-specific task
+
+    desc 'this will clear the database, load scenarios, & run the site'
+    task :run => :environment do
+      if RAILS_ENV == 'test'
+        if ENV['NAME']
+
+          puts "clearing database ..."
+          Rake::Task[:truncate].invoke # this isn't defined in scenarios!  need to not call this or include a :truncate task
+
+          puts "loading scenarios ..."
+          names = ENV['NAME'].split(',')
+          EolScenario.load *names
+
+          puts "running the site ..."
+          require 'commands/server'
+
+        else
+          puts "Usage: rake:run NAME=the_names,of_some,scenarios_to_load RAILS_ENV=test"
+        end
+      else
+        puts "sorry, i'm not comfortable doing this in any environment but 'test'"
+      end
+    end
+
+  end
+=end

data/lib/eol_scenarios.rb

@@ -0,0 +1,15 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'indifferent-variable-hash'
+require 'eol_scenarios/eol_scenarios'
+require 'eol_scenarios/eol_scenario'
+
+# TODO not 100% sure if i want this
+EolScenario.load_paths ||= [ 'scenarios' ] # default to a 'scenarios' directory relative to your current location
+
+# TODO get rid of this ... switch to a real logger
+EolScenario.verbose = false
+
+# TODO get rid of this, i think i want to *explicitly* require this
+require 'eol_scenarios/spec' if defined? Spec

data/rails_generators/scenario/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Creates a new scenario
+    
+Examples:
+    `./script/generate scenario Foo`

data/rails_generators/scenario/scenario_generator.rb

@@ -0,0 +1,44 @@
+# This generator creates a new 'scenario'
+class ScenarioGenerator < Rails::Generator::Base
+
+  attr_accessor :name_of_scenario_to_create, :name_of_scenario_file_to_create
+
+  # `./script/generate scenario foo` will result in:
+  #
+  #   runtime_args: ['foo']
+  #   runtime_options: {:quiet=>false, :generator=>"scenario", :command=>:create, :collision=>:ask}
+  #
+  def initialize(runtime_args, runtime_options = {})
+    setup_rails_to_run_scenarios
+    @name_of_scenario_to_create      = runtime_args.join(' ')
+    @name_of_scenario_file_to_create = runtime_args.join('_').downcase
+    super
+  end
+
+  # this should be done by ./script/generate blackbox
+  def setup_rails_to_run_scenarios
+    rakefile = File.join RAILS_ROOT, 'Rakefile'
+    if File.file? rakefile
+      source = File.read rakefile
+      unless source =~ /require .scenarios.tasks./
+        File.open( rakefile, 'a' ) do |f|
+          f << %[require 'scenarios/tasks']
+        end
+      end
+    end
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'scenarios'
+      m.template 'scenario.erb', "scenarios/#{ name_of_scenario_file_to_create }.rb"
+    end
+  end
+ 
+protected
+ 
+  def banner
+    "Usage: #{$0} _scenario Name of Scenario to Create"
+  end
+ 
+end

data/rails_generators/scenario/templates/scenario.erb

@@ -0,0 +1,5 @@
+# my one-line description of the <%= name_of_scenario_to_create %> scenario
+
+$foo = "the <%= name_of_scenario_file_to_create %> scenario sets a global variable!"
+
+puts "Hello from the <%= name_of_scenario_to_create %> scenario!"

data/spec/scenario_spec.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe EolScenario do
+
+  def path_to_test_scenarios
+    File.join File.dirname(__FILE__), '..', 'examples', 'scenarios'
+  end
+  def path_to_more_scenarios
+    File.join File.dirname(__FILE__), '..', 'examples', 'more_scenarios'
+  end
+
+  before do
+    EolScenario.load_paths = [ path_to_test_scenarios ]
+    $set_by_first_scenario = nil
+    $set_by_foo = nil
+  end
+
+  before :all do
+    @original_scenario_paths = EolScenario.load_paths
+  end
+  after :all do
+    EolScenario.load_paths = @original_scenario_paths
+  end
+
+  # PENDING
+  # it 'should grab variables from header (yaml?)'
+  # it 'should not *require* a summary'
+  # it 'should not *require* a description'
+
+  it 'should find scenario files properly' do
+    EolScenario.load_paths = []
+    EolScenario.all.should be_empty
+
+    EolScenario.load_paths = [ path_to_test_scenarios ]
+    EolScenario.all.length.should == 1
+    EolScenario.all.first.name.should == 'first'
+
+    EolScenario.load_paths << path_to_more_scenarios
+    EolScenario.all.length.should == 2
+    EolScenario.all.map(&:name).should include('first')
+    EolScenario.all.map(&:name).should include('foo')
+  end
+
+  it 'should be easy to get a scenario by name' do
+    EolScenario[:first].name.should == 'first'
+    EolScenario['first'].name.should == 'first'
+
+    EolScenario[:foo].should be_nil
+    EolScenario.load_paths << path_to_more_scenarios
+    EolScenario[:foo].should_not be_nil
+  end
+
+  it 'should be easy to get multiple scenarios by name' do
+    EolScenario[:first, :nonexistent, :notfound].length.should == 1
+    EolScenario[:first, :nonexistent, :notfound].first.name.should == 'first'
+
+    EolScenario[:first, :nonexistent, :foo].length.should == 1
+    EolScenario.load_paths << path_to_more_scenarios
+    EolScenario[:first, :nonexistent, :foo].length.should == 2
+    EolScenario[:first, :nonexistent, :foo].map(&:name).should include('first')
+    EolScenario[:first, :nonexistent, :foo].map(&:name).should include('foo')
+  end
+
+  it 'should have a name' do
+    EolScenario.all.first.should be_a_kind_of(EolScenario)
+    EolScenario.all.first.name.should == 'first'
+  end
+
+  it 'should have a summary' do
+    EolScenario.all.first.summary.should == 'i am the summary'
+  end
+
+  it 'should have a description' do
+    EolScenario.all.first.description.should == "i am the summary\n\n  only the first line\n  should be included in the summary\n\nno space here"
+  end
+
+  it 'should allow yaml in the header to load up some custom variables (needs to be a hash)' do
+    path = File.join File.dirname(__FILE__), '..', 'examples', 'yaml_frontmatter'
+    EolScenario.load_paths << path
+
+    EolScenario[:yaml_in_header].name.should == 'yaml_in_header'
+    EolScenario[:yaml_in_header].summary.should == 'i have some yaml'
+    EolScenario[:yaml_in_header].description.should == "i have some yaml\n\n  hi there\n  indeed i do"
+    EolScenario[:yaml_in_header].header.should include('foo: x')
+    EolScenario[:yaml_in_header].foo.should == 'x'
+  end
+
+  it 'should be loadable' do
+    $set_by_first_scenario.should be_nil
+    EolScenario[:first].load
+    $set_by_first_scenario.should == 'hello from first scenario!'
+  end
+
+  it 'should be able to load multiple scenarios and run any dependencies' do
+    $times_loads_stuff_has_been_run, $times_loads_more_stuff_has_been_run = nil, nil
+    path = File.join File.dirname(__FILE__), '..', 'examples', 'testing_dependencies'
+    EolScenario.load_paths << path
+
+    EolScenario[:load_more_stuff].dependencies.should include(:load_stuff)
+
+    $times_loads_stuff_has_been_run.should be_nil
+    $times_loads_more_stuff_has_been_run.should be_nil
+
+    EolScenario.load :load_stuff, :unique => false
+    $times_loads_stuff_has_been_run.should == 1
+    $times_loads_more_stuff_has_been_run.should be_nil
+
+    EolScenario.load :load_stuff, :load_stuff, :unique => false
+    $times_loads_stuff_has_been_run.should == 3
+    $times_loads_more_stuff_has_been_run.should be_nil
+
+    EolScenario.load :load_more_stuff, :unique => false
+    $times_loads_stuff_has_been_run.should == 4 # should be run once, as it's a dependency
+    $times_loads_more_stuff_has_been_run.should == 1
+
+    EolScenario.load :load_stuff, :load_more_stuff, :unique => false
+    $times_loads_stuff_has_been_run.should == 6 # should be run twice
+    $times_loads_more_stuff_has_been_run.should == 2
+  end
+
+  it 'should be able to load multiple scenarios and run any dependencies (running each dependency only once!)' do
+    $times_loads_stuff_has_been_run, $times_loads_more_stuff_has_been_run = nil, nil
+    path = File.join File.dirname(__FILE__), '..', 'examples', 'testing_dependencies'
+    EolScenario.load_paths << path
+
+    EolScenario.load :load_stuff, :load_more_stuff #, :unique => true  # <--- this should be the default!
+    $times_loads_stuff_has_been_run.should == 1 # should only run once!
+    $times_loads_more_stuff_has_been_run.should == 1
+  end
+
+  it 'should be able to load multiple scenarios' do
+    EolScenario.load_paths << path_to_more_scenarios
+
+    $set_by_first_scenario.should be_nil
+    $set_by_foo.should be_nil
+
+    EolScenario[:first, :foo].each {|scenario| scenario.load }
+
+    $set_by_first_scenario.should == 'hello from first scenario!'
+    $set_by_foo.should == 'hello from foo!'
+  end
+
+  it 'should be really easy to load multiple scenarios' do
+    EolScenario.load_paths << path_to_more_scenarios
+
+    $set_by_first_scenario.should be_nil
+    $set_by_foo.should be_nil
+
+    EolScenario.load :first, :foo
+
+    $set_by_first_scenario.should == 'hello from first scenario!'
+    $set_by_foo.should == 'hello from foo!'
+  end
+
+  it 'to_s should be the scenario name' do
+    EolScenario[:first].to_s.should == 'first'
+  end
+
+  it 'should allow globbing in load_paths' do
+    EolScenario.load_paths = [ File.join(File.dirname(__FILE__), '..', 'examp*', '**') ]
+
+    EolScenario.all.length.should == Dir[File.join(File.dirname(__FILE__), '..', 'examp*', '**', '*.rb')].length
+    EolScenario.all.map(&:name).should include('first')
+    EolScenario.all.map(&:name).should include('foo')
+  end
+
+end

data/spec/scenario_spec_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe EolScenario::Spec do
+
+  def path_to_test_scenarios
+    File.join File.dirname(__FILE__), '..', 'examples', 'scenarios'
+  end
+  def path_to_additional_scenarios
+    File.join File.dirname(__FILE__), '..', 'examples', 'additional_scenarios'
+  end
+
+  before :all do
+    $set_by_load_me.should be_nil
+    $set_by_load_me_too.should be_nil
+    @original_scenario_paths = EolScenario.load_paths
+  end
+  after :all do
+    EolScenario.load_paths = @original_scenario_paths
+  end
+
+  scenarios :load_me, :load_me_too # <---- this is what we're testing here
+                                   #       see spec_helper.rb for how to 
+                                   #       add this method to your app!
+
+  it 'should have the scenarios we want to try running' do
+    EolScenario.load_paths = [ path_to_additional_scenarios ]
+    EolScenario.all.length.should == 2
+    EolScenario.all.map(&:name).should include('load_me')
+    EolScenario.all.map(&:name).should include('load_me_too')
+  end
+
+  it 'should actually load the scenarios ok' do
+    $set_by_load_me.should == 'I was set by load_me'
+    $set_by_load_me_too.should == 'I was set by load_me_too!'
+  end
+
+end

data/spec/scenarios_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe EolScenarios do
+
+  describe '.config' do
+
+    it 'should hold configuration settings' do
+      EolScenarios.config.should be_a_kind_of(Hash)
+      EolScenarios.config.foo = 'bar'
+
+      EolScenarios.config.foo.should   == 'bar'
+      EolScenarios.config[:foo].should == 'bar'
+      EolScenarios[:foo].should        == 'bar'
+      EolScenarios.foo.should          == 'bar'
+    end
+
+    it 'should be able to easily reset to default values'
+
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'eol_scenarios'
+require 'spec'
+require 'spec/autorun'
+
+include EolScenario::Spec
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: eol_scenarios
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 3
+  version: 0.3.3
+platform: ruby
+authors: 
+- Jeremy Rice
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-10 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: "Based on openrain-scenarios, q.v.  Depends on hard-to-find gems at the moment: remi-indifferent-variable-hash and remi-simplecli"
+email: jrice.blue@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/additional_scenarios/load_me.rb
+- examples/additional_scenarios/load_me_too.rb
+- examples/more_scenarios/foo.rb
+- examples/scenarios/first.rb
+- examples/testing_dependencies/load_more_stuff.rb
+- examples/testing_dependencies/load_stuff.rb
+- examples/yaml_frontmatter/yaml_in_header.rb
+- lib/eol_scenarios.rb
+- lib/eol_scenarios/eol_scenario.rb
+- lib/eol_scenarios/eol_scenarios.rb
+- lib/eol_scenarios/spec.rb
+- lib/eol_scenarios/tasks.rb
+- rails_generators/scenario/USAGE
+- rails_generators/scenario/scenario_generator.rb
+- rails_generators/scenario/templates/scenario.erb
+- spec/scenario_spec.rb
+- spec/scenario_spec_spec.rb
+- spec/scenarios_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/JRice/eol_scenarios
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Execute arbitrary blocks of ruby code for loading testing scenarios
+test_files: 
+- spec/scenario_spec.rb
+- spec/scenario_spec_spec.rb
+- spec/scenarios_spec.rb
+- spec/spec_helper.rb
+- examples/additional_scenarios/load_me.rb
+- examples/additional_scenarios/load_me_too.rb
+- examples/more_scenarios/foo.rb
+- examples/scenarios/first.rb
+- examples/testing_dependencies/load_more_stuff.rb
+- examples/testing_dependencies/load_stuff.rb
+- examples/yaml_frontmatter/yaml_in_header.rb