sortability 0.1.0 → 1.1.0

data/spec/lib/sortability/active_record/base_spec.rb

@@ -3,7 +3,208 @@ require "rails_helper"
 module Sortability
   module ActiveRecord
     RSpec.describe Base do
-      pending "add some examples to (or delete) #{__FILE__}"
+      context 'unscoped' do
+        let(:container_1) { Container.new }
+        let(:container_2) { Container.new }
+
+        it 'can return the sort peers for a record' do
+          expect(container_1.sort_position_peers).to be_empty
+          expect(container_2.sort_position_peers).to be_empty
+
+          container_1.save!
+          expect(container_1.sort_position_peers).to eq [ container_1 ]
+          expect(container_2.sort_position_peers).to eq [ container_1 ]
+
+          container_2.save!
+          expect(container_1.sort_position_peers).to eq [ container_1, container_2 ]
+          expect(container_2.sort_position_peers).to eq [ container_1, container_2 ]
+        end
+
+        it 'automatically assigns sequential sort_positions to created records' do
+          expect(container_1.sort_position).to be_nil
+          expect(container_2.sort_position).to be_nil
+
+          container_1.save!
+          expect(container_1.sort_position).to eq 1
+          expect(container_2.sort_position).to be_nil
+
+          container_2.save!
+          expect(container_1.sort_position).to eq 1
+          expect(container_2.sort_position).to eq 2
+        end
+
+        it "automatically increases other records' sort_positions to avoid conflicts" do
+          container_1.save!
+          container_2.save!
+          container_3 = Container.create! sort_position: 1
+
+          expect(container_1.reload.sort_position).to eq 2
+          expect(container_2.reload.sort_position).to eq 3
+          expect(container_3.sort_position).to eq 1
+          expect(container_3.reload.sort_position).to eq 1
+        end
+
+        it 'can return the next record by sort_position' do
+          container_1.save!
+          container_2.save!
+
+          expect(container_1.next_by_sort_position).to eq container_2
+          expect(container_2.next_by_sort_position).to be_nil
+        end
+
+        it 'can return the previous record by sort_position' do
+          container_1.save!
+          container_2.save!
+
+          expect(container_1.previous_by_sort_position).to be_nil
+          expect(container_2.previous_by_sort_position).to eq container_1
+        end
+
+        it 'can compact the sort peers to make their numbers sequential' do
+          container_1.sort_position = 21
+          container_1.save!
+          container_2.sort_position = 42
+          container_2.save!
+
+          expect(container_1.reload.sort_position).to eq 21
+          expect(container_2.reload.sort_position).to eq 42
+
+          container_1.compact_sort_position_peers!
+
+          expect(container_1.sort_position).to eq 1
+          expect(container_1.reload.sort_position).to eq 1
+          expect(container_2.reload.sort_position).to eq 2
+
+          container_2.compact_sort_position_peers!
+
+          expect(container_1.reload.sort_position).to eq 1
+          expect(container_2.sort_position).to eq 2
+          expect(container_2.reload.sort_position).to eq 2
+        end
+      end
+
+      context 'scoped' do
+        let(:container_1) { Container.create }
+        let(:container_2) { Container.create }
+        let(:item_1)      { Item.new(container: container_1) }
+        let(:item_2)      { Item.new(container: container_1) }
+        let(:item_3)      { Item.new(container: container_2) }
+
+        it 'can return the sort peers for a record' do
+          expect(item_1.sort_position_peers).to be_empty
+          expect(item_2.sort_position_peers).to be_empty
+          expect(item_3.sort_position_peers).to be_empty
+
+          item_1.save!
+          expect(item_1.sort_position_peers).to eq [ item_1 ]
+          expect(item_2.sort_position_peers).to eq [ item_1 ]
+          expect(item_3.sort_position_peers).to be_empty
+
+          container_1.reload
+          container_2.reload
+
+          item_2.save!
+          expect(item_1.sort_position_peers).to eq [ item_1, item_2 ]
+          expect(item_2.sort_position_peers).to eq [ item_1, item_2 ]
+          expect(item_3.sort_position_peers).to be_empty
+
+          container_1.reload
+          container_2.reload
+
+          item_3.save!
+          expect(item_1.sort_position_peers).to eq [ item_1, item_2 ]
+          expect(item_2.sort_position_peers).to eq [ item_1, item_2 ]
+          expect(item_3.sort_position_peers).to eq [ item_3 ]
+        end
+
+        it 'automatically assigns sequential sort_positions to created records in each scope' do
+          expect(item_1.sort_position).to be_nil
+          expect(item_2.sort_position).to be_nil
+          expect(item_3.sort_position).to be_nil
+
+          item_1.save!
+          expect(item_1.sort_position).to eq 1
+          expect(item_2.sort_position).to be_nil
+          expect(item_3.sort_position).to be_nil
+
+          item_2.save!
+          expect(item_1.sort_position).to eq 1
+          expect(item_2.sort_position).to eq 2
+          expect(item_3.sort_position).to be_nil
+
+          item_3.save!
+          expect(item_1.sort_position).to eq 1
+          expect(item_2.sort_position).to eq 2
+          expect(item_3.sort_position).to eq 1
+        end
+
+        it "automatically increases other records' sort_positions to avoid conflicts" do
+          item_1.save!
+          item_2.save!
+          item_3.save!
+          item_4 = Item.create! container: container_1, sort_position: 1
+
+          expect(item_1.reload.sort_position).to eq 2
+          expect(item_2.reload.sort_position).to eq 3
+          expect(item_3.reload.sort_position).to eq 1
+          expect(item_4.sort_position).to eq 1
+          expect(item_4.reload.sort_position).to eq 1
+        end
+
+        it 'can return the next record by sort_position' do
+          item_1.save!
+          item_2.save!
+          item_3.save!
+
+          expect(item_1.next_by_sort_position).to eq item_2
+          expect(item_2.next_by_sort_position).to be_nil
+          expect(item_3.next_by_sort_position).to be_nil
+        end
+
+        it 'can return the previous record by sort_position' do
+          item_1.save!
+          item_2.save!
+          item_3.save!
+
+          expect(item_1.previous_by_sort_position).to be_nil
+          expect(item_2.previous_by_sort_position).to eq item_1
+          expect(item_3.previous_by_sort_position).to be_nil
+        end
+
+        it 'can compact the sort peers to make their numbers sequential' do
+          item_1.sort_position = 21
+          item_1.save!
+          item_2.sort_position = 42
+          item_2.save!
+          item_3.sort_position = 84
+          item_3.save!
+
+          expect(item_1.reload.sort_position).to eq 21
+          expect(item_2.reload.sort_position).to eq 42
+          expect(item_3.reload.sort_position).to eq 84
+
+          item_1.compact_sort_position_peers!
+
+          expect(item_1.sort_position).to eq 1
+          expect(item_1.reload.sort_position).to eq 1
+          expect(item_2.reload.sort_position).to eq 2
+          expect(item_3.reload.sort_position).to eq 84
+
+          item_2.compact_sort_position_peers!
+
+          expect(item_1.reload.sort_position).to eq 1
+          expect(item_2.sort_position).to eq 2
+          expect(item_2.reload.sort_position).to eq 2
+          expect(item_3.reload.sort_position).to eq 84
+
+          item_3.compact_sort_position_peers!
+
+          expect(item_1.reload.sort_position).to eq 1
+          expect(item_2.reload.sort_position).to eq 2
+          expect(item_3.sort_position).to eq 1
+          expect(item_3.reload.sort_position).to eq 1
+        end
+      end
     end
   end
 end

data/spec/lib/sortability/active_record/connection_adapters/table_definition_spec.rb

@@ -4,7 +4,27 @@ module Sortability
   module ActiveRecord
     module ConnectionAdapters
       RSpec.describe TableDefinition do
-        pending "add some examples to (or delete) #{__FILE__}"
+        let(:table_definition) { ::ActiveRecord::ConnectionAdapters::TableDefinition.new nil, :test }
+
+        context 'without :on and :null' do
+          let(:options) { { something: :else } }
+
+          it '#sortable calls the #integer method, adding defaults' do
+            expect(table_definition).to(
+              receive(:integer).with(:sort_position, options.merge(null: false))
+            )
+            table_definition.sortable options
+          end
+        end
+
+        context 'with :on and :null' do
+          let(:options) { { something: :else, on: :pos, null: true } }
+
+          it '#sortable calls the #integer method with the given options' do
+            expect(table_definition).to receive(:integer).with(:pos, options.except(:on))
+            table_definition.sortable options
+          end
+        end
       end
     end
   end

data/spec/lib/sortability/active_record/migration_spec.rb

@@ -3,7 +3,50 @@ require "rails_helper"
 module Sortability
   module ActiveRecord
     RSpec.describe Migration do
-      pending "add some examples to (or delete) #{__FILE__}"
+      let(:migration) { ::ActiveRecord::Migration.new }
+      let(:table)     { :test }
+
+      context 'without some options' do
+        let(:options) { { something: :else } }
+
+        it '#add_sortable_column can add a sortable column, adding defaults' do
+          expect(migration).to receive(:method_missing).with(
+            :add_column, table, :sort_position, :integer, options.merge(null: false)
+          )
+
+          migration.add_sortable_column table, options
+        end
+
+        it '#add_sortable_index can add a sortable index, adding defaults' do
+          expect(migration).to receive(:method_missing).with(
+            :add_index, table, [ :sort_position ], options.merge(unique: true)
+          )
+
+          migration.add_sortable_index table, options
+        end
+      end
+
+      context 'with all options' do
+        let(:options) do
+          { something: :else, on: :pos, null: true, unique: false, scope: :container_id }
+        end
+
+        it '#add_sortable_column can add a sortable column with the given options' do
+          expect(migration).to receive(:method_missing).with(
+            :add_column, table, :pos, :integer, options.except(:on)
+          )
+
+          migration.add_sortable_column table, options
+        end
+
+        it '#add_sortable_index can add a sortable index with the given options' do
+          expect(migration).to receive(:method_missing).with(
+            :add_index, table, [ :container_id, :pos ], options.except(:on, :scope)
+          )
+
+          migration.add_sortable_index table, options
+        end
+      end
     end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sortability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dante Soares
 - JP Slavinsky
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,56 +17,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: squeel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Provides ActiveRecord methods that make it easy to allow users to sort
   and reorder records in a list
 email:
@@ -85,10 +77,14 @@ files:
 - lib/sortability/version.rb
 - spec/dummy/README.md
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/container.rb
+- spec/dummy/app/models/item.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -112,8 +108,10 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20190523235417_create_containers.rb
+- spec/dummy/db/migrate/20190523235430_create_items.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
 - spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -128,7 +126,7 @@ homepage: https://github.com/openstax/sortability
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,16 +141,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: Rails gem that provides easy to use ordered records
 test_files:
+- spec/dummy/README.md
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/container.rb
+- spec/dummy/app/models/item.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -176,15 +179,15 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
+- spec/dummy/db/migrate/20190523235417_create_containers.rb
+- spec/dummy/db/migrate/20190523235430_create_items.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
 - spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.md
 - spec/lib/sortability/active_record/base_spec.rb
 - spec/lib/sortability/active_record/connection_adapters/table_definition_spec.rb
 - spec/lib/sortability/active_record/migration_spec.rb