josevalim-nested_scenarios 0.1.1 → 0.2

data/README

@@ -1,62 +1,81 @@
-NestedScenarios v0.1.1
-======================
+NestedScenarios
+License: MIT
+Version: 0.2
+
+Description
+-----------
 
 This plugin is based on FixtureScenarios and FixtureScenarioBuilder.
 It includes both worlds in just one plugin with some fixes, new features
-and Rails 2.2 support.
+and Rails 2.2 support (check what's new session bellow).
 
 You can check them at:
 
-  FixtureScenarios
-    Info: http://code.google.com/p/fixture-scenarios/
-    SVN : http://fixture-scenarios.googlecode.com/svn/trunk/fixture_scenarios
+  NestedScenarios
+    Info: http://josevalim.blogspot.com/
+    Git : http://github.com/josevalim/nested_scenarios
 
   FixtureScenariosBuilder
     Info: http://errtheblog.com/post/7708
     SVN : svn://errtheblog.com/svn/plugins/fixture_scenarios_builder
 
-  NestedScenarios
-    Info: http://josevalim.blogspot.com/
-    Git : http://github.com/josevalim/nested_scenarios
-
-== Install
+  FixtureScenarios
+    Info: http://code.google.com/p/fixture-scenarios/
+    SVN : http://fixture-scenarios.googlecode.com/svn/trunk/fixture_scenarios
 
-Install NestedScenarios is very easy. It is stored in GitHub, so if you have
-never installed a gem via GitHub run the following:
 
-  gem sources -a http://gems.github.com
+Install
+-------
 
-Then install the gem:
+Install Nested Scenarios is very easy. If you are using Rails 2.3.0, just do:
 
-  sudo gem install josevalim-nested_scenarios
+   gem sources -a http://gems.github.com
+   sudo gem install josevalim-nested_scenarios
 
-In RAILS_ROOT/config/environment.rb:
+If you want it as plugin, just do:
 
-  config.gem "josevalim-nested_scenarios",  :lib => "nested_scenarios", :source => "http://gems.github.com"
+   script/plugin install git://github.com/josevalim/nested_scenarios.git
 
-If you want it as plugin, just do:
+If you are running on Rails 2.2.x, you should use Nested Scenarios v0.1.1:
 
     cd myapp
     git clone git://github.com/josevalim/nested_scenarios.git
-    rm -rf vendor/plugins/nested_scenarios/.git
+    cd vendor/plugins/nested_scenarios
+    git checkout v0.1.1
+    rm -rf ./.git
+
 
-== Why
+Why?
+----
 
 You may, from time to time, wish to build your fixtures entirely in Ruby.
 Doing so has its advantages, such as automatically created join tables
-and default attributes.  YAML files, however, bring with them some real
+and default attributes. YAML files, however, bring with them some real
 nice features in Rails which are difficult to abandon: transactional fixtures, 
-table_name(:key) helpers, and auto-clearing between tests.  How does one get 
-the best of both worlds?
+table_name(:key) helpers and auto-clearing between tests. This plugin allow to
+get the best of both worlds.
 
-== Usage
+
+What's new?
+-----------
+
+FixtureScenario is totally rewritten: it's lighter, smaller and faster.
+
+FixtureScenarioBuilder was changed to expose some methods as API and it does
+not try to guess anymore when you should rebuild your scenarios. You have to
+call it explicitly using rake db:scenario:build.
+
+Finally Rails 2.2 support was also added.
+
+
+Usage
+-----
 
 Using the +scenario+ method within <tt>scenarios.rb</tt> file,
-FixtureScenariosBuilder can create your YAML fixture scenarios automatically
-at run time from Ruby-created fixtures.
+NestedScenarios can create your YAML fixtures automatically at run time.
 
-Any file inside the +fixture_path+ called scenarios.rb is loaded to
-generating scenarios:
+Any file inside the +fixture_path+ called scenario.rb or scenarios.rb
+is loaded to generating scenarios:
 
   [RAILS_ROOT]
   +-test/
@@ -75,8 +94,9 @@ Or:
       +-helpers/
         +-scenarios.rb
 
-Now build your scenarios in those file, wrapping scenarios in the 
-+scenario+ method and providing it with the name of your scenario.  
+Now build your scenarios in those files, wrapping scenarios in the 
++scenario+ method and providing it with the name of your scenario.
+
 A brief example of a complete <tt>scenarios.rb</tt> file:
 
   scenario :banned_users do
@@ -85,7 +105,7 @@ A brief example of a complete <tt>scenarios.rb</tt> file:
     end
   end
 
-Assuming +banned+ is a boolean field, this will create for us:
+This will create a file for us:
 
   [RAILS_ROOT]
   +-test/
@@ -93,7 +113,8 @@ Assuming +banned+ is a boolean field, this will create for us:
       +-banned_users/
         +-users.yml
 
-Our generated <tt>users.yml</tt> file will look something like this:
+Assuming that banned is a boolean field, our generated <tt>users.yml</tt>
+file will look something like this:
 
   chris: 
     name: Chris
@@ -117,9 +138,9 @@ Our generated <tt>users.yml</tt> file will look something like this:
 Notice how the keys correspond to the user names. You can register fields that
 can be used as fixtures names by:
 
-  NestedScenarios.record_name_fields << :nickname
+  NestedScenarios.record_name_fields += [ :nickname ]
 
-You can assign your records to instance variables, then call +names_from_ivars+
+You can also assign your records to instance variables, then call +names_from_ivars!+
 at the conclusion of your +scenario+ block.
 
   scenario :foo do
@@ -144,10 +165,9 @@ The above produces the following YAML:
 
 To build the scenario you have to run:
 
-  rake db:build:scenario
+  rake db:scenario:build
 
-In NestedScenarios, scenarios are not generated automatically. Another change
-is how scenarios are nested:
+NestedScenarios also allows you to nest scenarios:
 
   scenario :models => { :users => :banned } do
     User.create(:name => 'Kevin', :banned => true)
@@ -171,4 +191,30 @@ Or, in the case of nested scenarios:
 
   scenario :models => { :users => :banned }
 
-If no scenario is sent, the default behaviour is adopted.
+If no scenario is sent after all, the default behaviour is adopted.
+
+
+Fixtures path
+-------------
+
+If you have fixtures in your fixtures path root and you want those fixtures
+to also be loaded, you can configure:
+
+  NestedScenarios.load_root_fixtures = true
+
+You can disable such behaviour in your tests also, by doing:
+
+  scenario :models => { :users => :banned }, :root => false
+
+You just have to remember if you have a scenario with fixtures for a specified
+table, it will overwrite the fixtures in your root path for the same table.
+
+Bugs and Feedback
+-----------------
+
+If you discover any bugs, please send an e-mail to jose.valim@gmail.com
+If you just want to give some positive feedback or drop a line, that's fine too! =)
+
+Copyright (c) 2009 José Valim
+http://www.pagestacker.com/
+http://josevalim.blogspot.com/

data/Rakefile

@@ -2,11 +2,11 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-desc 'Generate documentation for Footnotes plugin.'
+desc 'Generate documentation for NestedScenarios plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'NestedScenarios'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/lib/nested_scenarios.rb

@@ -4,8 +4,8 @@ if RAILS_ENV == 'test'
   require 'active_record/fixtures'
 
   dir = File.dirname(__FILE__)
+  require File.join(dir, 'nested_scenarios', 'nested_scenarios')
   require File.join(dir, 'nested_scenarios', 'builder')
   require File.join(dir, 'nested_scenarios', 'fixtures')
   require File.join(dir, 'nested_scenarios', 'join')
-  require File.join(dir, 'nested_scenarios', 'nested_scenarios')
 end

data/lib/nested_scenarios/fixtures.rb

@@ -4,29 +4,62 @@ class Fixtures < (RUBY_VERSION < '1.9' ? YAML::Omap : Hash)
   end
 end
 
-module Test #:nodoc:
-  module Unit #:nodoc:
-    class TestCase #:nodoc:
-      superclass_delegating_accessor :scenario_path
+module ActiveRecord #:nodoc:
+  module TestFixtures #:nodoc:
+  
+    def self.included(base)
+      base.class_eval do
+        setup :setup_fixtures
+        teardown :teardown_fixtures
 
-      def self.scenario(scenario_name = nil, options = {})
+        superclass_delegating_accessor :fixture_path
+        superclass_delegating_accessor :fixture_table_names
+        superclass_delegating_accessor :fixture_class_names
+        superclass_delegating_accessor :use_transactional_fixtures
+        superclass_delegating_accessor :use_instantiated_fixtures   # true, false, or :no_instances
+        superclass_delegating_accessor :pre_loaded_fixtures
+
+        self.fixture_table_names = []
+        self.use_transactional_fixtures = false
+        self.use_instantiated_fixtures = true
+        self.pre_loaded_fixtures = false
+
+        self.fixture_class_names = {}
+
+        superclass_delegating_accessor :scenario_path
+        superclass_delegating_accessor :load_root_fixtures
+        superclass_delegating_accessor :root_table_names
+        superclass_delegating_accessor :scenario_table_names
+        self.load_root_fixtures = false
+      end
+
+      base.extend ClassMethods
+    end
+  
+    module ClassMethods
+      def scenario(scenario_name = nil, options = {})
         case scenario_name
           when Hash
+            self.load_root_fixtures = scenario_name.delete(:root) unless scenario_name[:root].nil?
             scenario_name = scenario_name.join('/')
           when Symbol, String
+            self.load_root_fixtures = options.delete(:root) unless options[:root].nil?
             scenario_name = scenario_name.to_s
+          else
+            raise ArgumentError, "Scenario must be a symbol, string or hash. You gave #{scenario_name.class}."
         end
 
-        self.scenario_path = "#{self.fixture_path}/#{scenario_name}/" if scenario_name
-
+        self.scenario_path = "#{self.fixture_path}/#{scenario_name}" if scenario_name
         self.fixtures(:all)
       end
 
-      def self.fixtures(*table_names)
+      def fixtures(*table_names)
         if table_names.first == :all
-          table_names  = Dir["#{self.scenario_path || self.fixture_path}/*.yml"]
-          table_names += Dir["#{self.scenario_path || self.fixture_path}/*.csv"]
-          table_names.map! { |f| File.basename(f).split('.')[0..-2].join('.') }
+          self.root_table_names = self.load_root_fixtures ? load_table_names_in_path(self.fixture_path) : []
+          self.scenario_table_names = self.scenario_path ? load_table_names_in_path(self.scenario_path) : []
+
+          table_names = self.root_table_names + self.scenario_table_names
+          table_names.uniq!
         else
           table_names = table_names.flatten.map { |n| n.to_s }
         end
@@ -38,35 +71,53 @@ module Test #:nodoc:
       end
 
       private
-        def load_fixtures
-          @loaded_fixtures = {}
-          fixtures = Fixtures.create_fixtures(self.scenario_path || self.fixture_path, fixture_table_names, fixture_class_names)
-          unless fixtures.nil?
-            if fixtures.instance_of?(Fixtures)
-              @loaded_fixtures[fixtures.table_name] = fixtures
-            else
-              fixtures.each { |f| @loaded_fixtures[f.table_name] = f }
-            end
-          end
+        def load_table_names_in_path(path)
+          table_names = Dir["#{path}/*.yml"] + Dir["#{path}/*.csv"]
+          table_names.map! { |f| File.basename(f).split('.')[0..-2].join('.') }
+          return table_names
+        end
+    end
+
+    private
+      def load_fixtures
+        @loaded_fixtures = {}
+
+        if self.load_root_fixtures
+          root_fixtures = Fixtures.create_fixtures(self.fixture_path, self.root_table_names, fixture_class_names)
         end
 
-        def teardown_fixtures
-          return unless defined?(ActiveRecord) && !ActiveRecord::Base.configurations.blank?
+        if self.scenario_path
+          scenario_fixtures = Fixtures.create_fixtures(self.scenario_path, self.scenario_table_names, fixture_class_names)
+        end
 
-          Fixtures.destroy_fixtures(self.fixture_table_names)
+        [root_fixtures, scenario_fixtures].each do |fixtures|
+          next if fixtures.nil?
 
-          unless use_transactional_fixtures?
-            Fixtures.reset_cache
+          if fixtures.instance_of?(Fixtures)
+            @loaded_fixtures[fixtures.table_name] = fixtures
+          else
+            fixtures.each { |f| @loaded_fixtures[f.table_name] = f }
           end
+        end
+      end
 
-          # Rollback changes if a transaction is active.
-          if use_transactional_fixtures? && ActiveRecord::Base.connection.open_transactions != 0
-            ActiveRecord::Base.connection.rollback_db_transaction
-            ActiveRecord::Base.connection.decrement_open_transactions
-          end
+      def teardown_fixtures
+        return unless defined?(ActiveRecord) && !ActiveRecord::Base.configurations.blank?
+
+        Fixtures.destroy_fixtures(self.fixture_table_names)
 
-          ActiveRecord::Base.clear_active_connections!
+        unless use_transactional_fixtures?
+          Fixtures.reset_cache
         end
-    end
+
+        # Rollback changes if a transaction is active.
+        if use_transactional_fixtures? && ActiveRecord::Base.connection.open_transactions != 0
+          ActiveRecord::Base.connection.rollback_db_transaction
+          ActiveRecord::Base.connection.decrement_open_transactions
+        end
+
+        ActiveRecord::Base.clear_active_connections!
+      end
+
   end
 end

data/lib/nested_scenarios/nested_scenarios.rb

@@ -17,4 +17,12 @@ class NestedScenarios
   def self.tables
     ActiveRecord::Base.connection.tables - @@skip_tables
   end
-end
+
+  def self.load_root_fixtures=(value)
+    Test::Unit::TestCase.load_root_fixtures = value
+  end
+
+  def self.load_root_fixtures
+    Test::Unit::TestCase.load_root_fixtures
+  end
+end

data/tasks/builder_tasks.rake

@@ -10,7 +10,11 @@ namespace :db do
       # while building scenarios
       ActionMailer::Base.delivery_method = :test
 
-      Dir.glob(NestedScenarios::Builder.fixtures_dir + '/**/scenarios.rb').each do |scenario_rb|
+      files = []
+      files += Dir.glob(NestedScenarios::Builder.fixtures_dir + '/**/scenario.rb')
+      files += Dir.glob(NestedScenarios::Builder.fixtures_dir + '/**/scenarios.rb')
+
+      files.each do |scenario_rb|
         puts "Reading #{scenario_rb.gsub(RAILS_ROOT, '')} scenario file:"
         require scenario_rb
         puts 

metadata

@@ -1,10 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-nested_scenarios
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: "0.2"
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
+- Tom Preston-Werner
+- Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []