resort 0.2.3 → 0.3.0

data/.gitignore

@@ -6,3 +6,4 @@ graph.png
 .yardoc/*
 doc/*
 tmp
+*.rbc

data/.rvmrc

@@ -1 +1 @@
-rvm --create use ruby-1.9.2@resort
+rvm --create use ruby-1.9.3-p0@resort

data/.travis.yml

@@ -0,0 +1,8 @@
+# http://about.travis-ci.org/docs/user/build-configuration/
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - ruby-head
+  - rbx
+  - rbx-2.0

data/Gemfile

@@ -1,3 +1,12 @@
 source "http://rubygems.org"
 
 gemspec
+
+#group :development, :test do
+#  # For debugging under ruby 1.9 special gems are needed
+#  gem 'ruby-debug19', :platform => :mri
+#  # See http://blog.wyeworks.com/2011/11/1/ruby-1-9-3-and-ruby-debug
+#  gem 'ruby-debug-base19', '>=0.11.26'
+#  gem 'linecache19', '>=0.5.13'
+#end
+

data/Readme.md

@@ -8,7 +8,9 @@ Resort provides sorting capabilities to your Rails 3 models.
 
 Or in your Gemfile:
 
-    gem 'resort'
+```ruby
+gem 'resort'
+```
 
 ##Rationale
 
@@ -30,44 +32,120 @@ First, run the migration for the model you want to Resort:
 
 Then in your Product model:
 
-    class Product < ActiveRecord::Base
-      resort!
-    end
+```ruby
+class Product < ActiveRecord::Base
+  resort!
+end
+```
 
 **NOTE**: By default, Resort will treat _all products_ as a single big tree.
 If you wanted to limit the tree scope, i.e. treating every ProductLine as a
 separate tree of sortable products, you must override the `siblings` method:
 
-    class Product < ActiveRecord::Base
-      resort!
+```ruby
+class Product < ActiveRecord::Base
+  resort!
 
-      def siblings
-        # Tree contains only products from my own product line
-        self.product_line.products
-      end
-    end
+  def siblings
+    # Tree contains only products from my own product line
+    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
+```ruby
+Product.transaction do
+  my_product.append_to(another_product)
+end
+```
         
 ###API
 
-Every time a product is created, it will be appended after the last element.
+**Every time a product is created, it will be appended after the last element.**
 
 Moreover, now a `product` responds to the following methods:
 
 * `first?` &mdash; Returns true if the element is the first of the tree.
 * `append_to(other_element)` &mdash; Appends the element _after_ another element.
+* `next` &mdash; Returns the next element in the list
+* `previous` &mdash; Returns the previous element in the list
 
 And the class Product has a new scope named `ordered` that returns the
 products in order.
 
+### Examples
+
+Given our `Product` example defined before, we can do things like:
+
+Getting products in order:
+
+```ruby
+Product.first_in_order # returns the first ordered product.
+Product.last_in_order # returns the last ordered product.
+Product.ordered # returns all products ordered as an Array, not a Relation!
+```
+
+Find ordered products with scopes or conditions:
+
+```ruby
+Product.where('price > 10').ordered # => Ordered array of products with price > 10
+Product.with_custom_scope.ordered # => Ordered array of products with your custom conditions
+```
+
+Modify the list of products:
+
+```ruby
+product = Product.create(:name => 'Bread')
+product.first? # => true
+
+another_product = Product.create(:name => 'Milk')
+yet_another_product = Product.create(:name => 'Salami')
+
+yet_another_product.append_to(product) # puts the products right after the first one
+
+Product.ordered.map(&:name) # => ['Bread', 'Salami', 'Milk']
+```
+
+Check neighbours:
+
+```ruby
+product = Product.create(:name => 'Bread')
+second_product = Product.create(:name => 'Milk')
+third_product = Product.create(:name => 'Salami')
+
+second_product.previous.name # => 'Bread'
+second_product.next.name # => 'Salami'
+
+third_product.next # => nil
+```
+
+Maybe you need different orders depending on the product vendor:
+
+```ruby
+class Product < ActiveRecord::Base
+  resort!
+
+  belongs_to :vendor
+
+  def siblings
+    self.vendor.products
+  end
+end
+
+bread = Product.create(:name => 'Bread', :vendor => Vendor.where(:name => 'Bread factory'))
+bread.first? # => true
+
+milk = Product.create(:name => 'Milk', :vendor => Vendor.where(:name => 'Cow world'))
+milk.first? # => true
+
+# bread and milk aren't neighbours
+```
+
 ##Under the hood
 
 Run the test suite by typing:

data/lib/resort.rb

@@ -1,4 +1,5 @@
 require 'generators/active_record/resort_generator' if defined?(Rails)
+require 'active_record' unless defined?(ActiveRecord)
 
 # # Resort
 #
@@ -155,10 +156,10 @@ module Resort
           if _siblings.count > 0
             delete_from_list
             old_first = _siblings.first_in_order
-            self.update_attribute(:next_id, old_first.id)
-            old_first.update_attribute(:first, false)
+            raise(ActiveRecord::RecordNotSaved) unless self.update_attribute(:next_id, old_first.id)
+            raise(ActiveRecord::RecordNotSaved) unless old_first.update_attribute(:first, false)
           end
-          self.update_attribute(:first, true)
+          raise(ActiveRecord::RecordNotSaved) unless self.update_attribute(:first, true)
         end
       end
 
@@ -177,8 +178,12 @@ module Resort
           return if another.next_id == id
           another.lock!
           delete_from_list
-          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
+          if self.next_id or (another && another.next_id)
+            raise(ActiveRecord::RecordNotSaved) unless self.update_attribute(:next_id, another.next_id)
+          end
+          if another
+            raise(ActiveRecord::RecordNotSaved) unless another.update_attribute(:next_id, self.id)
+          end
         end
       end
 
@@ -187,16 +192,16 @@ module Resort
       def delete_from_list
         if first? && self.next
           self.next.lock!
-          self.next.update_attribute(:first, true)
+          raise(ActiveRecord::RecordNotSaved) unless self.next.update_attribute(:first, true)
         elsif self.previous
           self.previous.lock!
-          self.previous.update_attribute(:next_id, self.next_id)
+          p = self.previous
+          self.previous = nil unless frozen?
+          raise(ActiveRecord::RecordNotSaved) unless p.update_attribute(:next_id, self.next_id)
         end
-
         unless frozen?
           self.first = false 
           self.next = nil 
-          self.previous = nil 
           save!
         end
       end
@@ -208,7 +213,7 @@ module Resort
       def last!
         self.class.transaction do
           self.lock!
-          _siblings.last_in_order.update_attribute(:next_id, self.id)
+          raise(ActiveRecord::RecordNotSaved) unless _siblings.last_in_order.update_attribute(:next_id, self.id)
         end
       end
 
@@ -229,5 +234,4 @@ module Resort
   end
 end
 
-require 'active_record' unless defined?(ActiveRecord)
 ActiveRecord::Base.extend Resort::ClassMethods

data/lib/resort/version.rb

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

data/resort.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "resort"
 
-  s.add_runtime_dependency 'activerecord', '~> 3.0.5'
+  s.add_runtime_dependency 'activerecord', '>= 3.0.5', '< 3.2'
+#  s.add_runtime_dependency 'activerecord', '~> 3.0.5'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rspec', '~> 2.5.0'
   s.add_development_dependency 'yard'

data/spec/resort_spec.rb

@@ -17,7 +17,7 @@ module Resort
         (class << subject.class; self; end).ancestors.should include(Sortable::ClassMethods)
       end
       it 'defines a siblings method' do
-        subject.class.instance_methods.should include(:siblings)
+        subject.should respond_to(:siblings)
       end
     end
 
@@ -67,8 +67,8 @@ module Resort
 
     describe "siblings" do
       before do
-        one_list = List.create(:name => 'My list')
-        another_list = List.create(:name => 'My other list')
+        one_list = OrderedList.create(:name => 'My list')
+        another_list = OrderedList.create(:name => 'My other list')
 
         4.times do |i|
           one_list.items << ListItem.new(:name => "My list item #{i}")
@@ -79,22 +79,22 @@ module Resort
 
       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"
+          OrderedList.find_by_name('My list').items.first_in_order.name.should == "My list item 0"
+          OrderedList.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"
+          OrderedList.find_by_name('My list').items.last_in_order.name.should == "My list item 3"
+          OrderedList.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']
+          OrderedList.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']
+          OrderedList.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
@@ -105,7 +105,7 @@ module Resort
       end
 
       after do
-        List.destroy_all
+        OrderedList.destroy_all
         ListItem.destroy_all
       end
     end
@@ -143,9 +143,9 @@ module Resort
 
         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)
+            one_list = OrderedList.create(:name => 'My list')
+            another_list = OrderedList.create(:name => 'My other list')
+            item = ListItem.create(:name => "My list item", :ordered_list => one_list)
 
             item.should be_first
             item.next.should be_nil
@@ -154,10 +154,10 @@ module Resort
         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)
+            one_list = OrderedList.create(:name => 'My list')
+            another_list = OrderedList.create(:name => 'My other list')
+            ListItem.create(:name => "1", :ordered_list => one_list)
+            ListItem.create(:name => "last!", :ordered_list => one_list)
 
             first = ListItem.find_by_name('1')
             last = ListItem.find_by_name('last!')
@@ -170,15 +170,15 @@ module Resort
           end
 
           it 'prepends the last element' do
-            one_list = List.create(:name => 'My list')
-            ListItem.create(:name => "First", :list => one_list)
-            ListItem.create(:name => "Second", :list => one_list)
-            third = ListItem.create(:name => "Third", :list => one_list)
+            one_list = OrderedList.create(:name => 'My list')
+            ListItem.create(:name => "First", :ordered_list => one_list)
+            ListItem.create(:name => "Second", :ordered_list => one_list)
+            third = ListItem.create(:name => "Third", :ordered_list => one_list)
 
             third.prepend
-            first = ListItem.where(:name => "First", :list_id => one_list).first
-            second = ListItem.where(:name => "Second", :list_id => one_list).first
-            third = ListItem.where(:name => "Third", :list_id => one_list).first
+            first = ListItem.where(:name => "First", :ordered_list_id => one_list).first
+            second = ListItem.where(:name => "Second", :ordered_list_id => one_list).first
+            third = ListItem.where(:name => "Third", :ordered_list_id => one_list).first
 
             first.should_not be_first
             second.should_not be_first
@@ -187,9 +187,10 @@ module Resort
             first.next.name.should == 'Second'
             second.next.should be_nil
           end
+
         end
         after do
-          List.destroy_all
+          OrderedList.destroy_all
           ListItem.destroy_all
         end
       end
@@ -259,7 +260,7 @@ module Resort
         @article3 = Article.find_by_name('3')
         @article4 = Article.find_by_name('4')
       end
-      
+
       describe "#push" do
         it "appends the element to the list" do
           @article1.push
@@ -299,6 +300,11 @@ module Resort
           article4.next.name.should == '1'
         end
 
+        it 'will raise ActiveRecord::RecordNotSaved if update fails' do
+          @article2.should_receive(:update_attribute).and_return(false)
+          expect { @article2.prepend }.to raise_error(ActiveRecord::RecordNotSaved)
+        end
+
         context 'when the article is already first' do
           it 'does nothing' do
             @article1.prepend
@@ -310,6 +316,11 @@ module Resort
       end
 
       describe "#append_to" do
+        it 'will raise ActiveRecord::RecordNotSaved if update fails' do
+          @article2.should_receive(:update_attribute).and_return(false)
+          expect { @article2.append_to(@article3) }.to raise_error(ActiveRecord::RecordNotSaved)
+        end
+
         context 'appending 1 after 2' do
           it "appends the element after another element" do
             @article1.append_to(@article2)
@@ -357,7 +368,7 @@ module Resort
 
             article1 = Article.find_by_name('1')
             article1.next.name.should == '3'
-            
+
             article2 = Article.find_by_name('2')
             article2.previous.name.should == '3'
             article2.next.name.should == '4'
@@ -405,7 +416,7 @@ module Resort
 
             article1 = Article.find_by_name('1')
             article1.next.name.should == '3'
-            
+
             article2 = Article.find_by_name('2')
             article2.previous.name.should == '3'
             article2.next.name.should == '4'

data/spec/spec_helper.rb

@@ -1,6 +1,12 @@
 require 'rspec'
 
 module Rails
+  class << self
+    # 3.0 defaults this, 3.1 does not
+    def application
+      "application"
+    end
+  end
 end
 
 require 'resort'
@@ -22,7 +28,7 @@ ActiveRecord::Schema.define do
     t.timestamps
   end
 
-  create_table :lists do |t|
+  create_table :ordered_lists do |t|
     t.string     :name
     t.timestamps
   end
@@ -31,7 +37,7 @@ ActiveRecord::Schema.define do
     t.string     :name
     t.boolean :first
     t.references :next
-    t.references :list
+    t.references :ordered_list
     t.timestamps
   end
 end
@@ -42,17 +48,17 @@ class Article < ActiveRecord::Base
   resort!
 end
 
-class List < ActiveRecord::Base
+class OrderedList < ActiveRecord::Base
   has_many :items, :class_name => 'ListItem'
 end
 
 class ListItem < ActiveRecord::Base
-  belongs_to :list
+  belongs_to :ordered_list
   resort!
 
   default_scope :order => 'created_at desc'
 
   def siblings
-    self.list.items
+    self.ordered_list.items
   end
 end

metadata

@@ -1,99 +1,98 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: resort
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.3
 platform: ruby
-authors: 
+authors:
 - Oriol Gual
 - Josep M. Bach
 - Josep Jaume Rey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-19 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70302327492940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70302327492940
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70302327491540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70302327491540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70302327490080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70302327490080
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70302327489380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: bluecloth
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70302327489380
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: &70302327488200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: generator_spec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70302327488200
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: &70302327487300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.1
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *70302327487300
 description: Positionless model sorting for Rails 3.
-email: 
+email:
 - info@codegram.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - Rakefile
@@ -106,35 +105,32 @@ files:
 - spec/generators/migration_spec.rb
 - spec/resort_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://codegram.github.com/resort
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: resort
-rubygems_version: 1.6.1
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Positionless model sorting for Rails 3.
-test_files: 
+test_files:
 - spec/generators/migration_spec.rb
 - spec/resort_spec.rb
 - spec/spec_helper.rb
+has_rdoc: