edwagner-range-subset 0.1.0

data/README.rdoc

@@ -0,0 +1,21 @@
+= range_subset
+
+http://github.com/edwagner/range-subset
+
+== DESCRIPTION:
+
+A simple extension to Ruby's core Range class to determine overlaps between two Ranges.
+
+== INSTALL:
+
+  [sudo] gem install edwagner-range-subset
+
+ or
+ 
+  git clone git://github.com/edwagner/range-subset.git
+  cd range-subset
+  rake install
+  
+== COPYRIGHT:
+
+Copyright (c) 2009 Ed Wagner. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/core_ext/range.rb

@@ -0,0 +1,39 @@
+# Extend the Range class with some set-like operators
+class Range
+
+  # Return a new Range that is the common interval of the two ranges,
+  # or nil if there is no overlap
+  def &(range)
+    range = range.to_range if range.respond_to?(:to_range)
+    return nil if range.begin > self.end || range.end < self.begin
+    return nil if range.begin == self.end && self.exclude_end?
+    return nil if range.end == self.begin && range.exclude_end?
+
+    if self.end < range.end
+      exclude_end = self.exclude_end?
+    elsif range.end < self.end
+      exclude_end = range.exclude_end?
+    else
+      exclude_end = self.exclude_end? || range.exclude_end?
+    end
+    Range.new([range.begin, self.begin].max, [range.end, self.end].min, exclude_end)
+  end
+  alias intersection &
+
+  # Returns true if this range is a subset of the given range
+  def subset?(range)
+    range = range.to_range if range.respond_to?(:to_range)
+    return false if self.begin < range.begin || self.end > range.end
+    return false if self.end == range.end && !self.exclude_end? && range.exclude_end?
+    true
+  end
+
+  # Returns true if this range is a superset of the given range
+  def superset?(range)
+    range = range.to_range if range.respond_to?(:to_range)
+    return false if self.begin > range.begin || self.end < range.end
+    return false if self.end == range.end && self.exclude_end? && !range.exclude_end?
+    true
+  end
+
+end

data/lib/range_subset.rb

@@ -0,0 +1 @@
+require 'core_ext/range'

data/spec/range_subset_spec.rb

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "A Range with subset extensions" do
+  # Intersection
+  describe "when asked to intersect 1..5 with 2..6" do
+    before(:each) do
+      @r = (1..5) & (2..6)
+      @r2 = (2..6) & (1..5)
+    end
+    it "should return 2..5" do
+      @r.should == (2..5)
+      @r2.should == (2..5)
+    end
+  end
+  
+  describe "when asked to intersect 1...5 with 2..6" do
+    before(:each) do
+      @r = (1...5) & (2..6)
+      @r2 = (2..6) & (1...5)
+    end
+    it "should return 2...5" do
+      @r.should == (2...5)
+      @r2.should == (2...5)
+    end
+  end
+  
+  describe "when asked to intersect 1..5 with 2...6" do
+    before(:each) do
+      @r = (1..5) & (2...6)
+      @r2 = (2...6) & (1..5)
+    end
+    it "should return 2..5" do
+      @r.should == (2..5)
+      @r2.should == (2..5)
+    end
+  end
+  
+  describe "when asked to intersect 1..5 with 2..3" do
+    before(:each) do
+      @r = (1..5) & (2..3)
+      @r2 = (2..3) & (1..5)
+    end
+    it "should return 2..3" do
+      @r.should == (2..3)
+      @r2.should == (2..3)
+    end
+  end
+
+  describe "when asked to intersect 1..5 with 2...3" do
+    before(:each) do
+      @r = (1..5) & (2...3)
+      @r2 = (2...3) & (1..5)
+    end
+    it "should return 2...3" do
+      @r.should == (2...3)
+      @r2.should == (2...3)
+    end
+  end
+
+  describe "when asked to intersect 1...5 with 2..3" do
+    before(:each) do
+      @r = (1...5) & (2..3)
+      @r2 = (2..3) & (1...5)
+    end
+    it "should return 2..3" do
+      @r.should == (2..3)
+      @r2.should == (2..3)
+    end
+  end
+
+  describe "when asked to intersect 1..5 with 7..10" do
+    before(:each) do
+      @r = (1..5) & (7..10)
+      @r2 = (7..10) & (1..5)
+    end
+    it "should return nil" do
+      @r.should == nil
+      @r2.should == nil
+    end
+  end
+
+  describe "when asked to intersect 1..5 with 5..7" do
+    before(:each) do
+      @r1 = (1..5)
+      @r2 = (5..7)
+      @r12 = @r1 & @r2
+      @r21 = @r2 & @r1
+    end
+    it "should return 5..5" do
+      @r12.should == (5..5)
+      @r21.should == (5..5)
+    end
+  end
+  
+  describe "when asked to intersect 1...5 with 5..7" do
+    before(:each) do
+      @r1 = (1...5)
+      @r2 = (5..7)
+      @r12 = @r1 & @r2
+      @r21 = @r2 & @r1
+    end
+    it "should return nil" do
+      @r12.should == nil
+      @r21.should == nil
+    end
+  end
+  
+  # Comparisons
+  describe "when asked to compare ranges," do
+    it "1..5 should be a superset of 2..3" do
+      (1..5).should be_superset(2..3)
+    end
+    it "1..5 should be a superset of 2..5" do
+      (1..5).should be_superset(2..5)
+    end
+    it "1..5 should be a superset of 2...5" do
+      (1..5).should be_superset(2...5)
+    end
+    it "1...5 should not be a superset of 2..5" do
+      (1...5).should_not be_superset(2..5)
+    end
+    it "2..3 should be a subset of 1..5" do
+      (2..3).should be_subset(1..5)
+    end
+    it "2..5 should be a subset of 1..5" do
+      (2..5).should be_subset(1..5)
+    end
+    it "2...5 should be a subset of 1..5" do
+      (2...5).should be_subset(1..5)
+    end
+    it "2..5 should not be a subset of 1...5" do
+      (2..5).should_not be_subset(1...5)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'range_subset'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: edwagner-range-subset
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ed Wagner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A simple extension to Ruby's core Range class to determine overlaps between two Ranges.
+email: ed@edwagner.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/core_ext
+- lib/core_ext/range.rb
+- lib/range_subset.rb
+- spec/range_subset_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/edwagner/range-subset
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple extension to Ruby's core Range class to determine overlaps between two Ranges.
+test_files: []
+