sample_models 0.9.0

data/lib/sample_models/model.rb

@@ -0,0 +1,136 @@
+require 'delegate'
+
+module SampleModels
+  class Model < Delegator
+    attr_reader :validation_collections
+    
+    def initialize(model_class)
+      @model_class = model_class
+      @validation_collections = Hash.new { |h, field|
+        h[field] = ValidationCollection.new(self, field)
+      }
+    end
+    
+    def __getobj__
+      @model_class
+    end
+    
+    def associations(klass)
+      @model_class.reflect_on_all_associations.select { |a|
+        begin
+          a.klass == klass
+        rescue NameError
+          false
+        end
+      }
+    end
+    
+    def belongs_to_associations
+      @model_class.reflect_on_all_associations.select { |assoc|
+        assoc.macro == :belongs_to
+      }
+    end
+    
+    def construct_finder_sql(*args)
+      @model_class.send(:construct_finder_sql, *args)
+    end
+    
+    def has_many_associations
+      @model_class.reflect_on_all_associations.select { |assoc|
+        assoc.macro == :has_many
+      }
+    end
+    
+    def record_validation(*args)
+      type = args.shift
+      config = args.extract_options!
+      fields = args
+      fields.each do |field|
+        @validation_collections[field].add(type, config)
+      end
+    end
+    
+    def validates_presence_of?(attr)
+      @validation_collections[attr].includes_presence?
+    end
+  
+    class ValidationCollection
+      def initialize(model, field)
+        @model, @field = model, field
+        @sequence_number = 0
+        @validations = {}
+      end
+      
+      def add(type, config)
+        @validations[type] = config
+      end
+      
+      def association
+        @model.belongs_to_associations.detect { |a|
+          a.association_foreign_key.to_sym == @field.to_sym
+        }
+      end
+      
+      def column
+        @model.columns.detect { |c| c.name == @field.to_s }
+      end
+      
+      def includes_presence?
+        @validations.has_key?(:validates_presence_of)
+      end
+      
+      def includes_uniqueness?
+        @validations.has_key?(:validates_uniqueness_of)
+      end
+      
+      def satisfying_present_associated_value
+        value = if includes_uniqueness?
+          association.klass.create_sample
+        else
+          association.klass.first || association.klass.sample
+        end
+        value = value.id if value
+        value
+      end
+      
+      def satisfying_present_value(prev_value)
+        if association
+          satisfying_present_associated_value
+        else
+          if prev_value.present?
+            prev_value
+          elsif column && column.type == :date
+            Date.today
+          else
+            "#{@field} #{@sequence_number}"
+          end
+        end
+      end
+      
+      def satisfying_value
+        @sequence_number += 1 if includes_uniqueness?
+        value = nil
+        @validations.each do |type, config|
+          case type
+          when :validates_email_format_of
+            value = "john.doe#{@sequence_number}@example.com"
+          when :validates_inclusion_of
+            value = config[:in].first
+          when :validates_presence_of
+            value = satisfying_present_value(value)
+          end
+        end
+        value = unique_value if value.nil? && includes_uniqueness?
+        value
+      end
+      
+      def unique_value
+        if column.type == :string
+          "#{@field.to_s.capitalize} #{@sequence_number}"
+        elsif column.type == :datetime
+          Time.utc(1970, 1, 1) + @sequence_number.days
+        end
+      end
+    end
+  end
+end

data/lib/sample_models/sampler.rb

@@ -0,0 +1,110 @@
+module SampleModels
+  class Sampler
+    def self.reified_belongs_to_associations(model, attrs)
+      assocs = {}
+      model.belongs_to_associations.each do |assoc|
+        if value = attrs[assoc.name]
+          if value.is_a?(Hash)
+            assocs[assoc.name] = assoc.klass.sample(value)
+          elsif value.is_a?(Array)
+            assocs[assoc.name] = assoc.klass.sample(*value)
+          end
+        end
+      end
+      assocs
+    end
+    
+    def self.reify_association_hashes(model, attrs)
+      a = attrs.clone
+      reified_belongs_to_associations(model, attrs).each do |name, value|
+        a[name] = value
+      end
+      model.has_many_associations.each do |assoc|
+        if values = a[assoc.name]
+          a[assoc.name] = values.map { |value|
+            value.is_a?(Hash) ? assoc.klass.sample(value) : value
+          }
+        end
+      end
+      a
+    end
+    
+    attr_accessor :before_save
+    attr_reader   :configured_default_attrs, :model_class, :named_sample_attrs,
+                  :polymorphic_default_classes
+    
+    def initialize(model_class)
+      @model_class = model_class
+      @configured_default_attrs = {}
+      @named_sample_attrs = HashWithIndifferentAccess.new
+      @polymorphic_default_classes = HashWithIndifferentAccess.new
+    end
+    
+    def create_sample(*args)
+      attrs = preprocessed_attributes(*args)
+      Creation.new(self, attrs).run
+    end
+    
+    def fix_deleted_associations(instance, orig_attrs)
+      needs_save = false
+      model.belongs_to_associations.each do |assoc|
+        if instance.send(assoc.primary_key_name) && 
+           !instance.send(assoc.name)
+         instance.send("#{assoc.name}=", assoc.klass.sample)
+         needs_save = true
+        end
+      end
+      save!(instance, orig_attrs) if needs_save
+    end
+    
+    def model
+      SampleModels.models[@model_class]
+    end
+    
+    def preprocessed_attributes(*args)
+      if args.first.is_a?(Symbol)
+        preprocessed_named_sample_attrs(args)
+      else
+        attrs = args.last.is_a?(Hash) ? args.pop : {}
+        args.each do |associated_value|
+          assocs = model.associations(associated_value.class)
+          if assocs.size == 1
+            attrs[assocs.first.name] = associated_value
+          else
+            raise "Not sure what to do with associated value #{associated_value.inspect}"
+          end
+        end
+        attrs
+      end
+    end
+    
+    def preprocessed_named_sample_attrs(args)
+      attrs = named_sample_attrs[args.shift]
+      attrs = attrs.merge(args.first) unless args.empty?
+      attrs
+    end
+    
+    def sample(*args)
+      attrs = preprocessed_attributes(*args)
+      instance = Finder.new(model, attrs).instance
+      if instance
+        fix_deleted_associations(instance, attrs)
+      else
+        instance = create_sample attrs
+      end
+      instance
+    end
+    
+    def save!(instance, orig_attrs)
+      if @before_save
+        if @before_save.arity == 1
+          @before_save.call instance
+        else
+          @before_save.call instance, orig_attrs
+        end
+      end
+      instance.save!
+    end
+  end
+end
+

data/lib/sample_models.rb

@@ -0,0 +1,117 @@
+if RAILS_ENV == 'test' # no reason to run this code outside of test mode
+  
+require "#{File.dirname(__FILE__)}/sample_models/creation"
+require "#{File.dirname(__FILE__)}/sample_models/finder"
+require "#{File.dirname(__FILE__)}/sample_models/model"
+require "#{File.dirname(__FILE__)}/sample_models/sampler"
+require "#{File.dirname(__FILE__)}/../vendor/ar_query/lib/ar_query"
+
+module SampleModels
+  mattr_reader :models
+  @@models = Hash.new { |h, model_class| 
+    h[model_class] = Model.new(model_class)
+  }
+  
+  mattr_reader :samplers
+  @@samplers = Hash.new { |h, model_class|
+    h[model_class] = Sampler.new(model_class)
+  }
+
+  def self.configure(model_class, opts ={})
+    yield ConfigureRecipient.new(model_class) if block_given?
+  end
+
+  protected
+  
+  def self.included( mod )
+    mod.extend ARClassMethods
+    super
+  end
+  
+  class ConfigureRecipient
+    def initialize(model_class)
+      @model_class = model_class
+    end
+    
+    def before_save(&proc)
+      sampler.before_save = proc
+    end
+    
+    def method_missing(meth, *args)
+      if meth.to_s =~ /(.*)_sample$/
+        sampler.named_sample_attrs[$1] = args.first
+      else
+        Attribute.new(sampler, meth)
+      end
+    end
+    
+    def sampler
+      SampleModels.samplers[@model_class]
+    end
+    
+    class Attribute
+      def initialize(sampler, attribute)
+        @sampler, @attribute = sampler, attribute
+      end
+      
+      def default_class(dc)
+        @sampler.polymorphic_default_classes[@attribute] = dc 
+      end
+      
+      def default(default)
+        if default.blank? and model.validates_presence_of?(@attribute)
+          raise "#{model.name} requires #{@attribute} to not be blank"
+        else
+          @sampler.configured_default_attrs[@attribute] = default
+        end
+      end
+      
+      def force_unique
+        model.record_validation :validates_uniqueness_of, @attribute
+      end
+      
+      def model
+        SampleModels.models[@sampler.model_class]
+      end
+    end
+  end
+  
+  module ARClassMethods
+    def create_sample(*args)
+      sampler = SampleModels.samplers[self]
+      sampler.create_sample(*args)
+    end
+    
+    def sample(*args)
+      sampler = SampleModels.samplers[self]
+      sampler.sample(*args)
+    end
+  end
+end
+
+module ActiveRecord
+  class Base
+    include SampleModels
+  end
+  
+  module Validations
+    module ClassMethods
+      [:validates_email_format_of,
+       :validates_inclusion_of, :validates_presence_of, 
+       :validates_uniqueness_of].each do |validation|
+        if method_defined?(validation)
+          define_method "#{validation}_with_sample_models".to_sym do |*args|
+            send "#{validation}_without_sample_models".to_sym, *args
+            SampleModels.models[self].record_validation(
+              validation, *args
+            )
+          end
+          alias_method_chain validation, :sample_models
+        end
+      end
+    end
+  end
+end
+
+end # if RAILS_ENV == 'test'
+

data/sample_models.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sample_models}
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francis Hwang"]
+  s.date = %q{2010-11-06}
+  s.description = %q{
+A library for making it extremely fast for Rails developers to set up and save ActiveRecord instances when writing test cases. It aims to:
+
+* meet all your validations automatically
+* only make you specify the attributes you care about
+* give you a rich set of features so you can specify associated values as concisely as possible
+* do this with as little configuration as possible
+}
+  s.email = %q{francis.hwang@profitably.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/sample_models.rb",
+     "lib/sample_models/creation.rb",
+     "lib/sample_models/finder.rb",
+     "lib/sample_models/model.rb",
+     "lib/sample_models/sampler.rb",
+     "sample_models.gemspec",
+     "spec/sample_models_spec.rb",
+     "spec_or_test/database.yml",
+     "spec_or_test/setup.rb",
+     "spec_or_test/specs_or_test_cases.rb",
+     "spec_or_test/vendor/validates_email_format_of/CHANGELOG",
+     "spec_or_test/vendor/validates_email_format_of/MIT-LICENSE",
+     "spec_or_test/vendor/validates_email_format_of/README",
+     "spec_or_test/vendor/validates_email_format_of/TODO",
+     "spec_or_test/vendor/validates_email_format_of/init.rb",
+     "spec_or_test/vendor/validates_email_format_of/lib/validates_email_format_of.rb",
+     "spec_or_test/vendor/validates_email_format_of/rakefile",
+     "spec_or_test/vendor/validates_email_format_of/test/database.yml",
+     "spec_or_test/vendor/validates_email_format_of/test/fixtures/people.yml",
+     "spec_or_test/vendor/validates_email_format_of/test/fixtures/person.rb",
+     "spec_or_test/vendor/validates_email_format_of/test/schema.rb",
+     "spec_or_test/vendor/validates_email_format_of/test/test_helper.rb",
+     "spec_or_test/vendor/validates_email_format_of/test/validates_email_format_of_test.rb",
+     "tasks/sample_models_tasks.rake",
+     "test/test_sample_models.rb",
+     "uninstall.rb",
+     "vendor/ar_query/MIT-LICENSE",
+     "vendor/ar_query/README",
+     "vendor/ar_query/ar_query.gemspec",
+     "vendor/ar_query/init.rb",
+     "vendor/ar_query/install.rb",
+     "vendor/ar_query/lib/ar_query.rb",
+     "vendor/ar_query/spec/ar_query_spec.rb",
+     "vendor/ar_query/tasks/ar_query_tasks.rake",
+     "vendor/ar_query/uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/fhwang/sample_models}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A library for making it extremely fast for Rails developers to set up and save ActiveRecord instances when writing test cases}
+  s.test_files = [
+    "spec/sample_models_spec.rb",
+     "test/test_sample_models.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/sample_models_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + "/../spec_or_test/setup"
+require 'test/unit/assertions'
+
+class Spec::Example::ExampleGroup
+  include Test::Unit::Assertions
+end
+
+initialize_db
+
+require File.dirname(__FILE__) + "/../spec_or_test/specs_or_test_cases"
+

data/spec_or_test/database.yml

@@ -0,0 +1,7 @@
+mysql:
+  adapter: mysql
+  host: localhost
+  username: test
+  password: test
+  database: sample_models_test
+