blueprints 0.6.3 → 0.7.1

data/README.rdoc

@@ -1,13 +1,59 @@
 = Blueprints
 
-Another replacement for factories and fixtures that focuses on being DRY and making developers type as little as possible.
+Awesome replacement for factories and fixtures that focuses on being DRY and making developers type as little as possible.
+
+== Setup
+
+The easiest way to install this gem for Ruby on Rails is just add this line to config/environment.rb (or config/environments/test.rb):
+
+  config.gem 'blueprints'
+
+If you're not using rails, then you can install it through command line
+
+  sudo gem install blueprints
+
+Lastly you could use it as plugin:
+
+  ruby script/plugin install git://github.com/sinsiliux/blueprints.git
+
+Blueprints is activated by calling Blueprints.enable at the bottom of your spec_helper/test_helper. If you're using RSpec
+make sure you call Blueprints.enable after requiring RSpec, otherwise it will lead to strange behaviour. This method accepts
+block and yields Blueprints::Configuration object.
+
+These options can be set on blueprint configuration object:
+* root - custom framework root if automatic detection fails for some reason (eg. not rails/merb project)
+* filename - custom patterns of files that contain your blueprints (in case one of automatic ones doesn't fit your needs)
+* prebuild - list of blueprints that should be preloaded (available in all tests, never reloaded so they're much faster)
+* orm - allows to set ORM (currently can be :active_record or nil). Defaults to :active_record.
+* transactions - set this to false if you don't want to use transactions. This will severely slow the tests but sometimes transactions can't be used.
+
+Sample usage:
+
+  Blueprints.enable do |config|
+    config.filename = 'my_blueprints.rb'
+    config.prebuild = :preloaded_blueprint
+  end
+
+== Blueprints file
+
+Blueprints file is the file that contains all definitions of blueprints. This can either be single file or whole folder
+if you have many blueprints.
+
+By default blueprints are searched in these files in this particular order in application root (which is either RAILS_ROOT if it's defined or current folder by default):
+* blueprint.rb
+* blueprint/*.rb
+* spec/blueprint.rb
+* spec/blueprint/*.rb
+* test/blueprint.rb
+* test/blueprint/*.rb
+You can set root option to override application root and filename option to pass custom filename pattern.
 
 == Usage
 
-Blueprints look like this:
+Definitions of blueprints look like this:
 
   blueprint :apple do
-    Fruit.create! :species => 'apple'
+    Fruit.blueprint :species => 'apple'
   end
 
   blueprint :orange do
@@ -15,14 +61,13 @@ Blueprints look like this:
   end
 
   blueprint :fruitbowl => [:apple, :orange] do
-    FruitBowl.create! :fruit => [@apple,@orange]
+    @fruits = [@apple,@orange]
+    FruitBowl.blueprint :fruits => @fruits
   end
 
-  blueprint :kitchen => :fruitbowl do
-    Kitchen.create! :fruitbowl => @fruitbowl
-  end
+  Kitchen.blueprint :kitchen, :fruitbowl => d(:fruitbowl)
 
-...and you use them in specs like:
+...and you use them in specs/tests like this:
 
   describe Fruit, "apple" do
     before do
@@ -40,7 +85,8 @@ Blueprints look like this:
     end
 
     it "should have 2 fruits" do
-      @fruitbowl.should have(2).fruit
+      @fruits.should == [@apple, @orange]
+      @fruitbowl.should have(2).fruits
     end
   end
 
@@ -77,80 +123,33 @@ And if you also need it to depend on other blueprints:
 
   SomeModel.blueprint(:something, :associated_column => :@some_iv).depends_on(:some_blueprint)
 
-...or if name of associated blueprint and instance variable are same...
+...or if name of blueprint that this one depends on and instance variable association uses are the same...
 
   SomeModel.blueprint(:something, :associated_column => d(:some_blueprint)) # I prefer this one
 
-=== Blueprints file
-
-Blueprints searches for blueprints files in this particular order in Rails (Merb) root:
-* blueprint.rb
-* blueprint/*.rb
-* spec/blueprint.rb
-* spec/blueprint/*.rb
-* test/blueprint.rb
-* test/blueprint/*.rb
-You can pass :root option to override framework root and :filename option to pass custom filename pattern
-
-== Setup
-
-The easiest way to install this gem for Ruby on Rails is just add this line to config/environment.rb (or config/environments/test.rb):
-
-  config.gem 'blueprints', :source => 'http://gemcutter.org'
-
-If you’re not using rails, then you can install it through command line
-
-  gem sources -a http://gemcutter.org
-  sudo gem install blueprints
+You can learn more about blueprint method in http://wiki.github.com/sinsiliux/blueprints/method-blueprint
 
-Lastly you could use it as plugin:
-
-  ruby script/plugin install git://github.com/sinsiliux/blueprints.git
-
-Blueprints is activated by calling enable_blueprints. For specifics on how to call that in your testing framework see a little lower.
-enable_blueprints supports these parameters:
-* :root - custom framework root if automatic detection fails for some reason (eg. not rails/merb project)
-* :filename - custom files pattern with blueprints plans
-* :prebuild - list of blueprints plans that should be preloaded (available in all tests, never reloaded so they're much faster)
-* :delete_policy - set custom delete policy when deleting everything from tables (before test suite or when calling demolish). Can be :truncate or :delete, defaults to :delete
-
-=== RSpec
-
-Add the following to spec_helper.rb
-
-  Spec::Runner.configure do |config|
-    ...
-    config.enable_blueprints :filename => 'scenarios.rb', :prebuild => :preloaded_scenario
-  end
-
-=== Test::Unit
-
-Add the following lines to test_helper.rb
-
-  class ActiveSupport::TestCase
-    ...
-    enable_blueprints
-  end
-
-== Advanced Usage
+=== Advanced Usage
 
 Its just ruby, right? So go nuts:
 
   1.upto(9) do |i|
     blueprint("user_#{i}") do
-      User.create! :name => "user#{i}"
+      User.blueprint :name => "user#{i}"
     end
   end
 
+You can also read more about advanced usages in http://wiki.github.com/sinsiliux/blueprints/advanced-usages
+
 == Transactions
 
-Blueprints is transactional, meaning that after every test transaction is dropped and database is reset to
-starting point. Starting point is empty database + any scenarios that you specify in enable_blueprints.
+Blueprints by default is transactional, meaning that before every test transaction is started and after every test that transaction is dropped
+which resets database to the state before the test. This state is empty database + any scenarios that you specify in enable_blueprints.
 
 == TODO
 
-* Add ability to revert one plan.
-* Add preloading plans for whole block of tests.
+* Add ability to revert one blueprint.
+* Add preloading blueprints for whole block of tests.
 * Fix rake tasks
 * Add merb support
 * Add support for other test frameworks (check support of cucumber)

data/Rakefile

@@ -8,6 +8,10 @@ begin
     gemspec.email = "sinsiliux@gmail.com"
     gemspec.homepage = "http://github.com/sinsiliux/blueprints"
     gemspec.authors = ["Andrius Chamentauskas"]
+    gemspec.bindir = 'bin'
+    gemspec.executables = ['blueprintify']
+    gemspec.add_dependency 'activesupport', '>=2.3.0'
+    gemspec.add_dependency 'database_cleaner', '~>0.5.0'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.7.1

data/bin/blueprintify

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'blueprints'
+require 'blueprints/convertable'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.on('-s','--source-files=PATTERN', 'Define pattern for source files (used by Dir.glob)') do |files|
+    options[:source_files] = files
+  end
+  
+  opts.on('-o', '--output-file=FILE', 'Define output file for converted data (used by Dir.glob)') do |file|
+    options[:output_file] = file
+  end
+  
+  opts.on('-h', '--help', 'Show help (this screen)') do
+    puts opts
+    exit
+  end
+  
+  opts.banner = "Usage: #{File.basename($0)} format --source-files=PATTERN --output-file=blueprints.rb\n"
+end
+
+begin 
+  optparse.parse!
+rescue OptionParser::ParseError => error
+  puts error
+  puts optparse.banner
+  exit
+end
+
+format = ARGV.shift
+unless [:fixtures, :factory_girl].include?(format.to_sym)
+  puts "Invalid format: #{format}" 
+  puts "Supported formats are: fixtures, factory_girl"
+  puts optparse.banner
+  exit
+end
+
+if format
+  converter = Blueprints::Converter.for(format).new(options)
+
+  converter.process!
+else
+  # require 'pp'
+  # pp optparse
+  puts optparse.banner
+end
+# fixture_files = Dir.glob('{spec,test}/fixtures/**/*.yml')
+# 
+# def parameterize(object)
+#   if object.is_a?(String)
+#     %Q(#{object}).inspect
+#   elsif object.nil?
+#     'nil'
+#   else
+#     object.to_s
+#   end
+# end
+# 
+# fixture_files.each do |fixture_file|
+#   puts "Processing #{fixture_files}..."
+#   
+#   klass = File.basename(fixture_file, '.yml').singularize.capitalize
+#   
+#   loaded_yaml = YAML.load(File.read(fixture_file))
+#   
+#   blueprints = loaded_yaml.collect do |title,yaml_obj|
+#     params = yaml_obj.collect do |k,v|
+#       ":#{k} => #{parameterize(v)}"
+#     end.join(', ')
+#     
+#     "#{klass}.blueprint(:#{title}, {#{params}})"
+#   end
+#   
+#   puts "Created #{blueprints.size} blueprints: #{loaded_yaml.keys.join(', ')}."
+# end

data/blueprints.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{blueprints}
-  s.version = "0.6.3"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrius Chamentauskas"]
-  s.date = %q{2010-07-03}
+  s.date = %q{2010-07-12}
+  s.default_executable = %q{blueprintify}
   s.description = %q{Another replacement for factories and fixtures. The library that lazy typists will love}
   s.email = %q{sinsiliux@gmail.com}
+  s.executables = ["blueprintify"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -22,22 +24,25 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "bin/blueprintify",
      "blueprints.gemspec",
      "init.rb",
      "install.rb",
      "lib/blueprints.rb",
+     "lib/blueprints/blueprint.rb",
      "lib/blueprints/buildable.rb",
+     "lib/blueprints/configuration.rb",
      "lib/blueprints/context.rb",
-     "lib/blueprints/database_backends/abstract.rb",
+     "lib/blueprints/convertable.rb",
+     "lib/blueprints/convertable/fixtures.rb",
      "lib/blueprints/database_backends/active_record.rb",
-     "lib/blueprints/database_backends/none.rb",
      "lib/blueprints/errors.rb",
+     "lib/blueprints/extensions/deprecated.rb",
      "lib/blueprints/extensions/rspec.rb",
      "lib/blueprints/extensions/test_unit.rb",
      "lib/blueprints/file_context.rb",
      "lib/blueprints/helper.rb",
      "lib/blueprints/namespace.rb",
-     "lib/blueprints/plan.rb",
      "lib/blueprints/root_namespace.rb",
      "spec/active_record/blueprint.rb",
      "spec/active_record/blueprints_spec.rb",
@@ -50,6 +55,9 @@ Gem::Specification.new do |s|
      "spec/no_db/blueprints_spec.rb",
      "spec/no_db/fixtures/fruit.rb",
      "spec/no_db/spec_helper.rb",
+     "spec/test_all.sh",
+     "spec/unit/configuration_spec.rb",
+     "spec/unit/spec_helper.rb",
      "test/blueprints_test.rb",
      "test/test_helper.rb",
      "uninstall.rb"
@@ -64,6 +72,8 @@ Gem::Specification.new do |s|
      "spec/no_db/spec_helper.rb",
      "spec/no_db/blueprints_spec.rb",
      "spec/no_db/blueprint.rb",
+     "spec/unit/spec_helper.rb",
+     "spec/unit/configuration_spec.rb",
      "spec/active_record/fixtures/fruit.rb",
      "spec/active_record/fixtures/tree.rb",
      "spec/active_record/fixtures/schema.rb",
@@ -79,9 +89,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.0"])
+      s.add_runtime_dependency(%q<database_cleaner>, ["~> 0.5.0"])
     else
+      s.add_dependency(%q<activesupport>, [">= 2.3.0"])
+      s.add_dependency(%q<database_cleaner>, ["~> 0.5.0"])
     end
   else
+    s.add_dependency(%q<activesupport>, [">= 2.3.0"])
+    s.add_dependency(%q<database_cleaner>, ["~> 0.5.0"])
   end
 end
 

data/lib/blueprints.rb

@@ -1,81 +1,56 @@
 require 'active_support'
 require 'active_support/core_ext'
+require 'database_cleaner'
 require 'set'
 
 files = %w{
-context buildable namespace root_namespace plan file_context helper errors
-database_backends/abstract database_backends/active_record database_backends/none
+configuration context buildable namespace root_namespace blueprint file_context helper errors extensions/deprecated
 }
-files << if defined? Spec or $0 =~ /script.spec$/ or defined? RSpec
-  'extensions/rspec'
-else
-  'extensions/test_unit'
-end
 files.each {|f| require File.join(File.dirname(__FILE__), 'blueprints', f) }
 
 module Blueprints
-  PLAN_FILES = [nil, "spec", "test"].map do |dir|
-    ["blueprint"].map do |file|
-      path = File.join([dir, file].compact)
-      ["#{path}.rb", File.join(path, "*.rb")]
-    end
-  end.flatten
-
-  # Returns a list of supported ORMs. For now it supports ActiveRecord and None.
-  def self.supported_orms
-    DatabaseBackends.constants.collect {|class_name| class_name.to_s.underscore.to_sym } - [:abstract]
-  end
-
-  # Returns root of project blueprints is used in. Automatically detected for rails and merb. Can be overwritten by using
-  # <tt>:root</tt> options when loading blueprints. If root can't be determined, returns nil which means that current
-  # directory is asumed as root.
-  def self.framework_root
-    @@framework_root ||= RAILS_ROOT rescue Rails.root rescue Merb.root rescue nil
+  # Contains current configuration of blueprints
+  def self.config
+    @@config ||= Blueprints::Configuration.new
   end
 
   # Setups variables from global context and starts transaction. Should be called before every test case.
   def self.setup(current_context)
     Namespace.root.setup
     Namespace.root.copy_ivars(current_context)
-    @@orm.start_transaction
+    DatabaseCleaner.start if config.orm
   end
 
   # Rollbacks transaction returning everything to state before test. Should be called after every test case.
   def self.teardown
-    @@orm.rollback_transaction
+    DatabaseCleaner.clean if config.orm
   end
 
-  # Sets up configuration, clears database, runs scenarios that have to be prebuilt. Should be run before all test cases and before <tt>setup</tt>.
-  # Accepts following options:
-  # * <tt>:delete_policy</tt> - allows changing how tables in database should be cleared. By default simply uses delete statement. Supports :delete and :truncate options.
-  # * <tt>:filename</tt> - Allows passing custom filename pattern in case blueprints are held in place other than spec/blueprint, test/blueprint, blueprint.
-  # * <tt>:prebuild</tt> - Allows passing scenarios that should be prebuilt and available in all tests. Works similarly to fixtures.
-  # * <tt>:root</tt> - Allows passing custom root folder to use in case of non rails and non merb project.
-  # * <tt>:orm</tt> - Allows specifying what orm should be used. Default to <tt>:active_record</tt>, also allows <tt>:none</tt>
-  def self.load(options = {})
-    options.assert_valid_keys(:delete_policy, :filename, :prebuild, :root, :orm)
-    options.symbolize_keys!
-    return unless Namespace.root.empty?
+  # Enables blueprints support for RSpec or Test::Unit depending on whether (R)Spec is defined or not. Yields
+  # Blueprints::Configuration object that you can use to configure blueprints.
+  def self.enable
+    yield config if block_given?
+    load
+    extension = (defined? Spec or defined? RSpec) ? 'rspec' : 'test_unit'
+    require File.join(File.dirname(__FILE__), 'blueprints', 'extensions', extension)
+  end
 
-    orm = (options.delete(:orm) || :active_record).to_sym
-    raise ArgumentError, "Unsupported ORM #{orm}. Blueprints supports only #{supported_orms.join(', ')}" unless supported_orms.include?(orm)
-    @@orm = DatabaseBackends.const_get(orm.to_s.classify).new
-    @@orm.delete_tables(@@delete_policy = options[:delete_policy])
+  # Sets up configuration, clears database, runs scenarios that have to be prebuilt. Should be run before all test cases and before Blueprints#setup.
+  def self.load
+    return unless Namespace.root.empty?
 
-    @@framework_root = options[:root] if options[:root]
-    load_scenarios_files(options[:filename] || PLAN_FILES)
+    require File.join(File.dirname(__FILE__), 'blueprints', 'database_backends', config.orm.to_s) if config.orm
+    DatabaseCleaner.clean_with :truncation if config.orm
 
-    Namespace.root.prebuild(options[:prebuild])
-  end
+    load_scenarios_files(config.filename)
 
-  # Clears all tables in database. Also accepts a list of tables in case not all tables should be cleared.
-  def self.delete_tables(*tables)
-    @@orm.delete_tables(@@delete_policy, *tables)
+    DatabaseCleaner.strategy = (config.transactions ? :transaction : :truncation) if config.orm
+    Namespace.root.prebuild(config.prebuild) if config.transactions
   end
 
   def self.backtrace_cleaner
     @backtrace_cleaner ||= ActiveSupport::BacktraceCleaner.new.tap do |bc|
-      root_sub = /^#{@@framework_root}[\\\/]/
+      root_sub = /^#{config.root}[\\\/]/
       blueprints_path = File.dirname(__FILE__).sub(root_sub, '')
 
       bc.add_filter {|line| line.sub('(eval)', @@file) }
@@ -98,7 +73,7 @@ module Blueprints
     FileContext.evaluating = true
 
     patterns.flatten!
-    patterns.collect! {|pattern| File.join(framework_root, pattern)} if framework_root
+    patterns.collect! {|pattern| File.join(config.root, pattern)} if config.root
 
     patterns.each do |pattern|
       unless (files = Dir.glob(pattern)).empty?
@@ -112,6 +87,6 @@ module Blueprints
     end
 
     FileContext.evaluating = false
-    raise "Plans file not found! Put plans in #{patterns.join(' or ')} or pass custom filename pattern with :filename option"
+    raise "Blueprints file not found! Put blueprints in #{patterns.join(' or ')} or pass custom filename pattern with :filename option"
   end
 end