mongoid_listable 0.1.3 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGY4YzBjMjJiMzExZjI2M2M2YTFmNTBkMjM5MmY0ZTMyMjNjNzYwZQ==
+    N2IzMjdhOTU3NzdkZTA2OWVkOTkzYTkzNjA2NmEwYmM3Y2MyN2E1OQ==
   data.tar.gz: !binary |-
-    YmVlYmFjMDk1YmE2NjE4ZjkxZDgwZTYwMzhmOWU1ZTI2ZTcyMGZjMw==
+    Mzc3MGVmOWRjNmQ4Yzc3YmI0YmE3Y2I2ODU5MzcxNDliMDE2N2NiZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTliYmRiODE5MTlmYzA3OTM0MjE2MWMyYzg1OWZiMGIzYmY1ZTIyYzdlZmVh
-    MDBhMTcyMjdjMDIxZjdhOTc0OTU0YWNhMGM2YjAwNDlkNjdiOTNkM2M0OTIw
-    YTBmOTRmNzRiOWQwNTE4MDYwNTI4ZmUzNzlhOTQxMjVhOWU2N2Q=
+    NjgxM2UzY2RiMDMyYWQ5ZTIzMTllZTQ3NmU4MjIzYzdlNDUwZDU2ZjJkNzFm
+    ODgwNmE4NTk4YzNjNWRkZWRmZjhlODU1YmIyMjkyMzAyYmY0MjZiMGMxOGY0
+    Zjk1Y2U2ZGFhMmFkYzg0MmEzODY2N2U3MDVlMWYxNGIyMGJmMjk=
   data.tar.gz: !binary |-
-    YWVhZGRiNGFhZGQ3ZjA4MmE0NWQ3ZDdiNjIxYmI5NDk5OTk3OWFiYzdhNTNl
-    MGY1NDg0ODhkYzNkNTU5MTg4ZTYxNjBjMDc2MWNkNGNlNTc2ZGJmMzdhYzAx
-    OWQzYTRlYWY1MDhiYWEwMmI2YTRiNTZhOGU2NmJhZWRiYWU5OGI=
+    MTEzMjQyNmY1MmVkZWQ3ZWZmNjQ3ZDkzZjNkMmQ2NTg5ZTNkMGY4MGM3MGIz
+    NjI4MzBmMTczOGEzYmYxOTQyZTQzN2EyNTJhZWY4ODZjMWVhODAzOTVlMTU2
+    NDI1ZjRjOWYyZjg1YzcyMjkyNmMzMTEwOGY4YmFmMzY1NGM3OWM=

data/lib/mongoid/listable.rb

@@ -55,7 +55,8 @@ module Mongoid
     #
     # @since 0.1.0
     def siblings field=:position
-      self.class.exists(field => true).ne id: id
+      klass = embedded? ? _parent.send(metadata.key) : self.class
+      klass.exists(field => true).ne id: id
     end
 
     private

data/lib/mongoid/listable/accessors.rb

@@ -37,6 +37,7 @@ module Mongoid
         def set name, meta
           before_method "#{name}=" do |objects|
             objects ||= []
+
             reposition objects, field_name(meta), 1
 
             (send(name).to_a - objects).each do |object|

data/lib/mongoid/listable/callbacks.rb

@@ -17,10 +17,10 @@ module Mongoid
         def created name
           callback = "#{name}_#{__method__}"
           define_method callback do
-            position = send name
+            position = send(name)
             if position.present?
-              siblings = siblings(name).gte name => position
-              reposition siblings, name, position + 1
+              siblings = siblings name
+              reposition siblings.gte(name => position), name, position + 1
             else
               set name, siblings(name).count + 1
             end
@@ -45,7 +45,6 @@ module Mongoid
           define_method callback do       
             apply_change_on name if send("#{name}_changed?")
           end
-
           before_update callback
           self
         end
@@ -82,11 +81,16 @@ module Mongoid
         def added name, meta
           callback = "#{name.to_s.singularize}_added"
           define_method callback do |object|
-            if object[field_name(meta)].nil?
-              object.set field_name(meta), has_many_count(name) + 1
+            return unless object.new_record?
+            field_name = field_name(meta)
+            if position = object.send(field_name) 
+              objects = object.siblings(field_name).gte(field_name => position)
+              reposition objects, field_name, position + 1
+            else                       
+              object.set field_name, has_many_count(name)
             end
           end
-          meta[:before_add] = callback
+          meta[:after_add] = callback
           self
         end
 
@@ -109,7 +113,7 @@ module Mongoid
             object.unset field_name
           end
 
-          meta[:before_remove] = callback
+          meta[:after_remove] = callback
           self
         end
 
@@ -140,28 +144,19 @@ module Mongoid
       # @return [Array] [from, to]
       #
       # @since 0.1.0
-      def change_on column
-        from, to = send "#{column}_change"
-        to = safe_to to
+      def change_on name
+        from, to = send "#{name}_change"
+        from ||= 0
+        to = if to > siblings(name).count + 1
+               siblings(name).count + 1
+             elsif to < 1
+               1
+             else
+               to
+             end
         [from, to]
       end
 
-      # Ensures the 'to' value is within acceptable bounds
-      #
-      # @param [ Integer ] to The supplied position value
-      # @return [ Integer ] The acceptable position value
-      #
-      # @since 0.1.0
-      def safe_to to
-        if to > self.class.count
-          self.class.count
-        elsif to < 1
-          1
-        else
-          to
-        end
-      end
-
     end    
   end
 end

data/lib/mongoid/listable/macros.rb

@@ -15,17 +15,14 @@ module Mongoid
         # @return self
         #
         # @since 0.1.0
-        def listed options={}
-          configuration = { field_name: :position }
-          configuration.merge! options if options.is_a?(Hash)
+        def listed
+          field :position, type: Integer
 
-          field_name = configuration[:field_name]
+          created(:position)
+            .updated(:position)
+            .destroyed(:position)
 
-          field field_name, type: Integer
-
-          created(field_name).updated(field_name).destroyed(field_name)
-
-          scope :list, order_by(field_name => :asc)
+          scope :list, order_by(:position => :asc)
           self
         end
 
@@ -39,11 +36,14 @@ module Mongoid
         # @since 0.0.1
         def lists name, options={}
           meta = reflect_on_association name
+
           field_name = field_name(meta)
           meta.klass.send :field, field_name, type: Integer
+
           ids_set(name, meta).set(name, meta)
             .added(name, meta).removed(name, meta)
 
+          meta.klass.send :include, Mongoid::Listable
           meta.klass.updated(field_name).destroyed(field_name)
 
           meta[:order] ||= "#{field_name(meta)} asc"

data/lib/mongoid/listable/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Listable
-    VERSION = '0.1.3'
+    VERSION = '0.2.1'
   end
 end

data/spec/models/article.rb

@@ -0,0 +1,10 @@
+class Article
+
+  include Mongoid::Document
+  include Mongoid::Listable
+
+  embeds_many :sections
+
+  lists :sections
+
+end

data/spec/models/item.rb

@@ -0,0 +1,8 @@
+class Item
+
+  include Mongoid::Document
+  include Mongoid::Listable
+
+  listed
+
+end

data/spec/models/photo.rb

@@ -7,6 +7,4 @@ class Photo
 
   belongs_to :user
 
-  listed
-
 end

data/spec/models/section.rb

@@ -0,0 +1,7 @@
+class Section
+
+  include Mongoid::Document
+
+  embedded_in :article
+
+end

data/spec/mongoid_listable_spec.rb

@@ -10,154 +10,306 @@ describe Mongoid::Listable do
 
   describe 'listed' do 
 
-    before :all do
-      Photo.destroy_all
-      10.times { Photo.create }
+    before :each do
+      Item.destroy_all
+      10.times { Item.create! }
     end
 
     after :each do 
-      ensure_order Photo.list, :position
+      ensure_order Item.list, :position
     end
 
-    it 'adds an object to the beginning of a list on create' do 
-      photo = Photo.create position: 1
-      expect(Photo.list.first.position).to eq(1)
-      expect(photo.id).to eq(Photo.list.first.id)
+    it 'should have a position field' do 
+      expect(Item.fields.key?('position')).to be_true
     end
 
-    it 'adds an object to the middle of a list on create' do 
-      photo = Photo.create position: 5
-      expect(Photo.list[4].position).to eq(5)
-      expect(photo.id).to eq(Photo.list[4].id)
+    it 'should have a list scope' do 
+      expect(Item.scopes.key?(:list)).to be_true
     end
 
-    it 'adds an object to the end of a list on create' do 
-      photo = Photo.create
-      expect(Photo.list.last.position).to eq(13)
-      expect(photo.id).to eq(Photo.list.last.id)
+    it 'should append new object at position 1' do
+      item = Item.create position: 1
+      expect(item.position).to eq(1)
     end
 
-    it 'updates the position of an object higher' do 
-      photo_id = Photo.list[1].id
-      Photo.list[1].update_attribute :position, 4
-      expect(photo_id).to eq(Photo.list[3].id)
-      expect(Photo.list[3].position).to eq(4)
+    it 'should append new object at position 5' do
+      item = Item.create position: 5
+      expect(item.position).to eq(5)
     end
 
-    it 'updates the position of an object lower' do 
-      photo_id = Photo.list[9].id
-      Photo.list[9].update_attribute :position, 2
-      expect(photo_id).to eq(Photo.list[1].id)
-      expect(Photo.list[1].position).to eq(2)      
+    it 'should append new object at end of list' do
+      item = Item.create
+      expect(item.position).to eq(11)
     end
 
-    it 'updates the position of an object the same' do 
-      photo_id = Photo.list[4].id
-      Photo.list[4].update_attribute :position, 5
-      expect(photo_id).to eq(Photo.list[4].id)
-      expect(Photo.list[4].position).to eq(5)      
+    it 'should maintain order when removing object at position 1' do
+      Item.list.first.destroy
     end
 
-    it 'removes an object from the beginning of a list on destroy' do 
-      Photo.list.first.destroy
-      expect(Photo.list.first.position).to eq(1)
+    it 'should maintain order when removing object at position 5' do
+      Item.where(position: 5).destroy
     end
 
-    it 'removes an object from the middle of a list on destroy' do 
-      Photo.list[6].destroy
-      expect(Photo.list.first.position).to eq(1)
-      expect(Photo.list[6].position).to eq(7)
-      expect(Photo.list.last.position).to eq(11)
+    it 'should maintain order when removing object at position 10' do
+      Item.list.last.destroy
     end
 
-    it 'removes an object from the end of a list on destroy' do 
-      Photo.list.last.destroy
-      expect(Photo.list.last.position).to eq(10)
+    it 'should maintain order when moving object from position 1 to 5' do
+      item = Item.list.first
+      item.update_attribute :position, 5
+      expect(Item.list.where(position: 5).first).to eq(item)
     end
-  end
-
-  describe 'lists' do 
-
-    before :all do
-      User.destroy_all
-      Photo.destroy_all
 
-      User.create
-      10.times { Photo.create }
+    it 'should maintain order when moving object from position 10 to 5' do
+      item = Item.list.last
+      item.update_attribute :position, 5
+      expect(Item.list.where(position: 5).first).to eq(item)
     end
 
-    after :each do 
-      ensure_order User.first.photos, :user_position
+    it 'should maintain order when moving object from position 2 to 6' do
+      item = Item.list.where(position: 2).first
+      item.update_attribute :position, 6
+      expect(Item.list.where(position: 6).first).to eq(item)
     end
 
-    it 'sets object list of an owner with the default setter' do
-      photos = Photo.all
-      User.first.photos = photos
-      photos.each_with_index do |photo, index|
-        expect(photo.id).to eq(User.first.photos[index].id)
-      end
-      expect(User.first.photos.count).to eq(Photo.count)
+    it 'should maintain order when moving object from position 8 to 4' do
+      item = Item.list.where(position: 8).first
+      item.update_attribute :position, 4
+      expect(Item.list.where(position: 4).first).to eq(item)
     end
 
-    it 'sets object list of an owner with the default ids setter' do 
-      ids = Photo.all[2..7].collect(&:id)
-      User.first.photo_ids = ids
-      ids.each_with_index do |id, index|
-        expect(id).to eq(User.first.photos[index].id)
-      end
-      expect(User.first.photos.count).to eq(6)
+    it 'should do nothing when assigning object to same position' do
+      item = Item.list.where(position: 5).first
+      item.update_attribute :position, 5
+      expect(Item.list.where(position: 5).first).to eq(item)
     end
 
-    it 'pushes objects to the list of an owner' do 
-      User.first.photos << Photo.all
-      expect(User.first.photos.count).to eq(10)
+    it 'should compensate for updated positions that are higher than bounds' do
+      item = Item.list.where(position: 5).first
+      item.update_attribute :position, 100
+      expect(Item.list.last).to eq(item)
     end
 
-    it 'updates the position of an object higher' do 
-      photo_id = User.first.photos[4].id
-      Photo.find(photo_id).update_attribute :user_position, 6
-      expect(photo_id).to eq(User.first.photos[5].id)
-      expect(User.first.photos[5].user_position).to eq(6)
+    it 'should compensate for updated positions that are lower than bounds' do
+      item = Item.list.where(position: 5).first
+      item.update_attribute :position, -100
+      expect(Item.list.first).to eq(item)
     end
 
-    it 'updates the position of an object lower' do 
-      photo_id = User.first.photos[4].id
-      Photo.find(photo_id).update_attribute :user_position, 1
-      expect(photo_id).to eq(User.first.photos[0].id)
-      expect(User.first.photos[0].user_position).to eq(1)
-    end
+  end
 
-    it 'updates the position of an object the same' do 
-      photo_id = User.first.photos[4].id
-      Photo.find(photo_id).update_attribute :user_position, 5
-      expect(photo_id).to eq(User.first.photos[4].id)
-      expect(User.first.photos[4].user_position).to eq(5)
-    end
+  describe 'lists' do
+    
+    describe 'embedded' do
 
-    it 'updates the position of an object out of bounds high' do 
-      photo_id = User.first.photos[4].id
-      Photo.find(photo_id).update_attribute :user_position, 1000
-      expect(photo_id).to eq(User.first.photos.last.id)
-      expect(User.first.photos.last.user_position).to eq(User.first.photos.count)
-    end
+      before :each do
+        Article.destroy_all
+        Article.create!
+        10.times { Article.first.sections.create! }
+      end
 
-    it 'updates the position of an object out of bounds low' do 
-      photo_id = User.first.photos[4].id
-      Photo.find(photo_id).update_attribute :user_position, -2
-      expect(photo_id).to eq(User.first.photos.first.id)
-      expect(User.first.photos.first.user_position).to eq(1)
-    end
+      after :each do 
+        ensure_order Article.first.sections, :article_position
+      end
+
+      it 'should have a position field' do 
+        expect(Section.fields.key?('article_position')).to be_true
+      end
+
+      it 'should append new objects with the default setter' do 
+        sections = 10.times.collect { Section.new }
+        sections.reverse!
+        Article.first.sections = sections
+
+        Article.first.sections.each_with_index do |section, index|
+          expect(section.id).to eq(sections[index].id)
+        end
+      end
+
+      it 'should append new object at position 1' do 
+        section = Article.first.sections.create article_position: 1
+        expect(section.article_position).to eq(1)
+      end
+
+      it 'should append new object at position 5' do 
+        section = Article.first.sections.create article_position: 5        
+        expect(section.article_position).to eq(5)
+      end
 
-    it 'removes objects from the list of an owner with the default unsetter' do 
-      User.first.photos.delete(Photo.first)
-      expect(User.first.photos.count).to eq(9)
+      it 'should append new object at end of list' do
+        section = Article.first.sections.create!
+        expect(section.article_position).to eq(11)
+      end
+
+      it 'should maintain order when removing object at position 1' do
+        Article.first.sections.first.destroy        
+      end
+
+      it 'should maintain order when removing object at position 5' do
+        Article.first.sections.where(article_position: 5).first.destroy
+      end
+
+      it 'should maintain order when removing object at position 10' do
+        Article.first.sections.where(article_position: 10).first.destroy
+      end
+
+      it 'should maintain order when moving object from position 1 to 5' do
+        section = Article.first.sections.where(article_position: 1).first
+        section.update_attribute :article_position, 5
+        expect(Article.first.sections.where(article_position: 5).first).to eq(section)
+      end
+
+      it 'should maintain order when moving object from position 10 to 5' do
+        section = Article.first.sections.where(article_position: 10).first
+        section.update_attribute :article_position, 5
+        expect(Article.first.sections.where(article_position: 5).first).to eq(section)
+      end
+
+      it 'should maintain order when moving object from position 2 to 6' do
+        section = Article.first.sections.where(article_position: 2).first
+        section.update_attribute :article_position, 6
+        expect(Article.first.sections.where(article_position: 6).first).to eq(section)
+      end
+
+      it 'should maintain order when moving object from position 8 to 4' do
+        section = Article.first.sections.where(article_position: 8).first
+        section.update_attribute :article_position, 4
+        expect(Article.first.sections.where(article_position: 4).first).to eq(section)
+      end
+
+      it 'should do nothing when assigning object to same position' do
+        section = Article.first.sections.where(article_position: 5).first
+        section.update_attribute :article_position, 5
+        expect(Article.first.sections.where(article_position: 5).first).to eq(section)
+      end
+
+      it 'should compensate for updated positions that are higher than bounds' do 
+        section = Article.first.sections.where(article_position: 5).first
+        section.update_attribute :article_position, 100
+        expect(Article.first.sections.last).to eq(section)
+      end
+
+      it 'should compensate for updated positions that are lower than bounds' do 
+        section = Article.first.sections.where(article_position: 5).first
+        section.update_attribute :article_position, -100
+        expect(Article.first.sections.first).to eq(section)
+      end
+      
     end
 
-    it 'removes objects from the list of an owner by destroy' do 
-      Photo.all[3].destroy
-      expect(User.first.photos.count).to eq(8)
-      Photo.first.destroy
+    describe 'referenced' do
+
+      before :each do
+        User.destroy_all
+        Photo.destroy_all
+        User.create!
+        10.times { User.first.photos.create! }
+      end
+
+      after :each do 
+        ensure_order User.first.photos, :user_position
+      end
+
+      it 'should have a position field' do 
+        expect(Photo.fields.key?('user_position')).to be_true
+      end
+
+      it 'should append new object at position 1' do 
+        photo = User.first.photos.create user_position: 1
+        expect(photo.user_position).to eq(1)
+      end
+
+      it 'should append new object at position 5' do 
+        photo = User.first.photos.create user_position: 5
+        expect(photo.user_position).to eq(5)
+      end
+
+      it 'should append new object at end of list' do
+        user = User.first.photos.create!
+        expect(user.user_position).to eq(11)
+      end
+
+      it 'should add new objects with the default setter' do
+        photos = 15.times.collect { Photo.create }
+
+        photos.reverse!
+
+        User.first.photos = photos
+        
+        expect(User.first.photos.count).to eq(15)
+
+        User.first.photos.each_with_index do |photo, index|
+          expect(photos[index].id).to eq(photo.id)
+        end
+      end
+
+      it 'should add new objects with the default ids setter' do
+        ids = 15.times.collect { Photo.create.id }
+
+        User.first.photo_ids = ids
+        expect(User.first.photos.count).to eq(15)
+
+        User.first.photos.each_with_index do |photo, index|
+          expect(ids[index]).to eq(User.first.photos[index].id)
+        end
+      end
+
+      it 'should maintain order when removing object at position 1' do
+        User.first.photos.first.destroy        
+      end
+
+      it 'should maintain order when removing object at position 5' do
+        User.first.photos.where(user_position: 5).first.destroy
+      end
+
+      it 'should maintain order when removing object at position 10' do
+        User.first.photos.where(user_position: 10).first.destroy
+      end
+
+      it 'should maintain order when moving object from position 1 to 5' do
+        photo = User.first.photos.where(user_position: 1).first
+        photo.update_attribute :user_position, 5
+        expect(User.first.photos.where(user_position: 5).first).to eq(photo)
+      end
+
+      it 'should maintain order when moving object from position 10 to 5' do
+        photo = User.first.photos.where(user_position: 10).first
+        photo.update_attribute :user_position, 5
+        expect(User.first.photos.where(user_position: 5).first).to eq(photo)
+      end
+
+      it 'should maintain order when moving object from position 2 to 6' do
+        photo = User.first.photos.where(user_position: 2).first
+        photo.update_attribute :user_position, 6
+        expect(User.first.photos.where(user_position: 6).first).to eq(photo)
+      end
+
+      it 'should maintain order when moving object from position 8 to 4' do
+        photo = User.first.photos.where(user_position: 8).first
+        photo.update_attribute :user_position, 4
+        expect(User.first.photos.where(user_position: 4).first).to eq(photo)
+      end
+
+      it 'should do nothing when assigning object to same position' do
+        photo = User.first.photos.where(user_position: 5).first
+        photo.update_attribute :user_position, 5
+        expect(User.first.photos.where(user_position: 5).first).to eq(photo)
+      end
+
+      it 'should compensate for updated positions that are higher than bounds' do 
+        photo = User.first.photos.where(user_position: 5).first
+        photo.update_attribute :user_position, 100
+        expect(User.first.photos.last).to eq(photo)
+      end
+
+      it 'should compensate for updated positions that are lower than bounds' do 
+        photo = User.first.photos.where(user_position: 5).first
+        photo.update_attribute :user_position, -100
+        expect(User.first.photos.first).to eq(photo)
+      end
+
     end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -7,8 +7,12 @@ if ENV['CI']
 end
 
 require File.expand_path '../../lib/mongoid_listable', __FILE__
+require File.expand_path '../../spec/models/item',     __FILE__
 require File.expand_path '../../spec/models/photo',    __FILE__
 require File.expand_path '../../spec/models/user',     __FILE__
+require File.expand_path '../../spec/models/section',  __FILE__
+require File.expand_path '../../spec/models/article',  __FILE__
+
 
 Mongoid.configure do |config|
   config.connect_to 'mongoid_listable_test'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_listable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - richardcalahan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-10 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -77,7 +77,10 @@ files:
 - lib/mongoid/listable/version.rb
 - lib/mongoid_listable.rb
 - mongoid_listable.gemspec
+- spec/models/article.rb
+- spec/models/item.rb
 - spec/models/photo.rb
+- spec/models/section.rb
 - spec/models/user.rb
 - spec/mongoid/listable/extensions/object_spec.rb
 - spec/mongoid_listable_spec.rb
@@ -107,7 +110,10 @@ signing_key:
 specification_version: 4
 summary: ''
 test_files:
+- spec/models/article.rb
+- spec/models/item.rb
 - spec/models/photo.rb
+- spec/models/section.rb
 - spec/models/user.rb
 - spec/mongoid/listable/extensions/object_spec.rb
 - spec/mongoid_listable_spec.rb