nakajima-fixjour 0.0.6 → 0.0.7

data/lib/fixjour/builders.rb

@@ -1,7 +1,9 @@
 module Fixjour
   class << self
+    include Definitions
+
     attr_accessor :allow_redundancy
-    
+
     # The list of classes that have builders defined.
     def builders
       @builders ||= Set.new
@@ -19,19 +21,19 @@ module Fixjour
           klass.new(options.merge(overrides))
         end
       end
-      
+
       name = name_for(klass)
-      
+
       define_create(name)
       define_valid_attributes(name)
     end
-    
+
     # Adds builders to Fixjour.
     def evaluate(&block)
       begin
         module_eval(&block)
       rescue NameError => e
-        if evaluator.respond_to?(e.name)
+        if e.name && evaluator.respond_to?(e.name)
           raise NonBlockBuilderReference.new("You must use a builder block in order to reference other Fixjour creation methods.")
         else
           raise e
@@ -46,9 +48,9 @@ module Fixjour
       when String, Symbol then builders.map(&:name).include?(builder)
       end
     end
-    
+
     private
-    
+
     # Registers a class' builder. This allows us to make sure
     # redundant builders aren't defined, which can lead to confusion
     # when trying to figure out where objects are being created.
@@ -57,53 +59,11 @@ module Fixjour
         raise RedundantBuilder.new("You already defined a builder for #{klass.inspect}")
       end
     end
-    
+
     def name_for(klass)
       klass.name.underscore
     end
-    
-    # Defines the new_* method
-    def define_new(klass, &block)
-      name = name_for(klass)
-      define_method("new_#{name}") do |*args|
-        overrides = OverridesHash.new(args.first || { })
-        
-        args = case block.arity
-        when 1 then [overrides]
-        when 2 then [MergingProxy.new(klass, overrides), overrides]
-        end
-        
-        result = block.bind(self).call(*args)
-        result
-      end
-    end
-    
-    # Defines the create_* method
-    def define_create(name)
-      define_method("create_#{name}") do |*args|
-        model = send("new_#{name}", *args)
-        model.save!
-        model
-      end
-    end
-    
-    # Defines the valid_*_attributes method
-    def define_valid_attributes(name)
-      define_method("valid_#{name}_attributes") do |*args|
-        if instance_variable_get("@__valid_#{name}_attrs").nil?
-          valid_attributes = send("new_#{name}").attributes
-          valid_attributes.delete_if { |key, value| value.nil? }
-          instance_variable_set("@__valid_#{name}_attrs", valid_attributes)
-        end
 
-        overrides = args.extract_options!
-        attrs = instance_variable_get("@__valid_#{name}_attrs").merge(overrides)
-        attrs.stringify_keys!
-        attrs.make_indifferent!
-        attrs
-      end
-    end
-    
     # Anonymous class used for reflecting on current Fixjour state.
     def evaluator
       @evaluator ||= begin

data/lib/fixjour/definitions.rb

@@ -0,0 +1,36 @@
+module Fixjour
+  module Definitions
+    # Defines the new_* method
+    def define_new(klass, &block)
+      define_method("new_#{name_for(klass)}") do |*args|
+        Generator.new(klass, block).call(self, args.extract_options!)
+      end
+    end
+  
+    # Defines the create_* method
+    def define_create(name)
+      define_method("create_#{name}") do |*args|
+        model = send("new_#{name}", *args)
+        model.save!
+        model
+      end
+    end
+  
+    # Defines the valid_*_attributes method
+    def define_valid_attributes(name)
+      define_method("valid_#{name}_attributes") do |*args|
+        if instance_variable_get("@__valid_#{name}_attrs").nil?
+          valid_attributes = send("new_#{name}").attributes
+          valid_attributes.delete_if { |key, value| value.nil? }
+          instance_variable_set("@__valid_#{name}_attrs", valid_attributes)
+        end
+
+        overrides = args.extract_options!
+        attrs = instance_variable_get("@__valid_#{name}_attrs").merge(overrides)
+        attrs.stringify_keys!
+        attrs.make_indifferent!
+        attrs
+      end
+    end
+  end
+end

data/lib/fixjour/errors.rb

@@ -1,7 +1,11 @@
 module Fixjour
-  # Raised when a builder returns an invalid object
+  # Raised when a builder returns an invalid object.
   class InvalidBuilder < StandardError; end
   
+  # Raised when a builder will return an invalid object
+  # due to a validates_uniqueness_of validation.
+  class DangerousBuilder < StandardError; end
+  
   # Raised when a builder returns an object of the wrong type
   class WrongBuilderType < StandardError; end
   

data/lib/fixjour/generator.rb

@@ -0,0 +1,27 @@
+module Fixjour
+  # This generates a new instance of a model object for 
+  # the new_[model] method.
+  class Generator
+    attr_reader :klass, :block
+  
+    def initialize(klass, block)
+      @klass, @block = klass, block
+    end
+  
+    def call(context, overrides={})
+      overrides = OverridesHash.new(overrides)
+      result = block.bind(context).call(*args(overrides))
+      case result
+      when Hash then klass.new(result.merge(overrides))
+      else result
+      end
+    end
+  
+    def args(overrides)
+      case block.arity
+      when 1 then [overrides]
+      when 2 then [MergingProxy.new(klass, overrides), overrides]
+      end
+    end
+  end
+end

data/lib/fixjour/overrides_hash.rb

@@ -12,8 +12,8 @@ module Fixjour
     # Allows for processing of the overrides hash. Deletes
     # the option when it's present, then yields the value.
     def process(option)
-      if value = delete(option)
-        yield value if block_given?
+      delete(option).tap do |value|
+        yield value if value and block_given?
       end
     end
   end

data/lib/fixjour/redundant_check.rb

@@ -3,6 +3,10 @@ module Fixjour
     klass.extend(RedundancyChecker)
   end
   
+  # Uses method_added hook to make sure no redundant builder methods
+  # get defined after a builder has already created them. For example,
+  # if you have a Comment builder, this hook will ensure that any attempt
+  # to define a #new_comment method will raise an exception.
   module RedundancyChecker
     BUILDER_METHOD_PATTERN = /^(new|create|valid)_(\w+)(_attributes)?$/
     

data/lib/fixjour/verify.rb

@@ -7,20 +7,40 @@ module Fixjour
     # * The creation methods return objects of the proper type
     def verify!
       builders.each do |klass|
-        result = evaluator.send("new_#{name_for(klass)}")
+        result = new_record(klass)
         
         unless result.valid?
-          raise InvalidBuilder.new("The builder for #{klass} returns an invalid object: #{result.errors.inspect}")
+          error(klass, InvalidBuilder, "returns an invalid object: #{result.errors.inspect}")
         end
         
         unless result.new_record?
-          raise BuilderSavedRecord.new("The builder for #{klass} must not save the object")
+          error(klass, BuilderSavedRecord, "must return a new record")
         end
         
         unless result.is_a?(klass)
-          raise WrongBuilderType.new("The builder for #{klass} must return instance of #{klass}")
+          error(klass, WrongBuilderType, "must return an instance of #{klass}")
+        end
+        
+        result.save!
+        
+        unless new_record(klass).valid?
+          msg = ""
+          msg << "returns invalid an invalid object after another object has been saved.\n"
+          msg << "This could be caused by a validates_uniqueness_of validation in your model.\n"
+          msg << "Use something like the faker gem to alleviate this issue."
+          error(klass, DangerousBuilder, msg)
         end
       end
     end
+    
+    private
+    
+    def error(klass, exception, msg)
+      raise exception.new("The builder for #{klass} #{msg} ")
+    end
+    
+    def new_record(klass)
+      evaluator.send("new_#{name_for(klass)}")
+    end
   end
 end

data/lib/fixjour.rb

@@ -3,11 +3,14 @@ $LOAD_PATH << File.dirname(__FILE__)
 require 'rubygems'
 require 'activerecord'
 require 'core_ext/hash'
+require 'core_ext/object'
 require 'fixjour/merging_proxy'
 require 'fixjour/redundant_check'
 require 'fixjour/overrides_hash'
 require 'fixjour/verify'
 require 'fixjour/errors'
+require 'fixjour/generator'
+require 'fixjour/definitions'
 require 'fixjour/builders'
 
 # This method is just for prettiness

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nakajima-fixjour
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Pat Nakajima
@@ -34,11 +34,13 @@ files:
 - lib/core_ext/hash.rb
 - lib/fixjour
 - lib/fixjour/builders.rb
-- lib/fixjour/merging_proxy.rb
+- lib/fixjour/definitions.rb
 - lib/fixjour/errors.rb
-- lib/fixjour/verify.rb
-- lib/fixjour/redundant_check.rb
+- lib/fixjour/generator.rb
+- lib/fixjour/merging_proxy.rb
 - lib/fixjour/overrides_hash.rb
+- lib/fixjour/redundant_check.rb
+- lib/fixjour/verify.rb
 - lib/fixjour.rb
 has_rdoc: true
 homepage: http://github.com/nakajima/fixjour