lexorank 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8c678d7cfe9046d4eeeb30c899a105ba37de5eececb64ff7b34447e051a8f23
-  data.tar.gz: 36ed27c5cc7603494de3f096619f21bc603b152f8c1311ad894ac77dffc95b0b
+  metadata.gz: 016c148a28989a35ab6afd0184625900cbec71dac5dcfa981cac45403c9aa0d5
+  data.tar.gz: 46cfe89fa41fb20b511235122b8511702ddfba532c1d475d7dfe2cec337a2e7c
 SHA512:
-  metadata.gz: 17531cc2661b9df6803957659dd97451e66885502504c345a7f54301f5ef78f65f9f28bba59745109f4820e5b21f26ac3c11ab77e558559edcbd94dd18be2845
-  data.tar.gz: cbb64e16863bb7f587f09f5b30b993712a68214b2b812a8bee87f29e97800955f429a8923c6dff6632a710b0261d74945ab1d1b34abec4c9f2c202c6a198d163
+  metadata.gz: 969a110cb1cc3c60ea599b6b747326a6f86c57de0a261c0f369d0691108c59f757e8d0d12b2d669bc2dbfefe275dd83e1d851f6f6b181ac1dec917388f54458c
+  data.tar.gz: 249348edc5ffeb92cc42a1d98e585c671560443d53e5a150b64d5674f49ceaf7857e3ca80208a8da0de20ca380aa5598fa5726672842c833294d2710d4a68e4a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/lexorank.rb

@@ -0,0 +1,82 @@
+require 'lexorank/version'
+
+# Inspired by https://github.com/DevStarSJ/LexoRank/blob/master/lexo_rank.rb licensed under
+# MIT License
+#
+# Copyright (c) 2019 SeokJoon.Yun
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+module Lexorank
+  class InvalidRankError < StandardError; end
+
+  MIN_CHAR = '0'.freeze
+  MAX_CHAR = 'z'.freeze
+
+  def value_between(_before_, _after_)
+    before = _before_ || MIN_CHAR
+    after = _after_ || MAX_CHAR
+
+    rank = ''
+
+    (before.length + after.length).times do |i|
+      prev_char = get_char(before, i, MIN_CHAR)
+      after_char = get_char(after, i, MAX_CHAR)
+
+      if prev_char == after_char
+        rank += prev_char
+        next
+      end
+
+      mid_char = mid(prev_char, after_char)
+      if mid_char == prev_char || mid_char == after_char
+        rank += prev_char
+        next
+      end
+
+      rank += mid_char
+      break
+    end
+
+    # Problem: If we try to get a rank before the character '0' or after 'z' the algorithm would return the same char
+    # This first of all breaks a possible unique constraint and of course makes no sense when ordering the items.
+    #
+    # Thoughts: I think this issue will never happen with the Lexorank::Rankable module
+    # Why? Let's look at '0' as a rank:
+    # Because the algorithm always chooses the char in between two other chars, '0' can only happen when before is nil and after is '1'
+    # In this case the algorithm will return '0U' though. This means there will never be an item with rank '0' which is why this condition
+    # should never equal to true.
+    #
+    # 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."
+    end
+    rank
+  end
+
+  def mid(prev, after)
+    middle_ascii = ((prev.ord + after.ord) / 2).round
+    middle_ascii.chr
+  end
+
+  def get_char(str, i, default_char)
+    i >= str.length ? default_char : str[i]
+  end
+
+end

data/lib/lexorank/rankable.rb

@@ -0,0 +1,92 @@
+require 'lexorank'
+require 'active_support/concern'
+
+module Lexorank::Rankable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    attr_reader :ranking_column, :ranking_group_by
+
+    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
+
+      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!"
+      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)
+    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
+          # if item is currently in front of the index we just use position otherwise position - 1
+          # if the item has no rank we use position - 1
+          position -= 1 if !self.send(self.class.ranking_column) || collection.map(&:id).index(self.id) > position
+          collection.offset(position).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
+
+      self.send("#{self.class.ranking_column}=", rank)
+    end
+
+    def move_to!(position)
+      move_to(position)
+      save
+    end
+
+    def move_to_top!
+      move_to!(0)
+    end
+
+  end
+
+end
+ActiveRecord::Base.send(:include, Lexorank::Rankable)
+

data/lib/lexorank/version.rb

@@ -0,0 +1,3 @@
+module Lexorank
+  VERSION = '0.1.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lexorank
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Richard Böhme
@@ -142,7 +142,11 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- lib/lexorank.rb
+- lib/lexorank/rankable.rb
+- lib/lexorank/version.rb
 homepage: https://github.com/richardboehme/lexorank
 licenses:
 - MIT
@@ -162,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Store order of your models by using lexicographic sorting.