lexorank 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4643e7db16d6b8ed5dcb807f80d2350663f168b8b66e0e81791d1c746fd1a17a
-  data.tar.gz: 2fdf4f043ef14b8fab235422f409b151fc1117000ea304c2612ccb0e71a079ca
+  metadata.gz: 422a0db95be12bd9cffe35d7f549b1ebb71dd5de9751424a3794fd18dc2065c1
+  data.tar.gz: 8d00dd0cb9331d2a5152bb9f68c3ba7a29ac84de4732bc03bf5bc78a946c8a58
 SHA512:
-  metadata.gz: 27fb2b029e5eab9088a1236b0b0cb18688e0a8efdee64cfedee869dd1b72a7257056757d59989dd6a0ffc8164af77282108258d066fd8462a1dfc0f074128b61
-  data.tar.gz: 9dda1742be04a290c3b68defcbb6f88302665ee01ff0f5cbb4086a62a004ee95e7ebe381f1280414dee6d84a8810a177e712ae4f86eee4c8e243a40a5c20d216
+  metadata.gz: c49a7c38ed0853cdddc5fd1664d085ad08b8b2d91c00e8920da4a19078c6949dd29608bd92013eb31fabd2b1b46191c9ef589fb53629196f0582b53d132ca0f6
+  data.tar.gz: 6e303a53f9185913313d20ef37a9a549b1323c174c98cda5f3533e8bf16e1188ece014fa0fbbf8545b55e040b316f671aa960b99adae3b184ab05e00c6783026

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Richard Böhme
+Copyright (c) 2024 Richard Böhme
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/lexorank/rankable.rb

@@ -1,92 +1,61 @@
+# frozen_string_literal: true
+
 require 'lexorank'
+require 'lexorank/ranking'
 require 'active_support/concern'
 
 module Lexorank::Rankable
   extend ActiveSupport::Concern
 
   module ClassMethods
-    attr_reader :ranking_column, :ranking_group_by
+    attr_reader :lexorank_ranking
 
-    def rank!(field: :rank, group_by: nil)
-      @ranking_column = check_column(field)
-      if group_by
-        @ranking_group_by = check_column(group_by)
-        unless @ranking_group_by
-          warn "The supplied grouping by \"#{group_by}\" is neither a column nor an association of the model!"
-        end
-      end
+    def rank!(field: :rank, group_by: nil, advisory_lock: {})
+      @lexorank_ranking = Lexorank::Ranking.new(record_class: self, field: field, group_by: group_by, advisory_lock: advisory_lock)
+      lexorank_ranking.validate!
 
-      if @ranking_column
-        self.scope :ranked, ->(direction: :asc) { where.not("#{field}": nil).order("#{field}": direction) }
-        self.include Lexorank
-        self.include InstanceMethods
-      else
-        warn "The supplied ranking column \"#{field}\" is not a column of the model!"
+      if lexorank_ranking.field
+        scope :ranked, ->(direction: :asc) { where.not("#{lexorank_ranking.field}": nil).order("#{lexorank_ranking.field}": direction) }
+        include InstanceMethods
       end
     end
-
-    private
-
-    def check_column(column_name)
-      return unless column_name
-      # This requires an active connection... do we want this?
-      if self.columns.map(&:name).include?(column_name.to_s)
-        column_name
-      # This requires rank! to be after the specific association
-      elsif (association = self.reflect_on_association(column_name))
-        association.foreign_key.to_sym
-      end
-    end
-
   end
 
   module InstanceMethods
-    def move_to_top
-      move_to(0)
+    def move_to_top(&)
+      move_to(0, &)
     end
 
-    def move_to(position)
-      collection = self.class.ranked
-      if self.class.ranking_group_by.present?
-        collection = collection.where("#{self.class.ranking_group_by}": send(self.class.ranking_group_by))
-      end
-
-      # exceptions:
-      #   move to the beginning (aka move to position 0)
-      #   move to end (aka position = collection.size - 1)
-      # when moving to the end of the collection the offset and limit statement automatically handles
-      # that 'after' is nil which is the same like [collection.last, nil]
-      before, after =
-        if position == 0
-          [nil, collection.first]
-        else
-          collection.where.not(id: self.id).offset(position - 1).limit(2)
-        end
-
-      rank =
-        if self == after && self.send(self.class.ranking_column).present?
-          self.send(self.class.ranking_column)
-        else
-          value_between(before&.send(self.class.ranking_column), after&.send(self.class.ranking_column))
-        end
+    def move_to_end(&)
+      self.class.lexorank_ranking.move_to(self, :last, &)
+    end
 
-      self.send("#{self.class.ranking_column}=", rank)
+    def move_to(position, &)
+      self.class.lexorank_ranking.move_to(self, position, &)
     end
 
     def move_to!(position)
-      move_to(position)
-      save
+      move_to(position) do
+        save
+      end
     end
 
     def move_to_top!
-      move_to!(0)
+      move_to_top do
+        save
+      end
+    end
+
+    def move_to_end!
+      move_to_end do
+        save
+      end
     end
 
     def no_rank?
-      !self.send(self.class.ranking_column)
+      !send(self.class.lexorank_ranking.field)
     end
   end
-
 end
-ActiveRecord::Base.send(:include, Lexorank::Rankable)
 
+ActiveRecord::Base.include Lexorank::Rankable

data/lib/lexorank/ranking.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+class Lexorank::Ranking
+  include Lexorank
+
+  attr_reader :record_class, :original_field, :field, :original_group_by, :group_by, :advisory_lock_config
+
+  def initialize(record_class:, field:, group_by:, advisory_lock:)
+    @record_class = record_class
+    @original_field = field
+    @field = process_column_name(field)
+    @original_group_by = group_by
+    @group_by = process_group_by_column_name(group_by)
+    @advisory_lock_config = { enabled: record_class.respond_to?(:with_advisory_lock) }.merge(advisory_lock)
+  end
+
+  def validate!
+    if advisory_lock_config[:enabled] && !record_class.respond_to?(:with_advisory_lock)
+      raise(
+        Lexorank::InvalidConfigError,
+        "Cannot enable advisory lock if #{record_class.name} does not respond to #with_advisory_lock. " \
+        'Consider installing the with_advisory_lock gem (https://rubygems.org/gems/with_advisory_lock).'
+      )
+    end
+
+    unless @field
+      # TODO: Make this raise an error. Supplying an invalid column should raise.
+      warn "The supplied ranking column \"#{@original_field}\" is not a column of the model!"
+    end
+
+    if original_group_by && !group_by
+      warn "The supplied grouping by \"#{original_group_by}\" is neither a column nor an association of the model!"
+    end
+  end
+
+  def move_to(instance, position)
+    if block_given? && advisory_locks_enabled?
+      return with_lock_if_enabled(instance) do
+        move_to(instance, position)
+        yield
+      end
+    end
+
+    collection = record_class.ranked
+    if group_by.present?
+      collection = collection.where("#{group_by}": instance.send(group_by))
+    end
+
+    # exceptions:
+    #   move to the beginning (aka move to position 0)
+    #   move to end (aka position = collection.size - 1)
+    # when moving to the end of the collection the offset and limit statement automatically handles
+    # that 'after' is nil which is the same like [collection.last, nil]
+    before, after =
+      if position == :last
+        [collection.last, nil]
+      elsif position.zero?
+        [nil, collection.first]
+      else
+        collection.where.not(id: instance.id).offset(position - 1).limit(2)
+      end
+
+    # If position >= collection.size both `before` and `after` will be nil. In this case
+    # we set before to the last element of the collection
+    if before.nil? && after.nil?
+      before = collection.last
+    end
+
+    rank =
+      if (self == after && send(field).present?) || (before == self && after.nil?)
+        send(field)
+      else
+        value_between(before&.send(field), after&.send(field))
+      end
+
+    instance.send(:"#{field}=", rank)
+
+    if block_given?
+      yield
+    else
+      rank
+    end
+  end
+
+  def with_lock_if_enabled(instance, &)
+    if advisory_locks_enabled?
+      advisory_lock_options = advisory_lock_config.except(:enabled, :lock_name)
+
+      record_class.with_advisory_lock(advisory_lock_name(instance), **advisory_lock_options, &)
+    else
+      yield
+    end
+  end
+
+  def advisory_lock_name(instance)
+    if advisory_lock_config[:lock_name].present?
+      advisory_lock_config[:lock_name].(instance)
+    else
+      "#{record_class.table_name}_update_#{field}".tap do |name|
+        if group_by.present?
+          name << "_group_#{instance.send(group_by)}"
+        end
+      end
+    end
+  end
+
+  def advisory_locks_enabled?
+    record_class.respond_to?(:with_advisory_lock) && advisory_lock_config[:enabled]
+  end
+
+  private
+
+  def process_column_name(name)
+    return unless name
+
+    # This requires an active connection... do we want this?
+    if record_class.columns.map(&:name).include?(name.to_s)
+      name
+    end
+  end
+
+  def process_group_by_column_name(name)
+    processed_name = process_column_name(name)
+
+    # This requires rank! to be after the specific association
+    if name && !processed_name && (association = record_class.reflect_on_association(name))
+      association.foreign_key.to_sym
+    else
+      processed_name
+    end
+  end
+end

data/lib/lexorank/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lexorank
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/lexorank.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lexorank/version'
 
 # Inspired by https://github.com/DevStarSJ/LexoRank/blob/master/lexo_rank.rb licensed under
@@ -24,13 +26,14 @@ require 'lexorank/version'
 # SOFTWARE.
 module Lexorank
   class InvalidRankError < StandardError; end
+  class InvalidConfigError < StandardError; end
 
-  MIN_CHAR = '0'.freeze
-  MAX_CHAR = 'z'.freeze
+  MIN_CHAR = '0'
+  MAX_CHAR = 'z'
 
-  def value_between(_before_, _after_)
-    before = _before_ || MIN_CHAR
-    after = _after_ || MAX_CHAR
+  def value_between(before_, after_)
+    before = before_ || MIN_CHAR
+    after = after_ || MAX_CHAR
 
     rank = ''
 
@@ -64,8 +67,10 @@ module Lexorank
     #
     # Please report if you have another opinion about that or if you reached the exception! (of course you can force it by using `value_between(nil, '0')`)
     if rank >= after
-      raise InvalidRankError, "This rank should not be achievable using the Lexorank::Rankable module! Please report to https://github.com/richardboehme/lexorank/issues! " +
-        "The supplied ranks were #{_before_.inspect} and #{_after_.inspect}. Please include those in the issue description."
+      raise InvalidRankError,
+        'This rank should not be achievable using the Lexorank::Rankable module! ' \
+        'Please report to https://github.com/richardboehme/lexorank/issues! ' \
+        "The supplied ranks were #{before_.inspect} and #{after_.inspect}. Please include those in the issue description."
     end
     rank
   end
@@ -75,8 +80,7 @@ module Lexorank
     middle_ascii.chr
   end
 
-  def get_char(str, i, default_char)
-    i >= str.length ? default_char : str[i]
+  def get_char(string, index, default_char)
+    index >= string.length ? default_char : string[index]
   end
-
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lexorank
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Böhme
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2024-08-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -39,104 +25,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda-context
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: m
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - richard.boehme1999@gmail.com
 executables: []
@@ -146,12 +48,17 @@ files:
 - LICENSE
 - lib/lexorank.rb
 - lib/lexorank/rankable.rb
+- lib/lexorank/ranking.rb
 - lib/lexorank/version.rb
 homepage: https://github.com/richardboehme/lexorank
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/richardboehme/lexorank
+  source_code_uri: https://github.com/richardboehme/lexorank
+  changelog_uri: https://github.com/richardboehme/lexorank/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +66,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Store order of your models by using lexicographic sorting.
 test_files: []