Fingertips-as_new-san 0.1.1 → 0.2

data/as_new-san.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{as_new-san}
-  s.version = "0.1.1"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eloy Duran"]
-  s.date = %q{2009-03-09}
+  s.date = %q{2009-07-15}
   s.description = %q{The AsNewSan mixin makes it easier to create associations on a new Active Record instance.  Use the as_new method to instantiate new empty objects that are immediately saved to the database with a special flag marking them as new. Because new instances are already stored in the database, you always have an id available for creating associations. This means you can use the same views and controller logic for new and edit actions which is especially helpful when you are creating new associated objects using Ajax calls.}
   s.email = %q{eloy.de.enige@gmail.com}
   s.extra_rdoc_files = ["README.rdoc", "LICENSE"]

data/lib/as_new_san.rb

@@ -49,10 +49,22 @@
 #       # Remove all records older than 1 week that have the `as_new` property set to `true`.
 #       Message.collect_garbage!
 #       
-#       # The mixin comes with the `find_without_as_new` class method, which behaves as the 
-#       # ActiveRecord::Base#find class method, but only finds records which have their 
-#       # `as_new` property set to `false`.
-#       @messages = Message.find_without_as_new(:all)
+#       # The mixin adds an `exclude_as_new` named_scope and makes `#find` and `#count` use it
+#       # out of the box.
+#       @messages = Message.find(:all)  # finds only records that have `as_new` set to `false`
+#       @messages = Message.count(:all) # counts only records that have `as_new` set to `false`
+#
+#       # If you need to find or count all records, even the ones with `as_new` set to `true`,
+#       # the mixin also comes with the `find_including_new_records` and `count_including_new_records`
+#       # class methods, which behave the same as ActiveRecord::Base#find and ActiveRecord::Base.count.
+#       @messages = Message.find_including_new_records(:all)  # finds all records
+#       @messages = Message.count_including_new_records(:all) # counts all records
+#
+#       # If you need to reload a record that has beed created with `as_new`, `reload` won't work.
+#       # You need to use `#find_including_new_records`.
+#       @message = Message.as_new
+#       @message.reload            # => ActiveRecord::RecordNotFound
+#       @message = Message.find_including_new_records(@message.id)
 #     end
 #     
 #     def new
@@ -65,7 +77,7 @@
 #     def update
 #       # The mixin comes with a `before_update` filter that sets the `as_new` column to 
 #       # `false` before saving the updated record.
-#       @message = Message.find(params[:id])
+#       @message = Message.find_including_new_records(params[:id])
 #       @message.update_attributes(params[:message])
 #
 #       # So, at this point the record is not marked `as_new` anymore.
@@ -73,8 +85,9 @@
 #   end
 module AsNewSan
   def self.included(base) #:nodoc:
-    base.extend(ClassMethods)
     base.before_update(:unset_as_new)
+    base.named_scope :exclude_as_new, { :conditions => { :as_new => false } }
+    base.extend(ClassMethods)
   end
   
   module ClassMethods
@@ -94,14 +107,28 @@ module AsNewSan
     # Finds and destroys all the records where the as_new column is set to
     # +true+ and +created_at+ is longer than 1 week ago.
     def collect_garbage!
-      find(:all, :conditions => ['as_new = ? AND created_at < ?', true, Time.now - 1.week]).each(&:destroy)
+      find_including_new_records(:all, :conditions => ['as_new = ? AND created_at < ?', true, Time.now - 1.week]).each(&:destroy)
     end
     
     # Works the same as <tt>ActiveRecord::Base.find</tt> but only returns
     # records for which the as_new column is set to +false+.
-    def find_without_as_new(*args)
-      with_scope(:find => { :conditions => { :as_new => false } }) do
-        find(*args)
+    def find_excluding_new_records(*args)
+      exclude_as_new.find_including_new_records(*args)
+    end
+    
+    # Works the same as <tt>ActiveRecord::Base.count</tt> but only returns
+    # records for which the as_new column is set to +false+.
+    def count_excluding_new_records(*args)
+      exclude_as_new.count_including_new_records(*args)
+    end
+    
+    def self.extended(klass)
+      class << klass
+        alias_method :find_including_new_records, :find
+        alias_method :find, :find_excluding_new_records
+        
+        alias_method :count_including_new_records, :count
+        alias_method :count, :count_excluding_new_records
       end
     end
   end
@@ -117,4 +144,4 @@ module AsNewSan
     self.as_new = false
     true
   end
-end
+end

data/test/as_new_san_test.rb

@@ -1,32 +1,37 @@
 require File.expand_path('../test_helper', __FILE__)
 
-describe "AsNewSan" do
+describe "AsNewSan", ActiveRecord::TestCase do
   include DBSetupAndTeardownHelper
   
-  it "should really create a record for a `new` object with `as_new` set to `true`" do
-    lambda { BaconFlavour.as_new(:name => 'chunky') }.should.differ('BaconFlavour.count', +1)
-    BaconFlavour.find_by_name('chunky').as_new.should.be true
+  it "should really create a record for a `new' object with `as_new' set to `true'" do
+    assert_difference('BaconFlavour.count_including_new_records', +1) { BaconFlavour.as_new(:name => 'chunky') }
+    BaconFlavour.find_including_new_records(:first, :conditions => { :name => 'chunky' }).as_new.should.be true
   end
   
   it "should garbage collect any record which has been in the db for a specific period" do
     old_record = BaconFlavour.as_new(:name => 'banana', :created_at => (Time.now - 1.week - 1))
     new_record = BaconFlavour.as_new(:name => 'smoked')
     
-    lambda { BaconFlavour.collect_garbage! }.should.differ('BaconFlavour.count', -1)
+    assert_difference('BaconFlavour.count_including_new_records', -1) { BaconFlavour.collect_garbage! }
   end
   
-  it "should be possible to do a `find` without matching any `as_new` records" do
+  it "should be possible to do a `find' including `as_new' records" do
     as_new_record = BaconFlavour.as_new(:name => 'smells as new')
     not_as_new_record = BaconFlavour.create(:name => 'does not smell at all')
     
-    BaconFlavour.find(:all).should == [as_new_record, not_as_new_record]
-    BaconFlavour.find_without_as_new(:all).should == [not_as_new_record]
+    BaconFlavour.find_including_new_records(:all).should == [as_new_record, not_as_new_record]
+    BaconFlavour.find(:all).should == [not_as_new_record]
   end
   
-  it "should set `as_new` records to `false` on update" do
+  it "should set `as_new' records to `false' on update" do
     record = BaconFlavour.as_new(:name => 'ice cream')
     record.as_new_record?.should.be true
     record.update_attribute(:name, 'that is right, bacon ice cream')
     record.as_new_record?.should.be false
   end
+  
+  it "should define a named scope to exclude as_new records" do
+    as_new_record = BaconFlavour.as_new(:name => 'good as new')
+    BaconFlavour.exclude_as_new.find_including_new_records(:first, :conditions => { :name => 'good as new' }).should.be.nil
+  end
 end

data/test/test_helper.rb

@@ -1,50 +1,31 @@
 require "rubygems"
-require "test/unit"
 require "test/spec"
 require 'activerecord'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
+$:.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../rails/init', __FILE__)
 
 module DBSetupAndTeardownHelper
   ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
   ActiveRecord::Migration.verbose = false
   
-  def self.included(base)
-    base.class_eval do
-      before do
-        ActiveRecord::Schema.define(:version => 1) do
-          create_table :bacon_flavours do |t|
-            t.string  :name
-            t.boolean :as_new, :default => false
-            t.timestamps
-          end
-        end
-      end
-      
-      after do
-        ActiveRecord::Base.connection.tables.each do |table|
-          ActiveRecord::Base.connection.drop_table(table)
-        end
+  def setup
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :bacon_flavours do |t|
+        t.string  :name
+        t.boolean :as_new, :default => false
+        t.timestamps
       end
     end
   end
-end
-
-class BaconFlavour < ActiveRecord::Base
-  include AsNewSan
-end
-
-module Test::Spec::Rails
-  module ShouldDiffer
-    def differ(eval_str, diff)
-      before = eval(eval_str)
-      @object.call
-      assert_equal before + diff, eval(eval_str)
+  
+  def teardown
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
     end
   end
 end
 
-Test::Spec::Should.send(:include, Test::Spec::Rails::ShouldDiffer)
+class BaconFlavour < ActiveRecord::Base
+  include AsNewSan
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Fingertips-as_new-san
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: "0.2"
 platform: ruby
 authors: 
 - Eloy Duran
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-09 00:00:00 -07:00
+date: 2009-07-15 00:00:00 -07:00
 default_executable: 
 dependencies: []