CHANGELOG.rdoc README.rdoc TODO.rdoc contributions.rdoc philosophy_and_bugs.rdoc spec/fixture_replacement/integration/cyclic_dependency_spec.rb spec/fixture_replacement/integration/default_warnings_spec.rb @@ -1,4 +1,4 @@ -Copyright (c) 2008 Scott Taylor (smtlaissezfaire) <scott@railsnewbie.com> +Copyright (c) 2008-2009 Scott Taylor (smtlaissezfaire) <scott@railsnewbie.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation MIT_LICENSE @@ -1,6 +1,6 @@ require 'rake' require 'rake/testtask' -require 'rake/rdoctask' +require 'hanna/rdoctask' require 'spec/rake/spectask' require 'spec/rake/verify_rcov' require 'rake/contrib/rubyforgepublisher' @@ -26,7 +26,17 @@ Rake::RDocTask.new(:rdoc_without_analytics) do |rdoc| rdoc.title = 'FixtureReplacement' rdoc.options << '--line-numbers' << '--inline-source' - ["README", "CHANGELOG", "GPL_LICENSE", "MIT_LICENSE", "lib/**/*.rb"].each do |file| + rdoc.options << '--webcvs=http://github.com/smtlaissezfaire/fixturereplacement/tree/master/' + + [ + "README.rdoc", + "CHANGELOG.rdoc", + "GPL_LICENSE", + "MIT_LICENSE", + "contributions.rdoc", + "philosophy_and_bugs.rdoc", + "lib/**/*.rb" + ].each do |file| rdoc.rdoc_files.include(file) end end @@ -41,7 +51,6 @@ task :rdoc => [:rdoc_without_analytics] do File.open(rdoc_index, "r+") do |file| file.write(contents) end - end task :rerdoc => [:clobber_rdoc, :rdoc] @@ -84,7 +93,7 @@ task :build_docs => [:rerdoc, :specdoc, :rcov, :flog_to_disk] desc "Run all examples with RCov" Spec::Rake::SpecTask.new(:rcov) do |t| t.rcov = true - t.rcov_opts = ['--exclude', 'spec'] + t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems'] t.rcov_dir = "doc/rcov" end @@ -114,6 +123,4 @@ task :output_sloc => :create_doc_directory do File.open(File.dirname(__FILE__) + "/doc/lines_of_code.txt", "w") do |f| f << sloc end -end - - +end \ No newline at end of file Rakefile @@ -1,5 +1,3 @@ -require 'ostruct' - dir = File.dirname(__FILE__) + "/fixture_replacement" load "#{dir}/version.rb" load "#{dir}/class_methods.rb" lib/fixture_replacement.rb @@ -1,12 +1,4 @@ module FixtureReplacement - # I am a series of ActiveRecord model attributes. - # - # My attributes come from the following places: - # - # * from the class which is specified with :from => :fixture_name - # when I was constructed - # * from the anonymous function which is passed from into my constructor - # class AttributeBuilder class << self def instances @@ -14,27 +6,21 @@ module FixtureReplacement end def add_instance(instance) - @instances ||= [] - @instances << instance + instances << instance end def clear_out_instances! @instances = nil end - # Finds the fixture by the given name - # If there are duplicate fixtures with the same name, - # it will find the first one which was specified. It will - # return nil if no fixture with the name given was found def find_by_fixture_name(arg) - instances.each { |instance| return instance if instance.fixture_name == arg } - nil + instances.detect { |instance| instance.fixture_name == arg } end end def initialize(fixture_name, options={}, &block) @fixture_name = fixture_name - @attributes_proc = block || lambda { Hash.new } + @attributes_proc = block || lambda {} @from = options[:from] @class = options[:class] @@ -45,57 +31,39 @@ module FixtureReplacement attr_reader :from def active_record_class - if @class - @class - elsif derived_fixture? - derived_fixture.active_record_class - else - constantize(fixture_name) - end - end - - def procedure_hash - os = OpenStruct.new - @attributes_proc.call(os) - os.marshal_dump + @active_record_class ||= find_active_record_class end - def to_hash(hash_to_merge=nil) - evaluate_attributes(to_hash_with_procs(hash_to_merge)) - end - - # Procedure for building the hash: - # - # 1. Find the hash for the parent builder (specified by :from) - # 2. Merge #1 (or an empty hash) with the hash given in the body - # 3. If an extra hash is given to the method, merge that in. - # - # to_hash always prefers later key/value pairs in this sequence. - # - def to_hash_with_procs(hash_to_merge = nil) - if hash_to_merge - to_hash_with_procs.merge(hash_to_merge) - else - if derived_fixture? - derived_fixtures_hash.merge(procedure_hash) - else - procedure_hash - end + def instantiate(hash_to_merge = {}, instance = active_record_class.new) + returning instance do + instantiate_parent_fixture(instance) + call_attribute_body(instance, hash_to_merge) + add_given_keys(instance, hash_to_merge) end end private - def derived_fixtures_hash - derived_fixture.to_hash + def instantiate_parent_fixture(instance) + derived_fixture.instantiate({}, instance) if derived_fixture? end - def find_by_fixture_name(symbol) - self.class.find_by_fixture_name(symbol) + def call_attribute_body(instance, hash_to_merge) + if @attributes_proc.arity == 2 + @attributes_proc.call(instance, hash_to_merge) + else + @attributes_proc.call(instance) + end end + def add_given_keys(instance, hash_to_merge) + hash_to_merge.each do |key, value| + instance.send("#{key}=", value) + end + end + def find_derived_fixture - find_by_fixture_name(from) + self.class.find_by_fixture_name(from) end def derived_fixture @@ -110,25 +78,20 @@ module FixtureReplacement symbol.to_s.camelize.constantize end - def evaluate_attribute(value) - case value - when Array - value.map! { |element| evaluate_attribute(element) } - when Proc - value.call + def find_active_record_class + if @class + @class else - value - end - end - - def evaluate_attributes(hash) - new_hash = {} - - hash.each do |key, value| - new_hash[key] = evaluate_attribute(value) + begin + constantize(fixture_name) + rescue NameError => e + if derived_fixture? + derived_fixture.active_record_class + else + raise e + end + end end - - new_hash end end end \ No newline at end of file lib/fixture_replacement/attribute_builder.rb @@ -5,33 +5,6 @@ module FixtureReplacement MethodGenerator.new(builder, self).generate_methods end - # Any user defined instance methods (as well as default_*) need the module's class scope to be - # accessible inside the block given to attributes_for - # - # Addresses bug #16858 (see CHANGELOG) - def method_added(method) - module_function method if method != :method_added - public method - end - - def reset! - @create_dependent_objects = true - end - - attr_writer :create_dependent_objects - - def create_dependent_objects? - if defined? @create_dependent_objects - @create_dependent_objects - else - @create_dependent_objects = true - end - end - - def default_method - create_dependent_objects? ? :create : :new - end - def random_string(length=10) chars = ("a".."z").to_a string = "" @@ -50,7 +23,18 @@ module FixtureReplacement end def reload! - load File.dirname(__FILE__) + "/../fixture_replacement.rb" + load File.expand_path(File.dirname(__FILE__) + "/../fixture_replacement.rb") + end + + private + + # Any user defined instance methods need the module's class scope to be + # accessible inside the block given to attributes_for + # + # Addresses bug #16858 (see CHANGELOG) + def method_added(method) + module_function method if method != :method_added + public method end end end lib/fixture_replacement/class_methods.rb @@ -8,18 +8,11 @@ module FixtureReplacement def generate_methods builder = @builder builder_name = builder.fixture_name - builder_class = builder.active_record_class - default_method = @evaluation_module.default_method @evaluation_module.module_eval do define_method("valid_#{builder_name}_attributes") do |*args| - builder.to_hash(*args) - end - - define_method("default_#{builder_name}") do |*args| - lambda do - __send__("#{default_method}_#{builder_name}", *args) - end + obj = __send__ "new_#{builder_name}" + obj.attributes end define_method("create_#{builder_name}") do |*args| @@ -29,11 +22,15 @@ module FixtureReplacement end define_method("new_#{builder_name}") do |*args| - new_object = builder_class.new - - attributes = __send__("valid_#{builder_name}_attributes", *args) - attributes.each { |attr, value| new_object.__send__("#{attr}=", value) } - new_object + new_object = builder.instantiate(*args) + end + + define_method("default_#{builder_name}") do |*args| + warning = "default_#{builder_name} has been deprecated. " + warning << "Please replace instances of default_#{builder_name} with the new_#{builder_name} method" + Kernel.warn(warning) + + __send__ "new_#{builder_name}" end end end lib/fixture_replacement/method_generator.rb @@ -1,11 +1,13 @@ module FixtureReplacement module Version unless defined?(FixtureReplacement::VERSION) - MAJOR = 2 - MINOR = 1 - TINY = 1 - - VERSION = "#{MAJOR}.#{MINOR}.#{TINY}" + MAJOR = 3 + MINOR = 0 + TINY = 0 + + version_string = "#{MAJOR}.#{MINOR}.#{TINY}" + version_string << " RC#{RELEASE_CANDIDATE}" if defined?(RELEASE_CANDIDATE) + VERSION = version_string end end end lib/fixture_replacement/version.rb @@ -56,77 +56,31 @@ module FixtureReplacement it "should use the class name of the inherited attribute, if specified" do AttributeBuilder.new(:foo, :class => Object) - AttributeBuilder.new(:bar, :from => :foo).active_record_class.should == Object - end - - it "should not raise an error if the model ends with 's'" do - AttributeBuilder.new(:actress).active_record_class.should == Actress - end - end - - describe AttributeBuilder, "hash, with simple arguments (only attributes and fixture name)" do - - it "should return a hash" do - AttributeBuilder.new(:foo).to_hash.should == {} + AttributeBuilder.new(:bar, :from => :foo).active_record_class.should == Bar end - it "should return the attributes hash given" do - attributes = AttributeBuilder.new(:foo) do |f| - f.foo = :bar - f.scott = :taylor - end - - attributes.to_hash.should == { - :foo => :bar, - :scott => :taylor - } - end - end - - module AttributeFromHelper - def setup_attributes - @from_attributes = AttributeBuilder.new(:foo) do |u| - u.first_name = :scott - end - end - end - - describe AttributeBuilder, "with an empty hash, after merge with another inherited attribute" do - include AttributeFromHelper - - before :each do - setup_attributes - @attributes = AttributeBuilder.new(:bar, :from => :foo) + it "should prefer the constantized name to the derived name" do + AttributeBuilder.new(:user) + AttributeBuilder.new(:admin, :from => :user).active_record_class.should == Admin end - it "should contain the keys from the inherited hash only" do - @attributes.to_hash.should == { - :first_name => :scott - } - end - end - - describe AttributeBuilder, "with a hash, after merge with another inherited attributes" do - include AttributeFromHelper - - before :each do - setup_attributes + it "should use the derived name if the constantized name fails (doesn't exist)" do + AttributeBuilder.new(:foo) + no_constant = AttributeBuilder.new(:no_constant, :from => :foo) + no_constant.active_record_class.should == Foo end - it "should overwrite an attribute" do - attributes = AttributeBuilder.new :bar, :from => :foo do |u| - u.first_name = :scott - end + it "should raise a name error if it has no class, the name can't be constantized, and is derived, but the derived class can't be constantized" do + builder_one = AttributeBuilder.new(:does_not_exist) + builder_two = AttributeBuilder.new(:also_does_not_exist, :from => :does_not_exist) - attributes.to_hash.should == {:first_name => :scott} + lambda { + builder_two.active_record_class + }.should raise_error(NameError) end - it "should keep any new attributes, as well as any attributes which weren't overwritten" do - attributes = AttributeBuilder.new(:bar, :from => :foo) do |os| - os.foo = :bar - end - - attributes.to_hash.should == {:foo => :bar, :first_name => :scott} + it "should not raise an error if the model ends with 's'" do + AttributeBuilder.new(:actress).active_record_class.should == Actress end end end spec/fixture_replacement/attribute_builder_spec.rb @@ -1,33 +1,6 @@ require File.dirname(__FILE__) + "/../spec_helper" describe FixtureReplacement do - before do - FixtureReplacement.reset! - end - - after do - FixtureReplacement.reset! - end - - it "should have create as the default" do - FixtureReplacement.create_dependent_objects?.should be_true - end - - it "should be able to set dependent object creation" do - FixtureReplacement.create_dependent_objects = false - FixtureReplacement.create_dependent_objects?.should be_false - end - - it "should have the default_method as :create when create_dependent_objects?" do - FixtureReplacement.create_dependent_objects = true - FixtureReplacement.default_method.should equal(:create) - end - - it "should have the default_method as :new when create_dependent_objects == false" do - FixtureReplacement.create_dependent_objects = false - FixtureReplacement.default_method.should equal(:new) - end - describe "random_string" do before do @fr = FixtureReplacement @@ -105,4 +78,19 @@ describe FixtureReplacement do FR.rails_root.should == "." end end + + describe "reload!" do + it "should call load on the main fixture replacement file" do + file_path = File.expand_path(File.dirname(__FILE__) + "/../../lib/fixture_replacement.rb") + FixtureReplacement.should_receive(:load).with(file_path) + + FixtureReplacement.reload! + end + end + + describe "method_added" do + it "should be private" do + FixtureReplacement.should_not respond_to(:method_added) + end + end end spec/fixture_replacement/fixture_replacement_spec.rb @@ -3,7 +3,14 @@ class User < ActiveRecord::Base end class Member < ActiveRecord::Base; end -class Post < ActiveRecord::Base; end + +class Post < ActiveRecord::Base + has_many :comments +end + +class Comment < ActiveRecord::Base + belongs_to :post +end class Player < ActiveRecord::Base end @@ -35,4 +42,15 @@ end class Subscription < ActiveRecord::Base has_and_belongs_to_many :subscribers -end \ No newline at end of file +end + +class Event < ActiveRecord::Base + has_one :schedule +end + +class Schedule < ActiveRecord::Base + belongs_to :event +end + +class Foo; end +class Bar; end \ No newline at end of file spec/fixture_replacement/fixtures/classes.rb @@ -24,14 +24,6 @@ module FixtureReplacement models = "user", "foo", "scott" models.each do |model| - it "should have the default_#{model} as a (module) method on the module" do - @obj.should respond_to("default_#{model}") - end - - it "should have the default_#{model} as a private method in the test case" do - @obj.private_methods.should include("default_#{model}") - end - it "should have the new_#{model} method as a (module) method on the module" do @obj.should respond_to("new_#{model}") end spec/fixture_replacement/integration/attributes_from_spec_without_block.rb @@ -18,20 +18,6 @@ module FixtureReplacement obj.create_foo.should be_a_kind_of(User) end - it "should evaluate any of the default_* methods before returning (if no over-writing key is given)" do - obj = use_module do - attributes_for :gender do |g| - g.sex = "Male" - end - - attributes_for :user do |u| - u.gender = default_gender - end - end - - obj.create_user.gender.sex.should == "Male" - end - it "should find the correct class name" do obj = use_module do attributes_for :admin spec/fixture_replacement/integration/create_method_spec.rb @@ -6,7 +6,7 @@ module FixtureReplacement @obj = use_module do attributes_for :subscriber do |s| s.first_name = "Scott" - s.subscriptions = [default_subscription] + s.subscriptions = [new_subscription] end attributes_for :subscription do |s| @@ -14,7 +14,7 @@ module FixtureReplacement end attributes_for :subscriber_with_two_subscriptions, :from => :subscriber, :class => Subscriber do |s| - s.subscriptions = [default_harpers_subscription, default_ny_times_subscription] + s.subscriptions = [new_harpers_subscription, new_ny_times_subscription] end attributes_for :harpers_subscription, :class => Subscription do |s| spec/fixture_replacement/integration/has_and_belongs_to_many_spec.rb @@ -18,20 +18,6 @@ module FixtureReplacement obj.new_foo.should be_a_kind_of(User) end - it "should evaluate any of the default_* methods before returning (if no over-writing key is given)" do - obj = use_module do - attributes_for :gender do |g| - g.sex = "Male" - end - - attributes_for :user do |u| - u.gender = default_gender - end - end - - obj.new_user.gender.sex.should == "Male" - end - it "should find the correct class name" do obj = use_module do attributes_for :admin @@ -94,20 +80,17 @@ module FixtureReplacement }.should_not raise_error end - it "should have saved dependent objects with the default_* method" do - obj = use_module do - attributes_for :gender do |g| - g.sex = "Male" - end - + it "should yield the object inside the block" do + obj = nil + + mod = use_module do attributes_for :user do |u| - u.key = "val" - u.gender = default_gender + obj = u end end - - user = obj.new_user - user.gender.should_not be_a_new_record + + mod.new_user # trigger the block + obj.should be_a_kind_of(User) end end end \ No newline at end of file spec/fixture_replacement/integration/new_method_spec.rb @@ -21,40 +21,21 @@ module FixtureReplacement it "should have the attributes given as a hash" do obj = use_module do attributes_for :user do |x| - x.foo = 17 + x.key = 17 end end - obj.valid_user_attributes.should == { - :foo => 17 - } + obj.valid_user_attributes.should include({ "key" => 17 }) end it "should have the attributes given" do obj = use_module do attributes_for :user do |x| - x.bar = 18 + x.key = 18 end end - obj.valid_user_attributes.should == { - :bar => 18 - } - end - - it "should evaluate a default_* call" do - obj = use_module do - attributes_for :user do |x| - x.username = "smtlaissezfaire" - x.key = "something" - end - - attributes_for :post do |x| - x.user = default_user - end - end - - obj.valid_post_attributes[:user].should be_a_kind_of(User) + obj.valid_user_attributes.should include({ "key" => 18 }) end end end \ No newline at end of file spec/fixture_replacement/integration/valid_attributes_spec.rb @@ -1,7 +1,7 @@ require File.dirname(__FILE__) + "/../spec_helper" describe FixtureReplacement do - it "should be at version 2.0.1" do - FixtureReplacement::VERSION.should == "2.1.1" + it "should be at version 3.0.0" do + FixtureReplacement::VERSION.should == "3.0.0" end end spec/fixture_replacement/version_spec.rb @@ -58,6 +58,24 @@ module SpecHelperFunctions t.column :subscriber_id, :integer t.column :subscription_id, :integer end + + create_table :events do |t| + t.column :created_at, :datetime + t.column :updated_at, :datetime + end + + create_table :schedules do |t| + t.integer :event_id + end + + create_table :posts do |t| + t.timestamps + end + + create_table :comments do |t| + t.integer :post_id + t.timestamps + end end def use_module(&block) spec/spec_helpers.rb @@ -9,7 +9,7 @@ module ::FixtureReplacement attributes_for :user do |u| u.username = scott u.key = "something" - u.gender = default_gender + u.gender = new_gender end private test/unit/user_test.rb README TODO spec/fixture_replacement/integration/default_build_method_spec.rb spec/fixture_replacement/integration/default_method_spec.rb spec/fixture_replacement/method_generator/evaluation_loading_spec.rb 979f1e2636ad7e86016229b23b0b94acab231d6a 459d850dc02637b48bb129b0dddfcd73ae5fa7c2 Scott Taylor scott@railsnewbie.com http://github.com/smtlaissezfaire/fixturereplacement/commit/3dbb7dabd579ff66e078b256df98edb712b2bc53 3dbb7dabd579ff66e078b256df98edb712b2bc53 2009-09-23T00:38:11-07:00 2009-09-23T00:38:11-07:00 Merge branch '3.0' 3f429cf225679b531ffbd8d41382f3bb9e798e62 Scott Taylor scott@railsnewbie.com