resort 0.0.2 → 0.2.0

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 graph.png
 .yardoc/*
 doc/*
+tmp

data/Readme.md

@@ -23,21 +23,10 @@ references a `next` element, which seems a bit more sensible :)
 
 ##Usage
 
-You must add two fields (`next_id` and `first`) to your model's table:
-
-    class AddResortFieldsToProducts < ActiveRecord::Migration
-      def self.up
-        add_column :products, :next_id, :integer
-        add_column :products, :first,   :boolean
-        add_index :products, :next_id
-        add_index :products, :first
-      end
+First, run the migration for the model you want to Resort:
 
-      def self.down
-        remove_column :products, :next_id
-        remove_column :products, :first
-      end
-    end
+    $ rails generate resort:migration product
+    $ rake db:migrate
 
 Then in your Product model:
 
@@ -57,6 +46,15 @@ separate tree of sortable products, you must override the `siblings` method:
         self.product_line.products
       end
     end
+
+### Concurrency
+
+Multiple users modifying the same list at the same time could be a problem, 
+so it's always a good practice to wrap the changes in a transaction:
+    
+    Product.transaction do
+      my_product.append_to(another_product)
+    end
         
 ###API
 

data/lib/generators/active_record/resort_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Resort
+  # Module containing Resort generators
+  module Generators
+
+    # Rails generator to add a migration for Resort
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      # Implement the required interface for `Rails::Generators::Migration`.
+      # Taken from `ActiveRecord` code.
+      # @see http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      desc "Creates a Resort migration."
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Copies a migration file adding resort fields to a given model
+      def copy_migration_file
+        migration_template 'migration.rb', "db/migrate/add_resort_fields_to_#{table_name.pluralize}.rb"
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,17 @@
+# Migration to add the necessary fields to a resorted model
+class AddResortFieldsTo<%= table_name.camelize %> < ActiveRecord::Migration
+  # Adds Resort fields, next_id and first, and indexes to a given model
+  def self.up
+    add_column :<%= table_name %>, :next_id, :integer
+    add_column :<%= table_name %>, :first,   :boolean
+    add_index :<%= table_name %>, :next_id
+    add_index :<%= table_name %>, :first
+  end
+
+  # Removes Resort fields
+  def self.down
+    remove_column :<%= table_name %>, :next_id
+    remove_column :<%= table_name %>, :first
+  end
+end
+

data/lib/resort/version.rb

@@ -1,4 +1,4 @@
 module Resort
   # Resort's version number
-  VERSION = "0.0.2"
+  VERSION = "0.2.0"
 end

data/lib/resort.rb

@@ -1,3 +1,5 @@
+require 'generators/active_record/resort_generator' if defined?(Rails)
+
 # # Resort
 #
 # A tool that allows any ActiveRecord model to be sorted.
@@ -71,12 +73,20 @@ module Resort
       #
       # @return [ActiveRecord::Base] the first element of the list.
       def first_in_order
-        where(:first => true).first
+        scoped.where(:first => true).first
+      end
+
+      # Returns the last element of the list.
+      #
+      # @return [ActiveRecord::Base] the last element of the list.
+      def last_in_order
+        scoped.where(:next_id => nil).first
       end
+
       
       # Returns eager-loaded Components in order.
       #
-      # OPTIMIZE: Avoid creating as many hashes.
+      # OPTIMIZE: Use IdentityMap when available
       # @return [Array<ActiveRecord::Base>] the ordered elements
       def ordered
         ordered_elements = []
@@ -90,10 +100,12 @@ module Resort
           end
         end
 
+        raise "Multiple or no first items in the list where found. Consider defining a siblings method" if ordered_elements.length != 1 && elements.length > 0
+        
         elements.length.times do
           ordered_elements << elements[ordered_elements.last.next_id]
         end
-        ordered_elements
+        ordered_elements.compact
       end
     end
 
@@ -146,47 +158,46 @@ module Resort
 
       # Puts the object in the last position of the list.
       def push
-        self.append_to(last) unless last?
+        self.append_to(_siblings.last_in_order) unless last?
       end
 
       # Puts the object right after another object in the list.
       def append_to(another)
-        if self.next
-          delete_from_list
-        elsif last? && self.previous
-          # self.previous.update_attribute(:next_id, nil)
-          self.previous = nil
-        end
+        return if another.next_id == id
 
-        self.update_attribute(:next_id, another.next_id) if self.next_id or (another && another.next_id)
-        another.update_attribute(:next_id, self.id) if another
+        delete_from_list
+
+        self.class.transaction do
+          self.update_attribute(:next_id, another.next_id) if self.next_id or (another && another.next_id)
+          another.update_attribute(:next_id, self.id) if another
+        end
       end
 
       private
 
       def delete_from_list
-        if first? && self.next
-          self.update_attribute(:first, nil) unless frozen?
-          self.next.first = true 
-          self.next.previous = nil
-          self.next.save!
-        elsif self.previous
-          previous.next = self.next
-          previous.save!
-          self.update_attribute(:next_id, nil) unless frozen?
+        self.class.transaction do
+          if first? && self.next
+            self.next.update_attribute(:first, true)
+          elsif self.previous
+            self.previous.update_attribute(:next_id, self.next_id)
+          end
+
+          unless frozen?
+            self.first = false 
+            self.next = nil 
+            self.previous = nil 
+            save!
+          end
         end
       end
 
       def last?
-        self.first != true && self.next_id == nil
-      end
-
-      def last
-        _siblings.where(:next_id => nil).first
+        !self.first && !self.next_id
       end
 
       def last!
-        last.update_attribute(:next_id, self.id)
+        _siblings.last_in_order.update_attribute(:next_id, self.id)
       end
 
       def _siblings

data/resort.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 2.5.0'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'bluecloth'
+  s.add_development_dependency 'generator_spec', '~> 0.8.1'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/generators/migration_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'action_controller'
+require 'action_view'
+ActionView::Template::Handlers::ERB::ENCODING_FLAG = ActionView::ENCODING_FLAG
+require 'generator_spec/test_case'
+
+module Resort
+  module Generators
+    describe MigrationGenerator do
+      include GeneratorSpec::TestCase
+      destination File.expand_path('../../../tmp', __FILE__)
+      tests MigrationGenerator
+      arguments %w(article)
+
+      before(:all) do
+        prepare_destination
+        mkdir File.join(self.test_case.destination_root, 'config')
+        run_generator
+      end
+
+      it 'generates Resort migration' do
+        destination_root.should have_structure {
+
+          directory "db" do
+            directory "migrate" do
+              migration "add_resort_fields_to_articles" do
+                contains "class AddResortFieldsToArticles"
+                contains ":articles, :next_id"
+                contains ":articles, :first"
+              end
+            end
+          end
+
+        }
+      end
+    end
+  end
+end

data/spec/resort_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-class Article < ActiveRecord::Base
-  resort!
-end
-
 module Resort
   describe Sortable do
 
@@ -26,15 +22,8 @@ module Resort
     end
 
     describe 'ClassMethods' do
-      describe "#first_in_order" do
-        it 'returns the first element of the list' do
-          first = double :article
-          Article.should_receive(:where).with(:first => true).and_return [first]
 
-          Article.first_in_order
-        end
-      end
-      describe "#ordered" do
+      describe "ordering" do
         before do
           Article.destroy_all
 
@@ -42,20 +31,85 @@ module Resort
             Article.create(:name => i.to_s)
           end
 
-          @article1 = Article.find_by_name('0')
-          @article2 = Article.find_by_name('1')
-          @article3 = Article.find_by_name('2')
-          @article4 = Article.find_by_name('3')
+          Article.find_by_name('0').append_to(Article.find_by_name('3'))
+          Article.find_by_name('1').append_to(Article.find_by_name('3'))
+          Article.find_by_name('2').append_to(Article.find_by_name('3'))
+
+          @article1 = Article.find_by_name('3')
+          @article2 = Article.find_by_name('2')
+          @article3 = Article.find_by_name('1')
+          @article4 = Article.find_by_name('0')
         end
-        it 'returns the first element of the list' do
-          Article.ordered.should == [@article1, @article2, @article3, @article4]
+
+        describe "#first_in_order" do
+          it 'returns the first element of the list' do
+            Article.first_in_order.should == @article1
+          end
         end
+
+        describe "#last_in_order" do
+          it 'returns the last element of the list' do
+            Article.last_in_order.should == @article4
+          end
+        end
+
+        describe "#ordered" do
+          it 'returns all elements ordered' do
+            Article.ordered.should == [@article1, @article2, @article3, @article4]
+          end
+        end
+
         after do
           Article.destroy_all
         end
       end
     end
 
+    describe "siblings" do
+      before do
+        one_list = List.create(:name => 'My list')
+        another_list = List.create(:name => 'My other list')
+
+        4.times do |i|
+          one_list.items << ListItem.new(:name => "My list item #{i}")
+          another_list.items << ListItem.new(:name => "My other list item #{i}")
+        end
+
+      end
+
+      describe "#first_in_order" do
+        it 'returns the first element of the list' do
+          List.find_by_name('My list').items.first_in_order.name.should == "My list item 0"
+          List.find_by_name('My other list').items.first_in_order.name.should == "My other list item 0"
+        end
+      end
+
+      describe "#last_in_order" do
+        it 'returns the last element of the list' do
+          List.find_by_name('My list').items.last_in_order.name.should == "My list item 3"
+          List.find_by_name('My other list').items.last_in_order.name.should == "My other list item 3"
+        end
+      end
+
+      describe "#ordered" do
+        it 'returns all elements ordered' do
+          List.find_by_name('My list').items.ordered.map(&:name).should == ['My list item 0', 'My list item 1', 'My list item 2', 'My list item 3']
+          List.find_by_name('My other list').items.ordered.map(&:name).should == ['My other list item 0', 'My other list item 1', 'My other list item 2', 'My other list item 3']
+        end
+
+        it 'raises when ordering without scope' do
+          expect {
+            ListItem.ordered
+          }.to raise_error
+        end
+      end
+
+      after do
+        List.destroy_all
+        ListItem.destroy_all
+      end
+    end
+
     describe "after create" do
       context 'when there are no siblings' do
         it 'prepends the element' do
@@ -72,14 +126,54 @@ module Resort
           Article.create(:name => 'last!')
 
           article = Article.find_by_name('last!')
+          first = Article.find_by_name('1')
 
           article.should be_last
+          article.next_id.should be_nil
           article.previous.name.should == '1'
+
+          first.next_id.should eq(article.id)
         end
       end
       after do
         Article.destroy_all
       end
+
+      context "with custom siblings" do
+
+        context 'when there are no siblings' do
+          it 'prepends the element' do
+            one_list = List.create(:name => 'My list')
+            another_list = List.create(:name => 'My other list')
+            item = ListItem.create(:name => "My list item", :list => one_list)
+
+            item.should be_first
+            item.next.should be_nil
+            item.previous.should be_nil
+          end
+        end
+        context 'otherwise' do
+          it 'appends the element' do
+            one_list = List.create(:name => 'My list')
+            another_list = List.create(:name => 'My other list')
+            ListItem.create(:name => "1", :list => one_list)
+            ListItem.create(:name => "last!", :list => one_list)
+
+            first = ListItem.find_by_name('1')
+            last = ListItem.find_by_name('last!')
+
+            last.should be_last
+            last.next_id.should be_nil
+            last.previous.name.should == '1'
+
+            first.next_id.should eq(last.id)
+          end
+        end
+        after do
+          List.destroy_all
+          ListItem.destroy_all
+        end
+      end
     end
 
     describe "after destroy" do
@@ -190,35 +284,43 @@ module Resort
           it "appends the element after another element" do
             @article1.append_to(@article2)
 
-            article2 = Article.find_by_name('2')
-            article2.next.name.should == '1'
-
             article1 = Article.find_by_name('1')
             article1.next.name.should == '3'
             article1.previous.name.should == '2'
             @article3.previous.name.should == '1'
+          end
+
+          it "sets the other element as first" do
+            @article1.append_to(@article2)
 
+            article2 = Article.find_by_name('2')
+            article2.next.name.should == '1'
             article2.should be_first
           end
         end
+
         context 'appending 1 after 3' do
           it "appends the element after another element" do
             @article1.append_to(@article3)
 
-            article2 = Article.find_by_name('2')
-            article2.should be_first
-            article2.previous.should be_nil
-
             article1 = Article.find_by_name('1')
             article1.should_not be_first
             article1.previous.name.should == '3'
             article1.next.name.should == '4'
 
             @article3.next.name.should == '1'
-
             @article4.previous.name.should == '1'
           end
+
+          it 'resets the first element' do
+            @article1.append_to(@article3)
+
+            article2 = Article.find_by_name('2')
+            article2.should be_first
+            article2.previous.should be_nil
+          end
         end
+
         context 'appending 2 after 3' do
           it "appends the element after another element" do
             @article2.append_to(@article3)
@@ -290,8 +392,11 @@ module Resort
           it 'does nothing' do
             @article2.append_to(@article1)
 
-            @article1.next.name.should == '2'
-            @article2.previous.name.should == '1'
+            article1 = Article.find_by_name('1')
+            article2 = Article.find_by_name('2')
+
+            article1.next.name.should == '2'
+            article2.previous.name.should == '1'
           end
         end
       end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require 'resort'
+require 'logger'
 
 ActiveRecord::Base.establish_connection(
   :adapter => 'sqlite3',
@@ -16,4 +17,38 @@ ActiveRecord::Schema.define do
 
     t.timestamps
   end
+
+  create_table :lists do |t|
+    t.string     :name
+    t.timestamps
+  end
+
+  create_table :list_items do |t|
+    t.string     :name
+    t.boolean :first
+    t.references :next
+    t.references :list
+    t.timestamps
+  end
+end
+
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+class Article < ActiveRecord::Base
+  resort!
+end
+
+class List < ActiveRecord::Base
+  has_many :items, :class_name => 'ListItem'
+end
+
+class ListItem < ActiveRecord::Base
+  belongs_to :list
+  resort!
+
+  default_scope :order => 'created_at desc'
+
+  def siblings
+    self.list.items
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: resort
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Oriol Gual
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 +01:00
+date: 2011-03-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,6 +70,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: generator_spec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+  type: :development
+  version_requirements: *id006
 description: Positionless model sorting for Rails 3.
 email: 
 - info@codegram.com
@@ -87,9 +98,12 @@ files:
 - LICENSE
 - Rakefile
 - Readme.md
+- lib/generators/active_record/resort_generator.rb
+- lib/generators/active_record/templates/migration.rb
 - lib/resort.rb
 - lib/resort/version.rb
 - resort.gemspec
+- spec/generators/migration_spec.rb
 - spec/resort_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -121,5 +135,6 @@ signing_key:
 specification_version: 3
 summary: Positionless model sorting for Rails 3.
 test_files: 
+- spec/generators/migration_spec.rb
 - spec/resort_spec.rb
 - spec/spec_helper.rb