openrain-scenarios 0.1.2 → 0.2.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 OpenRain, LLC.  All rights reserved.
+
+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/Rakefile

@@ -9,7 +9,7 @@ begin
     s.name        = "scenarios"
     s.summary     = "Create, Organize, and Run arbitrary snippets of Ruby code"
     s.email       = "remi@remitaylor.com"
-    s.homepage    = "http://github.com/remi/scenarios"
+    s.homepage    = "http://github.com/openrain/scenarios"
     s.description = "Create, Organize, and Run arbitrary snippets of Ruby code"
     s.authors     = %w( remi )
     s.files       = FileList["[A-Z]*", "{lib,spec,examples,rails_generators}/**/*"]

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 0
+:patch: 1
 :major: 0
 :minor: 2

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/lib/scenarios/scenario.rb

@@ -0,0 +1,138 @@
+# 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 Scenario
+
+  attr_accessor :file_path
+
+  def initialize file_path
+    @file_path = file_path
+  end
+
+  def name
+    File.basename(file_path).sub(/\.rb$/, '')
+  end
+  alias to_s name
+
+  # if the first line of the scenario's source code 
+  # is a comment, we use it as the scenario's description
+  #
+  # ideally, all scenarios should have a short simple description
+  #
+  def description
+    if first_line =~ /^#/
+      first_line.sub(/^#*/, '').strip
+    else
+      ''
+    end
+  end
+
+  def first_line
+    source_code.split("\n").first
+  end
+
+  def source_code
+    File.read file_path
+  end
+
+  # evaluates the code of the scenario
+  def load
+    self.class.load self # pass the loading off to the class
+  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 << Scenario.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 => #{ Scenario.load_paths.inspect }"
+        puts "#{ Scenario.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 "looking for scenario(s) with name(s): #{ names.inspect }" if Scenario.verbose
+      if names.length == 1
+        puts "all scenario names: #{ all.map(&:name) }" if Scenario.verbose
+        puts "btw, the load paths are: #{ load_paths.inspect }" if Scenario.verbose
+        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 "called Scenario.load with scenarios #{ scenarios.inspect }" if Scenario.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 ...
+      scenarios.each do |scenario|
+        scenario = self[scenario] unless scenario.is_a?Scenario # try getting using self[] if not a scenario
+        puts "loading #{ scenario.name } (#{ scenario.description })" if Scenario.verbose && scenario.is_a?(Scenario)
+        begin
+          if scenario.is_a?Scenario
+            puts "eval'ing scenario: #{ scenario.inspect }" if Scenario.verbose
+            eval scenario.source_code
+          else
+            puts "Unsure how to load scenario: #{ scenario.inspect }"
+          end
+        rescue => ex
+          raise "An Exception was thrown by scenario: #{ scenario.name }\n\n#{ ex }"
+        end
+      end
+    end
+  end  
+
+end

data/lib/scenarios/spec.rb

@@ -0,0 +1,43 @@
+class Scenario
+
+  # 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 'scenarios'
+    #
+    #   Spec::Runner.configure do |config|
+    #     include Scenario::Spec
+    #   end
+    #
+    # is RSpec is loaded, we'll load up the Scenario::Spec for 
+    # you automatically.  if you need to manually load this:
+    #
+    #   require 'scenarios/spec'
+    #
+    def scenario *scenarios
+      puts "Scenario::Spec::Helper.scenario #{ scenarios.inspect }" if Scenario.verbose
+      options = (scenarios.last.is_a?Hash) ? scenarios.pop : { }
+      options[:before] ||= :each
+      before options[:before] do
+        Scenario.load *scenarios
+      end
+    end
+    alias scenarios scenario
+
+  end
+
+end

data/lib/scenarios.rb

@@ -1,143 +1,8 @@
 $:.unshift File.dirname(__FILE__)
 
-# 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 Scenario
+require 'scenarios/scenario'
 
-  attr_accessor :file_path
+Scenario.load_paths ||= [ 'scenarios' ] # default to a 'scenarios' directory relative to your current location
+Scenario.verbose = false
 
-  def initialize file_path
-    @file_path = file_path
-  end
-
-  def name
-    File.basename(file_path).sub(/\.rb$/, '')
-  end
-  alias to_s name
-
-  # if the first line of the scenario's source code 
-  # is a comment, we use it as the scenario's description
-  #
-  # ideally, all scenarios should have a short simple description
-  #
-  def description
-    if first_line =~ /^#/
-      first_line.sub(/^#*/, '').strip
-    else
-      ''
-    end
-  end
-
-  def first_line
-    source_code.split("\n").first
-  end
-
-  def source_code
-    File.read file_path
-  end
-
-  # evaluates the code of the scenario
-  def load
-    self.class.load self # pass the loading off to the class
-  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 << Scenario.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 => #{ Scenario.load_paths.inspect }"
-        puts "#{ Scenario.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 "looking for scenario(s) with name(s): #{ names.inspect }" if Scenario.verbose
-      if names.length == 1
-        puts "all scenario names: #{ all.map(&:name) }" if Scenario.verbose
-        puts "btw, the load paths are: #{ load_paths.inspect }" if Scenario.verbose
-        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 "called Scenario.load with scenarios #{ scenarios.inspect }" if Scenario.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 ...
-      scenarios.each do |scenario|
-        scenario = self[scenario] unless scenario.is_a?Scenario # try getting using self[] if not a scenario
-        puts "loading #{ scenario.name } (#{ scenario.description })" if Scenario.verbose && scenario.is_a?(Scenario)
-        begin
-          if scenario.is_a?Scenario
-            puts "eval'ing scenario: #{ scenario.inspect }" if Scenario.verbose
-            eval scenario.source_code
-          else
-            puts "Unsure how to load scenario: #{ scenario.inspect }"
-          end
-        rescue => ex
-          raise "An Exception was thrown by scenario: #{ scenario.name }\n\n#{ ex }"
-        end
-      end
-    end
-  end  
-
-  Scenario.load_paths ||= [ 'scenarios' ] # default to a 'scenarios' directory relative to your current location
-  Scenario.verbose = false
-
-end
+require 'scenarios/spec' if defined? Spec

data/spec/scenario_spec.rb

@@ -1,7 +1,5 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-# this isn't exactly a model ... just something that helps 
-# with out development and speccing
 describe Scenario do
 
   def path_to_test_scenarios
@@ -104,7 +102,7 @@ describe Scenario do
   it 'should allow globbing in load_paths' do
     Scenario.load_paths = [ File.join(File.dirname(__FILE__), '..', 'examp*', '**') ]
 
-    Scenario.all.length.should == 2
+    Scenario.all.length.should == 4
     Scenario.all.map(&:name).should include('first')
     Scenario.all.map(&:name).should include('foo')
   end

data/spec/scenario_spec_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Scenario::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 = Scenario.load_paths
+  end
+  after :all do
+    Scenario.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
+    Scenario.load_paths = [ path_to_additional_scenarios ]
+    Scenario.all.length.should == 2
+    Scenario.all.map(&:name).should include('load_me')
+    Scenario.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/spec_helper.rb

@@ -1 +1,5 @@
 require File.dirname(__FILE__) + '/../lib/scenarios'
+
+Spec::Runner.configure do |config|
+  include Scenario::Spec
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: openrain-scenarios
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors: 
 - remi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 00:00:00 -08:00
+date: 2009-02-06 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -22,17 +22,23 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- MIT-LICENSE
 - Rakefile
 - VERSION.yml
 - README.markdown
+- LICENSE
 - lib/scenarios
+- lib/scenarios/spec.rb
+- lib/scenarios/scenario.rb
 - lib/scenarios/tasks.rb
 - lib/scenarios.rb
 - spec/scenario_spec.rb
 - spec/spec_helper.rb
+- spec/scenario_spec_spec.rb
 - examples/scenarios
 - examples/scenarios/first.rb
+- examples/additional_scenarios
+- examples/additional_scenarios/load_me_too.rb
+- examples/additional_scenarios/load_me.rb
 - examples/more_scenarios
 - examples/more_scenarios/foo.rb
 - rails_generators/scenario