mongoid_listable 0.0.8 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGRjNjdkNDcwYWI2YjJhNzY1OTY1ZGQ4ODZkMWE3ZTlmYWJlMDkzYQ==
+    M2JkMzNmNGMyODlkMTEwMzRkZjhkNjcwOGE2ZmEyZDU5YmI3NmE2Zg==
   data.tar.gz: !binary |-
-    NTZkOWZhNTFjYmYxMDQ4MjI3NTczZTdhMGQwYjlhYmMwN2I0Nzc1OA==
+    MmJjNDY1OGIyOThmNmNkMTVhN2NiNGQ3YzVkYjkwNTdhMDU2YzkzZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjZlY2E4MGVhMGI1OWFjMTQ5NGU2MTQ3NjQ0Y2U1NDJmMzhkMmVlMTkxZGUy
-    Y2QyMDFlZGJlMWVhNjU4NmI5NWMwMTFhYmYwY2RlYWQ2MjBhM2UyNDZjOTVi
-    ZjAxYTRmOTg2YmFmYjU3MzQwZjRmNDFiY2IzMTUwMjBhNDllMWQ=
+    YzBhYmRkYzMwN2FkNDlhZjNkY2Q0MzI1MzAwNmE4ZjFkZTMxMzNjN2VkNmU3
+    MzNkZmUxZTEzZmE3YjA2ZjVhNjgzMmIzMDIwODE2MWI2Yzk3OGMyYmJkYjkz
+    NWFjN2RjYTIzN2I3MmZmYTZmNWI3ZDQyOWEyZDc0YzBhNDUzZmU=
   data.tar.gz: !binary |-
-    NDc1M2YwYzlkZDFjODhhZDQ0ODVmYWUxOGU2MTA2ZGM3M2NmYjg4ZmIyNzdl
-    N2I5ZGE0MjNjYzJhNWEwY2FhOGQ1YmQ4M2ZlMmQ3MWMxOWNjNzIwMGMyMGIz
-    MmM5NjljODU4ZDBiM2QzODEyMTRiNjk2Y2ZmYmY4OWQ0OTdmODM=
+    YzI5MGM3MTZjYjg2MWY3ZjQzNTExNGYzMWJmNzA3ZjFkNWZlZTlmMzdlYjQ4
+    MWVhZWVkMTQ3NGU3ZjFiODI0NTU0NDQ0MWZjNzhkNGM3MGIzMTFiYjliMTRi
+    M2Q4NDk5MWRlODA5MWIyOTdmOWZhZjFiZjYyODg1NDhkNWFlMTg=

data/lib/mongoid/listable/accessors.rb

@@ -35,8 +35,9 @@ module Mongoid
         # @since 0.0.6
         def _setter name, meta
           before_method "#{name}=" do |objects|
+            objects ||= []
             objects.each_with_index do |object, index|
-              object.update_attribute field_name(meta), index + 1
+              object.set field_name(meta), index + 1
             end
 
             (send(name).to_a - objects).each do |object|

data/lib/mongoid/listable/callbacks.rb

@@ -18,9 +18,11 @@ module Mongoid
         def added name, meta
           callback = "#{name.to_s.singularize}_added"
           define_method callback do |object|
-            object.update_attribute field_name(meta), has_many_count(name)
+            if object[field_name(meta)].nil?
+              object.set field_name(meta), has_many_count(name) + 1
+            end
           end
-          meta[:after_add] = callback
+          meta[:before_add] = callback
           self
         end
 
@@ -41,7 +43,7 @@ module Mongoid
             position = object.send field_name
             send(name).where(field_name.gt => position)
               .each_with_index do |object, index|
-              object.update_attribute field_name, position + index
+              object.set field_name, position + index
             end
             object.unset field_name
           end
@@ -50,9 +52,60 @@ module Mongoid
           self
         end
 
+        # Defines a mongoid before_create callback.
+        # Sets the position field to current object count + 1
+        #
+        # @param [ Hash ] The configuration hash
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.1.0
+        def created configuration          
+          define_method __method__ do             
+            set configuration[:column], self.class.count + 1
+          end
+          before_create __method__
+          self
+        end
+
+        # Defines a mongoid before_update callback.        
+        # If the position column has changed, apply the change.
+        # Hoe the change is applied varies depending on the redrection
+        # of the update.
+        #
+        # @param [ Hash ] The configuration hash
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.1.0
+        def updated configuration
+          define_method __method__ do             
+            column = configuration[:column]            
+            apply_change_on column if send("#{column}_changed?")
+          end
+          before_update __method__
+          self
+        end
+
+        # Defines a mongoid before_destroy callback.        
+        # Resets all sibling object's higher in the list
+        #
+        # @param [ Hash ] The configuration hash
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.1.0
+        def destroyed configuration
+          define_method __method__ do             
+            column = configuration[:column]
+            reposition siblings.gt(column => position), column, position
+          end
+          before_destroy __method__
+          self
+        end
+
       end
 
-    end
-    
+    end    
   end
 end

data/lib/mongoid/listable/macros.rb

@@ -8,6 +8,27 @@ module Mongoid
 
       module ClassMethods
 
+        # Macro to set basic position field on an object
+        #
+        # @param [ Hash ]   options The options hash
+        #
+        # @return self
+        #
+        # @since 0.1.0
+        def listed options={}
+          configuration = { column: :position }
+          configuration.merge! options if options.is_a?(Hash)
+
+          field configuration[:column], type: Integer
+
+          created(configuration)
+            .updated(configuration)
+            .destroyed(configuration)
+
+          scope :list, order_by(configuration[:column] => :asc)
+          self
+        end
+
         # Macro to set relation on which to make a list
         #
         # @param [ Symbol ] name The name of the has_many relation

data/lib/mongoid/listable/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Listable
-    VERSION = '0.0.8'
+    VERSION = '0.1.0'
   end
 end

data/lib/mongoid/listable.rb

@@ -30,6 +30,7 @@ module Mongoid
 
     # Proxies to the class level version
     #
+    # @param [ MetaData ] meta The MetaData class
     # @see Class.field_name
     #
     # @since 0.0.6
@@ -41,10 +42,80 @@ module Mongoid
     # Needed because the mongoid callbacks dont update
     # has_many relations until after invoked.
     #
+    # @param [ Symbol ]   name The name of the has_many relation
+    #
     # @since 0.0.7
     def has_many_count name
       send(name).uniq(&:id).count
     end
 
+    private
+
+    # Applies a position change on column. Which objects are repositioned
+    # depends on the direction of the change.
+    #
+    # @param [ Symbol ] name The name of position column
+    #
+    # @since 0.1.0
+    def apply_change_on column
+      from, to = change_on column
+      if to > from
+        reposition siblings.between(column => from..to), column, from
+      elsif to < from       
+        reposition siblings.between(column => to..from), column, to + 1
+      end
+      set column, to
+    end
+
+    # Resets column on objects starting at 'start'
+    #
+    # @param [ Array ] objects The objects to interate
+    # @param [ Symbol ] column The column to update
+    # @param [ Integer ] start The starting position
+    #
+    # @since 0.1.0
+    def reposition objects, column, start
+      objects.each_with_index do |object, index|
+        object.set column, start + index
+      end
+    end
+
+    # Returns the old and new values for column
+    #
+    # @param [ Symbol ] column The column to retrieve the change
+    # @return [Array] [from, to]
+    #
+    # @since 0.1.0
+    def change_on column
+      from, to = send "#{column}_change"
+      to = safe_to to
+      [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
+
+    # Retrieves an object's list siblings
+    #
+    # @return [ Array ]
+    #
+    # @since 0.1.0
+    def siblings
+      self.class.list.ne id: id
+    end
+
   end
 end

data/lib/mongoid_listable.rb

@@ -1 +1,4 @@
 require 'mongoid/listable'
+
+
+

data/spec/models/photo.rb

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

data/spec/mongoid_listable_spec.rb

@@ -3,41 +3,122 @@ require 'spec_helper'
 describe Mongoid::Listable do 
 
   before :all do 
-    @user = User.create!
-    @photos = []
-    10.times { @photos << Photo.create }
+    User.create!    
+    10.times { Photo.create }
   end  
 
   it 'created a user' do
-    expect(@user).to be_true
+    expect(User.first).to be_true
   end
 
   it 'created 10 photos' do    
-    expect(@photos.count).to eq(10)
+    expect(Photo.count).to eq(10)
   end
 
-  it 'assigns all photos to a user with the default setter' do 
-    @user.photos = @photos
-    expect(@user.photos.count).to eq(@photos.count)
+  it 'added the position field for a photo' do 
+    expect(Photo.instance_methods.include?(:position)).to be_true
   end
 
-  it 'assigns all photos to a user with the default ids setter' do 
-    ids = @photos.collect(&:id)
-    @user.photo_ids = ids
-    expect(@user.photos.count).to eq(@photos.count)
+  it 'orders photos' do 
+    Photo.list.each_with_index do |photo, index|
+      expect(photo.position).to eq(index + 1)
+    end
+  end
+
+  it 'updates photo order on position change higher' do
+    photo_a_id = Photo.list[3].id
+    photo_b_id = Photo.list[7].id
+
+    expect(Photo.find(photo_a_id).position).to eq(4)
+    expect(Photo.find(photo_b_id).position).to eq(8)
+
+    Photo.find(photo_a_id).update_attribute :position, 9
+
+    expect(Photo.find(photo_a_id).position).to eq(9)
+    expect(Photo.find(photo_b_id).position).to eq(7)
+  end
+
+  it 'updates photo order on position change lower' do
+    photo_a_id = Photo.list[5].id
+    photo_b_id = Photo.list[9].id
+
+    expect(Photo.find(photo_a_id).position).to eq(6)
+    expect(Photo.find(photo_b_id).position).to eq(10)
+
+    Photo.find(photo_a_id).update_attribute :position, 2
+
+    expect(Photo.find(photo_a_id).position).to eq(2)
+    expect(Photo.find(photo_b_id).position).to eq(10)
+  end
+
+  it 'updates photo order on photo destroy' do
+    photo_a_id = Photo.list[5].id
+    photo_b_id = Photo.list[9].id
+
+    expect(Photo.find(photo_b_id).position).to eq(10)
+
+    Photo.find(photo_a_id).destroy
+
+    expect(Photo.find(photo_b_id).position).to eq(9)
+  end
+
+  it 'creates a new photo' do
+    Photo.create
+    expect(Photo.all.count).to eq(10)
+    expect(Photo.last.position).to eq(10)
+  end
+
+  it 'adds photos to a user with the default setter' do 
+    User.first.photos = Photo.all
+    expect(User.first.photos.count).to eq(10)
+  end
+
+  it 'orders photos for a user' do 
+    User.first.photos.each_with_index do |photo, index|
+      expect(photo.user_position).to eq(index + 1)
+    end
+  end
+
+  it 'removes photos from a user' do 
+    User.first.photos = nil
+    expect(User.first.photos.count).to eq(0)
+  end
+
+  it 'adds 5 photos to a user with the default ids setter' do
+    User.first.photo_ids = Photo.all[0..4].map &:id
+    expect(User.first.photos.count).to eq(5)
+  end
+
+  it 'adds all photos to a user with the default ids setter' do
+    User.first.photo_ids = Photo.all.map &:id
+    expect(User.first.photos.count).to eq(10)
+  end
+
+  it 'orders photos for a user' do 
+    User.first.photos.each_with_index do |photo, index|
+      expect(photo.user_position).to eq(index + 1)
+    end
+  end
+
+  it 'adds a new photo to a user' do 
+    User.first.photos << Photo.new
+    expect(User.first.photos.count).to eq(11)
+    expect(User.first.photos.last.user_position).to eq(11)
   end
 
-  it 'removes a photo from a user using the delete method' do 
-    @user.photos.delete @photos[0]
-    expect(@user.photos.count).to eq(@photos.count - 1)
+  it 'adds a created photo to a user' do 
+    User.first.photos << Photo.create
+    expect(User.first.photos.count).to eq(12)
+    expect(User.first.photos.last.user_position).to eq(12)
   end
 
-  it 'removes a photo from a user using the default setter' do 
-    @user.photos = @photos[0..4]
-    expect(@user.photos.count).to eq(@photos.count - 5)
+  it 'deletes a photo from a user' do 
+    User.first.photos.delete(Photo.all[5])
+    expect(User.first.photos.count).to eq(11)
+    expect(User.first.photos.last.user_position).to eq(11)
   end
 
-  it 'updated the position field for all the photos' do 
+  it 'orders photos for a user' do 
     User.first.photos.each_with_index do |photo, index|
       expect(photo.user_position).to eq(index + 1)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_listable
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - richardcalahan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid