ranges_merger 0.1.0 → 0.2.0

data/README.rdoc

@@ -2,23 +2,9 @@
 
 Very simple gem for merging range-like objects.
 
-== How to use
+== How to use, simple merge
 
-Please use range-like object converted to format [[from, to], [from, to], ...].
-
-If you want to merge 2 ranges please use code just like below.
-
- a = [1, 3]
-
- b = [2, 4]
-
- result = RangesMerger.two_way_merge([a, b])
-
- # => result = [[1, 4]]
-
-
-
-If you want to merge more than 2 ranges please use code just like below.
+If you want to merge please use code just like below.
 
  a = [1, 3]
 
@@ -28,9 +14,9 @@ If you want to merge more than 2 ranges please use code just like below.
 
  result = RangesMerger.merge([a, b, c])
 
- # => result = [[1, 6]]
-
+ # result => [[1, 6]]
 
+== Range objects
 
 If you want to merge Range objects.
 
@@ -46,8 +32,49 @@ If you want to merge Range objects.
 
  result = RangesMerger.merge(ranges)
 
- # => result = [(1..3),(5..8)]
+ # result => [(1..3),(5..8)]
+
+== Exclusion
+
+If you want to exclude please use code just like below.
+
+First - base:
+
+ a = [1, 3]
+
+ b = [3, 5]
+
+ c = [9, 11]
+
+Seconds - exclusions:
+
+ x = [2, 4]
+
+ y = [4, 10]
+
+And run some processing
+
+ result = RangesMerger.exclude([a, b, c], [x, y])
+
+ # result => [[1, 2], [10, 11]]
+
+== I want an instance
+
+If you want to have instance, add and remove ranges as you wish just do something like that:
+
+ r = RangesMerger.new
+
+ r += [[1, 10]]
+
+ r += [[8, 15]]
+
+ # r.to_array => [[1, 15]]
+
+ r -= [[2, 4]]
+
+ r -= [[11, 12]]
 
+ # r.to_array => [[1, 2], [4,11], [12,15]]
 
 
 == Contributing to ranges_merger

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/ranges_merger/ranges_merger_exclusion.rb

@@ -0,0 +1,88 @@
+module RangesMergerExclusion
+
+  def exclude(_array_a, _array_b)
+    new_array = Array.new
+
+    # array of bases
+    bases = merge(_array_a)
+
+    # loop for "base"
+    i = 0
+    while i < bases.size
+      base = bases[i]
+
+      # loop for "exclusions"
+      _array_b.each do |b|
+        # base can be excluded to this level that is empty
+        if not base.nil?
+          result = two_way_exclusion([base, b])
+          if result.size == 1
+            base = two_way_exclusion([base, b])[0]
+          elsif result.size == 2
+            # first go to processing, last go to base pool
+            base = result[0]
+            bases << result[1]
+          elsif result.size == 0
+            base = nil
+          end
+        end
+
+      end
+
+      new_array << base if not base.nil?
+      i += 1
+    end
+
+    return merge(new_array)
+  end
+
+  # Merge two Arrays
+  def two_way_exclusion(_array)
+    base_from = _array[0][0]
+    base_to = _array[0][1]
+
+    excl_from = _array[1][0]
+    excl_to = _array[1][1]
+
+    # puts "base_from #{base_from} base_to #{base_to} excl_from #{excl_from} excl_to #{excl_to}"
+
+    # 1A. BASE < EXCL
+    if (base_to < excl_to and base_from < excl_from and base_to < excl_from)
+      # puts "1a"
+      return [[base_from, base_to]]
+    end
+
+    # 1B. BASE > EXCL
+    if  (base_to > excl_to and base_from > excl_from and excl_to < base_from)
+      # puts "1b"
+      return [[base_from, base_to]]
+    end
+
+    # 2 EXCL contains BASE => nothing
+    if base_from >= excl_from and base_to <= excl_to
+      # puts "2"
+      return []
+    end
+
+    # 3 EXCL inside BASE
+    if excl_from > base_from and excl_to < base_to
+      # puts "3"
+      return [[base_from, excl_from], [excl_to, base_to]]
+    end
+
+    # 4A EXCL has inside BASE from
+    if excl_from <= base_from and excl_to >= base_from
+      # puts "4a"
+      return [[excl_to, base_to]]
+    end
+
+    # 4b EXCL has inside BASE to
+    if excl_from <= base_to and excl_to >= base_from
+      # puts "4b"
+      return [[base_from, excl_from]]
+    end
+
+    raise 'Not implemented, is it even possible?'
+  end
+
+end

data/lib/ranges_merger/ranges_merger_merging.rb

@@ -0,0 +1,108 @@
+module RangesMergerMerging
+
+  # Merge for various objects (Array, Range). Result is
+  def merge(_array)
+    klass = _array.first.class
+    array = self.normalize_array(_array)
+    result = self.merge_loop(array)
+
+    if klass.to_s == "Range"
+      return self.array_to_ranges(result)
+    end
+
+    return result
+  end
+
+  protected
+
+  # Merge loop for merging Array of Arrays
+  def merge_loop(_array)
+    return _array if _array.size <= 1
+    return self.two_way_merge(_array) if _array.size == 2
+
+    before = _array
+    while true do
+      after = self.merge_array(_array)
+      return after if before == after or not check_overlaps(after)
+      before = after
+    end
+  end
+
+  # Merging phase
+  def merge_array(_array)
+    return _array if _array.size <= 1
+    sorted = _array.sort { |a, b| a[0] <=> b[0] }.uniq
+
+    i = 1
+    while i < sorted.size do
+      to_merge = [sorted[i-1], sorted[i]]
+      # puts "merging #{to_merge.inspect}"
+
+      result = self.two_way_merge(to_merge)
+      # puts "merged #{result.inspect}"
+
+      sorted[i-1] = result[0]
+
+      if result.size == 1
+        sorted[i] = nil
+        sorted.delete_if { |s| s.nil? }
+      else
+        i += 1
+      end
+    end
+
+    return sorted
+  end
+
+  # Check if there are overlaps in Array
+  def check_overlaps(_array)
+    sorted = _array.sort { |a, b| a[0] <=> b[0] }.uniq
+
+    (1...sorted.size).each do |i|
+      return true if sorted[i][0] <= sorted[i-1][0]
+      return true if sorted[i][0] <= sorted[i-1][1]
+    end
+    return false
+  end
+
+  # Merge two Arrays
+  def two_way_merge(_array)
+    a_from = _array[0][0]
+    b_from = _array[1][0]
+    a_to = _array[0][1]
+    b_to = _array[1][1]
+
+    # 1A. outside each other A > B
+    if (a_to < b_to and a_from < b_from and a_to < b_from)
+      return [[a_from, a_to], [b_from, b_to]]
+    end
+
+    # 1B. outside each other B > A
+    if  (a_to > b_to and a_from > b_from and b_to < a_from)
+      return [[b_from, b_to], [a_from, a_to]]
+    end
+
+    # 2A. A is inside B
+    if a_from >= b_from and a_to <= b_to
+      return [[b_from, b_to]]
+    end
+
+    # 2B. B is inside A
+    if b_from >= a_from and b_to <= a_to
+      return [[a_from, a_to]]
+    end
+
+    # 3A. overlapping, A < B
+    if a_from < b_from and a_to < b_to and a_to >= b_from
+      return [[a_from, b_to]]
+    end
+
+    # 3B. overlapping, B < A
+    if b_from < a_from and b_to < a_to and b_to >= a_from
+      return [[b_from, a_to]]
+    end
+
+    raise 'Not implemented, is it even possible?'
+  end
+
+end

data/lib/ranges_merger/ranges_merger_utils.rb

@@ -0,0 +1,18 @@
+module RangesMergerUtils
+  # Convert Array of Arrays or Ranges to Array of Arrays
+  def normalize_array(_array)
+    klass = _array.first.class
+    if klass.to_s == "Array"
+      return self.merge_loop(_array)
+    elsif klass.to_s == "Range"
+      return _array.collect { |a| [a.first, a.last] }
+    else
+      return []
+    end
+  end
+
+  # Convert Array of Arrays to Array of Ranges
+  def array_to_ranges(_array)
+    _array.collect { |r| Range.new(r[0], r[1]) }
+  end
+end

data/lib/ranges_merger.rb

@@ -1,102 +1,44 @@
-class RangesMerger
+require 'ranges_merger/ranges_merger_merging'
+require 'ranges_merger/ranges_merger_utils'
+require 'ranges_merger/ranges_merger_exclusion'
 
-  # Merge for various objects (Array, Range)
-  def self.merge(_array)
-    klass = _array.first.class
+class RangesMerger
+  extend RangesMergerMerging
+  extend RangesMergerUtils
+  extend RangesMergerExclusion
 
-    if klass.to_s == "Array"
-      return self.merge_loop(_array)
-    elsif klass.to_s == "Range"
-      result = self.merge_loop( _array.collect{|a| [a.first, a.last]} )
-      return result.collect{|r| Range.new(r[0], r[1])}
-    else
-      return []
-    end
+  attr_reader :ranges
 
+  def initialize(_array = [])
+    @ranges = self.class.merge(
+      self.class.normalize_array(_array)
+    )
   end
 
-  # Merge loop
-  def self.merge_loop(_array)
-    before = _array
-    while true do
-      after = self.merge_array(_array)
-      return after if before == after or not check_overlaps(after)
-      before = after
-    end
+  def add(_array)
+    @ranges = self.class.merge(@ranges + _array)
+    return self
   end
 
-  def self.merge_array(_array)
-    return _array if _array.size <= 1
-    sorted = _array.sort { |a, b| a[0] <=> b[0] }.uniq
-
-    i = 1
-    while i < sorted.size do
-      to_merge = [sorted[i-1], sorted[i]]
-      # puts "merging #{to_merge.inspect}"
-
-      result = self.two_way_merge(to_merge)
-      # puts "merged #{result.inspect}"
-
-      sorted[i-1] = result[0]
-
-      if result.size == 1
-        sorted[i] = nil
-        sorted.delete_if { |s| s.nil? }
-      else
-        i += 1
-      end
-    end
-
-    return sorted
+  def +(_array)
+    add(_array)
   end
 
-  # Check if there are overlaps in Array
-  def self.check_overlaps(_array)
-    sorted = _array.sort { |a, b| a[0] <=> b[0] }.uniq
-
-    (1...sorted.size).each do |i|
-      return true if sorted[i][0] <= sorted[i-1][0]
-      return true if sorted[i][0] <= sorted[i-1][1]
-    end
-    return false
+  def remove(_array)
+    @ranges = self.class.exclude(@ranges, _array)
+    return self
   end
 
-  def self.two_way_merge(_array)
-    a_from = _array[0][0]
-    b_from = _array[1][0]
-    a_to = _array[0][1]
-    b_to = _array[1][1]
-
-    # 1A. outside each other A > B
-    if (a_to < b_to and a_from < b_from and a_to < b_from)
-      return [[a_from, a_to], [b_from, b_to]]
-    end
-
-    # 1B. outside each other B > A
-    if  (a_to > b_to and a_from > b_from and b_to < a_from)
-      return [[b_from, b_to], [a_from, a_to]]
-    end
-
-    # 2A. A is inside B
-    if a_from >= b_from and a_to <= b_to
-      return [[b_from, b_to]]
-    end
-
-    # 2B. B is inside A
-    if b_from >= a_from and b_to <= a_to
-      return [[a_from, a_to]]
-    end
-
-    # 3A. overlapping, A < B
-    if a_from < b_from and a_to < b_to and a_to >= b_from
-      return [[a_from, b_to]]
-    end
+  def -(_array)
+    remove(_array)
+  end
 
-    # 3B. overlapping, B < A
-    if b_from < a_from and b_to < a_to and b_to >= a_from
-      return [[b_from, a_to]]
-    end
+  def to_ranges
+    self.class.array_to_ranges(@ranges)
+  end
 
-    raise 'Not implemented'
+  def to_array
+    @ranges
   end
+
 end

data/ranges_merger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ranges_merger"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aleksander Kwiatkowski"]
-  s.date = "2011-12-04"
+  s.date = "2011-12-06"
   s.description = "Simple gem used for merging range-like objects. If you have problems with operations on ranges this gem can save you some time."
   s.email = "bobikx@poczta.fm"
   s.extra_rdoc_files = [
@@ -27,6 +27,9 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/ranges_merger.rb",
+    "lib/ranges_merger/ranges_merger_exclusion.rb",
+    "lib/ranges_merger/ranges_merger_merging.rb",
+    "lib/ranges_merger/ranges_merger_utils.rb",
     "ranges_merger.gemspec",
     "spec/ranges_merger_spec.rb",
     "spec/spec_helper.rb"

data/spec/ranges_merger_spec.rb

@@ -1,17 +1,20 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "RangesMerger" do
+
+  # Merging
+
   it "should merge 2 overlapping ranges" do
     a = [1, 3]
     b = [2, 4]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 4]]
   end
 
   it "should merge 2 overlapping ranges" do
     a = [2, 4]
     b = [1, 3]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 4]]
   end
 
@@ -19,7 +22,7 @@ describe "RangesMerger" do
     b = [1, 3]
     a = [5, 6]
     # it sorts :)
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 3], [5, 6]]
     result.should_not == [[5, 6], [1, 3]]
   end
@@ -27,28 +30,28 @@ describe "RangesMerger" do
   it "should merge 2 not overlapping ranges" do
     a = [1, 3]
     b = [5, 6]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 3], [5, 6]]
   end
 
   it "should merge 2 identical ranges" do
     a = [1, 2]
     b = [1, 2]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 2]]
   end
 
   it "should merge 2 ranges, A within B" do
     a = [1, 5]
     b = [2, 3]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 5]]
   end
 
   it "should merge 2 ranges, B within A" do
     b = [1, 5]
     a = [2, 3]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 5]]
   end
 
@@ -105,7 +108,7 @@ describe "RangesMerger" do
   it "should do the readme code" do
     a = [1, 3]
     b = [2, 4]
-    result = RangesMerger.two_way_merge([a, b])
+    result = RangesMerger.merge([a, b])
     result.should == [[1, 4]]
 
     a = [1, 3]
@@ -142,8 +145,137 @@ describe "RangesMerger" do
       (5..8)
     ]
     result = RangesMerger.merge(ranges)
-    result.should == [(1..3),(5..8)]
+    result.should == [(1..3), (5..8)]
+  end
+
+
+  #Exclusion
+
+  it "should exclude ranges 'inside' range" do
+    result = RangesMerger.exclude([[1, 4]], [[2, 3]])
+    result.should == [[1, 2], [3, 4]]
+  end
+
+  it "should exclude ranges at right end" do
+    result = RangesMerger.exclude([[1, 4]], [[3, 4]])
+    result.should == [[1, 3]]
+  end
+
+  it "should exclude ranges at left end" do
+    result = RangesMerger.exclude([[1, 4]], [[1, 2]])
+    result.should == [[2, 4]]
+  end
+
+  it "should exclude ranges 'outside' range" do
+    result = RangesMerger.exclude([[1, 4]], [[0, 5]])
+    result.should == []
+  end
+
+  it "should not exclude ranges because exclude range is 'outside' base range" do
+    result = RangesMerger.exclude([[1, 4]], [[5, 6]])
+    result.should == [[1, 4]]
+  end
+
+  it "should exclude using many ranges (1)" do
+    result = RangesMerger.exclude([[1, 2], [3, 4], [5, 6]], [[2, 5]])
+    result.should == [[1, 2], [5, 6]]
+  end
+
+  it "should exclude using many ranges (2)" do
+    result = RangesMerger.exclude([[1, 2], [3, 4], [5, 6]], [[1, 6]])
+    result.should == []
+  end
+
+  it "should exclude using many ranges (3)" do
+    result = RangesMerger.exclude([[1, 2], [3, 4], [5, 6]], [[2, 3], [4, 5]])
+    result.should == [[1, 2], [3, 4], [5, 6]]
+  end
+
+  it "should exclude using many ranges (4)" do
+    result = RangesMerger.exclude([[1, 10]], [[2, 3], [4, 5], [6, 7]])
+    result.should == [[1, 2], [3, 4], [5, 6], [7, 10]]
   end
 
+  it "should exclude using many ranges (5)" do
+    result = RangesMerger.exclude([[1, 4], [6, 10]], [[4, 6]])
+    result.should == [[1, 4], [6, 10]]
+  end
+
+  it "should exclude using many ranges (6)" do
+    result = RangesMerger.exclude([[1, 4], [6, 10]], [[3, 7]])
+    result.should == [[1, 3], [7, 10]]
+  end
+
+  it "should exclude using many ranges (7)" do
+    result = RangesMerger.exclude([[1, 4], [6, 10]], [[0, 7]])
+    result.should == [[7, 10]]
+  end
+
+  it "should exclude using many ranges (8)" do
+    result = RangesMerger.exclude([[1, 4], [6, 10]], [[8, 8]])
+    result.should == [[1, 4], [6, 10]]
+  end
+
+  it "should exclude using many ranges (8)" do
+    result = RangesMerger.exclude([[1, 3], [3, 5], [9, 11]], [[2, 4], [4, 10]])
+    result.should == [[1, 2], [10, 11]]
+  end
+
+  # Instance
+
+  it "should create instance, add 2 ranges and process them to array format (using add method)" do
+    r = RangesMerger.new
+    r.add [[1, 2]]
+    r.add [[2, 3]]
+    r.kind_of?(RangesMerger).should
+    r.to_array.should == [[1, 3]]
+  end
+
+  it "should create instance, add 2 ranges and process them to array format (using plus operator)" do
+    r = RangesMerger.new
+    r += [[1, 2]]
+    r += [[2, 3]]
+    r.kind_of?(RangesMerger).should
+    r.to_array.should == [[1, 3]]
+  end
+
+
+  it "should create instance, add 2 ranges, remove 2 and process them to array format (using add/remove method)" do
+    r = RangesMerger.new
+    r.add [[1, 10]]
+    r.add [[8, 15]]
+    r.to_array.should == [[1, 15]]
+
+    r.remove [[2, 4]]
+    r.remove [[11, 12]]
+    r.kind_of?(RangesMerger).should
+    r.to_array.should == [[1, 2], [4, 11], [12, 15]]
+  end
+
+  it "should create instance, add 2 ranges, remove 2 and process them to array format (using plus/minus operator)" do
+    r = RangesMerger.new
+    r += [[1, 10]]
+    r += [[8, 15]]
+    r.to_array.should == [[1, 15]]
+
+    r -= [[2, 4]]
+    r -= [[11, 12]]
+    r.kind_of?(RangesMerger).should
+    r.to_array.should == [[1, 2], [4, 11], [12, 15]]
+  end
+
+  it "should create instance, mixed test" do
+    r = RangesMerger.new
+    r += [[10, 50]]
+    r.to_array.should == [[10, 50]]
+    r -= [[15, 30]]
+    r.to_array.should == [[10, 15], [30, 50]]
+    r += [[0, 20]]
+    r.to_array.should == [[0, 20], [30, 50]]
+    r -= [[2, 5]]
+    r.to_array.should == [[0, 2], [5, 20], [30, 50]]
+    r += [[-2, 3]]
+    r.to_array.should == [[-2, 3], [5, 20], [30, 50]]
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ranges_merger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-04 00:00:00.000000000Z
+date: 2011-12-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &75213000 !ruby/object:Gem::Requirement
+  requirement: &83398430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *75213000
+  version_requirements: *83398430
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &75212750 !ruby/object:Gem::Requirement
+  requirement: &83398180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *75212750
+  version_requirements: *83398180
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &75212470 !ruby/object:Gem::Requirement
+  requirement: &83397940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *75212470
+  version_requirements: *83397940
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &75212230 !ruby/object:Gem::Requirement
+  requirement: &83333790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75212230
+  version_requirements: *83333790
 description: Simple gem used for merging range-like objects. If you have problems
   with operations on ranges this gem can save you some time.
 email: bobikx@poczta.fm
@@ -74,6 +74,9 @@ files:
 - Rakefile
 - VERSION
 - lib/ranges_merger.rb
+- lib/ranges_merger/ranges_merger_exclusion.rb
+- lib/ranges_merger/ranges_merger_merging.rb
+- lib/ranges_merger/ranges_merger_utils.rb
 - ranges_merger.gemspec
 - spec/ranges_merger_spec.rb
 - spec/spec_helper.rb
@@ -92,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 63330927
+      hash: -671424623
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: