mongoid_orderable 1.2.0 → 4.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njk2ODJiZDJmM2RiNmY2MTkzNDljNjkzYmI1ZGIzMzI5YzlhNjI1ZQ==
+  data.tar.gz: !binary |-
+    NjU4ZWExYTdjN2MzOGY0YWQzN2RiMTk1NzI1ODM1NzUyNTdjMDkyNw==
+SHA512:
+  metadata.gz: !binary |-
+    OWMyZGZkOTliN2MzNmVhOTExMWJkZDI5OTg0MzY0MTcwMjcyY2Q4MzMzZDdh
+    OTFkM2Q2NWNkMDQwZGQ0Y2FhZDQ4OTliN2ViMDM2MGJiNGY2M2FkMzI1NWRl
+    MjQ1MTM3NjkyNDZmOWYzZTYxYzY2NjI3ODI4OTQwYWJmZmMwNzA=
+  data.tar.gz: !binary |-
+    ODFjOGIwNDhhMjdjNjk4M2E5MzY2M2JmZDdiMWI2MDgzNWI2M2Y0NDA0YzAz
+    Mjg1YmU1OTM3YzgyNDVjZGU2ODdhMWU0YTcxYTc4YzQxYzE0MTRkYWIxYWNk
+    ZTU2NThlOGZlMmRjMDc3NGQ4MmVkYjQxYzM4YzY0MzhkZmY1N2E=

data/.travis.yml

@@ -1,6 +1,5 @@
-script: "bundle exec rake spec"
-
 rvm:
+  - 1.8.7
   - 1.9.2
   - 1.9.3
   - ruby-head
@@ -8,11 +7,18 @@ rvm:
 
 env:
   - MONGOID_VERSION=2
-  - MONGOID_VERSION='~> 3.0.0'
+  - MONGOID_VERSION=3
+  - MONGOID_VERSION=4
 
 matrix:
   exclude:
+    - rvm: 1.8.7
+      env: MONGOID_VERSION=3
+    - rvm: 1.8.7
+      env: MONGOID_VERSION=4
+    - rvm: 1.9.2
+      env: MONGOID_VERSION=3
     - rvm: 1.9.2
-      env: MONGOID_VERSION='~> 3.0.0'
+      env: MONGOID_VERSION=4
 
-services: mongodb
+services: mongodb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 4.0.0
+
+  * Semantic versioning
+  * Added Mongoid 4 support (@dblock)
+  * Fixes by @johnnyshields and @zhengjia

data/Gemfile

@@ -3,9 +3,13 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in mongoid_orderable.gemspec
 gemspec
 
-case version = ENV['MONGOID_VERSION'] || "~> 3.0.0.rc"
+case version = ENV['MONGOID_VERSION'] || "~> 3.1"
+when /4/
+  gem "mongoid", :github => 'mongoid/mongoid'
+when /3/
+  gem "mongoid", "~> 3.1"
 when /2/
-  gem "mongoid", "~> 2.4.0"
+  gem "mongoid", "~> 2.8"
 else
   gem "mongoid", version
 end

data/README.md

@@ -9,7 +9,7 @@ Mongoid::Orderable is a ordered list implementation for your mongoid models.
 * It uses native mongo batch increment feature
 * It supports assignable api
 * It proper assingns position while moving document between scopes
-* It supports both mongoid 2 and 3
+* It supports mongoid 2, 3 and 4
 
 # How?
 
@@ -60,4 +60,4 @@ Fork && Patch && Spec && Push && Pull request.
 
 # License
 
-Mongoid::Orderable is released under the MIT license.
+Mongoid::Orderable is released under the MIT license.

data/Rakefile

@@ -2,3 +2,5 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+
+task :default => [ :spec ]

data/lib/mongoid/orderable.rb

@@ -13,7 +13,7 @@ module Mongoid::Orderable
       configuration.merge! options if options.is_a?(Hash)
       configuration[:scope] = "#{configuration[:scope]}_id".to_sym if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
 
-      field configuration[:column], :type => Integer
+      field configuration[:column], orderable_field_opts(configuration)
       if configuration[:index]
         if MongoidOrderable.mongoid2?
           index configuration[:column]
@@ -40,9 +40,22 @@ module Mongoid::Orderable
         configuration[:base]
       end
 
+      self_class = self
+      define_method :orderable_inherited_class do
+        self_class if configuration[:inherited]
+      end
+
       before_save :add_to_list
       after_destroy :remove_from_list
     end
+
+    private
+
+    def orderable_field_opts(configuration)
+      field_opts = { :type => Integer }
+      field_opts.merge!(configuration.slice(:as))
+      field_opts
+    end
   end
 
   def move_to! target_position
@@ -98,7 +111,7 @@ module Mongoid::Orderable
   end
 
   def remove_from_list
-    orderable_scoped.where(orderable_column.gt => orderable_position).inc(orderable_column, -1)
+    MongoidOrderable.inc orderable_scoped.where(orderable_column.gt => orderable_position), orderable_column, -1
   end
 
 private
@@ -115,11 +128,21 @@ private
     if embedded?
       send(metadata.inverse).send(metadata.name).orderable_scope(self)
     else
-      self.class.orderable_scope(self)
+      (orderable_inherited_class || self.class).orderable_scope(self)
     end
   end
 
   def orderable_scope_changed?
+    if Mongoid.respond_to?(:unit_of_work)
+      Mongoid.unit_of_work do
+        orderable_scope_changed_query
+      end
+    else
+      orderable_scope_changed_query
+    end
+  end
+
+  def orderable_scope_changed_query
     !orderable_scoped.where(:_id => _id).exists?
   end
 
@@ -134,10 +157,10 @@ private
     target_position = target_position_to_position target_position
 
     unless in_list?
-      orderable_scoped.where(orderable_column.gte => target_position).inc(orderable_column, 1)
+      MongoidOrderable.inc orderable_scoped.where(orderable_column.gte => target_position), orderable_column, 1
     else
-      orderable_scoped.where(orderable_column.gte => target_position, orderable_column.lt => orderable_position).inc(orderable_column, 1) if target_position < orderable_position
-      orderable_scoped.where(orderable_column.gt => orderable_position, orderable_column.lte => target_position).inc(orderable_column, -1) if target_position > orderable_position
+      MongoidOrderable.inc(orderable_scoped.where(orderable_column.gte => target_position, orderable_column.lt => orderable_position), orderable_column, 1) if target_position < orderable_position
+      MongoidOrderable.inc(orderable_scoped.where(orderable_column.gt => orderable_position, orderable_column.lte => target_position), orderable_column, -1) if target_position > orderable_position
     end
 
     self.orderable_position = target_position

data/lib/mongoid_orderable.rb

@@ -1,6 +1,17 @@
 module MongoidOrderable
   def self.mongoid2?
-    Mongoid.const_defined? :Contexts
+    ::Mongoid.const_defined? :Contexts
+  end
+  def self.mongoid3?
+    ::Mongoid.const_defined? :Observer
+  end
+
+  def self.inc instance, attribute, value
+    if MongoidOrderable.mongoid2? || MongoidOrderable.mongoid3?
+      instance.inc attribute, value
+    else
+      instance.inc(attribute => value)
+    end
   end
 end
 

data/lib/mongoid_orderable/mongoid/contexts/enumerable.rb

@@ -4,7 +4,7 @@ module MongoidOrderable #:nodoc:
       module Enumerable #:nodoc:
         def inc attribute, value
           iterate do |doc|
-            doc.inc(attribute, value)
+            MongoidOrderable.inc doc, attribute, value
           end
         end
       end

data/lib/mongoid_orderable/mongoid/contextual/memory.rb

@@ -2,9 +2,9 @@ module MongoidOrderable #:nodoc:
   module Mongoid #:nodoc:
     module Contextual #:nodoc:
       module Memory #:nodoc:
-        def inc attribute, value
+        def inc(* args)
           each do |document|
-            document.inc(attribute, value)
+            document.inc *args
           end
         end
       end

data/lib/mongoid_orderable/version.rb

@@ -1,3 +1,3 @@
 module MongoidOrderable
-  VERSION = "1.2.0"
+  VERSION = '4.0.0'
 end

data/spec/mongoid/orderable_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Mongoid::Orderable do
+
   class SimpleOrderable
     include Mongoid::Document
     include Mongoid::Orderable
@@ -18,6 +19,7 @@ describe Mongoid::Orderable do
     include Mongoid::Document
     include Mongoid::Orderable
 
+    field :group_id
     belongs_to :scoped_group
 
     orderable :scope => :group
@@ -42,7 +44,7 @@ describe Mongoid::Orderable do
     include Mongoid::Document
     include Mongoid::Orderable
 
-    orderable :column => :pos
+    orderable :column => :pos, :as => :my_position
   end
 
   class NoIndexOrderable
@@ -59,7 +61,21 @@ describe Mongoid::Orderable do
     orderable :base => 0
   end
 
+  class Fruit
+    include Mongoid::Document
+    include Mongoid::Orderable
+
+    orderable :inherited => true
+  end
+
+  class Apple < Fruit
+  end
+
+  class Orange < Fruit
+  end
+
   describe SimpleOrderable do
+
     before :each do
       SimpleOrderable.delete_all
       5.times do
@@ -79,8 +95,10 @@ describe Mongoid::Orderable do
     it 'should have index on position column' do
       if MongoidOrderable.mongoid2?
         SimpleOrderable.index_options[:position].should_not be_nil
-      else
+      elsif MongoidOrderable.mongoid3?
         SimpleOrderable.index_options[{:position => 1}].should_not be_nil
+      else
+        SimpleOrderable.index_specifications.detect { |spec| spec.key == {:position => 1} }.should_not be_nil
       end
     end
 
@@ -108,7 +126,6 @@ describe Mongoid::Orderable do
         SimpleOrderable.where(:position => 3).destroy
         positions.should == [1, 2, 3, 4]
       end
-
     end
 
     describe 'inserting' do
@@ -130,7 +147,6 @@ describe Mongoid::Orderable do
         positions.should == [1, 2, 3, 4, 5, 6]
         newbie.position.should == 4
       end
-
     end
 
     describe 'movement' do
@@ -177,18 +193,17 @@ describe Mongoid::Orderable do
         record.reload.position.should == 4
       end
 
-      it "does nothing if position not change" do
+      it 'does nothing if position not change' do
         record = SimpleOrderable.where(:position => 3).first
         record.save
         positions.should == [1, 2, 3, 4, 5]
         record.reload.position.should == 3
       end
-
     end
-
   end
 
   describe ScopedOrderable do
+
     before :each do
       ScopedOrderable.delete_all
       2.times do
@@ -223,7 +238,6 @@ describe Mongoid::Orderable do
         ScopedOrderable.where(:position => 2, :group_id => 2).destroy
         positions.should == [1, 2, 1, 2]
       end
-
     end
 
     describe 'inserting' do
@@ -245,30 +259,72 @@ describe Mongoid::Orderable do
         positions.should == [1, 2, 1, 2, 3, 4]
         newbie.position.should == 2
       end
-
     end
 
-    describe "scope movement" do
+    describe 'scope movement' do
 
-      it "without point on position" do
-        record = ScopedOrderable.where(:group_id => 2, :position => 2).first
-        record.update_attributes :group_id => 1
-        positions.should == [1, 2, 3, 1, 2]
-        record.reload.position.should == 3
-      end
+      let(:record){ ScopedOrderable.where(:group_id => 2, :position => 2).first }
 
-      it "with point on position" do
-        record = ScopedOrderable.where(:group_id => 2, :position => 2).first
-        record.update_attributes :group_id => 1, :move_to => :top
-        positions.should == [1, 2, 3, 1, 2]
-        record.reload.position.should == 1
+      it 'to a new scope group' do
+        record.update_attributes :group_id => 3
+        positions.should == [1, 2, 1, 2, 1]
+        record.position.should == 1
       end
 
+      context 'when moving to an existing scope group' do
+
+        it 'without a position' do
+          record.update_attributes :group_id => 1
+          positions.should == [1, 2, 3, 1, 2]
+          record.reload.position.should == 3
+        end
+
+        it 'with symbol position' do
+          record.update_attributes :group_id => 1, :move_to => :top
+          positions.should == [1, 2, 3, 1, 2]
+          record.reload.position.should == 1
+        end
+
+        it 'with point position' do
+          record.update_attributes :group_id => 1, :move_to => 2
+          positions.should == [1, 2, 3, 1, 2]
+          record.reload.position.should == 2
+        end
+      end
     end
 
+    if defined?(Mongoid::IdentityMap)
+
+      context 'when identity map is enabled' do
+
+        let(:record){ ScopedOrderable.where(:group_id => 2, :position => 2).first }
+
+        before do
+          Mongoid.identity_map_enabled = true
+          Mongoid::IdentityMap[ScopedOrderable.collection_name] = { record.id => record }
+        end
+
+        after do
+          Mongoid.identity_map_enabled = false
+        end
+
+        it 'to a new scope group' do
+          record.update_attributes :group_id => 3
+          positions.should == [1, 2, 1, 2, 1]
+          record.position.should == 1
+        end
+
+        it 'to an existing scope group' do
+          record.update_attributes :group_id => 1, :move_to => 2
+          positions.should == [1, 2, 3, 1, 2]
+          record.reload.position.should == 2
+        end
+      end
+    end
   end
 
   describe EmbeddedOrderable do
+
     before :each do
       EmbedsOrderable.delete_all
       eo = EmbedsOrderable.create!
@@ -285,13 +341,20 @@ describe Mongoid::Orderable do
       EmbedsOrderable.order_by(:position => 1).all.map { |eo| eo.embedded_orderables.map(&:position).sort }
     end
 
-    it 'should set proper position while creation' do
+    it 'sets proper position while creation' do
       positions.should == [[1, 2], [1, 2, 3]]
     end
 
+    it 'moves an item returned by a query to position' do
+      embedded_orderable_1 = EmbedsOrderable.first.embedded_orderables.where(:position => 1).first
+      embedded_orderable_2 = EmbedsOrderable.first.embedded_orderables.where(:position => 2).first
+      embedded_orderable_1.move_to! 2
+      embedded_orderable_2.reload.position.should == 1
+    end
   end
 
   describe CustomizedOrderable do
+
     it 'does not have default position field' do
       CustomizedOrderable.fields.should_not have_key('position')
     end
@@ -299,16 +362,27 @@ describe Mongoid::Orderable do
     it 'should have custom pos field' do
       CustomizedOrderable.fields.should have_key('pos')
     end
+
+    it 'should have an alias my_position which points to pos field on Mongoid 3+' do
+      if CustomizedOrderable.respond_to?(:database_field_name)
+        CustomizedOrderable.database_field_name('my_position').should eq('pos')
+      end
+    end
   end
 
   describe NoIndexOrderable do
+
     it 'should not have index on position column' do
-      NoIndexOrderable.index_options[:position].should be_nil
+      if MongoidOrderable.mongoid2? || MongoidOrderable.mongoid3?
+        NoIndexOrderable.index_options[:position].should be_nil
+      else
+        NoIndexOrderable.index_specifications.detect { |spec| spec.key == :position }.should be_nil
+      end
     end
   end
 
-
   describe ZeroBasedOrderable do
+
     before :each do
       ZeroBasedOrderable.delete_all
       5.times do
@@ -344,7 +418,6 @@ describe Mongoid::Orderable do
         ZeroBasedOrderable.where(:position => 2).destroy
         positions.should == [0, 1, 2, 3]
       end
-
     end
 
     describe 'inserting' do
@@ -366,7 +439,6 @@ describe Mongoid::Orderable do
         positions.should == [0, 1, 2, 3, 4, 5]
         newbie.position.should == 3
       end
-
     end
 
     describe 'movement' do
@@ -413,15 +485,22 @@ describe Mongoid::Orderable do
         record.reload.position.should == 3
       end
 
-      it "does nothing if position not change" do
+      it 'does nothing if position not change' do
         record = ZeroBasedOrderable.where(:position => 3).first
         record.save
         positions.should == [0, 1, 2, 3, 4]
         record.reload.position.should == 3
       end
-
     end
-
   end
 
+  describe Fruit do
+
+    it 'should set proper position' do
+      fruit1 = Apple.create
+      fruit2 = Orange.create
+      fruit1.position.should == 1
+      fruit2.position.should == 2
+    end
+  end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_orderable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 4.0.0
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,6 +63,7 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -85,33 +79,26 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 796603552408515910
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 796603552408515910
 requirements: []
 rubyforge_project: mongoid_orderable
-rubygems_version: 1.8.24
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Acts as list mongoid implementation
 test_files:
 - spec/mongoid/orderable_spec.rb