fractional_indexer 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 529455a944319ae06942cb577687a1c6d06e2869316d0f715c7a03415704c0a9
-  data.tar.gz: afccd5d154f1637648c6418637d4243a518c0774f575a4b2eea909db0f89e762
+  metadata.gz: 0d3588d2624cbc372dd3013729e5543eeabf9ab227005bf5c7a02e59360d7dcb
+  data.tar.gz: 1b11cf313ea2e71ed55bab5f394fcab8d1797e08b7a86df7012bcfafe43d0f68
 SHA512:
-  metadata.gz: ab6facf8bbf718cdc36fd3bfb74d27913b3f68635b1a573e72426ee70a1d132b860f0008cef13d6bca89273f24ca226c765e4a44f80591e5da058e8e9fe71518
-  data.tar.gz: 933bf9eca9dfd21b40ba7fda2bb4951cf198fd398580e800118366fd5b58e4514b5744739ecb5192ef4b5dbea4b1a5994f692de79e7ed329a5875512f8f9d4be
+  metadata.gz: d8735e7f53ea599b2a3cbfdaafd34cd2c854991c461d02b4383a7a47fb36ab956d9bbdbd80c0cf018ab668050133e0039c4e117e654cba77da2ee9fe964b70b9
+  data.tar.gz: 6b4c53291cb4fb77ebb3fb279531693a8b2c6c74dd1ad775e6bb69d19bd2e23d742a3316c9922df94dcaad24a3af0c260b14aa3caacf4b7f142844f1fb9537bc

data/README.md

@@ -61,6 +61,26 @@ FractionalIndexer.generate_key(prev_key: 'a1', next_key: 'a1')
 # => error
 ```
 
+### Generate Multiple Order keys
+
+To generate multiple order keys, use the `FractionalIndexer.generate_keys` method.
+
+```ruby
+require 'fractional_indexer'
+
+# generate n order keys that sequentially follow a given prev_key.
+FractionalIndexer.generate_keys(prev_key: "b11", count: 5)
+# => ["b12", "b13", "b14", "b15", "b16"]
+
+# generate n order keys that sequentially precede a given next_key.
+FractionalIndexer.generate_keys(next_key: "b11", count: 5)
+# => ["b0w", "b0x", "b0y", "b0z", "b10"]
+
+# generate n order keys between the given prev_key and next_key.
+FractionalIndexer.generate_keys(prev_key: "b10", next_key: "b11", count: 5)
+# => ["b108", "b10G", "b10V", "b10d", "b10l"]
+```
+
 ## Configure
 
 ### base

data/lib/fractional_indexer/decrementer.rb

@@ -39,9 +39,5 @@ module FractionalIndexer
     def borrow?(index)
       index == -1
     end
-
-    def digits
-      FractionalIndexer.configuration.digits
-    end
   end
 end

data/lib/fractional_indexer/incrementer.rb

@@ -39,9 +39,5 @@ module FractionalIndexer
     def carry_over?(index)
       index == digits.length
     end
-
-    def digits
-      FractionalIndexer.configuration.digits
-    end
   end
 end

data/lib/fractional_indexer/midpointer.rb

@@ -45,19 +45,15 @@ module FractionalIndexer
 
     private
 
-    def digits
-      FractionalIndexer.configuration.digits
-    end
-
     def validate_positions!(prev_pos, next_pos)
-      raise FractionalIndexerError, "prev_pos must be less than next_pos" if !next_pos.empty? && prev_pos >= next_pos
+      raise Error, "prev_pos must be less than next_pos" if !next_pos.empty? && prev_pos >= next_pos
 
       # NOTE
       # In a string, "0.3" and "0.30" are mathematically equivalent.
       # Therefore, a trailing "0" is prohibited.
       return unless prev_pos.end_with?(digits.first) || next_pos.end_with?(digits.first)
 
-      raise FractionalIndexerError, "prev_pos and next_pos cannot end with #{digits.first}"
+      raise Error, "prev_pos and next_pos cannot end with #{digits.first}"
     end
   end
 end

data/lib/fractional_indexer/order_key.rb

@@ -64,10 +64,6 @@ module FractionalIndexer
 
     private
 
-    def digits
-      FractionalIndexer.configuration.digits
-    end
-
     def integer_digits(key = self.key)
       if self.class.positive?(key)
         key.ord - "a".ord + INTEGER_BASE_DIGIT
@@ -83,7 +79,7 @@ module FractionalIndexer
     end
 
     def raise_error(description = nil)
-      raise FractionalIndexerError, "invalid order key: '#{key}' description: #{description}"
+      raise Error, "invalid order key: '#{key}' description: #{description}"
     end
 
     def minimum_integer

data/lib/fractional_indexer/version.rb

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

data/lib/fractional_indexer.rb

@@ -2,17 +2,21 @@
 
 require "fractional_indexer/version"
 
-module FractionalIndexer
-  autoload :Configuration, "fractional_indexer/configuration"
-  autoload :Decrementer,   "fractional_indexer/decrementer"
-  autoload :Incrementer,   "fractional_indexer/incrementer"
-  autoload :Midpointer,    "fractional_indexer/midpointer"
-  autoload :OrderKey,      "fractional_indexer/order_key"
+require "fractional_indexer/configuration"
+require "fractional_indexer/decrementer"
+require "fractional_indexer/incrementer"
+require "fractional_indexer/midpointer"
+require "fractional_indexer/order_key"
 
-  class FractionalIndexerError < StandardError; end
+module FractionalIndexer
+  class Error < StandardError; end
 
   @configuration = Configuration.new
 
+  [Decrementer, Incrementer, Midpointer, OrderKey].each do |klass|
+    klass.send(:define_method, :digits) { FractionalIndexer.configuration.digits }
+  end
+
   def self.configure
     yield(configuration) if block_given?
 
@@ -26,10 +30,10 @@ module FractionalIndexer
   def self.generate_key(prev_key: nil, next_key: nil)
     return OrderKey.zero if prev_key.nil? && next_key.nil?
 
-    raise FractionalIndexerError, "prev_key and next_key cannot be empty" if prev_key&.empty? || next_key&.empty?
+    raise Error, "prev_key and next_key cannot be empty" if prev_key&.empty? || next_key&.empty?
 
     if !prev_key.nil? && !next_key.nil? && prev_key >= next_key
-      raise FractionalIndexerError, "#{prev_key} is not less than #{next_key}"
+      raise Error, "#{prev_key} is not less than #{next_key}"
     end
 
     prev_order_key = OrderKey.new(prev_key)
@@ -50,6 +54,42 @@ module FractionalIndexer
     end
   end
 
+  def self.generate_keys(prev_key: nil, next_key: nil, count: 1)
+    return [] if count <= 0
+    return [generate_key(prev_key: prev_key, next_key: next_key)] if count == 1
+
+    if next_key.nil?
+      base_order_key = generate_key(prev_key: prev_key)
+      result = [base_order_key]
+
+      (count - 1).times do
+        result << generate_key(prev_key: result.last)
+      end
+
+      return result
+    end
+
+    if prev_key.nil?
+      base_order_key = generate_key(next_key: next_key)
+      result = [base_order_key]
+
+      (count - 1).times do
+        result << generate_key(next_key: result.last)
+      end
+
+      return result.reverse
+    end
+
+    mid = count / 2
+    base_order_key = generate_key(prev_key: prev_key, next_key: next_key)
+
+    [
+      *generate_keys(prev_key: prev_key, next_key: base_order_key, count: mid),
+      base_order_key,
+      *generate_keys(prev_key: base_order_key, next_key: next_key, count: count - mid - 1),
+    ]
+  end
+
   def self.decrement(order_key)
     return order_key.integer + Midpointer.execute("", order_key.fractional) if order_key.minimum_integer?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fractional_indexer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - kazu