oort 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59358b08ac7c205469cd32c017b73ab36846c520e6d066e67c577bfd4daaacad
-  data.tar.gz: 1c8ab9a97f89c45b7f1630198b2d810ceb6a877d7adbfd0641c92241e5aca425
+  metadata.gz: 93d4111c81efb6f7e4f31bca10cfbef5c96a89ff1513db010fc6e31c45905552
+  data.tar.gz: d2fd5e70bb3ae83b72524fbb768551d8319db308aa9e0c124735804f29477421
 SHA512:
-  metadata.gz: 819c6dce941d799a7497e88fe05bc104391e5bc0ce13e3f4ed0a96e388a1ccb3940f1e46de139a02fc742dc2fc26fa2b9643d5ce30995ae242fb2bf5132c4e44
-  data.tar.gz: 7763c120b0311b667159bf1adc48c464a8b43d3a770ac78af8bc9fcba7e616bbce11eef5564859c149b3ea09656e75e29bc2183f35d085fc6942d78a83b5fc58
+  metadata.gz: 6b81fea732d5131d90cc061fe21536edbdc2a1d35022b90feccd00c90fefb818e0ec4d29487202378c03a4a919bc1aef1e67165774b2e459d38bdf261ed15716
+  data.tar.gz: da75ab4163fe2b5ddb37099659ae0c38a248bdd44e2c8bcf627ad5e17ce6d634813c02072bafe876797b0b2a9973797a88f92ba8cf9d230a910462af9327abfe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oort (0.1.1)
+    oort (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -69,6 +69,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-22
 
 DEPENDENCIES
   activerecord (~> 7.0, >= 7.0.1)
@@ -81,4 +82,4 @@ DEPENDENCIES
   zeitwerk (~> 2.5)
 
 BUNDLED WITH
-   2.4.10
+   2.5.3

data/README.md

@@ -17,7 +17,7 @@ Let's begin with a basic schema involving a User and a Post. You can substitute
 
 Firstly, you will also need the following migration to users (postgresql only for now):
 
-```
+```RUBY
   def change
     add_column(:users, :posts_ordering, :integer, array: true, default: [], using: 'ARRAY[benefit_type]::INTEGER[]')
 
@@ -31,7 +31,7 @@ This will store the ids of posts in an array on the user, and will only accept i
 
 Include the `Oort::Ordered` module in the parent object:
 
-```
+```RUBY
 class User < ActiveRecord::Base
   include Oort::Ordered
   handles_ordering_of :posts
@@ -52,7 +52,7 @@ This inclusion adds `update_posts_ordering` to the user model and `insert_at` to
 
 The following callbacks are also added to post:
 
-```
+```RUBY
 after_create_commit :insert_at
 after_destroy :remove_from_reorderable
 ```
@@ -63,10 +63,20 @@ These callbacks automatically insert a new post at the first position and remove
 To change to order of a post, simply call `post.insert_at(12)`
 To remove a post, simply call `post.remove_from_reorderable`
 
-### Scope
-The `ordered_with` scope is also added to the post model. This allows a `user` object to have the following query:
+### Scopes
+You can add the `ordered_with` scope.
+
+```RUBY
+class Post < ActiveRecord::Base
+  include Oort::Scopes
 
+  belongs_to :user
+end
 ```
+
+This allows a `user` object to have the following query:
+
+```RUBY
 user.posts.ordered_with(user.posts_ordering)
 
 # or
@@ -74,6 +84,21 @@ user.posts.ordered_with(user.posts_ordering)
 Post.where(user_id: user.id).ordered_with(user.posts_ordering)
 ```
 
+### Customization
+
+`handles_ordering_of` can allow for new records to be the top of the order or the bottom of the order. By default it will push any new records to the top of the order, but you can specify the bottom of the order like so:
+
+```ruby
+
+class User < ActiveRecord::Base
+  include Oort::Ordered
+  handles_ordering_of :posts, default: :bottom
+
+  has_many :posts
+end
+
+```
+
 
 ## Installation
 

data/Rakefile

@@ -7,6 +7,8 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = false
 end
 
 require "rubocop/rake_task"

data/lib/oort/callbacks.rb

@@ -2,22 +2,24 @@
 
 module Oort
   class Callbacks
-    def self.call(association_class:, remove_from_method_name:, insert_method_name:, instance_name:)
+    def self.call(association_class:, remove_from_method_name:, insert_method_name:, instance_name:, default:)
       new(
         association_class: association_class,
         remove_from_method_name: remove_from_method_name,
         insert_method_name: insert_method_name,
-        instance_name: instance_name
+        instance_name: instance_name,
+        default: default
       ).call
     end
 
-    attr_reader :association_class, :remove_from_method_name, :insert_method_name, :instance_name
+    attr_reader :association_class, :remove_from_method_name, :insert_method_name, :instance_name, :default
 
-    def initialize(association_class:, remove_from_method_name:, insert_method_name:, instance_name:)
+    def initialize(association_class:, remove_from_method_name:, insert_method_name:, instance_name:, default:)
       @association_class = association_class
       @remove_from_method_name = remove_from_method_name
       @insert_method_name = insert_method_name
       @instance_name = instance_name
+      @default = default
     end
 
     def call
@@ -29,7 +31,7 @@ module Oort
 
     def add_callbacks
       association_class.class_eval do
-        after_create_commit :insert_at
+        after_create_commit :initial_insert_at
         after_destroy :remove_from_reorderable
       end
     end
@@ -45,9 +47,13 @@ module Oort
         #   public_send(:user).public_send(:remove_from_posts_ordering, id)
         # end
         <<-RUBY, __FILE__, __LINE__ + 1
-          def insert_at(position = 0)
+          def insert_at(position = 0, initial: nil)
             public_send(#{instance_name.inspect})
-              .public_send(#{insert_method_name.inspect}, insert: id, at: position)
+              .public_send(#{insert_method_name.inspect}, insert: id, at: position, initial: initial)
+          end
+
+          def initial_insert_at
+            insert_at(initial: #{default.inspect})
           end
 
           def remove_from_reorderable

data/lib/oort/inserts.rb

@@ -26,13 +26,22 @@ module Oort
         #   end
         # end
         <<-RUBY, __FILE__, __LINE__ + 1
-          def #{insert_method_name}(insert:, at: 0)
+          def #{insert_method_name}(insert:, at: 0, initial: nil)
             with_lock do
               current_values = public_send(#{stored_in.inspect})
-              current_index = current_values.find_index(insert)
-              insertable = current_index.blank? ? insert : current_values.delete_at(current_index)
-              current_values.insert(at, insertable)
-              update(#{stored_in.inspect} => current_values)
+
+              if initial == :top
+                current_values.unshift(insert)
+                save
+              elsif initial == :bottom
+                current_values << insert
+                save
+              else
+                current_index = current_values.find_index(insert)
+                insertable = current_index.blank? ? insert : current_values.delete_at(current_index)
+                current_values.insert(at, insertable)
+                update(#{stored_in.inspect} => current_values)
+              end
             end
           end
         RUBY

data/lib/oort/ordered.rb

@@ -7,27 +7,25 @@ module Oort
   module Ordered
     def self.included(base)
       base.extend ClassMethods
-      # base.include InstanceMethods
-
-      base.class_eval do
-      end
     end
 
     module ClassMethods
-      def handles_ordering_of(association)
+      def handles_ordering_of(association, default: :top)
         args = {
           stored_in: :"#{association}_ordering",
           insert_method_name: :"update_#{association}_ordering",
           remove_from_method_name: :"remove_from_#{association}_ordering",
           association_class: association.to_s.classify.constantize,
           instance_name: :"#{name.downcase}",
-          class_name: name.classify.constantize
+          class_name: name.classify.constantize,
+          default:
         }
 
         Inserts.call(**args.slice(:stored_in, :insert_method_name, :class_name))
         Removes.call(**args.slice(:stored_in, :remove_from_method_name, :class_name))
-        Scopes.call(**args.slice(:association_class))
-        Callbacks.call(**args.slice(:association_class, :remove_from_method_name, :insert_method_name, :instance_name))
+        Callbacks.call(
+          **args.slice(:association_class, :remove_from_method_name, :insert_method_name, :instance_name, :default)
+        )
       end
     end
   end

data/lib/oort/scopes.rb

@@ -1,30 +1,20 @@
 # frozen_string_literal: true
 
 module Oort
-  class Scopes
-    def self.call(association_class:)
-      new(association_class: association_class).call
-    end
-
-    def initialize(association_class:)
-      @association_class = association_class
-    end
-
-    def call
+  module Scopes
+    def self.included(base)
       # user = User.find(909)
       # user.posts.ordered_with(user.posts_ordered)
       # by default this will use posts.id::INTEGER
       # but you can pass in something else if you have joins and items
       # stored in another table
-      @association_class.class_eval do
-        scope :ordered_with, lambda { |ids, type = "#{table_name}.id::INTEGER"|
-          if ids.blank?
-            order(:id)
-          else
-            order(Arel.sql("array_position(ARRAY[#{ids.join(", ")}], #{type})"))
-          end
-        }
-      end
+      base.scope :ordered_with, lambda { |ids, type = "#{table_name}.id::INTEGER"|
+                                  if ids.blank?
+                                    order(:id)
+                                  else
+                                    order(Arel.sql("array_position(ARRAY[#{ids.join(", ")}], #{type})"))
+                                  end
+                                }
     end
   end
 end

data/lib/oort/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oort
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oort
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - tobyond
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies: []
 description: Rails sorting and ordering without deadlocks
 email:
@@ -40,6 +40,7 @@ files:
 - lib/oort/removes.rb
 - lib/oort/scopes.rb
 - lib/oort/version.rb
+- oort-0.1.2.gem
 - sig/oort.rbs
 homepage: https://github.com/tobyond/oort
 licenses:
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Oort to sort, order