range_array 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in range_array.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Flinter
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# RangeArray
+
+This is a very simple subclass of the `Array` class, aimed specifically at supporting `Ranges`, rather than general objects.
+
+When a new range is added to the array (using the `<<` method), the RangeArray ensures that there are no overlapping ranges, and if necessary, merges any overlapping ranges into a single range.
+
+For example, if the RangeArray holds the ranges (1..10) and (20..30), appending the range (5..25) will merge all ranges into a single range (1..30).
+
+At this stage, only the `<<` has been overridden, so no other methods are checked to guard against non-range members.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'range_array'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install range_array
+
+## Usage
+
+In your `Gemfile`:
+
+```gem 'range_array'```
+
+Simple example:
+
+    require 'range_array'
+    ra = RangeArray.new
+    ra << (1..10)  # [(1..10)]
+    ra << (20..30) # [(1..10), (20..30)]
+    ra << (5..25)  # [(1..30)]
+
+Also works for dates:
+
+    require 'range_array'
+    require 'date'
+    ra = RangeArray.new
+    ra << (Date.parse('2013-01-01') .. Date.parse('2013-05-01'))
+    ra << (Date.parse('2013-10-01') .. Date.parse('2013-12-31'))
+    ra << (Date.parse('2013-04-01') .. Date.parse('2013-11-01')) # [('2013-01-01' .. '2013-12-31')]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/range_array/range.rb

@@ -0,0 +1,43 @@
+class Range
+  def merge(r)
+    return self if self == r
+
+    return self if fully_overlaps?(r)
+    return r if fully_overlapped_by?(r)
+
+    return (r.min .. self.max) if adjoins?(r) || start_overlapped_by?(r)
+    return (self.min .. r.max) if adjoined_by?(r) || end_overlapped_by?(r)
+
+    nil
+  end
+
+  def merge!(r)
+    merge(r) || self
+  end
+
+  private
+
+  def fully_overlaps?(r)
+    start_overlapped_by?(r) && end_overlapped_by?(r)
+  end
+
+  def fully_overlapped_by?(r)
+    r.cover?(self.min) && r.cover?(self.max)
+  end
+
+  def start_overlapped_by?(r)
+    self.cover?(r.max)
+  end
+
+  def end_overlapped_by?(r)
+    self.cover?(r.min)
+  end
+
+  def adjoins?(r)
+    r.max.succ == self.min    
+  end
+
+  def adjoined_by?(r)
+    self.max.succ == r.min
+  end
+end

data/lib/range_array/range_array.rb

@@ -0,0 +1,23 @@
+class RangeArray < Array
+  alias append <<
+
+  def <<(range)
+    return unless range.class == Range
+    super eliminate_overlaps(merged_range(range))
+  end
+
+  private
+
+  def merged_range(range)
+    self.inject(range) do |memo_range, r|
+      memo_range.merge!(r)
+    end
+  end
+
+  def eliminate_overlaps(range)
+    self.delete_if do |r|
+      r.merge(range)
+    end
+    range
+  end
+end

data/lib/range_array/version.rb

@@ -0,0 +1,3 @@
+class RangeArray < Array
+  VERSION = "0.0.1"
+end

data/lib/range_array.rb

@@ -0,0 +1,3 @@
+require "range_array/version"
+require "range_array/range_array"
+require "range_array/range"

data/range_array.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'range_array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "range_array"
+  spec.version       = RangeArray::VERSION
+  spec.authors       = ["Steve Flinter"]
+  spec.email         = ["stephen@flinter.com"]
+  spec.description   = %q{Gem to create and manage an array of ranges}
+  spec.summary       = %q{Gem to create and manage an array of ranges}
+  spec.homepage      = "https://github.com/sflinter/range_array"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/range_array_spec.rb

@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/../lib/range_array'
+
+require 'date'
+
+describe RangeArray do
+  it "can create a new RangeArray" do
+    ra = RangeArray.new
+    expect(ra.class).to eq(RangeArray)
+  end
+
+  it "can add new items" do
+    ra = RangeArray.new
+    ra << (1..2)
+    expect(ra.size).to eq(1)
+  end
+
+  it "can add two items" do
+    ra = RangeArray.new
+    ra << (1..10)
+    ra << (20..30)
+    expect(ra.size).to eq(2)
+    expect(ra.first).to eq(1..10)
+    expect(ra.last).to eq(20..30)
+  end
+
+  it "won't add non-range items" do
+    ra = RangeArray.new
+    ra << (1..2)
+    ra << 4
+    expect(ra.size).to eq(1)
+  end
+
+  it "can append non-consecutive intervals" do
+    ra = RangeArray.new
+    ra << (1..5)
+    ra << (10..20)
+    expect(ra.size).to eq(2)
+  end
+
+  it "can append consecutive intervals" do
+    ra = RangeArray.new
+    ra << (1..2)
+    ra << (3..4)
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(1..4)
+  end
+
+  it "can append consecutive intervals in reverse order" do
+    ra = RangeArray.new
+    ra << (3..4)
+    ra << (1..2)
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(1..4)
+  end
+
+  it "can add simple overlapping intervals" do
+    ra = RangeArray.new
+    ra << (1..5)
+    ra << (4..10)
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(1..10)
+  end
+
+  it "can add simple overlapping intervals in reverse order" do
+    ra = RangeArray.new
+    ra << (4..10)
+    ra << (1..5)
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(1..10)
+  end
+
+  it "can add identical ranges without duplication" do
+    ra = RangeArray.new
+    ra << (1..10)
+    ra << (1..10)
+    expect(ra.size).to eq(1)
+  end
+
+  it "can join multiple intervals" do
+    ra = RangeArray.new
+    ra << (1..4)
+    ra << (8..10)
+    ra << (5..7)
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(1..10)
+  end
+
+  it "can join overlapping intervals" do
+    ra = RangeArray.new
+    ra << (1..4)
+    ra << (6..10)
+    ra << (3..8)
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(1..10)
+  end
+
+  it "can join overlapping date intervals" do
+    ra = RangeArray.new
+    ra << (Date.parse('2013-01-01') .. Date.parse('2013-05-01'))
+    ra << (Date.parse('2013-10-01') .. Date.parse('2013-12-31'))
+    expect(ra.size).to eq(2)
+
+    ra << (Date.parse('2013-04-01') .. Date.parse('2013-11-01'))
+    expect(ra.size).to eq(1)
+    expect(ra.first).to eq(Date.parse('2013-01-01') .. Date.parse('2013-12-31'))
+  end
+end

data/spec/range_merge_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../lib/range_array'
+require 'date'
+
+describe Range do
+  it "doesn't merge where there's no overlap" do
+    expect((1..10).merge(20..30)).to be(nil)
+  end
+
+  it "returns self where there's no overlap" do
+    expect((1..10).merge!(20..30)).to eq(1..10)
+  end
+
+  it "merges identical ranges" do
+    expect((1..10).merge(1..10)).to eq(1..10)
+  end
+
+  it "merges overlapping ranges" do
+    expect((1..10).merge(5..20)).to eq(1..20)
+  end
+
+  it "merges out of order overlapping ranges" do
+    expect((5..20).merge(1..10)).to eq(1..20)
+  end
+
+  it "merges consecutive ranges" do
+    expect((1..10).merge(11..20)).to eq(1..20)
+  end
+
+  it "merges out of order consecutive ranges" do
+    expect((11..20).merge(1..10)).to eq(1..20)
+  end
+
+  it "merges fully overlapping ranges" do
+    expect((1..20).merge(5..15)).to eq(1..20)
+  end
+
+  it "merges fully overlapping out of order ranges" do
+    expect((5..15).merge(1..20)).to eq(1..20)
+  end
+
+  it "merges date ranges" do
+    r1 = (Date.parse('2013-01-01') .. Date.parse('2013-07-01'))
+    r2 = (Date.parse('2013-06-01') .. Date.parse('2013-12-31'))
+    r3 = (Date.parse('2013-01-01') .. Date.parse('2013-12-31'))
+
+    expect(r1.merge(r2)).to eq(r3)
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: range_array
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steve Flinter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to create and manage an array of ranges
+email:
+- stephen@flinter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/range_array.rb
+- lib/range_array/range.rb
+- lib/range_array/range_array.rb
+- lib/range_array/version.rb
+- range_array.gemspec
+- spec/range_array_spec.rb
+- spec/range_merge_spec.rb
+homepage: https://github.com/sflinter/range_array
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Gem to create and manage an array of ranges
+test_files:
+- spec/range_array_spec.rb
+- spec/range_merge_spec.rb