alvarobp-inverse_sortable 0.1.0

data/Manifest

@@ -0,0 +1,11 @@
+benchmark/benchmark.rb
+benchmark/schema.rb
+init.rb
+lib/inverse_sortable.rb
+Manifest
+Rakefile
+README.rdoc
+test/inverse_sortable_test.rb
+test/schema.rb
+test/test_helper.rb
+TODO

data/README.rdoc

@@ -0,0 +1,33 @@
+= inverse_sortable
+
+Sets negative timestamps on Active Record models for efficiently sort in reverse order.
+
+== Install
+
+  sudo gem install alvarobp-inverse_sortable --source http://gems.github.com
+
+Add to environment.rb:
+
+  config.gem "alvarobp-inverse_sortable", :lib => "inverse_sortable"
+
+== Usage
+
+As a very simple plugin, using it is simple. Just add an integer attribute called "created_at_inverse" to your model. Afterwards you can make that model inverse sortable, for example:
+
+  class Film < ActiveRecord::Base
+    acts_as_inverse_sortable
+  end
+
+Therefore, you can get an inverse sorted array of Films with Film.find(:all, :order => 'created_at_inverse') working on an efficient way.
+
+== Test
+
+Just do
+
+  rake test
+  
+== Benchmarks
+
+I ran some benchmarks to see how efficient is this method. Well, most of the times benchmarks showed that this method is more efficient than "ORDER BY created_at DESC" as the table grows.
+
+Just in case you want to run these benchmarks, you will need a mysql database (maybe other engines as well) and configure it at the top of benchmark/benchmark.rb file.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('inverse_sortable', '0.1.0') do |p|
+  p.description     = "Sets negative timestamps on Active Record models for efficiently sort in reverse order."
+  p.url             = "http://github.com/alvarobp/inverse_sortable"
+  p.author          = "Alvaro Bautista Pino"
+  p.email           = "alvarobp@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/TODO

@@ -0,0 +1 @@
+- Go deep in the fact that in Rails 2.3 on before_create record attributes information is not available.

data/benchmark/benchmark.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+    :adapter => "mysql",
+    :database => "testing_dates",
+    :username => "root",
+    :password => "",
+    :host => "localhost"
+})
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+class WithCreatedModel < ActiveRecord::Base
+end
+
+def add_rows(ntimes)
+  tdate = Time.now-100.days
+  ntimes.times do |n|
+    wcm = WithCreatedModel.create(:something => "Model #{n}")
+    tdate += (rand(5)+1).days
+    wcm.update_attribute(:created_at, tdate)
+  end
+end
+
+def do_benchmark
+  Benchmark.bm(10) do |x|
+    x.report("normal") {WithCreatedModel.find(:all, :order => "created_at DESC")}
+    x.report("inverse") {WithCreatedModel.find(:all, :order => "created_at_inverse")}
+  end
+end
+
+puts
+puts
+puts "-- Benchmark for 5000 rows --"
+puts
+
+add_rows(5000)
+do_benchmark
+
+puts
+puts
+puts "-- Benchmark for 10000 rows --"
+puts
+
+add_rows(5000)
+do_benchmark
+
+puts
+puts
+puts "-- Benchmark for 15000 rows --"
+puts
+
+add_rows(5000)
+do_benchmark
+
+puts
+puts
+puts "-- Benchmark for 20000 rows --"
+puts
+
+add_rows(5000)
+do_benchmark

data/benchmark/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 0) do
+  begin
+    drop_table :with_created_models
+  rescue
+  end
+  
+  create_table :with_created_models, :force => true do |t|
+    t.column :something, :string    
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime    
+    t.column :created_at_inverse, :integer
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'inverse_sortable'

data/lib/inverse_sortable.rb

@@ -0,0 +1,34 @@
+module InverseSortable  
+  def self.included(base)
+    super
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods  
+    def acts_as_inverse_sortable    
+      include InverseSortable::InstanceMethods
+    end
+  end
+    
+  module InstanceMethods        
+    def set_created_at_inverse
+      self.update_attribute(:created_at_inverse, -self.created_at.to_i)
+    end
+    
+    def set_updated_at_inverse
+      self.updated_at_inverse = -Time.now.to_i
+    end
+    
+    def after_create
+      set_created_at_inverse if self.respond_to?(:created_at_inverse)
+      super
+    end    
+    
+    def before_save
+      set_updated_at_inverse if self.respond_to?(:updated_at_inverse)
+      super
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, InverseSortable

data/test/inverse_sortable_test.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class WithCreatedModel
+  acts_as_inverse_sortable
+end
+
+class WithUpdatedModel
+  acts_as_inverse_sortable
+end
+
+class WithBothModel
+  acts_as_inverse_sortable
+end
+
+class ActsAsInverseSortableTest < Test::Unit::TestCase
+  context "A model that acts as an inverse sortable" do    
+    should "have the inverse of its created_at time when is created if created_at_inverse is available" do
+      with_created = WithCreatedModel.create(:something => "Testing")
+      
+      assert_not_nil with_created.created_at_inverse
+      assert_equal -with_created.created_at.to_i, with_created.created_at_inverse
+    end
+    
+    should "have the inverse of its updated_at time when is created if updated_at_inverse is available" do
+      with_updated = WithUpdatedModel.create(:something => "Testing")
+      
+      assert_not_nil with_updated.updated_at_inverse
+      assert_equal -with_updated.updated_at.to_i, with_updated.updated_at_inverse
+    end
+    
+    should "update its updated_at_inverse value at update" do      
+      with_updated = WithUpdatedModel.create(:something => "Testing")      
+      before_updated = with_updated.updated_at_inverse
+      sleep 1
+      with_updated.update_attribute(:something, "Testing update")      
+
+      assert with_updated.updated_at_inverse < before_updated
+    end
+  end
+end

data/test/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :with_created_models, :force => true do |t|
+    t.column :something, :string    
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime    
+    t.column :created_at_inverse, :integer
+  end
+  
+  add_index :with_created_models, :created_at_inverse
+  
+  create_table :with_updated_models, :force => true do |t|
+    t.column :something, :string    
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime    
+    t.column :updated_at_inverse, :integer
+  end
+  
+  create_table :with_both_models, :force => true do |t|
+    t.column :something, :string    
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime    
+    t.column :created_at_inverse, :integer
+    t.column :updated_at_inverse, :integer
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+#$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+
+require 'rubygems'
+require 'active_record'
+require 'shoulda'
+
+require File.dirname(__FILE__) + '/../lib/inverse_sortable'
+
+ActiveRecord::Base.establish_connection({
+    :adapter => "sqlite3",
+    :dbfile => "test/test.db"
+})
+
+class WithCreatedModel < ActiveRecord::Base
+end
+
+class WithUpdatedModel < ActiveRecord::Base
+end
+
+class WithBothModel < ActiveRecord::Base
+end
+
+load(File.dirname(__FILE__) + "/schema.rb")

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: alvarobp-inverse_sortable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alvaro Bautista Pino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Sets negative timestamps on Active Record models for efficiently sort in reverse order.
+email: alvarobp@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/inverse_sortable.rb
+- README.rdoc
+- TODO
+files: 
+- benchmark/benchmark.rb
+- benchmark/schema.rb
+- init.rb
+- lib/inverse_sortable.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- test/inverse_sortable_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/alvarobp/inverse_sortable
+post_install_message: 
+rdoc_options: []
+
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: inverse_sortable
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Sets negative timestamps on Active Record models for efficiently sort in reverse order.
+test_files: 
+- test/inverse_sortable_test.rb
+- test/test_helper.rb