multi_range 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 770406d2ee94a20090941404e6bfde0d3a516554be093ae1eb09aa0f85b19688
-  data.tar.gz: b1d0e13fb9cd75e2d897d8f2b7e5b9a54ca5c543fcb16c12fb9e35a4cd8717ac
+  metadata.gz: 8b6430c0f1e34bd416c5ac86b7427a287b980282604b7220a518feb8eb90e3d3
+  data.tar.gz: 01f8ca6da27bc8a960ef531e114cdfc15296fac6af91e4e588642a11b7b56ac7
 SHA512:
-  metadata.gz: a0fbb1372f1ccdd9967142fa2ad0e13da8859e3c796c594ea2d53c61646ec98d21a395a0f81f1cc41486fc4b408161ceb2ed45c5fe97aeca701e4688892fd979
-  data.tar.gz: e41cfe73cc1024d9899a1722215dfbfc2ab0b74bd446e279b1c7c791df162e7c6068332c8ebb01a0594b04d71c7322890fb68c4be148aff46b8a1637a5420717
+  metadata.gz: a14a3bee4fece94aa0c39a8fcdd614dfcd94afe771a7075f84e33093cf3a0e5e8990029685f09bc89b13c93d1ce89b82bc527c0f120f43f0238e39e902fd6a28
+  data.tar.gz: 513bba26a2dee77e82720214102e9231390954e94cdf36cff610066578179ea67498bfd29576ceb9177362981f34baad2abdddca877f782dc0b47123523e71b0

data/.travis.yml

@@ -4,16 +4,12 @@ env:
     - CC_TEST_REPORTER_ID=a2bb1313ac63f7ae7a7f13ac962870e3cdb0c345b6c60d2857807cc5153d7c3b
 language: ruby
 rvm:
+  - 2.0
   - 2.2
   - 2.6
   - 2.7
 gemfile:
   - gemfiles/Gemfile
-matrix:
-  include:
-    - dist: trusty
-      rvm: 1.8.7
-      gemfile: gemfiles/ruby_1_8_7.gemfile
 before_install:
   - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
       gem i rubygems-update -v '< 3' && update_rubygems;

data/README.md

@@ -7,7 +7,10 @@
 [![Test Coverage](https://codeclimate.com/github/khiav223577/multi_range/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/multi_range/coverage)
 
 ## Supports
-- Ruby 1.8 ~ 2.7
+ 
+- Ruby 2.0 ~ 2.7
+
+For Ruby 1.8.x and 1.9.x, please use multi_range < 2.
 
 ## Installation
 
@@ -25,7 +28,7 @@ Or install it yourself as:
 
 ## Usage
 
-Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union and difference.
+Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union, intersection, and difference.
 
 ### Sample a number
 ```rb
@@ -72,6 +75,22 @@ multi_range.ranges
 # => [1..6, 10..25, 30..30]
 ```
 
+### Intersection ranges
+
+```rb
+multi_range = MultiRange.new([1..5])
+multi_range &= 3..8
+multi_range.ranges
+# => [3..5]
+```
+
+```rb
+multi_range = MultiRange.new([1..3, 5..10])
+multi_range &= MultiRange.new([2..6, 8..9])
+multi_range.ranges
+# => [2..3, 5..6, 8..9]
+```
+
 ### Merge overlaps
 ```rb
 multi_range = MultiRange.new([1, 2, 4..6, 7, 8..12])
@@ -103,6 +122,23 @@ multi_range.overlaps?(MultiRange.new([6..8, 18..22]))
 # => true
 ```
 
+
+### Check if it contains overlaps
+
+```rb
+MultiRange.new([0..3, 5..10, 20..50]).contain_overlaps?
+# => false
+
+MultiRange.new([0...5, 5..10, 20..50]).contain_overlaps?
+# => false
+
+MultiRange.new([0..5, 5..10, 20..50]).contain_overlaps?
+# => true
+
+MultiRange.new([0...7, 5..10, 20..50]).contain_overlaps?
+# => true
+```
+
 ### Range-like interface
 
 #### each

data/bin/setup

@@ -3,6 +3,6 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install --gemfile=gemfiles/4.2.gemfile
+bundle install --gemfile=gemfiles/Gemfile
 
 # Do any other automated setup that you need to do here

data/lib/multi_range.rb

@@ -2,6 +2,7 @@
 
 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" \
@@ -22,8 +23,17 @@ class MultiRange
   attr_reader :ranges
 
   def initialize(ranges)
-    @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) }
+    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)
@@ -48,37 +58,41 @@ class MultiRange
     return MultiRange.new(new_ranges)
   end
 
-  def -(other)
-    if other.is_a?(MultiRange)
-      new_multi_range = dup
-      other.ranges.each{|range| new_multi_range -= range }
-      return new_multi_range
+  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|
+      matching_ranges_converted_to_exclusive = tree.search(range) || []
+
+      # 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 multirange, 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
 
-    new_ranges = @ranges.dup
+  alias intersection &
 
-    return MultiRange.new(new_ranges) if new_ranges.empty?
-    return MultiRange.new(new_ranges) if other.begin > @ranges.last.end # 大於最大值
-    return MultiRange.new(new_ranges) if other.end < @ranges.first.begin # 小於最小值
+  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|
       next if other.begin > range.end # 大於這個 range
       break if other.end < range.begin # 小於這個 range
 
-      sub_range1 = range.begin...other.begin
-
-      sub_range2_begin = if other.exclude_end?
-                           other.end
-                         else
-                           other.end + (other.end.is_a?(Float) ? Float::EPSILON : 1)
-                         end
-      sub_range2 = range.exclude_end? ? sub_range2_begin...range.end : sub_range2_begin..range.end
-
-      sub_ranges = []
-      sub_ranges << sub_range1 if sub_range1.begin <= sub_range1.end
-      sub_ranges << sub_range2 if sub_range2.begin <= sub_range2.end
-
+      sub_ranges = possible_sub_ranges_of(range, other)
       new_ranges[idx + changed_size, 1] = sub_ranges
       changed_size += sub_ranges.size - 1
       break if other.end <= range.end # 沒有超過一個 range 的範圍
@@ -87,11 +101,15 @@ class MultiRange
     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
@@ -160,4 +178,45 @@ class MultiRange
     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 + (other.end.is_a?(Float) ? Float::EPSILON : 1)
+                       end
+
+    sub_range2 = range.exclude_end? ? sub_range2_begin...range.end : sub_range2_begin..range.end
+
+    sub_ranges = []
+    sub_ranges << sub_range1 if sub_range1.begin <= sub_range1.end
+    sub_ranges << sub_range2 if sub_range2.begin <= sub_range2.end
+    return sub_ranges
+  end
+
+  def overlaps_with_range?(range)
+    return false if @ranges.empty?
+    return false if range.begin > @ranges.last.end # larger than maxinum
+    return false if range.end < @ranges.first.begin # smaller than mininum
+    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
 end

data/lib/multi_range/version.rb

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

data/multi_range.gemspec

@@ -34,10 +34,14 @@ Gem::Specification.new do |spec|
     'bug_tracker_uri'   => 'https://github.com/khiav223577/multi_range/issues',
   }
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_development_dependency 'bundler', '>= 1.17', '< 3.x'
   spec.add_development_dependency 'rake', '>= 10.5.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-color', '~> 0.0.2'
   spec.add_development_dependency 'backports', '~> 3.15.0'
 
   spec.add_dependency 'roulette-wheel-selection', '~> 1.1.1'
+  spec.add_dependency 'fast_interval_tree', '~> 0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_range
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: backports
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: fast_interval_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Allow you to manipulate a group of ranges. Such as merging overlapping
   ranges, doing ranges union and difference.
 email:
@@ -105,7 +133,6 @@ files:
 - bin/console
 - bin/setup
 - gemfiles/Gemfile
-- gemfiles/ruby_1_8_7.gemfile
 - lib/multi_range.rb
 - lib/multi_range/version.rb
 - multi_range.gemspec
@@ -126,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/gemfiles/ruby_1_8_7.gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rails_or.gemspec
-
-group :test do
-  gem 'simplecov'
-  gem 'minitest', '~> 5.11.3'
-end
-
-gemspec :path => '../'