transient 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,9 @@
+= 1.0.1 2009-12-29
+
+* Added call back to populate effective_at with DateTime.now if it is not explicitly set to something else.
+* Added presence validation to effective_at.
+
+
 = 1.0.0 2009-12-26
 
 * Initial release  Ported from another project.

data/README.rdoc

@@ -13,6 +13,9 @@ Provides an API for making any ActiveRecord object transient.
 * Convenience methods for transient objects, ie. current?, expired?, expire!, etc.
 * Callbacks for expiring current 'active' record prior to creating new one where certain configured fields 
   match.  See the Transient::ActiveRecordExtensions::InstanceMethods docs for more information.
+* A callback to populate the expiring at field of a new record with DateTime.now unless a value was explicitly 
+  specified for the effective at field.
+* Automatically adds a presence validation for effective_at to the model.
 
 
 == REQUIREMENTS
@@ -31,7 +34,7 @@ Provides an API for making any ActiveRecord object transient.
 
 Add to environment file:
 
-  config.gem "transient", :version => '1.0.0', :source => 'http://gemcutter.org'
+  config.gem "transient", :version => '1.0.1', :source => 'http://gemcutter.org'
 
 Run:
 
@@ -40,6 +43,13 @@ Run:
 
 == USAGE
 
+Add the transient fields to your model:
+
+  def self.up
+    add_column :users, :effective_at, :datetime, :null => false
+    add_column :users, :expiring_at, :datetime
+  end
+
 Call the macro from your ActiveRecord descendant class:
 
   class User < ActiveRecord::Base

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/transient.rb

@@ -4,7 +4,7 @@ require 'date_time_extensions'
 require 'transient/active_record_extensions'
 
 module Transient
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end
 
 ActiveRecord::Base.send( :include, Transient::ActiveRecordExtensions ) if defined?( ActiveRecord::Base )

data/lib/transient/active_record_extensions.rb

@@ -21,16 +21,21 @@ module Transient
     end
 
     module InstanceMethods
-      def self.included( includee ) #:nodoc:
-        #includee.validates_presence_of :effective_at
-        #includee.validates_presence_of :expiring_at
+      def self.included( base ) #:nodoc:
+        base.validates_presence_of :effective_at
+        #base.validates_presence_of :expiring_at
 
-        #includee.default(:effective_at) { DateTime.beginning_of }
-        #includee.default(:expiring_at) { DateTime.end_of }
-
-        includee.named_scope :current, lambda { { :conditions => ["effective_at <= ? AND (expiring_at IS NULL OR expiring_at > ?)",
+        base.named_scope :effective, lambda { { :conditions => ["effective_at <= ? AND (expiring_at IS NULL OR expiring_at > ?)",
                                                                   DateTime.now.utc, DateTime.now.utc] } }
 
+        base.before_validation_on_create :check_and_set_effective_at
+
+        protected
+        
+        def check_and_set_effective_at
+          self[:effective_at] = DateTime.now if self[:effective_at].nil?
+        end
+        
         public
 
         # Validates this record's effective dates occur in correct sequence (ie. effective_at is before 
@@ -46,18 +51,11 @@ module Transient
           super
         end
 
-        # The date this record becomes effective.  Returns DateTime.beginning_of for records that have a 
-        # nil value in the database.
-        #
-        def effective_at
-          return self[:effective_at].blank? ? DateTime.beginning_of : self[:effective_at]
-        end
-
         # The date this record expires.  Returns DateTime.end_of for records that have a 
         # nil value in the database.
         #
         def expiring_at
-          return self[:expiring_at].blank? ? DateTime.end_of : self[:expiring_at]
+          return self[:expiring_at].nil? ? DateTime.end_of : self[:expiring_at]
         end
 
         # The range this record is effective wihtin.
@@ -122,8 +120,8 @@ module Transient
     end
 
     module SingleActive
-      def self.included( includee ) #:nodoc:
-        includee.before_create :expire_current_active
+      def self.included( base ) #:nodoc:
+        base.before_create :expire_current_active
         
         private
         
@@ -137,7 +135,7 @@ module Transient
           
           conditions = {}
           self.transient_options[:single_active].each { |attr| conditions.merge!( attr.to_sym => attributes[attr] ) }
-          old = self.class.current.find( :first, :conditions => conditions )
+          old = self.class.effective.first( :conditions => conditions )
           old.expire! unless old.nil?
         end
       end

data/spec/transient_shared_spec.rb

@@ -54,10 +54,23 @@ shared_examples_for "Any transient" do
     @instance.should_not be_past
     @instance.should be_future
   end
+  
+  it "should respond to :effective" do
+    @klass.respond_to?( :effective ).should be_true
+  end
 
   it "should invoke callbacks around expire!" do
     @instance.should_receive(:before_expire!)
     @instance.should_receive(:after_expire!)
     @instance.expire!
   end
+  
+  it "should set effective_at to now if it was not explicitly set to something else" do
+     @instance_no_dates.effective_at.should_not be_nil
+  end
+  
+  it "should not allow records without an effective_at date to be saved" do
+     @instance_no_dates.effective_at = nil
+     @instance_no_dates.save.should be_false
+  end
 end

data/spec/transient_spec.rb

@@ -12,8 +12,9 @@ describe "Transient" do
   describe "having models descending from ActiveRecord" do
     describe "that are not single active" do
       before(:each) do
-        @instance = User.new( :name => 'John Smith', :effective_at => (DateTime.now - 1.days), :expiring_at => DateTime.end_of )
-        @instance.save!
+        @klass = User
+        @instance = @klass.create( :name => 'John Smith', :effective_at => (DateTime.now - 1.days), :expiring_at => DateTime.end_of )
+        @instance_no_dates = @klass.create( :name => 'Jack Smith' )
       end
 
       it_should_behave_like "Any transient"
@@ -30,34 +31,32 @@ describe "Transient" do
     describe "that are single active" do
       before(:each) do
         @klass = ContactNumber
-        @instance = @klass.new( :number => '012345678901', :location => 'home', :effective_at => (DateTime.now - 1.days) )
-        @instance.save!
+        @instance = @klass.create( :number => '012345678901', :location => 'home', :effective_at => (DateTime.now - 1.days) )
+        @instance_no_dates = @klass.create( :number => '012345678901', :location => 'home' )
       end
 
       it_should_behave_like "Any transient"
       it_should_behave_like "Any transient that is single active"      
 
       it "should expire the current active before saving a new one" do
-        @new_contact = ContactNumber.new( :number => '019876543210', :location => 'home', :effective_at => DateTime.now )
-        @new_contact.save!
+        @new_contact = ContactNumber.create( :number => '019876543210', :location => 'home', :effective_at => DateTime.now )
         @instance.reload
         @instance.expired?.should be_true
       end
     end
     
     describe "that are single active with check exists" do
-      before(:each) do
+      before :each do
         @klass = Address
-        @instance = @klass.new( :street => '26 street', :location => 'home', :effective_at => (DateTime.now - 1.days) )
-        @instance.save!
+        @instance = @klass.create( :street => '26 street', :location => 'home', :effective_at => (DateTime.now - 1.days) )
+        @instance_no_dates = @klass.create( :street => '26 street', :location => 'home' )
       end
 
       it_should_behave_like "Any transient"
       it_should_behave_like "Any transient that is single active"
 
       it "should expire the current active before saving a new one" do
-        @new_address = Address.new( :street => '27 street', :location => 'home', :effective_at => DateTime.now )
-        @new_address.save!
+        @new_address = Address.create( :street => '27 street', :location => 'home', :effective_at => DateTime.now )
         @instance.reload
         @instance.expired?.should be_true
       end

data/transient.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{transient}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["C. Jason Harrelson (midas)"]
-  s.date = %q{2009-12-27}
+  s.date = %q{2009-12-29}
   s.description = %q{Provides an API for making any ActiveRecord object transient.  In addition, provides functionality for models where only a single instance of the model can be current at one time.}
   s.email = %q{jason@lookforwardenterprises.com}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: transient
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - C. Jason Harrelson (midas)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-27 00:00:00 -06:00
+date: 2009-12-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency