sample_models 1.2.6 → 2.0.0

data/Gemfile

@@ -1,13 +1,8 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
 gem 'activerecord', ENV['ACTIVE_RECORD_VERSION']
 gem "activesupport", ENV['ACTIVE_RECORD_VERSION']
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.0"
@@ -15,5 +10,10 @@ end
 
 group :test do
   gem 'sqlite3'
-  gem "validates_email_format_of"
+  version_str = if ENV['ACTIVE_RECORD_VERSION'] =~ /^3\./
+    "~> 1.5.0"
+  else
+    "~> 1.4.0"
+  end
+  gem "validates_email_format_of", version_str
 end

data/Gemfile.lock

@@ -1,25 +1,40 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activerecord (2.3.10)
-      activesupport (= 2.3.10)
-    activesupport (2.3.10)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.0)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    multi_json (1.0.3)
     rake (0.8.7)
     sqlite3 (1.3.4)
-    validates_email_format_of (1.4.5)
+    tzinfo (0.3.29)
+    validates_email_format_of (1.5.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 2.3.10)
-  activesupport (= 2.3.10)
+  activerecord (= 3.1.0)
+  activesupport (= 3.1.0)
   bundler (~> 1.0.0)
   jeweler (~> 1.6.0)
   sqlite3
-  validates_email_format_of
+  validates_email_format_of (~> 1.5.0)

data/README.markdown

@@ -8,7 +8,7 @@ A library for making it extremely fast for Rails developers to set up and save A
 * give you a rich set of features so you can specify associations as concisely as possible
 * do this with as little configuration as possible
 
-Feature overview
+Overview
 ================
 
 Let's say you've got a set of models that look like this:
@@ -69,6 +69,11 @@ You can specify associated records in the sample call:
     sad = Tag.sample(:tag => 'sad')
     funny_yet_sad = BlogPost.sample(:tags => [funny, sad])
     
+You can also specify associated records by passing them in at the beginning of the argument list, if there's only one association that would work with the record's class:
+
+    jane = User.sample(:first_name => 'Jane')
+    BlogPost.sample(jane, :title => 'What I ate for lunch')
+    
 You can also specify associated records by passing in hashes or arrays:
 
     bills_post2 = BlogPost.sample(:user => {:first_name => 'Bill'})
@@ -78,11 +83,6 @@ You can also specify associated records by passing in hashes or arrays:
       :tags => [{:tag => 'funny'}, {:tag => 'sad'}]
     )
     puts funny_yet_sad2.tags.size     # => 2
-    
-You can also specify associated records by passing them in at the beginning of the argument list, if there's only one association that would work with the record's class:
-
-    jane = User.sample(:first_name => 'Jane')
-    BlogPost.sample(jane, :title => 'What I ate for lunch')
 
 Instance attributes
 =========================
@@ -94,12 +94,12 @@ SampleModels reads your validations to get hints about how to craft an instance
 validates_email_format_of
 -------------------------
 
-If you use the validates_email_format_of plugin at [http://github.com/alexdunae/validates_email_format_of](http://github.com/alexdunae/validates_email_format_of), SampleModels will ensure that the attribute in question is a valid email address.
+If you use the [validates_email_format_of gem](http://rubygems.org/gems/validates_email_format_of), SampleModels will ensure that the attribute in question is a valid email address.
 
 validates_presence_of
 ---------------------
 
-SampleModels already sets values to be non-blank, but this validation comes in handy if you have an `attr_accessor`:
+SampleModels already sets database columns to be non-blank, but this validation comes in handy if you have an `attr_accessor`:
 
     class UserWithPassword < ActiveRecord::Base
       attr_accessor :password
@@ -123,35 +123,6 @@ validates_uniqueness_of
 SampleModels will ensure that new instances will have different values for attributes where uniqueness is required, as discussed below under "New records vs. old records."
 
 
-New records vs. old records
-===========================
-
-Most of the time, consecutive calls to `sample` will return the same record, because this is marginally faster, and the design assumption is that if you're calling `sample` you don't care which instance you get as long as it satisfies the attributes you specified.
-
-    user1 = User.sample
-    user2 = User.sample
-    puts (user1 == user2)   # probably true
-    
-    rick1 = User.sample(:first_name => 'Rick')
-    puts (user1 == rick1)   # probably false, but you never know
-    
-    rick2 = User.sample(:first_name => 'Rick')
-    puts (rick1 == rick2)   # probably true
-    
-If having a distinct record is important to the test, you should call `create_sample`, which always saves a new record in the DB and returns it.
-
-    blog_post1 = BlogPost.sample
-    blog_post2 = BlogPost.create_sample
-    puts (blog_post1 == blog_post2)   # will always be false
-
-If the class validates the uniqueness of a field, that field will always be distinct for every new instance returned by `create_sample`.
-
-    tag1 = Tag.sample
-    tag2 = Tag.create_sample
-    puts (tag1 == tag2)           # will always be false
-    puts (tag1.tag == tag2.tag)   # will always be false, because Tag validates
-                                  # the uniqueness of the `tag` attribute
-
 Associations
 ============
 
@@ -170,7 +141,7 @@ You can also specify these associations as if you were calling `new` or `create!
     BlogPost.sample(:user => kelley)
     BlogPost.sample(:user_id => kelley.id)
 
-If you want, you can simply specify the record at the beginning of the argument list for `sample` or `create_sample`, and SampleModels will assign them to the appropriate association, as long as there's only one association that fits the class.
+If you want, you can simply specify the record at the beginning of the argument list for `sample`, and SampleModels will assign them to the appropriate association, as long as there's only one association that fits the class.
 
     kim = User.sample(:first_name => 'Kim')
     BlogPost.sample(kim, :title => 'funny')
@@ -201,8 +172,8 @@ If you want, you can simply specify the important attributes of the associated v
 You can combine the two syntaxes in deeper associations:
 
     bb_episode = Video.sample(:show => [amc, {:name => 'Breaking Bad'}])
-    puts bb_episode.show.network.name  # => 'AMC'
-    puts bb_episode.show.name     # => 'Breaking Bad'
+    puts bb_episode.show.network.name   # => 'AMC'
+    puts bb_episode.show.name           # => 'Breaking Bad'
 
 Polymorphic belongs-to associations
 -----------------------------------
@@ -277,7 +248,7 @@ With `before_save` you can specify a block that runs before the record is saved.
       end
     end
 
-You can also take a second argument, which will pass in the hash that was used during the call to `sample` or `create_sample`.
+You can also take a second argument, which will pass in the hash that was used during the call to `sample`.
 
     SampleModels.configure(Appointment) do |appt|
       appt.before_save do |appt_record, sample_attrs|
@@ -330,7 +301,7 @@ Named samples can be used to pre-set values for commonly used combinations of at
     bp1 = BlogPost.sample(:funny)
     puts bp1.title   # => 'Laugh already'
 
-    bp2 = BlogPost.create_sample(:funny)
+    bp2 = BlogPost.sample(:funny)
     puts bp2.title      # => 'Laugh already'
     puts (bp1 == bp2)   # => false
     
@@ -338,6 +309,14 @@ You can override individual attributes, as well:
 
     bp3 = BlogPost.sample(:funny, :average_rating => 4.0)
     puts bp3.average_rating   # => 4.0
+    
+Backwards-incompatible changes in SampleModels 2
+================================================
+
+`sample` always creates a new record now. This is a change from SampleModels 1, which would first attempt to find an existing record in the database that satisfied the stated attributes. In practice, that ended up making tests too confusing.
+
+`create_sample` and `sample` now do the same thing, and `create_sample` is deprecated.
+
 
 About
 =====

data/Rakefile

@@ -3,28 +3,24 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rubygems'
 
-ActiveRecordVersions = %w(3.1.1 3.0.1 2.3.10)
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/unit/*_test.rb']
+  t.verbose = true
+end
+
+ActiveRecordVersions = %w(3.1.1 3.0.10 2.3.14)
 
-desc "Run all tests"
-task :test do
+desc "Run all tests, for all tested versions of ActiveRecord"
+task :all_tests do
   ActiveRecordVersions.each do |ar_version|
-    cmd = "ACTIVE_RECORD_VERSION=#{ar_version} ruby test/test_sample_models.rb"
+    cmd = "ACTIVE_RECORD_VERSION=#{ar_version} rake test"
     puts cmd
     puts `cd . && #{cmd}`
     puts
   end
 end
 
-task :default => :test
-
-desc 'Generate documentation for the sample_models plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SampleModels'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :all_tests
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|

data/VERSION

@@ -1 +1 @@
-1.2.6
+2.0.0

data/lib/sample_models/attribute_sequence.rb

@@ -0,0 +1,182 @@
+module SampleModels
+  class AttributeSequence
+    def self.build(*args)
+      Builder.new(*args).run
+    end
+    
+    def initialize(model, column, validation, input)
+      @model, @column, @validation, @input = model, column, validation, input
+      @number = 0
+    end
+    
+    def belongs_to_association
+      @model.belongs_to_associations.detect { |a|
+        a.foreign_key == @column.name
+      }
+    end
+    
+    def next
+      @number += 1
+      @input.next if @input
+      value
+    end
+    
+    def value
+      case @column.type
+        when :string, :text
+          "#{@column.name} #{@number}"
+        when :integer
+          belongs_to_association ? belongs_to_assoc_foreign_key_value : @number
+        when :datetime
+          Time.now.utc - @number.minutes
+        when :date
+          Date.today - @number
+        when :float
+          @number.to_f
+        end
+    end
+    
+    class Builder
+      def initialize(pass, model, column, force_unique)
+        @pass, @model, @column, @force_unique =
+          pass, model, column, force_unique
+      end
+      
+      def base
+        base_class = SampleModels.const_get(
+          "#{@pass.to_s.capitalize}PassBaseAttributeSequence"
+        )
+        base_class.new(@model, @column)
+      end
+  
+      def run
+        input = base
+        uniqueness_validation = if @force_unique
+          Model::Validation.new(:validates_uniqueness_of)
+        end
+        @model.validations(@column.name).each do |validation|
+          if validation.type == :validates_uniqueness_of
+            uniqueness_validation = validation
+          elsif s_class = sequence_class(validation)
+            input = s_class.new(@model, @column, validation, input)
+          end
+        end
+        if uniqueness_validation
+          input = ValidatesUniquenessOfAttributeSequence.new(
+            @model, @column, uniqueness_validation, input
+          )
+        end
+        input
+      end
+      
+      def sequence_class(validation)
+        sequence_name = validation.type.to_s.camelize + 'AttributeSequence'
+        if SampleModels.const_defined?(sequence_name)
+          SampleModels.const_get(sequence_name)
+        end
+      end
+    end
+  end
+  
+  class FirstPassBaseAttributeSequence < AttributeSequence
+    def initialize(model, column)
+      super(model, column, nil, nil)
+    end
+    
+    def belongs_to_assoc_foreign_key_value
+      nil
+    end
+  end
+  
+  class SecondPassBaseAttributeSequence < AttributeSequence
+    def initialize(model, column)
+      super(model, column, nil, nil)
+      @previous_values = {}
+    end
+    
+    def belongs_assoc_value_already_used?(record)
+      @previous_values.any? { |prev_num, prev_record|
+        prev_record == record && prev_num != @number
+      }
+    end
+    
+    def belongs_to_assoc_foreign_key_value
+      assoc_klass = belongs_to_association.klass
+      unless assoc_klass == @model.ar_class
+        record = (assoc_klass.last || assoc_klass.sample)
+        while belongs_assoc_value_already_used?(record)
+          record = assoc_klass.sample
+        end
+        @previous_values[@number] = record
+        record.id
+      end
+    end
+  end
+  
+  class ValidatesEmailFormatOfAttributeSequence < AttributeSequence
+    def value
+      "john.doe.#{@number}@example.com"
+    end
+  end
+  
+  class ValidatesInclusionOfAttributeSequence < AttributeSequence
+    def value
+      @validation.config[:in].first
+    end
+  end
+  
+  class ValidatesPresenceOfAttributeSequence < AttributeSequence
+    def belongs_to_value
+      @previous_belongs_to_instances ||= {}
+      if @previous_belongs_to_instances[@number]
+        value = @previous_belongs_to_instances[@number]
+        begin
+          value.reload
+          value.id
+        rescue ActiveRecord::RecordNotFound
+          set_belongs_to_instance
+          @previous_belongs_to_instances[@number].id
+        end
+      else
+        set_belongs_to_instance
+        @previous_belongs_to_instances[@number].id
+      end
+    end
+    
+    def existing_instance_not_previously_returned
+      previous_ids = @previous_belongs_to_instances.values.map(&:id)
+      instance = nil
+      if previous_ids.empty?
+        belongs_to_association.klass.last
+      else
+        belongs_to_association.klass.last(
+          :conditions => ["id not in (?)", previous_ids]
+        )
+      end
+    end
+    
+    def set_belongs_to_instance
+      instance = existing_instance_not_previously_returned
+      instance ||= belongs_to_association.klass.sample
+      @previous_belongs_to_instances[@number] = instance
+    end
+    
+    def value
+      belongs_to_association ? belongs_to_value : super
+    end
+  end
+  
+  class ValidatesUniquenessOfAttributeSequence < AttributeSequence
+    def value
+      v = @input.value
+      unless @validation.config[:allow_nil] && v.nil?
+        unless @validation.config[:allow_blank] && v.blank?
+          until @model.unique?(@column.name, v)
+            v = @input.next
+          end
+        end
+      end
+      v
+    end
+  end
+end