mongoid_orderable 5.0.0 → 6.0.2

data/spec/integration/zero_based_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe ZeroBasedOrderable do
+
+  shared_examples_for 'zero_based_orderable' do
+
+    before :each do
+      5.times { ZeroBasedOrderable.create! }
+    end
+
+    def positions
+      ZeroBasedOrderable.pluck(:position).sort
+    end
+
+    it 'should have a orderable base of 0' do
+      expect(ZeroBasedOrderable.create!.orderable_top).to eq(0)
+    end
+
+    it 'should set proper position while creation' do
+      expect(positions).to eq([0, 1, 2, 3, 4])
+    end
+
+    describe 'reset position' do
+      before { ZeroBasedOrderable.update_all(position: nil) }
+      it 'should properly reset position' do
+        ZeroBasedOrderable.all.map(&:save)
+        expect(positions).to eq([0, 1, 2, 3, 4])
+      end
+    end
+
+    describe 'removement' do
+      it 'top' do
+        ZeroBasedOrderable.where(position: 0).destroy
+        expect(positions).to eq([0, 1, 2, 3])
+      end
+
+      it 'bottom' do
+        ZeroBasedOrderable.where(position: 4).destroy
+        expect(positions).to eq([0, 1, 2, 3])
+      end
+
+      it 'middle' do
+        ZeroBasedOrderable.where(position: 2).destroy
+        expect(positions).to eq([0, 1, 2, 3])
+      end
+    end
+
+    describe 'inserting' do
+      it 'top' do
+        newbie = ZeroBasedOrderable.create! move_to: :top
+        expect(positions).to eq([0, 1, 2, 3, 4, 5])
+        expect(newbie.position).to eq(0)
+      end
+
+      it 'bottom' do
+        newbie = ZeroBasedOrderable.create! move_to: :bottom
+        expect(positions).to eq([0, 1, 2, 3, 4, 5])
+        expect(newbie.position).to eq(5)
+      end
+
+      it 'middle' do
+        newbie = ZeroBasedOrderable.create! move_to: 3
+        expect(positions).to eq([0, 1, 2, 3, 4, 5])
+        expect(newbie.position).to eq(3)
+      end
+
+      it 'middle (with a numeric string)' do
+        newbie = ZeroBasedOrderable.create! move_to: '3'
+        expect(positions).to eq([0, 1, 2, 3, 4, 5])
+        expect(newbie.position).to eq(3)
+      end
+
+      it 'middle (with a non-numeric string)' do
+        expect do
+          ZeroBasedOrderable.create! move_to: 'three'
+        end.to raise_error Mongoid::Orderable::Errors::InvalidTargetPosition
+      end
+    end
+
+    describe 'movement' do
+      it 'higher from top' do
+        record = ZeroBasedOrderable.where(position: 0).first
+        record.update_attributes move_to: :higher
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(0)
+      end
+
+      it 'higher from bottom' do
+        record = ZeroBasedOrderable.where(position: 4).first
+        record.update_attributes move_to: :higher
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(3)
+      end
+
+      it 'higher from middle' do
+        record = ZeroBasedOrderable.where(position: 3).first
+        record.update_attributes move_to: :higher
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(2)
+      end
+
+      it 'lower from top' do
+        record = ZeroBasedOrderable.where(position: 0).first
+        record.update_attributes move_to: :lower
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(1)
+      end
+
+      it 'lower from bottom' do
+        record = ZeroBasedOrderable.where(position: 4).first
+        record.update_attributes move_to: :lower
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(4)
+      end
+
+      it 'lower from middle' do
+        record = ZeroBasedOrderable.where(position: 2).first
+        record.update_attributes move_to: :lower
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(3)
+      end
+
+      it 'does nothing if position not change' do
+        record = ZeroBasedOrderable.where(position: 3).first
+        record.save
+        expect(positions).to eq([0, 1, 2, 3, 4])
+        expect(record.reload.position).to eq(3)
+      end
+    end
+
+    describe 'utility methods' do
+      it 'should return a collection of items lower/higher on the list for next_items/previous_items' do
+        record1 = ZeroBasedOrderable.where(position: 0).first
+        record2 = ZeroBasedOrderable.where(position: 1).first
+        record3 = ZeroBasedOrderable.where(position: 2).first
+        record4 = ZeroBasedOrderable.where(position: 3).first
+        record5 = ZeroBasedOrderable.where(position: 4).first
+        expect(record1.next_items.to_a).to eq([record2, record3, record4, record5])
+        expect(record5.previous_items.to_a).to eq([record1, record2, record3, record4])
+        expect(record3.previous_items.to_a).to eq([record1, record2])
+        expect(record3.next_items.to_a).to eq([record4, record5])
+        expect(record1.next_item).to eq(record2)
+        expect(record2.previous_item).to eq(record1)
+        expect(record1.previous_item).to eq(nil)
+        expect(record5.next_item).to eq(nil)
+      end
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'zero_based_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'zero_based_orderable'
+  end
+end

data/spec/spec_helper.rb

@@ -1,30 +1,42 @@
-require 'bundler'
-Bundler.require
-
-if ::Mongoid::Compatibility::Version.mongoid2?
-  Mongoid.configure do |config|
-    config.master = Mongo::Connection.new.db 'mongoid_orderable_test'
-    config.logger = nil
-  end
-else
-  Mongoid.configure do |config|
-    config.connect_to 'mongoid_orderable_test'
-  end
-end
-
-unless Mongoid::Compatibility::Version.mongoid2?
-  Mongoid.logger.level = Logger::INFO
-  Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
-end
-
-RSpec.configure do |config|
-  config.after(:all) do
-    if Mongoid::Compatibility::Version.mongoid2?
-      Mongoid.master.connection.drop_database(Mongoid.database.name)
-    elsif Mongoid::Compatibility::Version.mongoid3? || Mongoid::Compatibility::Version.mongoid4?
-      Mongoid.default_session.drop
-    else
-      Mongoid::Clients.default.database.drop
-    end
-  end
-end
+require 'bundler'
+Bundler.require
+require 'rspec'
+require 'rspec/retry'
+
+Mongoid.configure do |config|
+  config.connect_to 'mongoid_orderable_test'
+end
+
+Mongoid.logger.level = Logger::INFO
+Mongo::Logger.logger.level = Logger::INFO
+Mongoid::Config.belongs_to_required_by_default = false
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.before(:each) do
+    Mongoid.purge!
+    Mongoid.models.each do |model|
+      model.create_indexes if model.name =~ /Mongoid::Orderable::Models/
+    end
+  end
+end
+
+require_relative 'support/models'
+
+def set_transactions(enabled)
+  Mongoid.models.each do |model|
+    next unless model.respond_to?(:orderable_configs)
+    model.orderable_configs.values.each do |config|
+      config[:use_transactions] = enabled
+    end
+  end
+end
+
+def enable_transactions!
+  before { set_transactions(true) }
+end
+
+def disable_transactions!
+  before { set_transactions(false) }
+end

data/spec/support/models.rb

@@ -0,0 +1,122 @@
+
+
+Mongoid::Orderable.configure do |c|
+  c.use_transactions = true
+  c.transaction_max_retries = 100
+  c.lock_collection = :foo_bar_locks
+end
+
+class SimpleOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  orderable
+end
+
+class ScopedGroup
+  include Mongoid::Document
+
+  has_many :scoped_orderables
+  has_many :multiple_fields_orderables
+end
+
+class ScopedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  belongs_to :group, class_name: 'ScopedGroup', optional: true
+
+  orderable scope: :group
+end
+
+class StringScopedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  field :some_scope, type: Integer
+
+  orderable scope: 'some_scope'
+end
+
+class EmbedsOrderable
+  include Mongoid::Document
+
+  embeds_many :embedded_orderables
+end
+
+class EmbeddedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  embedded_in :embeds_orderable
+
+  orderable
+end
+
+class CustomizedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  orderable field: :pos, as: :my_position
+end
+
+class NoIndexOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  orderable index: false
+end
+
+class ZeroBasedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  orderable base: 0
+end
+
+class InheritedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  orderable inherited: true
+end
+
+class Apple < InheritedOrderable
+  orderable field: :serial
+end
+
+class Orange < InheritedOrderable
+end
+
+class ForeignKeyDiffersOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  belongs_to :different_scope, class_name: 'ForeignKeyDiffersOrderable',
+             foreign_key: 'different_orderable_id',
+             optional: true
+
+  orderable scope: :different_scope
+end
+
+class MultipleFieldsOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  belongs_to :group, class_name: 'ScopedGroup', optional: true
+
+  orderable field: :pos, base: 0, index: false, as: :position
+  orderable field: :serial_no, default: true
+  orderable field: :groups, scope: :group
+end
+
+class MultipleScopedOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  belongs_to :apple, optional: true
+  belongs_to :orange, optional: true
+
+  orderable field: :posa, scope: :apple_id
+  orderable field: :poso, scope: :orange_id
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_orderable
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.2
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,22 +30,22 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,61 +53,84 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid-compatibility
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Gem allows mongoid model behave as orderable list
+        version: 7.0.0
+description: Enables Mongoid models to track their position in list
 email:
 - kinwizard@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rvmrc"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/config/locales/en.yml
 - lib/mongoid/orderable.rb
-- lib/mongoid/orderable/callbacks.rb
-- lib/mongoid/orderable/configuration.rb
-- lib/mongoid/orderable/errors.rb
+- lib/mongoid/orderable/configs/field_config.rb
+- lib/mongoid/orderable/configs/global_config.rb
 - lib/mongoid/orderable/errors/invalid_target_position.rb
-- lib/mongoid/orderable/errors/mongoid_orderable_error.rb
-- lib/mongoid/orderable/generator.rb
-- lib/mongoid/orderable/generator/helpers.rb
-- lib/mongoid/orderable/generator/listable.rb
-- lib/mongoid/orderable/generator/movable.rb
-- lib/mongoid/orderable/generator/position.rb
-- lib/mongoid/orderable/generator/scope.rb
-- lib/mongoid/orderable/helpers.rb
-- lib/mongoid/orderable/listable.rb
-- lib/mongoid/orderable/movable.rb
-- lib/mongoid/orderable/orderable_class.rb
+- lib/mongoid/orderable/errors/transaction_failed.rb
+- lib/mongoid/orderable/generators/base.rb
+- lib/mongoid/orderable/generators/helpers.rb
+- lib/mongoid/orderable/generators/listable.rb
+- lib/mongoid/orderable/generators/lock_collection.rb
+- lib/mongoid/orderable/generators/movable.rb
+- lib/mongoid/orderable/generators/position.rb
+- lib/mongoid/orderable/generators/scope.rb
+- lib/mongoid/orderable/handlers/base.rb
+- lib/mongoid/orderable/handlers/document.rb
+- lib/mongoid/orderable/handlers/document_embedded.rb
+- lib/mongoid/orderable/handlers/document_transactional.rb
+- lib/mongoid/orderable/handlers/transaction.rb
+- lib/mongoid/orderable/installer.rb
+- lib/mongoid/orderable/mixins/callbacks.rb
+- lib/mongoid/orderable/mixins/helpers.rb
+- lib/mongoid/orderable/mixins/listable.rb
+- lib/mongoid/orderable/mixins/movable.rb
+- lib/mongoid/orderable/version.rb
 - lib/mongoid_orderable.rb
-- lib/mongoid_orderable/mongoid/contexts/enumerable.rb
-- lib/mongoid_orderable/mongoid/contexts/mongo.rb
-- lib/mongoid_orderable/mongoid/contextual/memory.rb
-- lib/mongoid_orderable/mongoid/criteria.rb
-- lib/mongoid_orderable/version.rb
-- mongoid_orderable.gemspec
-- spec/mongoid/orderable_spec.rb
+- spec/integration/concurrency_spec.rb
+- spec/integration/customized_spec.rb
+- spec/integration/embedded_spec.rb
+- spec/integration/foreign_key_spec.rb
+- spec/integration/inherited_spec.rb
+- spec/integration/multiple_fields_spec.rb
+- spec/integration/multiple_scoped_spec.rb
+- spec/integration/no_indexed_spec.rb
+- spec/integration/scoped_spec.rb
+- spec/integration/simple_spec.rb
+- spec/integration/string_scoped_spec.rb
+- spec/integration/zero_based_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+- spec/support/models.rb
+homepage: https://github.com/mongoid/mongoid_orderable
 licenses: []
 metadata: {}
 post_install_message: 
@@ -125,11 +148,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: mongoid_orderable
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Acts as list mongoid implementation
+summary: Mongoid orderable list implementation
 test_files:
-- spec/mongoid/orderable_spec.rb
+- spec/integration/concurrency_spec.rb
+- spec/integration/customized_spec.rb
+- spec/integration/embedded_spec.rb
+- spec/integration/foreign_key_spec.rb
+- spec/integration/inherited_spec.rb
+- spec/integration/multiple_fields_spec.rb
+- spec/integration/multiple_scoped_spec.rb
+- spec/integration/no_indexed_spec.rb
+- spec/integration/scoped_spec.rb
+- spec/integration/simple_spec.rb
+- spec/integration/string_scoped_spec.rb
+- spec/integration/zero_based_spec.rb
 - spec/spec_helper.rb
+- spec/support/models.rb