Fingertips-as_new-san 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2008 Fingertips, Eloy Duran <eloy.de.enige@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,6 @@
+= AsNewSan
+
+A simple plugin which allows you to create records in the database, but treat
+them as if they were new records.
+
+See AsNewSan for documentation and an example.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/as_new_san.rb

@@ -0,0 +1,120 @@
+# 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.
+#
+# An Active Record class using this mixin needs to have an +as_new+ boolean
+# column with the default value set to +false+ and a +created_at+ column.
+#
+# See AsNewSan::ClassMethods for documentation on the class methods added to
+# ActiveRecord::Base.
+#
+# Example:
+#
+#   class CreateMessages < ActiveRecord::Migration
+#     def self.up
+#       create_table :messages do |t|
+#         t.string :body
+#         t.boolean :as_new, :default => false
+#         t.timestamps
+#       end
+#     end
+#   end
+#   
+#   class CreateRecipients < ActiveRecord::Migration
+#     def self.up
+#       create_table :recipient do |t|
+#         t.integer :message_id
+#         t.string :name
+#       end
+#     end
+#   end
+#
+#   class Message < ActiveRecord::Base
+#     include AsNewSan
+#     has_many :recipients, :dependent => :destroy
+#   end
+#   
+#   class Recipient < ActiveRecord::Base
+#     belongs_to :message
+#   end
+#   
+#   class MessagesController < ApplicationController
+#     def index
+#       # 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)
+#     end
+#     
+#     def new
+#      # Create and save a message with the `as_new` property set to `true`.
+#      # 
+#      # Recipients are created and associated using Ajax calls on the recipients controller.
+#      @message = Message.as_new
+#     end
+#     
+#     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.update_attributes(params[:message])
+#
+#       # So, at this point the record is not marked `as_new` anymore.
+#     end
+#   end
+module AsNewSan
+  def self.included(base) #:nodoc:
+    base.extend(ClassMethods)
+    base.before_update(:unset_as_new)
+  end
+  
+  module ClassMethods
+    # Instantiates a new object, sets the as_new column to +true+ and saves the
+    # associated record without validation.
+    #
+    # If the record is never updated, or its as_new property explicitely set to
+    # +false+, it will be destroyed after 1 week when the collect_garbage!
+    # class method is called.
+    #
+    # See <tt>ActiveRecord::Base.new</tt> for all the other options that can be
+    # passed to as_new.
+    def as_new(attributes = {})
+      returning( new(attributes.merge( :as_new => true )) ) { |record| record.save(false) }
+    end
+    
+    # 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)
+    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)
+      end
+    end
+  end
+  
+  # Returns a boolean indicating whether or not this is a +as_new+ record.
+  def as_new_record?
+    self.as_new
+  end
+  
+  private
+  
+  def unset_as_new
+    self.as_new = false
+    true
+  end
+end

data/test/as_new_san_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe "AsNewSan" 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
+  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)
+  end
+  
+  it "should be possible to do a `find` without matching any `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]
+  end
+  
+  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
+end

data/test/test_helper.rb

@@ -0,0 +1,50 @@
+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'))
+
+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
+      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)
+    end
+  end
+end
+
+Test::Spec::Should.send(:include, Test::Spec::Rails::ShouldDiffer)

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: Fingertips-as_new-san
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eloy Duran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 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.
+email: eloy.de.enige@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/as_new_san.rb
+- test/as_new_san_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/alloy/as_new_san
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple plugin which allows you to create records in the database, but treat them as if they were new records.
+test_files: []
+