object_daddy 0.4.1 → 0.4.3

data/README.markdown

@@ -1,6 +1,6 @@
 Object Daddy
 ============
-_Version 0.4.1 (April 28, 2009)_
+_Version 0.4.3 (February 5, 2010)_
 
 __Authors:__  [Rick Bradley](mailto:blogicx@rickbradley.com), [Yossef Mendelssohn](mailto:ymendel@pobox.com)
 

data/VERSION.yml

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

data/lib/object_daddy.rb

@@ -3,20 +3,20 @@ module ObjectDaddy
   def self.included(klass)
     klass.extend ClassMethods
     if defined? ActiveRecord and klass < ActiveRecord::Base
-      klass.extend RailsClassMethods
-
+      klass.extend RailsClassMethods    
+      
       class << klass
         alias_method :validates_presence_of_without_object_daddy, :validates_presence_of
         alias_method :validates_presence_of, :validates_presence_of_with_object_daddy
-      end
+      end   
     end
   end
-
+    
   module ClassMethods
     attr_accessor :exemplars_generated, :exemplar_path, :generators
     attr_reader :presence_validated_attributes
     protected :exemplars_generated=
-
+    
     # :call-seq:
     #   spawn()
     #   spawn() do |obj| ... end
@@ -33,7 +33,10 @@ module ObjectDaddy
           : const_get(@concrete_subclass_name).spawn(args)
       end
       generate_values(args)
-      instance = new(args)
+      instance = new
+      args.each_pair do |attribute, value|
+        instance.send("#{attribute}=", value)  # support setting of mass-assignment protected attributes
+      end
       yield instance if block_given?
       instance
     end
@@ -52,9 +55,9 @@ module ObjectDaddy
         handle = gen_data.keys.first
         args = gen_data[handle]
       end
-
+      
       raise ArgumentError, "an attribute name must be specified" unless handle = handle.to_sym
-
+      
       unless args.is_a?(Hash)
         unless block
           retval = args
@@ -62,11 +65,11 @@ module ObjectDaddy
         end
         args = {}  # args is assumed to be a hash for the rest of the method
       end
-
+      
       if args[:start]
         block ||= lambda { |prev|  prev.succ }
       end
-
+      
       if args[:method]
         h = { :method => args[:method].to_sym }
         h[:start] = args[:start] if args[:start]
@@ -87,21 +90,24 @@ module ObjectDaddy
     def generates_subclass(subclass_name)
       @concrete_subclass_name = subclass_name.to_s
     end
-
+    
     def gather_exemplars
       return if exemplars_generated
+      
+      self.generators ||= {}
       if superclass.respond_to?(:gather_exemplars)
         superclass.gather_exemplars
-        self.generators = (superclass.generators || {}).dup
+        self.generators = (superclass.generators).merge(generators).dup
       end
 
-      [*exemplar_path].each do |raw_path|
+      exemplar_path.each do |raw_path|
         path = File.join(raw_path, "#{underscore(name)}_exemplar.rb")
         load(path) if File.exists?(path)
       end
+      
       self.exemplars_generated = true
     end
-
+    
     def presence_validated_attributes
       @presence_validated_attributes ||= {}
       attrs = @presence_validated_attributes
@@ -110,25 +116,26 @@ module ObjectDaddy
       end
       attrs
     end
-
+    
   protected
-
+  
     # we define an underscore helper ourselves since the ActiveSupport isn't available if we're not using Rails
     def underscore(string)
       string.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
     end
-
+    
     def record_generator_for(handle, generator)
       self.generators ||= {}
       raise ArgumentError, "a generator for attribute [:#{handle}] has already been specified" if (generators[handle] || {})[:source] == self
       generators[handle] = { :generator => generator, :source => self }
     end
-
+  
   private
-
+    
     def generate_values(args)
       (generators || {}).each_pair do |handle, gen_data|
         next if args.include?(handle) or args.include?(handle.to_s)
+        
         generator = gen_data[:generator]
         if generator[:block]
           process_generated_value(args, handle, generator, generator[:block])
@@ -143,25 +150,29 @@ module ObjectDaddy
           args[handle] = generator[:class].next
         end
       end
-
+      
       generate_missing(args)
     end
-
+    
     def process_generated_value(args, handle, generator, block)
       if generator[:start]
         value = generator[:start]
         generator.delete(:start)
       else
-        value = block.call(generator[:prev])
+        if block.arity == 0
+          value = block.call
+        else
+          value = block.call(generator[:prev])
+        end
       end
       generator[:prev] = args[handle] = value
     end
-
+    
     def generate_missing(args)
       if presence_validated_attributes and !presence_validated_attributes.empty?
         req = {}
         (presence_validated_attributes.keys - args.keys).each {|a| req[a.to_s] = true } # find attributes required by validates_presence_of not already set
-
+        
         belongs_to_associations = reflect_on_all_associations(:belongs_to).to_a
         missing = belongs_to_associations.select { |a|  req[a.name.to_s] or req[a.primary_key_name.to_s] }
         if create_scope = scope(:create)
@@ -172,13 +183,17 @@ module ObjectDaddy
       end
     end
   end
-
+  
   module RailsClassMethods
     def exemplar_path
-      dir = File.directory?(File.join(RAILS_ROOT, 'spec')) ? 'spec' : 'test'
-      File.join(RAILS_ROOT, dir, 'exemplars')
+      paths = ['spec', 'test'].inject([]) do |array, dir|
+        if File.directory?(File.join(RAILS_ROOT, dir))
+          array << File.join(RAILS_ROOT, dir, 'exemplars')
+        end
+        array
+      end
     end
-
+    
     def validates_presence_of_with_object_daddy(*attr_names)
       @presence_validated_attributes ||= {}
       new_attr = attr_names.dup
@@ -186,7 +201,7 @@ module ObjectDaddy
       new_attr.each {|a| @presence_validated_attributes[a] = true }
       validates_presence_of_without_object_daddy(*attr_names)
     end
-
+    
     # :call-seq:
     #   generate()
     #   generate() do |obj| ... end
@@ -204,7 +219,7 @@ module ObjectDaddy
         yield instance if block_given?
       end
     end
-
+    
     # :call-seq:
     #   generate()
     #   generate() do |obj| ... end

data/spec/object_daddy_spec.rb

@@ -157,7 +157,7 @@ describe ObjectDaddy, 'when registering exemplars' do
   before :each do
     @class = Class.new(OpenStruct)
     @class.send(:include, ObjectDaddy)
-    @file_path = File.join(File.dirname(__FILE__), 'tmp')
+    @file_path = [File.join(File.dirname(__FILE__), 'tmp')]
     @file_name = File.join(@file_path, 'widget_exemplar.rb')
     @class.stubs(:exemplar_path).returns(@file_path)
     @class.stubs(:name).returns('Widget')
@@ -506,7 +506,7 @@ describe ObjectDaddy, "when spawning a class instance" do
         SubWidget.stubs(:exemplar_path).returns(@subfile_path)
         
         File.open(@file_name, 'w') do |f|
-          f.puts "class Widget\ngenerator_for :blah do |prev| 'blah'; end\nend\n"
+          f.puts "class Widget\ngenerator_for :blah do |prev| 'blah'; end\ngenerator_for :other do |prev| 'bang'; end\nend\n"
         end
       end
       
@@ -516,35 +516,48 @@ describe ObjectDaddy, "when spawning a class instance" do
       end
       
       it 'should use generators from the parent class' do
-        SubWidget.spawn.blah.should == 'blah'
+        SubWidget.spawn.other.should == 'bang'
+        SubWidget.spawn.blah.should  == 'blah'
       end
       
-      it 'should let subclass generators override parent generators' do
-        File.open(@subfile_name, 'w') do |f|
-          f.puts "class SubWidget\ngenerator_for :blah do |prev| 'blip'; end\nend\n"
+      describe 'with subclass generators' do
+        before :each do
+          File.open(@subfile_name, 'w') do |f|
+            f.puts "class SubWidget\ngenerator_for :blah do |prev| 'blip'; end\nend\n"
+          end
+        end
+        
+        it 'should still use generators from the parent class' do
+          SubWidget.spawn.other.should == 'bang'
+        end
+        
+        it 'should allow overriding parent generators' do
+          SubWidget.spawn.blah.should == 'blip'
         end
-        SubWidget.spawn.blah.should == 'blip'
       end
     end
-
+    
     describe 'using generators called directly' do
+      before :each do
+        @class.generator_for :other do |prev| 'bang'; end
+        @class.generator_for :blah  do |prev| 'blah'; end
+      end
+      
       it 'should use generators from the parent class' do
-        @class.generator_for :blah do |prev| 'blah'; end
-        @subclass.spawn.blah.should == 'blah'
+        @subclass.spawn.other.should == 'bang'
+        @subclass.spawn.blah.should  == 'blah'
       end
       
-      it 'should let subclass generators override parent generators' do
-        pending 'figuring out what to do about this, including deciding whether or not this is even important' do
-          @class.generator_for :blah do |prev| 'blah'; end
-          # p @class
-          # p @subclass
-          # @subclass.send(:gather_exemplars)
-          # p @subclass.generators
+      describe 'with subclass generators' do
+        before :each do
           @subclass.generator_for :blah do |prev| 'blip'; end
-          # @subclass.send(:gather_exemplars)
-          # p @subclass.generators
-          # p @subclass.generators[:blah][:generator][:block].call
-          # @subclass.send(:gather_exemplars)
+        end
+        
+        it 'should still use generators from the parent class' do
+          @subclass.spawn.other.should == 'bang'
+        end
+        
+        it 'should allow overriding parent generators' do
           @subclass.spawn.blah.should == 'blip'
         end
       end
@@ -593,6 +606,10 @@ if File.exists?("#{File.dirname(__FILE__)}/../../../../config/environment.rb")
   class YaModel < ActiveRecord::Base
   end
 
+  class ProtectedAttribute < ActiveRecord::Base
+    attr_accessible :public_name
+  end
+
   describe ObjectDaddy, "when integrated with Rails" do
     it "should provide a means of generating and saving a class instance" do
       Frobnitz.should respond_to(:generate)
@@ -639,28 +656,43 @@ if File.exists?("#{File.dirname(__FILE__)}/../../../../config/environment.rb")
     describe 'giving an exemplar path for an ActiveRecord model' do
       it 'should check if a spec directory exists' do
         File.expects(:directory?).with(File.join(RAILS_ROOT, 'spec'))
-        Frobnitz.exemplar_path
+        File.expects(:directory?).with(File.join(RAILS_ROOT, 'test'))
+        Frobnitz.exemplar_path.should == []
       end
       
       describe 'if a spec directory exists' do
         before :each do
-          File.stubs(:directory?).returns(true)
+          File.expects(:directory?).with(File.join(RAILS_ROOT, 'spec')).returns(true)
+          File.expects(:directory?).with(File.join(RAILS_ROOT, 'test')).returns(false)
         end
         
-        it 'should use the spec directory' do
-          Frobnitz.exemplar_path.should == File.join(RAILS_ROOT, 'spec', 'exemplars')
+        it 'should return the spec directory string in an array' do
+          Frobnitz.exemplar_path.should == [File.join(RAILS_ROOT, 'spec', 'exemplars')]
         end
       end
       
       describe 'if a spec directory does not exist' do
         before :each do
-          File.stubs(:directory?).returns(false)
+          File.expects(:directory?).with(File.join(RAILS_ROOT, 'spec')).returns(false)
+          File.expects(:directory?).with(File.join(RAILS_ROOT, 'test')).returns(true)
+        end
+        
+        it 'should return the test directory string in an array' do
+          Frobnitz.exemplar_path.should == [File.join(RAILS_ROOT, 'test', 'exemplars')]
+        end
+      end
+
+      describe 'if both directories exist' do
+        before :each do
+          File.expects(:directory?).with(File.join(RAILS_ROOT, 'spec')).returns(true)
+          File.expects(:directory?).with(File.join(RAILS_ROOT, 'test')).returns(true)
         end
         
-        it 'should use the test directory' do
-          Frobnitz.exemplar_path.should == File.join(RAILS_ROOT, 'test', 'exemplars')
+        it 'should return both directory strings in an array' do
+          Frobnitz.exemplar_path.should == [ File.join(RAILS_ROOT, 'spec', 'exemplars'), File.join(RAILS_ROOT, 'test', 'exemplars')]
         end
       end
+
     end
     
     describe 'when an association is required by name' do
@@ -844,5 +876,19 @@ if File.exists?("#{File.dirname(__FILE__)}/../../../../config/environment.rb")
       Frobnitz.generator_for :name => 'thing'
       Frobnitz.generate('name' => 'boo').name.should == 'boo'
     end
+
+    describe "supporting mass-assignment protected attributes" do
+      it "should allow setting a value for a non-protected attribute" do
+        ProtectedAttribute.generate!(:public_name => 'no_worries').public_name.should == 'no_worries'
+      end
+
+      it "should have a protected attribute, which is not set when using regular create!" do
+        ProtectedAttribute.create!(:private_name => 'protected name').private_name.should == nil
+      end
+
+      it "should allow setting a value for a protected attribute" do
+        ProtectedAttribute.generate!(:private_name => 'protected name').private_name.should == 'protected name'
+      end
+    end
   end
 end

data/spec/resources/schema

@@ -27,4 +27,9 @@ ActiveRecord::Schema.define(:version => 0) do
   create_table :ya_models, :force => true do |t|
     t.column :name, :string
   end
+
+  create_table :protected_attributes, :force => true do |t|
+    t.column :public_name, :string
+    t.column :private_name, :string
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: object_daddy
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors: 
 - Rick Bradley
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-16 00:00:00 -02:00
+date: 2010-02-28 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,6 @@ files:
 - init.rb
 - install.rb
 - lib/object_daddy.rb
-- lib/object_daddy_flymake.rb
 - rails/init.rb
 - spec/install_spec.rb
 - spec/object_daddy_spec.rb

data/lib/object_daddy_flymake.rb

@@ -1,239 +0,0 @@
-module ObjectDaddy
-
-  def self.included(klass)
-    klass.extend ClassMethods
-    if defined? ActiveRecord and klass < ActiveRecord::Base
-      klass.extend RailsClassMethods
-
-      class << klass
-        alias_method :validates_presence_of_without_object_daddy, :validates_presence_of
-        alias_method :validates_presence_of, :validates_presence_of_with_object_daddy
-      end
-    end
-  end
-
-  module ClassMethods
-    attr_accessor :exemplars_generated, :exemplar_path, :generators
-    attr_reader :presence_validated_attributes
-    protected :exemplars_generated=
-
-    # :call-seq:
-    #   spawn()
-    #   spawn() do |obj| ... end
-    #   spawn(args)
-    #   spawn(args) do |obj| ... end
-    #
-    # Creates a valid instance of this class, using any known generators. The
-    # generated instance is yielded to a block if provided.
-    def spawn(args = {})
-      gather_exemplars
-      if @concrete_subclass_name
-        return block_given? \
-          ? const_get(@concrete_subclass_name).spawn(args) {|instance| yield instance} \
-          : const_get(@concrete_subclass_name).spawn(args)
-      end
-      generate_values(args)
-      instance = new(args)
-      yield instance if block_given?
-      instance
-    end
-
-    # register a generator for an attribute of this class
-    # generator_for :foo do |prev| ... end
-    # generator_for :foo do ... end
-    # generator_for :foo, value
-    # generator_for :foo => value
-    # generator_for :foo, :class => GeneratorClass
-    # generator_for :foo, :method => :method_name
-    def generator_for(handle, args = {}, &block)
-      if handle.is_a?(Hash)
-        raise ArgumentError, "only specify one attr => value pair at a time" unless handle.keys.length == 1
-        gen_data = handle
-        handle = gen_data.keys.first
-        args = gen_data[handle]
-      end
-
-      raise ArgumentError, "an attribute name must be specified" unless handle = handle.to_sym
-
-      unless args.is_a?(Hash)
-        unless block
-          retval = args
-          block = lambda { retval }  # lambda { args } results in returning the empty hash that args gets changed to
-        end
-        args = {}  # args is assumed to be a hash for the rest of the method
-      end
-
-      if args[:start]
-        block ||= lambda { |prev|  prev.succ }
-      end
-
-      if args[:method]
-        h = { :method => args[:method].to_sym }
-        h[:start] = args[:start] if args[:start]
-        record_generator_for(handle, h)
-      elsif args[:class]
-        raise ArgumentError, "generator class [#{args[:class].name}] does not have a :next method" unless args[:class].respond_to?(:next)
-        record_generator_for(handle, :class => args[:class])
-      elsif block
-        raise ArgumentError, "generator block must take an optional single argument" unless (-1..1).include?(block.arity)  # NOTE: lambda {} has an arity of -1, while lambda {||} has an arity of 0
-        h = { :block => block }
-        h[:start] = args[:start] if args[:start]
-        record_generator_for(handle, h)
-      else
-        raise ArgumentError, "a block, :class generator, :method generator, or value must be specified to generator_for"
-      end
-    end
-
-    def generates_subclass(subclass_name)
-      @concrete_subclass_name = subclass_name.to_s
-    end
-
-    def gather_exemplars
-      return if exemplars_generated
-      if superclass.respond_to?(:gather_exemplars)
-        superclass.gather_exemplars
-        self.generators = (superclass.generators || {}).dup
-      end
-
-      [*exemplar_path].each do |raw_path|
-        path = File.join(raw_path, "#{underscore(name)}_exemplar.rb")
-        load(path) if File.exists?(path)
-      end
-      self.exemplars_generated = true
-    end
-
-    def presence_validated_attributes
-      @presence_validated_attributes ||= {}
-      attrs = @presence_validated_attributes
-      if superclass.respond_to?(:presence_validated_attributes)
-        attrs = superclass.presence_validated_attributes.merge(attrs)
-      end
-      attrs
-    end
-
-  protected
-
-    # we define an underscore helper ourselves since the ActiveSupport isn't available if we're not using Rails
-    def underscore(string)
-      string.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
-    end
-
-    def record_generator_for(handle, generator)
-      self.generators ||= {}
-      raise ArgumentError, "a generator for attribute [:#{handle}] has already been specified" if (generators[handle] || {})[:source] == self
-      generators[handle] = { :generator => generator, :source => self }
-    end
-
-  private
-
-    def generate_values(args)
-      (generators || {}).each_pair do |handle, gen_data|
-        next if args.include?(handle) or args.include?(handle.to_s)
-        generator = gen_data[:generator]
-        if generator[:block]
-          process_generated_value(args, handle, generator, generator[:block])
-        elsif generator[:method]
-          method = method(generator[:method])
-          if method.arity == 1
-            process_generated_value(args, handle, generator, method)
-          else
-            args[handle] = method.call
-          end
-        elsif generator[:class]
-          args[handle] = generator[:class].next
-        end
-      end
-
-      generate_missing(args)
-    end
-
-    def process_generated_value(args, handle, generator, block)
-      if generator[:start]
-        value = generator[:start]
-        generator.delete(:start)
-      else
-        value = block.call(generator[:prev])
-      end
-      generator[:prev] = args[handle] = value
-    end
-
-    def generate_missing(args)
-      if presence_validated_attributes and !presence_validated_attributes.empty?
-        req = {}
-        (presence_validated_attributes.keys - args.keys).each {|a| req[a.to_s] = true } # find attributes required by validates_presence_of not already set
-
-        belongs_to_associations = reflect_on_all_associations(:belongs_to).to_a
-        missing = belongs_to_associations.select { |a|  req[a.name.to_s] or req[a.primary_key_name.to_s] }
-        if create_scope = scope(:create)
-          missing.reject! { |a|   create_scope.include?(a.primary_key_name) }
-        end
-        missing.reject! { |a|  [a.name, a.primary_key_name].any? { |n|  args.stringify_keys.include?(n.to_s) } }
-        missing.each {|a| args[a.name] = a.class_name.constantize.generate }
-      end
-    end
-  end
-
-  module RailsClassMethods
-    def exemplar_path
-      dir = File.directory?(File.join(RAILS_ROOT, 'spec')) ? 'spec' : 'test'
-      File.join(RAILS_ROOT, dir, 'exemplars')
-    end
-
-    def validates_presence_of_with_object_daddy(*attr_names)
-      @presence_validated_attributes ||= {}
-      new_attr = attr_names.dup
-      new_attr.pop if new_attr.last.is_a?(Hash)
-      new_attr.each {|a| @presence_validated_attributes[a] = true }
-      validates_presence_of_without_object_daddy(*attr_names)
-    end
-
-    # :call-seq:
-    #   generate()
-    #   generate() do |obj| ... end
-    #   generate(args)
-    #   generate(args) do |obj| ... end
-    #
-    # Creates and tries to save an instance of this class, using any known
-    # generators. The generated instance is yielded to a block if provided.
-    #
-    # This will not raise errors on a failed save. Use generate! if you
-    # want errors raised.
-    def generate(args = {})
-      spawn(args) do |instance|
-        instance.save
-        yield instance if block_given?
-      end
-    end
-
-    # :call-seq:
-    #   generate()
-    #   generate() do |obj| ... end
-    #   generate(args)
-    #   generate(args) do |obj| ... end
-    #
-    # Creates and tries to save! an instance of this class, using any known
-    # generators. The generated instance is yielded to a block if provided.
-    #
-    # This will raise errors on a failed save. Use generate if you do not want
-    # errors raised.
-    def generate!(args = {})
-      spawn(args) do |instance|
-        instance.save!
-        yield instance if block_given?
-      end
-    end
-  end
-end
-
-unless ActiveRecord::Base.respond_to? :inherited_with_object_daddy
-  class ActiveRecord::Base
-    def self.inherited_with_object_daddy(subclass)
-      self.inherited_without_object_daddy(subclass)
-      subclass.send(:include, ObjectDaddy) unless subclass < ObjectDaddy
-    end
-
-    class << self
-      alias_method_chain :inherited, :object_daddy
-    end
-  end
-end