fractional_indexing 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ec000613bb56c79ff44198f1fc0e45be734922f89c22b5ce9fb5ec5ec0ae2df
+  data.tar.gz: ead7373a2c426ff75274a5b0fb87cf3f5e8332075ae4e2c70fa071d1795c5ea8
+SHA512:
+  metadata.gz: 8914f607fd7028a06c1082901baa30aba1330f354643af03cf1a2b99985cd239378ba96aebf17c8a241bf2dbab2550fb9111086047e45456998a07392e1494af
+  data.tar.gz: 2b2996841ca207d20a26670d30f4dffeef721334ab6ceb2a5143abd543f400ee43b8289867c5057c8827e4f5ddf7d934003316ca13cccad133b7c6b14c5a5cff

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fractional_indexing.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    fractional_indexing (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.18.0)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  fractional_indexing!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

data/README.md

@@ -0,0 +1,57 @@
+# Fractional Indexing
+
+This is based on [Implementing Fractional Indexing
+](https://observablehq.com/@dgreensp/implementing-fractional-indexing) by [David Greenspan
+](https://github.com/dgreensp).
+
+Fractional indexing is a technique to create an ordering that can be used for [Realtime Editing of Ordered Sequences](https://www.figma.com/blog/realtime-editing-of-ordered-sequences/).
+
+This implementation includes variable-length integers, and the prepend/append optimization described in David's article.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add fractional_indexing
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fractional_indexing
+
+## Usage
+
+```ruby
+require "fractional_indexing"
+
+first = FractionalIndexing.generate_key_between(None, None)
+raise unless first == 'a0'
+
+# Insert after 1st
+second = FractionalIndexing.generate_key_between(first, None)
+raise unless second == 'a1'
+
+# Insert after 2nd
+third = FractionalIndexing.generate_key_between(second, None)
+raise unless third == 'a2'
+
+# Insert before 1st
+zeroth = FractionalIndexing.generate_key_between(None, first)
+raise unless zeroth == 'Zz'
+
+# Insert in between 2nd and 3rd. Midpoint
+second_and_half = FractionalIndexing.generate_key_between(second, third)
+raise unless second_and_half == 'a1V'
+```
+
+## Other Languages
+
+This is a Ruby port of the [Python port](https://github.com/httpie/fractional-indexing-python) of the [original JavaScript implementation](https://github.com/rocicorp/fractional-indexing).
+That means that this implementation is byte-for-byte compatible with:
+
+| Language   | Repo                                                 |
+| ---------- | ---------------------------------------------------- |
+| JavaScript | https://github.com/rocicorp/fractional-indexing      |
+| Go         | https://github.com/rocicorp/fracdex                  |
+| Python     | https://github.com/httpie/fractional-indexing-python |
+
+The code was ported entirely by ChatGPT.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/fractional_indexing/version.rb

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

data/lib/fractional_indexing.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Provides functions for generating ordering strings
+# <https://observablehq.com/@dgreensp/implementing-fractional-indexing>
+# <https://github.com/aalin/fractional_indexing.rb>
+# Ported from Python using ChatGPT:
+# <https://github.com/httpie/fractional-indexing-python>
+
+require_relative "fractional_indexing/version"
+require "bigdecimal"
+
+module FractionalIndexing
+  class Error < StandardError
+  end
+
+  BASE_62_DIGITS =
+    "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+  SMALLEST_INTEGER = "A00000000000000000000000000"
+  INTEGER_ZERO = "a0"
+
+  def self.midpoint(a, b, digits)
+    # `a` may be empty string, `b` is null or non-empty string.
+    # `a < b` lexicographically if `b` is non-null.
+    # no trailing zeros allowed.
+    # digits is a string such as '0123456789' for base 10.  Digits must be in
+    # ascending character code order!
+    raise Error, "#{a} >= #{b}" if b && a >= b
+    raise Error, "trailing zero" if (a[-1] == "0") || (b && (b[-1] == "0"))
+    if b
+      # remove longest common prefix.  pad `a` with 0s as we
+      # go.  note that we don't need to pad `b`, because it can't
+      # end before `a` while traversing the common prefix.
+      n = 0
+      a = a.ljust(b.length, "0")
+      for i in 0..(b.length - 1)
+        if a[i] == b[i]
+          n += 1
+        else
+          break
+        end
+      end
+
+      return b[0..(n - 1)] + midpoint(a[n..-1], b[n..-1], digits) if n > 0
+    end
+
+    # first digits (or lack of digit) are different
+    digit_a = a.empty? ? 0 : digits.index(a[0])
+    digit_b = b.nil? ? digits.length : digits.index(b[0])
+    if digit_b - digit_a > 1
+      min_digit = (0.5 * (digit_a + digit_b)).round
+      return digits[min_digit]
+    else
+      if b && b.length > 1
+        return b[0]
+      else
+        # `b` is null or has length 1 (a single digit).
+        # the first digit of `a` is the previous digit to `b`,
+        # or 9 if `b` is null.
+        # given, for example, midpoint('49', '5'), return
+        # '4' + midpoint('9', null), which will become
+        # '4' + '9' + midpoint('', null), which is '495'
+        digit_a = a.empty? ? 0 : digits.index(a[0])
+        return digits[digit_a] + midpoint(a[1..-1], nil, digits)
+      end
+    end
+  end
+
+  def self.validate_integer(i)
+    unless i.length == get_integer_length(i[0])
+      raise Error, "invalid integer part of order key: #{i}"
+    end
+  end
+
+  def self.get_integer_length(head)
+    if ('a'..'z').cover?(head)
+      return head.ord - 'a'.ord + 2
+    elsif ('A'..'Z').cover?(head)
+      return 'Z'.ord - head.ord + 2
+    end
+    raise Error, "invalid order key head: " + head
+  end
+
+  def self.get_integer_part(key)
+    integer_part_length = get_integer_length(key[0])
+    raise Error, "invalid order key: #{key}" if integer_part_length > key.size
+
+    key[0...integer_part_length]
+  end
+
+  def self.validate_order_key(key)
+    raise Error, "invalid order key: #{key}" if key == SMALLEST_INTEGER
+
+    # get_integer_part() will throw if the first character is bad,
+    # or the key is too short.  we'd call it to check these things
+    # even if we didn't need the result
+    i = get_integer_part(key)
+    f = key[i.size..]
+    raise Error, "invalid order key: #{key}" if f[-1] == "0"
+
+    nil
+  end
+
+  def self.increment_integer(x, digits)
+    validate_integer(x)
+    head, *digs = x.chars
+    carry = true
+    digs.reverse_each do |d|
+      i = digits.index(d) + 1
+      if i == digits.size
+        d.replace('0')
+      else
+        d.replace(digits[i])
+        carry = false
+        break
+      end
+    end
+    if carry
+      if head == 'Z'
+        return 'a0'
+      elsif head == 'z'
+        return nil
+      end
+      h = (head.ord + 1).chr
+      if h > 'a'
+        digs.push('0')
+      else
+        digs.pop
+      end
+      return h + digs.join
+    else
+      return head + digs.join
+    end
+  end
+
+  def self.decrement_integer(x, digits)
+    validate_integer(x)
+    head, *digs = x.chars
+    borrow = true
+    digs.reverse_each do |d|
+      i = digits.index(d) - 1
+      if i == -1
+        d.replace(digits[-1])
+      else
+        d.replace(digits[i])
+        borrow = false
+        break
+      end
+    end
+    if borrow
+      if head == 'a'
+        return 'Z' + digits[-1]
+      elsif head == 'A'
+        return nil
+      end
+      h = (head.ord - 1).chr
+      if h < 'Z'
+        digs.push(digits[-1])
+      else
+        digs.pop
+      end
+      return h + digs.join
+    else
+      return head + digs.join
+    end
+  end
+
+  def self.generate_key_between(a, b, digits = BASE_62_DIGITS)
+    validate_order_key(a) if a
+    validate_order_key(b) if b
+    raise "a >= b" if a && b && a >= b
+
+    if a == nil
+      return INTEGER_ZERO if b == nil
+      ib = get_integer_part(b)
+      fb = b[ib.length..-1]
+      return ib + midpoint("", fb, digits) if ib == SMALLEST_INTEGER
+      return ib if ib < b
+      res = decrement_integer(ib, digits)
+      raise "cannot decrement any more" if res == nil
+      return res
+    end
+
+    if b == nil
+      ia = get_integer_part(a)
+      fa = a[ia.length..-1]
+      i = increment_integer(ia, digits)
+      return ia + midpoint(fa, nil, digits) if i == nil
+      return i
+    end
+
+    ia = get_integer_part(a)
+    fa = a[ia.length..-1]
+    ib = get_integer_part(b)
+    fb = b[ib.length..-1]
+    return ia + midpoint(fa, fb, digits) if ia == ib
+    i = increment_integer(ia, digits)
+    raise "cannot increment any more" if i == nil
+
+    return i if i < b
+
+    return ia + midpoint(fa, nil, digits)
+  end
+
+  # Returns an array of n distinct keys in sorted order.
+  # If a and b are both nil, returns [a0, a1, ...]
+  # If one or the other is nil, returns consecutive "integer"
+  # keys. Otherwise, returns relatively short keys between.
+  def self.generate_n_keys_between(a, b, n, digits = BASE_62_DIGITS)
+    return [] if n.zero?
+
+    return [generate_key_between(a, b, digits)] if n == 1
+
+    unless b
+      c = generate_key_between(a, b, digits)
+      result = [c]
+      (n - 1).times do
+        c = generate_key_between(c, b, digits)
+        result << c
+      end
+      return result
+    end
+
+    unless a
+      c = generate_key_between(a, b, digits)
+      result = [c]
+      (n - 1).times do
+        c = generate_key_between(a, c, digits)
+        result << c
+      end
+      return result.reverse
+    end
+
+    mid = n / 2
+    c = generate_key_between(a, b, digits)
+    [
+      *generate_n_keys_between(a, c, mid.floor, digits),
+      c,
+      *generate_n_keys_between(c, b, n - mid.floor - 1, digits)
+    ]
+  end
+
+  # Rounds a float to an integer using decimal.Decimal.quantize with
+  # decimal.ROUND_HALF_UP rounding method.
+  def self.round_half_up(n)
+    (n.to_d.round(0, half: :up)).to_i
+  end
+end

data/sig/fractional_indexing.rbs

@@ -0,0 +1,4 @@
+module FractionalIndexing
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: fractional_indexing
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andreas Alin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- andreas.alin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/fractional_indexing.rb
+- lib/fractional_indexing/version.rb
+- sig/fractional_indexing.rbs
+homepage: https://github.com/aalin/fractional_indexing.rb
+licenses:
+- " CC0-1.0"
+metadata:
+  homepage_uri: https://github.com/aalin/fractional_indexing.rb
+  source_code_uri: https://github.com/aalin/fractional_indexing.rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Fractional Indexing in Ruby
+test_files: []