set_of_ranges 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9142960fa98dfc74d66581a09fffd896fae62a28
+  data.tar.gz: f63d71318e3c2968282dc83c81d27e7344f916ec
+SHA512:
+  metadata.gz: e9469ebb965c96ea42e8c046b180f0232271e73be1f95ba5451454143d2209f2f3af16d2dd130bceccf1d5b76d87e2a287681ef7b499b02f0dc2bcbedc6b567a
+  data.tar.gz: 3fdb8eb4abaf4535a05ad4f319ed3cf81cfd39e8269881637e8f6b44b59afc834489fcc48c63c06b51d05faf4f670fc4115d56da1faac7b788382951476c3fd1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Galen Palmer
+
+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,49 @@
+# SetOfRanges [![Build Status](https://secure.travis-ci.org/palmergs/set_of_ranges.png?branch=master)](http://travis-ci.org/palmergs/set_of_ranges)
+
+`SetOfRanges::Set` is a simple gem that inherits from `Set` and allows `Range` instances as values. It behaves like `Set` except that the add method attempts to merge adjacent and overlapping ranges. It was designed for use with integer values. Insertion of new range values is proportional to the number of existing values in the set.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'set_of_ranges'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install set_of_ranges
+
+## Usage
+
+    require 'set_of_ranges'
+
+    set = SetOfRanges::Set.new
+    set << (5..10)
+    set << (15..20)
+    set.to_a #=>  [5..10, 15..20]
+    
+    set << (2..6)
+    set.to_a #=>  [2..10, 15..20]
+
+    set << (3..9)
+    set.to_a #=>  [2..10, 15..20]
+
+    set << (11...12)
+    set.to_a #=>  [2..11, 15..20]
+
+    set << (12..14)
+    set.to_a #=>  [2..20]
+
+
+
+
+## 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,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => 'spec'

data/lib/set_of_ranges/set.rb

@@ -0,0 +1,59 @@
+require 'set'
+
+class SetOfRanges::Set < Set
+
+  def add(obj)
+    raise ArgumentError if obj.nil?
+    raise ArgumentError unless obj.is_a? Range
+    rng = obj.exclude_end? ? (obj.begin..(obj.end-1)) : obj
+
+    if empty?
+      super(rng)
+    else
+
+      overlapping_ranges = Set.new
+      each do |r|
+        if r.begin <= rng.begin and r.end >= rng.end
+
+          # new range is completely contained within an 
+          # existing range don't need to modify anything
+          return self
+        elsif (rng.begin < r.begin and rng.end >= r.begin - 1) or
+            (rng.end > r.end and rng.begin <= r.end + 1)
+          overlapping_ranges << r
+        end
+      end
+
+      if overlapping_ranges.size == 0
+
+        super(rng)
+
+      else
+
+        subtract(overlapping_ranges)
+        overlapping_ranges << rng
+        min = overlapping_ranges.map(&:begin).min
+        max = overlapping_ranges.map(&:end).max
+        super(min..max)
+      end
+    end
+
+    self
+  end
+
+  def << obj
+    add(obj)
+  end
+
+  def merge enum
+    enum.each do |e|
+      add(e)
+    end
+    self
+  end
+
+  def replace enum
+    clear
+    merge(enum)
+  end
+end

data/lib/set_of_ranges/version.rb

@@ -0,0 +1,3 @@
+module SetOfRanges
+  VERSION = "0.0.1"
+end

data/lib/set_of_ranges.rb

@@ -0,0 +1,5 @@
+require "set_of_ranges/version"
+require "set_of_ranges/set"
+
+module SetOfRanges
+end

data/spec/set_of_ranges/set_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe SetOfRanges::Set do
+
+  before(:each) do 
+
+    @r = SetOfRanges::Set.new
+    @r << (10..12)
+
+  end
+
+  it 'raises an error unless a range is added' do
+    expect { @r << nil }.to raise_error(ArgumentError)
+    expect { @r << "test" }.to raise_error(ArgumentError)
+  end
+
+  it 'ignores ranges within existing ranges' do
+    @r << (10..11)
+    @r.count.should == 1
+    @r.should include(10..12)
+
+    @r << (11..12)
+    @r.count.should == 1
+    @r.should include(10..12)
+
+    @r << (10..12)
+    @r.count.should == 1
+    @r.should include(10..12)
+  end
+
+  it 'adds disjoint ranges' do
+    @r << (1..8)
+    @r << (14..15)
+    @r.count.should == 3
+    @r.should include (1..8)
+    @r.should include (14..15)
+    @r.should include (10..12)
+  end
+
+  it 'adds overlapping ranges' do
+
+    @r << (9..13)
+    @r.count.should == 1
+    @r.should include (9..13)
+
+  end
+
+  it 'adds overlapping ranges on beginning' do
+    @r << (9..11)
+    @r.count.should == 1
+    @r.should include (9..12)
+  end
+
+  it 'adds overlapping ranges on the end' do
+    @r << (11..13)
+    @r.count.should == 1
+    @r.should include (10..13)
+  end
+
+  it 'converts open ranges to closed ranges' do
+    @r << (1...5)
+    @r.count.should == 2
+    @r.should include (1..4)
+  end
+
+  it 'merges multiple ranges if overlapping' do
+    @r << (14..18)
+    @r << (1..3)
+    @r.count.should == 3
+    @r << (3..14)
+    @r.count.should == 1
+    @r.should include (1..18)
+  end
+
+  it 'merges adjacent ranges' do
+    @r << (8..9)
+    @r.count.should == 1
+    @r << (13..14)
+    @r.count.should == 1
+    @r.should include (8..14)
+  end
+
+  it 'merges sets' do
+    r2 = SetOfRanges::Set.new
+    r2 << (1..10)
+    r2 << (20..30)
+    @r.merge(r2)
+    @r.count.should == 2
+    @r.should include (1..12)
+    @r.should include (20..30)
+    r2.count.should == 2
+    r2.should include (1..10)
+  end
+
+  it 'replaces sets' do
+    r2 = SetOfRanges::Set.new
+    r2 << (20..30)
+    @r.replace(r2)
+    @r.count.should == 1
+    @r.should include (20..30)
+  end
+end
+

data/spec/set_of_ranges/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SetOfRanges::VERSION do
+  it 'is in semantic format' do
+    SetOfRanges::VERSION.should =~ /\d+[.]\d+[.]\d+([.-]\w+)?/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'set_of_ranges'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: set_of_ranges
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Galen Palmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: A subclass of Set that attempts to merge overlapping or adjacent Range
+  values.
+email:
+- palmergs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/set_of_ranges/set.rb
+- lib/set_of_ranges/version.rb
+- lib/set_of_ranges.rb
+- spec/set_of_ranges/set_spec.rb
+- spec/set_of_ranges/version_spec.rb
+- spec/spec_helper.rb
+- README.md
+- LICENSE.txt
+homepage: https://github.com/palmergs/set_of_ranges
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: set_of_ranges
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Developed to enable iteration through a set of discontiguous ranges.
+test_files:
+- spec/set_of_ranges/set_spec.rb
+- spec/set_of_ranges/version_spec.rb
+- spec/spec_helper.rb