multi_range 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d15ee2b69e3bd9f58929f35e5e85107e873739b6ecd9499095262e5463b8c733
-  data.tar.gz: f641524f185a2f759c17cd85a640ac00d825363f9d62b71e1ac2348a878a6717
+  metadata.gz: 8f1ca3c6c80f92c3cbbd68f289ffd138c1d988bc33cd506e9eded313b0244504
+  data.tar.gz: e27a2de532a9b307e1f1ca7cfe8eff18fbe3af7e607f11291449eb22ec66ad42
 SHA512:
-  metadata.gz: f8fcafe38be61f3a971578e4f35bae4751f12e15b550531e7867efba0b982bafee5fecaba53674de6db66d99e6355f65b2a751387eb63668b306d17635b9a01f
-  data.tar.gz: 818da2c0e7c4e3ce7d07764de88325ffa9bcd3e574d0a73bc46af46b8f7accc3273638ec4704224c5600d087539464b0ca5547907f861bf9eb3aba202e9fb708
+  metadata.gz: e3623cbe2b34d20ca94b5a15848fc579a597e5381cee8f2245d5e053ef692e4511821772cc4461d62d7e0ea7bc4cc55613468e5df166d5f56bf68ac91c55b7e4
+  data.tar.gz: c04934e7ddc717db16902fea4846b3aabf531b1ea2c8e015f8bf754d8d9dac8abf5cdd4b1bf4c6770752fc35ad02ecc5e9969ca35c05b73fffa8302c1847f779

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Change Log
 
+### [v2.2.1](https://github.com/khiav223577/multi_range/compare/v2.2.0...v2.2.1) 2023/10/28
+- [#35](https://github.com/khiav223577/multi_range/pull/35) Fix: intersection with excluded empty range contains extra element (@khiav223577)
+
+### [v2.2.0](https://github.com/khiav223577/multi_range/compare/v2.1.1...v2.2.0) 2023/10/21
+- [#34](https://github.com/khiav223577/multi_range/pull/34) Fix: wrong empty range check which causes some differences to be dropped  (@khiav223577)
+- [#33](https://github.com/khiav223577/multi_range/pull/33) Fix: result should not be empty when intersection with inclusive range with one element (@khiav223577)
+- [#32](https://github.com/khiav223577/multi_range/pull/32) Drop the support of ruby 2.2 (@khiav223577)
+
 ### [v2.1.1](https://github.com/khiav223577/multi_range/compare/v2.1.0...v2.1.1) 2021/08/07
 - [#26](https://github.com/khiav223577/multi_range/pull/26) Fix: unexpected float value when sample an one-element range (@khiav223577)
 

data/README.md

@@ -9,9 +9,8 @@
 ## Supports
  
 - Ruby 2.3 ~ 2.7
-
-For Ruby 1.8.x and 1.9.x, please use multi_range < 2.
-For Ruby 2.0 ~ 2.2, please use multi_range <= 2.1.
+  - For Ruby 1.8.x and 1.9.x, please use multi_range < v2.0.0
+  - For Ruby 2.0 ~ 2.2, please use multi_range < v2.2.0
 
 ## Installation
 

data/lib/multi_range/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class MultiRange
-  VERSION = '2.2.0'
+  VERSION = '2.2.2'
 end

data/lib/multi_range.rb

@@ -1,242 +1,251 @@
-# frozen_string_literal: true
-
-require 'multi_range/version'
-require 'roulette-wheel-selection'
-require 'interval_tree'
-
-if not Range.method_defined?(:size)
-  warn "Please backports Range#size method to use multi_range gem.\n" \
-       "You can use backports gem and add the following lines to your program:\n" \
-       "require 'backports/1.9.2/float/infinity'\n" \
-       "require 'backports/2.0.0/range/size'"
-end
-
-if not Enumerable.method_defined?(:to_h)
-  warn "Please backports Enumerable#to_h method to use multi_range gem.\n" \
-       "You can use backports gem and add the following lines to your program:\n" \
-       "require 'backports/2.1.0/enumerable/to_h'"
-end
-
-class MultiRange
-  INDEX_WITH_DEFAULT = Object.new
-
-  attr_reader :ranges
-
-  def initialize(ranges)
-    if ranges.is_a? MultiRange
-      @ranges = ranges.ranges
-      @is_float = ranges.is_float?
-    else
-      @ranges = ranges.map{|s| s.is_a?(Numeric) ? s..s : s }.sort_by(&:begin).freeze
-      @is_float = @ranges.any?{|range| range.begin.is_a?(Float) || range.end.is_a?(Float) }
-    end
-  end
-
-  def is_float?
-    @is_float
-  end
-
-  def merge_overlaps(merge_same_value = true)
-    return MultiRange.new([]) if @ranges.size == 0
-
-    new_ranges = []
-    current_range = nil
-
-    @ranges.each do |range|
-      next current_range = range if current_range == nil
-      next if range.end <= current_range.end
-
-      if can_combine?(current_range, range, merge_same_value)
-        current_range = range.exclude_end? ? current_range.begin...range.end : current_range.begin..range.end
-      else
-        new_ranges << current_range
-        current_range = range
-      end
-    end
-
-    new_ranges << current_range
-    return MultiRange.new(new_ranges)
-  end
-
-  def &(other)
-    other_ranges = MultiRange.new(other).merge_overlaps.ranges
-    tree = IntervalTree::Tree.new(other_ranges)
-    intersected_ranges = merge_overlaps.ranges.flat_map do |range|
-      # A workaround for the issue: https://github.com/greensync/interval-tree/issues/17
-      query = (range.first == range.last) ? range.first : range
-      matching_ranges_converted_to_exclusive = tree.search(query) || []
-
-      # The interval tree converts interval endings to exclusive, so we need to restore the original
-      matching_ranges = matching_ranges_converted_to_exclusive.map do |matching_range_converted_to_exclusive|
-        other_ranges.find do |other_range|
-          # Having merged overlaps in each multi_range, there's no need to check the endings,
-          # since there will only be one range with each beginning
-          other_range.begin == matching_range_converted_to_exclusive.begin
-        end
-      end
-
-      matching_ranges.map do |matching_range|
-        intersect_two_ranges(range, matching_range)
-      end
-    end
-    MultiRange.new(intersected_ranges)
-  end
-
-  alias intersection &
-
-  def -(other)
-    return difference_with_other_multi_range(other) if other.is_a?(MultiRange)
-
-    new_ranges = @ranges.dup
-    return MultiRange.new(new_ranges) if not overlaps_with_range?(other)
-
-    changed_size = 0
-    @ranges.each_with_index do |range, idx|
-      # when this range is smaller than and not overlaps with `other`
-      #      range          other
-      #   |---------|    |---------|
-      next if other.begin > range.end
-
-      # when this range is larger than and not overlaps with `other`
-      #      other          range
-      #   |---------|    |---------|
-      break if other.end < range.begin
-
-      sub_ranges = possible_sub_ranges_of(range, other)
-      new_ranges[idx + changed_size, 1] = sub_ranges
-      changed_size += sub_ranges.size - 1
-
-      # when the maximum value of this range is larger than that of `other`
-      #     range
-      # -------------|
-      #   other
-      # ---------|
-      break if other.end <= range.end
-    end
-
-    return MultiRange.new(new_ranges)
-  end
-
-  alias difference -
-
-  def |(other)
-    other_ranges = other.is_a?(MultiRange) ? other.ranges : [other]
-    return MultiRange.new(@ranges + other_ranges).merge_overlaps
-  end
-
-  alias union |
-
-  def overlaps?(other)
-    multi_range = merge_overlaps
-    return multi_range.ranges != (multi_range - other).ranges
-  end
-
-  def sample
-    range = RouletteWheelSelection.sample(@ranges.map{|s| [s, s.size] }.to_h)
-    return nil if range == nil
-    return rand(range)
-  end
-
-  def size
-    @ranges.inject(0){|sum, v| sum + v.size }
-  end
-
-  def any?
-    @ranges.any?
-  end
-
-  def index_with(default = INDEX_WITH_DEFAULT)
-    if block_given?
-      fail ArgumentError, 'wrong number of arguments (given 1, expected 0)' if default != INDEX_WITH_DEFAULT
-      return map{|s| [s, yield(s)] }.to_h
-    end
-
-    return to_enum(:index_with){ size } if default == INDEX_WITH_DEFAULT
-    return map{|s| [s, default] }.to_h
-  end
-
-  def each
-    return to_enum(:each){ size } if !block_given?
-
-    ranges.each do |range|
-      range.each{|s| yield(s) }
-    end
-  end
-
-  def map
-    return to_enum(:map){ size } if !block_given?
-    return each.map{|s| yield(s) }
-  end
-
-  def to_a
-    each.to_a
-  end
-
-  def min
-    range = @ranges.first
-    return range.min if range
-  end
-
-  def max
-    range = @ranges.last
-    return range.max if range
-  end
-
-  def contain_overlaps?
-    merge_overlaps(false).ranges != ranges
-  end
-
-  private
-
-  # make sure that range1.begin <= range2.begin
-  def can_combine?(range1, range2, merge_same_value)
-    return merge_same_value if range1.end == range2.begin and range1.exclude_end?
-    return range1.end >= range2.begin if @is_float
-    return range1.end + 1 >= range2.begin
-  end
-
-  def difference_with_other_multi_range(other)
-    new_multi_range = dup
-    other.ranges.each{|range| new_multi_range -= range }
-    return new_multi_range
-  end
-
-  def possible_sub_ranges_of(range, other)
-    sub_range1 = range.begin...other.begin
-
-    sub_range2_begin = if other.exclude_end?
-                         other.end
-                       else
-                         other.end.is_a?(Float) ? other.end.next_float : other.end + 1
-                       end
-
-    sub_range2 = range.exclude_end? ? sub_range2_begin...range.end : sub_range2_begin..range.end
-
-    sub_ranges = []
-    sub_ranges << sub_range1 if not empty_range?(sub_range1)
-    sub_ranges << sub_range2 if not empty_range?(sub_range2)
-    return sub_ranges
-  end
-
-  def overlaps_with_range?(range)
-    return false if @ranges.empty?
-    return false if range.begin > @ranges.last.end # larger than maximum
-    return false if range.end < @ranges.first.begin # smaller than minimum
-    return true
-  end
-
-  def intersect_two_ranges(range_a, range_b)
-    ranges = [range_a, range_b]
-    start = ranges.map(&:begin).max
-    finish = ranges.map(&:end).min
-    if ranges.sort_by{|range| [range.end, range.exclude_end? ? 1 : 0] }.first.exclude_end?
-      start...finish
-    else
-      start..finish
-    end
-  end
-
-  def empty_range?(range)
-    range.begin > range.end || (range.begin == range.end && range.exclude_end?)
-  end
-end
+# frozen_string_literal: true
+
+require 'multi_range/version'
+require 'roulette-wheel-selection'
+require 'interval_tree'
+
+if not Range.method_defined?(:size)
+  warn "Please backports Range#size method to use multi_range gem.\n" \
+       "You can use backports gem and add the following lines to your program:\n" \
+       "require 'backports/1.9.2/float/infinity'\n" \
+       "require 'backports/2.0.0/range/size'"
+end
+
+if not Enumerable.method_defined?(:to_h)
+  warn "Please backports Enumerable#to_h method to use multi_range gem.\n" \
+       "You can use backports gem and add the following lines to your program:\n" \
+       "require 'backports/2.1.0/enumerable/to_h'"
+end
+
+class MultiRange
+  INDEX_WITH_DEFAULT = Object.new
+
+  attr_reader :ranges
+
+  def initialize(ranges)
+    if ranges.is_a? MultiRange
+      @ranges = ranges.ranges
+      @is_float = ranges.is_float?
+    else
+      ranges = [ranges] if !ranges.is_a?(Array)
+      @ranges = ranges.map{|s| s.is_a?(Numeric) ? s..s : s }.sort_by(&:begin).freeze
+      @is_float = @ranges.any?{|range| range.begin.is_a?(Float) || range.end.is_a?(Float) }
+    end
+  end
+
+  def is_float?
+    @is_float
+  end
+
+  def merge_overlaps(merge_same_value = true)
+    return MultiRange.new([]) if @ranges.size == 0
+
+    new_ranges = []
+    current_range = nil
+
+    @ranges.each do |range|
+      next current_range = range if current_range == nil
+      next if range.end <= current_range.end
+
+      if can_combine?(current_range, range, merge_same_value)
+        current_range = range.exclude_end? ? current_range.begin...range.end : current_range.begin..range.end
+      else
+        new_ranges << current_range
+        current_range = range
+      end
+    end
+
+    new_ranges << current_range
+    return MultiRange.new(new_ranges)
+  end
+
+  def &(other)
+    other_ranges = MultiRange.new(other).merge_overlaps.ranges
+    tree = IntervalTree::Tree.new(other_ranges)
+    intersected_ranges = merge_overlaps.ranges.flat_map do |range|
+      # A workaround for the issue: https://github.com/greensync/interval-tree/issues/17
+      query = (range.first == range.last) ? range.first : range
+      matching_ranges_converted_to_exclusive = tree.search(query) || []
+
+      # The interval tree converts interval endings to exclusive, so we need to restore the original
+      matching_ranges = matching_ranges_converted_to_exclusive.map do |matching_range_converted_to_exclusive|
+        other_ranges.find do |other_range|
+          # Having merged overlaps in each multi_range, there's no need to check the endings,
+          # since there will only be one range with each beginning
+          other_range.begin == matching_range_converted_to_exclusive.begin
+        end
+      end
+
+      matching_ranges.map do |matching_range|
+        intersect_two_ranges(range, matching_range)
+      end
+    end
+    MultiRange.new(intersected_ranges)
+  end
+
+  alias intersection &
+
+  def -(other)
+    return difference_with_other_multi_range(other) if other.is_a?(MultiRange)
+
+    new_ranges = @ranges.dup
+    return MultiRange.new(new_ranges) if not overlaps_with_range?(other)
+
+    changed_size = 0
+    @ranges.each_with_index do |range, idx|
+      # when this range is smaller than and not overlaps with `other`
+      #      range          other
+      #   |---------|    |---------|
+      next if other.begin > range.end
+
+      # when this range is larger than and not overlaps with `other`
+      #      other          range
+      #   |---------|    |---------|
+      break if other.end < range.begin
+
+      sub_ranges = possible_sub_ranges_of(range, other)
+      new_ranges[idx + changed_size, 1] = sub_ranges
+      changed_size += sub_ranges.size - 1
+
+      # when the maximum value of this range is larger than that of `other`
+      #     range
+      # -------------|
+      #   other
+      # ---------|
+      break if other.end <= range.end
+    end
+
+    return MultiRange.new(new_ranges)
+  end
+
+  alias difference -
+
+  def |(other)
+    other_ranges = other.is_a?(MultiRange) ? other.ranges : [other]
+    return MultiRange.new(@ranges + other_ranges).merge_overlaps
+  end
+
+  alias union |
+
+  def overlaps?(other)
+    multi_range = merge_overlaps
+    return multi_range.ranges != (multi_range - other).ranges
+  end
+
+  def sample
+    range = RouletteWheelSelection.sample(@ranges.map{|s| [s, s.size] }.to_h)
+    return nil if range == nil
+    return rand(range)
+  end
+
+  def size
+    @ranges.inject(0){|sum, v| sum + v.size }
+  end
+
+  def any?
+    @ranges.any?
+  end
+
+  def index_with(default = INDEX_WITH_DEFAULT)
+    if block_given?
+      fail ArgumentError, 'wrong number of arguments (given 1, expected 0)' if default != INDEX_WITH_DEFAULT
+      return map{|s| [s, yield(s)] }.to_h
+    end
+
+    return to_enum(:index_with){ size } if default == INDEX_WITH_DEFAULT
+    return map{|s| [s, default] }.to_h
+  end
+
+  def each
+    return to_enum(:each){ size } if !block_given?
+
+    ranges.each do |range|
+      range.each{|s| yield(s) }
+    end
+  end
+
+  def map
+    return to_enum(:map){ size } if !block_given?
+    return each.map{|s| yield(s) }
+  end
+
+  def to_a
+    each.to_a
+  end
+
+  def min
+    range = @ranges.first
+    return range.min if range
+  end
+
+  def max
+    range = @ranges.last
+    return range.max if range
+  end
+
+  def contain_overlaps?
+    merge_overlaps(false).ranges != ranges
+  end
+
+  private
+
+  # make sure that range1.begin <= range2.begin
+  def can_combine?(range1, range2, merge_same_value)
+    return merge_same_value if range1.end == range2.begin and range1.exclude_end?
+    return range1.end >= range2.begin if @is_float
+    return range1.end + 1 >= range2.begin
+  end
+
+  def difference_with_other_multi_range(other)
+    new_multi_range = dup
+    other.ranges.each{|range| new_multi_range -= range }
+    return new_multi_range
+  end
+
+  def possible_sub_ranges_of(range, other)
+    sub_range1 = range.begin...other.begin
+
+    sub_range2_begin = if other.exclude_end?
+                         other.end
+                       else
+                         other.end.is_a?(Float) ? other.end.next_float : other.end + 1
+                       end
+
+    sub_range2 = range.exclude_end? ? sub_range2_begin...range.end : sub_range2_begin..range.end
+
+    sub_ranges = []
+    sub_ranges << sub_range1 if not empty_range?(sub_range1)
+    sub_ranges << sub_range2 if not empty_range?(sub_range2)
+    return sub_ranges
+  end
+
+  def overlaps_with_range?(range)
+    return false if @ranges.empty?
+    return false if range.begin > @ranges.last.end # larger than maximum
+    return false if range.end < @ranges.first.begin # smaller than minimum
+    return true
+  end
+
+  def intersect_two_ranges(range1, range2)
+    start_range = range_with_larger_start(range1, range2)
+    end_range = range_with_smaller_end(range1, range2)
+    return start_range.begin...end_range.end if end_range.exclude_end?
+    return start_range.begin..end_range.end
+  end
+
+  def empty_range?(range)
+    range.begin > range.end || (range.begin == range.end && range.exclude_end?)
+  end
+
+  def range_with_larger_start(range1, range2)
+    return range1 if range1.begin > range2.begin
+    return range2
+  end
+
+  def range_with_smaller_end(range1, range2)
+    return range1 if range1.end < range2.end
+    return range2 if range1.end > range2.end
+    return range1 if range1.exclude_end?
+    return range2
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_range
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler