multi_range 0.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 201ed1151cccd779945250523ac3872fc7496d6b
-  data.tar.gz: 8fe06100aeffb7392877ad7c5ce51561eabc65b4
+SHA256:
+  metadata.gz: 8b6430c0f1e34bd416c5ac86b7427a287b980282604b7220a518feb8eb90e3d3
+  data.tar.gz: 01f8ca6da27bc8a960ef531e114cdfc15296fac6af91e4e588642a11b7b56ac7
 SHA512:
-  metadata.gz: 341b27fe3a106b36021fc5480d6e3529941c3b32e18e2d7280bb1264a8d2cebf694d6fda12f2eba0a27812cb668eb48e0e4503fedd144b1836bdebc7b715d17d
-  data.tar.gz: ce029763753f86cf0ad073bcccb8ed66c482f288b5bd50d1229179b5afd744d285267ba9364f63728847852ff35bc5a58c7332a9c4b0185ef90b180f587e3ffa
+  metadata.gz: a14a3bee4fece94aa0c39a8fcdd614dfcd94afe771a7075f84e33093cf3a0e5e8990029685f09bc89b13c93d1ce89b82bc527c0f120f43f0238e39e902fd6a28
+  data.tar.gz: 513bba26a2dee77e82720214102e9231390954e94cdf36cff610066578179ea67498bfd29576ceb9177362981f34baad2abdddca877f782dc0b47123523e71b0

data/.rubocop.yml

@@ -76,10 +76,6 @@ Layout/EndAlignment:
   Description: 'Align ends correctly.'
   Enabled: true
 
-Lint/EndInMethod:
-  Description: 'END blocks should not be placed inside method definitions.'
-  Enabled: true
-
 Lint/EnsureReturn:
   Description: 'Do not use return in an ensure block.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-return-ensure'
@@ -181,8 +177,8 @@ Lint/UselessAssignment:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
   Enabled: true
 
-Lint/UselessComparison:
-  Description: 'Checks for comparison of something with itself.'
+Lint/BinaryOperatorWithIdenticalOperands:
+  Description: 'This cop checks for places where binary operator has identical operands.'
   Enabled: true
 
 Lint/UselessElseWithoutRescue:
@@ -581,9 +577,12 @@ Style/For:
 Style/FormatString:
   Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf'
-  EnforcedStyle: sprintf
+  EnforcedStyle: percent
   Enabled: true
 
+Style/FormatStringToken:
+  Enabled: false
+
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars'
@@ -809,7 +808,7 @@ Style/PercentQLiterals:
 Style/PerlBackrefs:
   Description: 'Avoid Perl-style regex back references.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
-  Enabled: true
+  Enabled: false
 
 Naming/PredicateName:
   Description: 'Check the names of predicate methods.'
@@ -1065,7 +1064,7 @@ Style/SymbolProc:
   Description: 'Use symbols as procs instead of blocks when possible.'
   Enabled: false # wants to support ruby 1.8
 
-Layout/Tab:
+Layout/IndentationStyle:
   Description: 'No hard tabs.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation'
   Enabled: true

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/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Change Log
 
+### [v1.1.0](https://github.com/khiav223577/multi_range/compare/v1.0.0...v1.1.0) 2020/10/15
+- [#13](https://github.com/khiav223577/multi_range/pull/13) Rename flatten => merge_overlaps (@khiav223577)
+
+### [v1.0.0](https://github.com/khiav223577/multi_range/compare/v0.0.4...v1.0.0) 2020/10/15
+- [#12](https://github.com/khiav223577/multi_range/pull/12) Implement #overlaps? (@khiav223577)
+- [#11](https://github.com/khiav223577/multi_range/pull/11) Support difference other multi_range object (@khiav223577)
+- [#10](https://github.com/khiav223577/multi_range/pull/10) Add frozen_string_literal (@khiav223577)
+- [#9](https://github.com/khiav223577/multi_range/pull/9) Implement range union (@khiav223577)
+- [#8](https://github.com/khiav223577/multi_range/pull/8) Support initializing a MultiRange object with unsorted ranges (@khiav223577)
+
+### [v0.0.4](https://github.com/khiav223577/multi_range/compare/v0.0.3...v0.0.4) 2020/03/26
+- [#7](https://github.com/khiav223577/multi_range/pull/7) Add flatten method (@khiav223577)
+
 ### [v0.0.3](https://github.com/khiav223577/multi_range/compare/v0.0.2...v0.0.3) 2020/03/02
 - [#6](https://github.com/khiav223577/multi_range/pull/6) freeze internal ranges variable (@khiav223577)
 - [#5](https://github.com/khiav223577/multi_range/pull/5) Add min, max, to_a method (@khiav223577)
@@ -8,6 +21,6 @@
 - [#4](https://github.com/khiav223577/multi_range/pull/4) Add each, map, index_with methods (@khiav223577)
 - [#3](https://github.com/khiav223577/multi_range/pull/3) Support passing integer as range (@khiav223577)
 
-### v0.0.1 2020/03/01
+### [v0.0.1](https://github.com/khiav223577/multi_range/compare/v0.0.1...v0.0.1) 2020/03/01
 - [#2](https://github.com/khiav223577/multi_range/pull/2) Support Ruby 1.8.7 (@khiav223577)
 - [#1](https://github.com/khiav223577/multi_range/pull/1) Implement MultiRange (@khiav223577)

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.
+Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union, intersection, and difference.
 
 ### Sample a number
 ```rb
@@ -34,7 +37,7 @@ multi_range.sample
 # => equals to [1, 2, 3, 4, 5, 10, 11, 12].sample
 ```
 
-### Range difference
+### Difference of ranges
 ```rb
 multi_range = MultiRange.new([1..10])
 multi_range -= 5..7
@@ -49,11 +52,91 @@ multi_range.ranges
 # => [1...5, 86..100]
 ```
 
-### Flatten
+```rb
+multi_range = MultiRange.new([1..10, 50..70, 80..100])
+multi_range -= MultiRange.new([5..60, 75..85])
+multi_range.ranges
+# => [1...5, 61..70, 86..100] 
+```
+
+### Union ranges
+
+```rb
+multi_range = MultiRange.new([1..5])
+multi_range |= 3..8
+multi_range.ranges
+# => [1..8]
+```
+
+```rb
+multi_range = MultiRange.new([1..5, 10..15, 20..25])
+multi_range |= MultiRange.new([3..6, 14..22, 30])
+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])
-multi_range.flatten.ranges
+multi_range.merge_overlaps.ranges
 # => [1..2, 4..12]
+
+multi_range = MultiRange.new([1.2..1.5, 1.7..1.9, 1.8..2.2])
+multi_range.merge_overlaps.ranges
+# => [1.2..1.5, 1.7..2.2]
+```
+
+### Check if it overlaps with the other
+
+```rb
+multi_range = MultiRange.new([1..5, 10..15, 20..25])
+multi_range.overlaps?(7..8)
+# => false
+
+multi_range.overlaps?(3..8)
+# => true
+
+multi_range.overlaps?(7..12)
+# => true
+```
+
+```rb
+multi_range = MultiRange.new([1..5, 10..15, 20..25])
+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
@@ -94,6 +177,50 @@ MultiRange.new([1..3, 6, 8..9]).to_a
 # => [1, 2, 3, 6, 8, 9]
 ```
 
+
+#### size
+```rb
+MultiRange.new([1..3, 6, 8..9]).size
+# => 6
+```
+
+### Warning
+
+The return value may be different when there are some overlapped ranges.
+Call `merge_overlaps` if you want to merge overlapped ranges.
+
+```rb
+MultiRange.new([1..5, 3..6]).to_a
+# => [1, 2, 3, 4, 5, 3, 4, 5, 6] 
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.to_a
+# => [1, 2, 3, 4, 5, 6]
+```
+
+```rb
+MultiRange.new([1..5, 3..6]).each{|s| print s }
+# => 123453456
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.each{|s| print s }
+# => 123456
+```
+
+```rb
+MultiRange.new([1..5, 3..6]).map{|s| s * 2 }
+# => [2, 4, 6, 8, 10, 6, 8, 10, 12] 
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.map{|s| s * 2 }
+# => [2, 4, 6, 8, 10, 12] 
+```
+
+```rb
+MultiRange.new([1..5, 3..6]).size
+# => 9
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.size
+# => 6
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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

@@ -1,5 +1,8 @@
+# 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" \
@@ -19,25 +22,35 @@ class MultiRange
 
   attr_reader :ranges
 
-  def initialize(ranges) # range 要由小到大排序，且各 range 不能重疊
-    @ranges = ranges.map{|s| s.is_a?(Integer) ? s..s : s }.freeze
+  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 flatten
-    return if @ranges.size == 0
+  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.max <= current_range.max
+      next if range.end <= current_range.end
 
-      if current_range.max + 1 < range.min
+      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
-      else
-        current_range = current_range.min..range.max
       end
     end
 
@@ -45,33 +58,63 @@ class MultiRange
     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|
+      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
+
+  alias intersection &
+
   def -(other)
-    new_ranges = @ranges.dup
+    return difference_with_other_multi_range(other) if other.is_a?(MultiRange)
 
-    return MultiRange.new(new_ranges) if new_ranges.empty?
-    return MultiRange.new(new_ranges) if other.min > @ranges.last.max # 大於最大值
-    return MultiRange.new(new_ranges) if other.max < @ranges.first.min # 小於最小值
+    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.min > range.max # 大於這個 range
-      break if other.max < range.min # 小於這個 range
-
-      sub_range1 = range.min...other.min
-      sub_range2 = (other.max + 1)..range.max
-
-      sub_ranges = []
-      sub_ranges << sub_range1 if sub_range1.any?
-      sub_ranges << sub_range2 if sub_range2.any?
+      next if other.begin > range.end # 大於這個 range
+      break if other.end < range.begin # 小於這個 range
 
+      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.max <= range.max # 沒有超過一個 range 的範圍
+      break if other.end <= range.end # 沒有超過一個 range 的範圍
     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
@@ -122,4 +165,58 @@ class MultiRange
     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 + (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,3 +1,5 @@
+# frozen_string_literal: true
+
 class MultiRange
-  VERSION = '0.0.4'
+  VERSION = '2.0.0'
 end

data/multi_range.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['khiav reoy']
   spec.email         = ['mrtmrt15xn@yahoo.com.tw']
 
-  spec.summary       = 'Provides cross-rails methods for you to upgrade rails, backport features, create easy-to-maintain gems, and so on.'
-  spec.description   = 'Provides cross-rails methods for you to upgrade rails, backport features, create easy-to-maintain gems, and so on.'
+  spec.summary       = 'Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union and difference.'
+  spec.description   = 'Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union and difference.'
   spec.homepage      = 'https://github.com/khiav223577/multi_range'
   spec.license       = 'MIT'
 
@@ -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: 0.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-26 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,8 +100,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
-description: Provides cross-rails methods for you to upgrade rails, backport features,
-  create easy-to-maintain gems, and so on.
+- !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:
 - mrtmrt15xn@yahoo.com.tw
 executables: []
@@ -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,17 +153,16 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Provides cross-rails methods for you to upgrade rails, backport features,
-  create easy-to-maintain gems, and so on.
+summary: Allow you to manipulate a group of ranges. Such as merging overlapping ranges,
+  doing ranges union and difference.
 test_files: []

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 => '../'