range_list 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3bbec9e50fbfcf613d6371f9851c1410269819c738d362bbe0db73bf6ab1ed6
-  data.tar.gz: 48b42d5f37e67577cc92528b4f3e898b58f81f7781fa4ea388347572fb70d90a
+  metadata.gz: 7ea59292d297f5583f7a9ceddaf8194cbd33704180c3e43f15fe87358c8d02d5
+  data.tar.gz: f8ea601a80d2261c1b869aa57699bd0c71d048b4a94b25b978d67d1636d426b5
 SHA512:
-  metadata.gz: c6f784320a3ab3b9b1c7714c9c7350aef3824b222a28ca0b1278722a728564b91c6c40faf3bbb8ea8a2926795daa56ca8f3db740cec6fd8833371bb60214ddd8
-  data.tar.gz: 98c20d0456e3c84432dfa9d3d09438c4887606dead589cfb1006407569b3c7f1330e0e3401fba5562b0c1c0c3dba408ad43fa0ea18f99232775ce7dcef69c3ee
+  metadata.gz: 52b7dd400bb94273b9e0ff1702db7d5bd328f88e425322ba3838cc859e4629f0f5f2776bcedec7f73ba90ca0936b8f661fd435bde89bf67bbfdede88c93f62b5
+  data.tar.gz: af2aee3e2b4c37cdffbe89518423ea037b3348db50c9bfeff3b27259f6ff54f055265c3cbfb7c5ec7a9bc7410baa475e1d2f59be0259a5061b2e5197bd8e7280

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    range_list (1.2.0)
+    range_list (1.3.0)
       rbtree (~> 0.4.5)
 
 GEM

data/README.md

@@ -10,7 +10,6 @@ RangeList use AVL Tree processing internally, so range operations are very fast.
 [![Gem Version](https://badge.fury.io/rb/range_list.svg)](https://rubygems.org/gems/range_list)
 [![Documentation](https://img.shields.io/badge/docs-YARD-blue.svg)](https://rubydoc.info/gems/range_list)
 [![pipeline status](https://gitlab.com/songhuangcn/range_list/badges/main/pipeline.svg)](https://gitlab.com/songhuangcn/range_list/-/commits/main)
-[![coverage report](https://gitlab.com/songhuangcn/range_list/badges/main/coverage.svg)](https://gitlab.com/songhuangcn/range_list/-/commits/main)
 
 ## Installation
 

data/lib/range_list/avl_tree/abstract_adapter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class RangeList
+  # @!visibility private
+  module AvlTree
+    class AbstractAdapter
+      def put(key, value)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def lower_entry(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def sub_map(from_key, to_key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def remove(key)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def each(&block)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/range_list/avl_tree/rbtree_adapter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rbtree"
+require_relative "abstract_adapter"
+
+class RangeList
+  # @!visibility private
+  module AvlTree
+    class RBTreeAdapter < AbstractAdapter
+      def initialize
+        @rbtree = RBTree.new
+      end
+
+      def put(key, value)
+        rbtree[key] = value
+      end
+
+      def lower_entry(key)
+        rbtree.upper_bound(key)
+      end
+
+      def sub_map(from_key, to_key)
+        rbtree.bound(from_key, to_key).to_a
+      end
+
+      def remove(key)
+        rbtree.delete(key)
+      end
+
+      def each(&block)
+        rbtree.each(&block)
+      end
+
+      private
+
+      attr_reader :rbtree
+    end
+  end
+end

data/lib/range_list/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RangeList
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/range_list.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "rbtree"
 require_relative "range_list/version"
 require_relative "range_list/errors"
+require_relative "range_list/avl_tree/rbtree_adapter"
 
 class RangeList
   include Enumerable
 
   def initialize
-    @tree = RBTree.new
+    @avl_tree = AvlTree::RBTreeAdapter.new
   end
 
   # Add range into current range list.
@@ -23,27 +23,27 @@ class RangeList
     return self if empty_range?(range)
 
     # Get real range start.
-    start_floor_entry = tree.upper_bound(range[0])
-    range_start = if !start_floor_entry.nil? && start_floor_entry[1] >= range[0]
-      start_floor_entry[0]
+    start_lower_range = avl_tree.lower_entry(range[0])
+    range_start = if !start_lower_range.nil? && start_lower_range[1] >= range[0]
+      start_lower_range[0]
     else
       range[0]
     end
 
     # Get real range end.
-    end_floor_entry = tree.upper_bound(range[1])
-    range_end = if !end_floor_entry.nil? && end_floor_entry[1] >= range[1]
-      end_floor_entry[1]
+    end_lower_range = avl_tree.lower_entry(range[1])
+    range_end = if !end_lower_range.nil? && end_lower_range[1] >= range[1]
+      end_lower_range[1]
     else
       range[1]
     end
 
     # Insert or replace new range.
-    tree[range_start] = range_end
+    avl_tree.put(range_start, range_end)
 
     # Remove keys between range, exclude start, include end.
-    between_maps = tree.bound(range[0] + 1, range[1])
-    between_maps.to_a.each { |key, _value| tree.delete(key) }
+    sub_range = avl_tree.sub_map(range[0] + 1, range[1])
+    sub_range.each { |range_start, _range_end| avl_tree.remove(range_start) }
 
     self
   end
@@ -58,21 +58,21 @@ class RangeList
     # Return when range is empty.
     return self if empty_range?(range)
 
-    # Insert end lower entry
-    end_lower_entry = tree.upper_bound(range[1] - 1)
-    if !end_lower_entry.nil? && end_lower_entry[1] > range[1]
-      tree[range[1]] = end_lower_entry[1]
+    # Insert end lower range, `-1` means not include.
+    end_lower_range = avl_tree.lower_entry(range[1] - 1)
+    if !end_lower_range.nil? && end_lower_range[1] > range[1]
+      avl_tree.put(range[1], end_lower_range[1])
     end
 
-    # Relace start lower entry
-    start_lower_entry = tree.upper_bound(range[0] - 1)
-    if !start_lower_entry.nil? && start_lower_entry[1] > range[0]
-      tree[start_lower_entry[0]] = range[0]
+    # Relace start lower range, `-1` means not include.
+    start_lower_range = avl_tree.lower_entry(range[0] - 1)
+    if !start_lower_range.nil? && start_lower_range[1] > range[0]
+      avl_tree.put(start_lower_range[0], range[0])
     end
 
     # Remove keys between range, include start, exclude end
-    between_maps = tree.bound(range[0], range[1] - 1)
-    between_maps.to_a.each { |key, _value| tree.delete(key) }
+    sub_range = avl_tree.sub_map(range[0], range[1] - 1)
+    sub_range.each { |range_start, _range_end| avl_tree.remove(range_start) }
 
     self
   end
@@ -80,7 +80,8 @@ class RangeList
   # Print current range list.
   # @return [void]
   def print
-    puts map { |k, v| "[#{k}, #{v})" }.join(" ")
+    info = map { |k, v| "[#{k}, #{v})" }.join(" ")
+    puts info
   end
 
   # Returns true if current ranges contains all elements of the range.
@@ -94,8 +95,8 @@ class RangeList
     # Return false when range is empty.
     return false if empty_range?(range)
 
-    start_floor_entry = tree.upper_bound(range[0])
-    !start_floor_entry.nil? && start_floor_entry[1] >= range[1]
+    start_lower_range = avl_tree.lower_entry(range[0])
+    !start_lower_range.nil? && start_lower_range[1] >= range[1]
   end
 
   # Returns true if current ranges contains any element of the range.
@@ -109,8 +110,9 @@ class RangeList
     # Return false when range is empty.
     return false if empty_range?(range)
 
-    end_lower_entry = tree.upper_bound(range[1] - 1)
-    !end_lower_entry.nil? && end_lower_entry[1] > range[0]
+    # `-1` means not include.
+    end_lower_range = avl_tree.lower_entry(range[1] - 1)
+    !end_lower_range.nil? && end_lower_range[1] > range[0]
   end
 
   # Returns true if current ranges contains the element.
@@ -120,15 +122,15 @@ class RangeList
   def contains?(element)
     raise ArgumentError, "`element` should be `Integer` type." unless element.is_a?(Integer)
 
-    floor_entry = tree.upper_bound(element)
-    !floor_entry.nil? && floor_entry[1] > element
+    lower_entry = avl_tree.lower_entry(element)
+    !lower_entry.nil? && lower_entry[1] > element
   end
 
   # Give RangeList iterative ability.
   # @yield [range_start, range_end] give the range element to the block
   def each(&block)
     if block
-      tree.each(&block)
+      avl_tree.each(&block)
     else
       enum_for(:each)
     end
@@ -141,7 +143,7 @@ class RangeList
 
   private
 
-  attr_reader :tree
+  attr_reader :avl_tree
 
   def validate_range!(range)
     raise ArgumentError, "`range` should be `Array` type." unless range.is_a?(Array)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: range_list
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Song Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree
@@ -37,6 +37,8 @@ files:
 - README.md
 - Rakefile
 - lib/range_list.rb
+- lib/range_list/avl_tree/abstract_adapter.rb
+- lib/range_list/avl_tree/rbtree_adapter.rb
 - lib/range_list/errors.rb
 - lib/range_list/version.rb
 - range_list.gemspec