aurora-geometry 0.0.2

data/test/geometry/point.rb

@@ -0,0 +1,258 @@
+require 'minitest/autorun'
+require 'geometry/point'
+
+describe Geometry::Point do
+    PointZero = Geometry::PointZero
+
+    describe "class methods" do
+	it "must generate a PointZero" do
+	    Point.zero.must_be_instance_of(PointZero)
+	end
+
+	it "must generate a Point full of zeros" do
+	    Point.zero(3).must_equal Point[0,0,0]
+	end
+    end
+
+    describe "constructor" do
+	it "must return the Point when constructed from a Point" do
+	    original_point = Point[3,4]
+	    point = Geometry::Point[original_point]
+	    point.must_be_same_as original_point
+	    point.size.must_equal 2
+	    point.x.must_equal 3
+	    point.y.must_equal 4
+	end
+
+	it "must return the PointZero when constructed from a PointZero" do
+	    original_point = Geometry::PointZero.new
+	    point = Geometry::Point[original_point]
+	    point.must_be_same_as original_point
+	end
+    end
+
+    it "create a Point object from an array" do
+	point = Geometry::Point[[3,4]]
+	assert_equal(2, point.size)
+	assert_equal(3, point.x)
+	assert_equal(4, point.y)
+    end
+    it "create a Point object from individual parameters" do
+	point = Geometry::Point[3,4]
+	assert_equal(2, point.size)
+	assert_equal(3, point.x)
+	assert_equal(4, point.y)
+    end
+    it "create a Point object from a Vector" do
+	point = Geometry::Point[Vector[3,4]]
+	assert_equal(2, point.size)
+	assert_equal(3, point.x)
+	assert_equal(4, point.y)
+    end
+
+    it "create a Point object from a Point using list syntax" do
+	point = Geometry::Point[Geometry::Point[13,14]]
+	assert_equal(2, point.size)
+	assert_equal(13, point.x)
+	assert_equal(14, point.y)
+    end
+    it "allow indexed element access" do
+	point = Geometry::Point[5,6]
+	assert_equal(2, point.size)
+	assert_equal(5, point[0])
+	assert_equal(6, point[1])
+    end
+    it "allow named element access" do
+	point = Geometry::Point[5,6,7]
+	assert_equal(3, point.size)
+	assert_equal(5, point.x)
+	assert_equal(6, point.y)
+	assert_equal(7, point.z)
+    end
+
+    it "implement inspect" do
+	point = Geometry::Point[8,9]
+	assert_equal('Point[8, 9]', point.inspect)
+    end
+    it "implement to_s" do
+	point = Geometry::Point[10,11]
+	assert_equal('Point[10, 11]', point.to_s)
+    end
+
+    it "must support array access" do
+	Point[1,2][0].must_equal 1
+	Point[1,2][1].must_equal 2
+	Point[1,2][2].must_equal nil
+    end
+
+    it "must clone" do
+	Point[1,2].clone.must_be_instance_of(Point)
+	Point[1,2].clone.must_equal Point[1,2]
+    end
+
+    it "must duplicate" do
+	Point[1,2].dup.must_be_instance_of(Point)
+	Point[1,2].dup.must_equal Point[1,2]
+    end
+
+    describe "arithmetic" do
+	let(:left) { Point[1,2] }
+	let(:right) { Point[3,4] }
+
+	it "must have +@" do
+	    (+left).must_equal Point[1,2]
+	    (+left).must_be_instance_of(Point)
+	end
+
+	it "must have unary negation" do
+	    (-left).must_equal Point[-1,-2]
+	    (-left).must_be_instance_of(Point)
+	end
+
+	describe "when adding" do
+	    it "return a Point when adding two Points" do
+		assert_kind_of(Point, left+right)
+	    end
+
+	    it "must return a Point when adding an array to a Point" do
+		(left + [5,6]).must_equal Point[6,8]
+	    end
+
+	    it "must add a Numeric to all elements" do
+		(left + 2).must_equal Point[3,4]
+		(2 + left).must_equal Point[3,4]
+	    end
+
+	    it "must raise an exception when adding mismatched sizes" do
+		lambda { left + [1,2,3,4] }.must_raise Geometry::DimensionMismatch
+	    end
+
+	    it "must return a Point when adding a Vector" do
+		(left + Vector[5,6]).must_equal Point[6,8]
+		(Vector[5,6] + right).must_equal Vector[8,10]
+	    end
+
+	    it "must return self when adding a PointZero" do
+		(left + Point.zero).must_equal left
+	    end
+
+	    it "must return self when adding a NilClass" do
+		(left + nil).must_equal left
+	    end
+	end
+
+	describe "when subtracting" do
+	    it "return a Point when subtracting two Points" do
+		assert_kind_of(Point, left-right)
+	    end
+
+	    it "must return a Point when subtracting an array from a Point" do
+		(left - [5,6]).must_equal Point[-4, -4]
+	    end
+
+	    it "must subtract a Numeric from all elements" do
+		(left - 2).must_equal Point[-1, 0]
+		(2 - left).must_equal Point[1,0]
+	    end
+
+	    it "must raise an exception when subtracting mismatched sizes" do
+		lambda { left - [1,2,3,4] }.must_raise Geometry::DimensionMismatch
+	    end
+
+	    it "must return self when subtracting a PointZero" do
+		(left - Point.zero).must_equal left
+	    end
+
+	    it "must return self when subtracting a NilClass" do
+		(left - nil).must_equal left
+	    end
+	end
+
+	describe "when multiplying" do
+	    it "must return a Point when multiplied by a Matrix" do
+		(Matrix[[1,2],[3,4]]*Point[5,6]).must_equal Point[17, 39]
+	    end
+	end
+    end
+
+    describe "coercion" do
+	subject { Point[1,2] }
+
+	it "must coerce Arrays into Points" do
+	    subject.coerce([3,4]).must_equal [Point[3,4], subject]
+	end
+
+	it "must coerce Vectors into Points" do
+	    subject.coerce(Vector[3,4]).must_equal [Point[3,4], subject]
+	end
+
+	it "must coerce a Numeric into a Point" do
+	    subject.coerce(42).must_equal [Point[42,42], subject]
+	end
+
+	it "must reject anything that can't be coerced" do
+	    -> { subject.coerce(NilClass) }.must_raise TypeError
+	end
+    end
+
+    describe "comparison" do
+	let(:point) { Point[1,2] }
+
+	it "must compare equal to an equal Array" do
+	    point.must_be :==, [1,2]
+	    point.must_be :eql?, [1,2]
+	    [1,2].must_equal point
+	end
+
+	it "must not compare equal to an unequal Array" do
+	    point.wont_equal [3,2]
+	    [3,2].wont_equal point
+	end
+
+	it "must compare equal to an equal Point" do
+	    point.must_be :==, Point[1,2]
+	    point.must_be :eql?, Point[1,2]
+	    Point[1,2].must_equal point
+	end
+
+	it "must not compare equal to an unequal Point" do
+	    point.wont_equal Point[3,2]
+	    Point[3,2].wont_equal point
+	end
+
+	it "must compare equal to an equal Vector" do
+	    point.must_equal Vector[1,2]
+	    Vector[1,2].must_equal point
+	end
+
+	it "must not compare equal to an unequal Vector" do
+	    point.wont_equal Vector[3,2]
+	    Vector[3,2].wont_equal point
+	end
+
+	it "must think that floats == ints" do
+	    Point[1,2].must_be :==, Point[1.0,2.0]
+	    Point[1.0,2.0].must_be :==, Point[1,2]
+	end
+
+	it "must not think that floats eql? ints" do
+	    Point[1,2].wont_be :eql?, Point[1.0,2.0]
+	    Point[1.0,2.0].wont_be :eql?, Point[1,2]
+	end
+
+	describe "spaceship" do
+	    it "must spaceship with another Point of the same length" do
+		(Point[1,2] <=> Point[0,3]).must_equal Point[1,-1]
+	    end
+
+	    it "must spaceship with another Point of different length" do
+		(Point[1,2] <=> Point[0,3,4]).must_equal Point[1,-1]
+		(Point[1,2,4] <=> Point[0,3]).must_equal Point[1,-1]
+	    end
+
+	    it "must spaceship with an Array" do
+		(Point[1,2] <=> [0,3]).must_equal Point[1,-1]
+	    end
+	end
+    end
+end

data/test/geometry/point_zero.rb

@@ -0,0 +1,177 @@
+require 'minitest/autorun'
+require 'geometry/point_zero'
+
+describe Geometry::PointZero do
+    let(:zero) { Geometry::PointZero.new }
+
+    describe "arithmetic" do
+	let(:left) { Point[1,2] }
+	let(:right) { Point[3,4] }
+	
+	it "must have +@" do
+	    (+zero).must_be :eql?, 0
+	    (+zero).must_be_instance_of(Geometry::PointZero)
+	end
+	
+	it "must have unary negation" do
+	    (-zero).must_be :eql?, 0
+	    (-zero).must_be_instance_of(Geometry::PointZero)
+	end
+
+	describe "Accessors" do
+	    it "must return 0 for array access" do
+		zero[3].must_equal 0
+	    end
+
+	    it "must return 0 for named element access" do
+		zero.x.must_equal 0
+		zero.y.must_equal 0
+		zero.z.must_equal 0
+	    end
+	end
+
+	describe "when adding" do
+	    it "must return a number" do
+		(zero + 3).must_equal 3
+		(3 + zero).must_equal 3
+	    end
+
+	    it "return a Point when adding two Points" do
+		(zero + right).must_be_kind_of Point
+		(left + zero).must_be_kind_of Point
+	    end
+	    
+	    it "must return an Array when adding an array" do
+		(zero + [5,6]).must_equal [5,6]
+#		([5,6] + zero).must_equal [5,6]
+	    end
+
+	    it "must return a Point when adding a Size" do
+		(zero + Size[5,6]).must_be_instance_of(Point)
+		(zero + Size[5,6]).must_equal Point[5,6]
+	    end
+	end
+	
+	describe "when subtracting" do
+	    it "must return a number" do
+		(zero - 3).must_equal -3
+		(3 - zero).must_equal 3
+	    end
+
+	    it "return a Point when subtracting two Points" do
+		(zero - right).must_equal Point[-3,-4]
+		(left - zero).must_equal Point[1,2]
+	    end
+	    
+	    it "must return a Point when subtracting an array" do
+		(zero - [5,6]).must_equal [-5, -6]
+#		([5,6] - zero).must_equal [5,6]
+	    end
+
+	    it "must return a Point when subtracting a Size" do
+		(zero - Size[5,6]).must_be_instance_of(Point)
+		(zero - Size[5,6]).must_equal Point[-5,-6]
+	    end
+	end
+	
+	describe "multiplication" do
+	    it "must return 0 for scalars" do
+		(zero * 3).must_equal 0
+		(zero * 3.0).must_equal 0.0
+	    end
+
+	    it "must return 0 for Points" do
+		(zero * Point[1,2]).must_equal 0
+	    end
+
+	    it "must return 0 for Vectors" do
+		(zero * Vector[2,3]).must_equal 0
+	    end
+	end
+
+	describe "division" do
+	    it "must return 0 for non-zero scalars" do
+		(zero / 3).must_equal 0
+		(zero / 4.0).must_equal 0
+	    end
+
+	    it "must raise an exception when divided by 0" do
+		lambda { zero / 0 }.must_raise ZeroDivisionError
+	    end
+
+	    it "must raise an exception for Points" do
+		lambda { zero / Point[1,2] }.must_raise Geometry::OperationNotDefined
+	    end
+
+	    it "must raise an exception for Vectors" do
+		lambda { zero / Vector[1,2] }.must_raise Geometry::OperationNotDefined
+	    end
+
+	end
+
+    end
+
+    describe "coercion" do
+	it "must coerce Arrays into Points" do
+	    zero.coerce([3,4]).must_equal [Point[3,4], Point[0,0]]
+	end
+	
+	it "must coerce Vectors into Vectors" do
+	    zero.coerce(Vector[3,4]).must_equal [Vector[3,4], Vector[0,0]]
+	end
+
+	it "must coerce Points into Points" do
+	    zero.coerce(Point[5,6]).must_equal [Point[5,6], Point[0,0]]
+	end
+    end
+
+    describe "comparison" do
+	subject { Geometry::PointZero.new }
+	
+	it "must be equal to 0 and 0.0" do
+	    zero.must_be :eql?, 0
+	    zero.must_be :eql?, 0.0
+	end
+
+	it "must not be equal to a non-zero number" do
+	    1.wont_equal zero
+	    3.14.wont_equal zero
+	end
+
+	it "must be equal to an Array of zeros" do
+	    zero.must_be :==, [0,0]
+	    zero.must_be :eql?, [0,0]
+	    zero.must_be :===, [0,0]
+	    [0,0].must_equal zero
+	    subject.must_equal [0,0]
+	end
+	
+	it "must not be equal to a non-zero Array" do
+	    zero.wont_equal [3,2]
+	    [3,2].wont_equal zero
+	end
+	
+	it "must be equal to a Point at the origin" do
+	    zero.must_be :==, Point[0,0]
+	    zero.must_be :eql?, Point[0,0]
+	    zero.must_be :===, Point[0,0]
+	    Point[0,0].must_equal zero
+	    subject.must_equal Point[0,0]
+	end
+	
+	it "must not be equal to a Point not at the origin" do
+	    zero.wont_equal Point[3,2]
+	    Point[3,2].wont_equal zero
+	end
+	
+	it "must be equal to an Vector of zeroes" do
+	    zero.must_be :eql?, Vector[0,0]
+	    Vector[0,0].must_equal zero
+	end
+	
+	it "must not be equal to a non-zero Vector" do
+	    zero.wont_equal Vector[3,2]
+	    Vector[3,2].wont_equal zero
+	end
+    end
+end

data/test/geometry/polygon.rb

@@ -0,0 +1,214 @@
+require 'minitest/autorun'
+require 'geometry/polygon'
+
+describe Geometry::Polygon do
+    Polygon = Geometry::Polygon
+
+    let(:cw_unit_square) { Polygon.new [0,0], [0,1], [1,1], [1,0] }
+    let(:unit_square) { Polygon.new [0,0], [1,0], [1,1], [0,1] }
+    let(:simple_concave) { Polygon.new [0,0], [4,0], [4,2], [3,2], [3,1], [1,1], [1,2], [0,2] }
+    subject { unit_square }
+
+    it "must create a Polygon object with no arguments" do
+	polygon = Geometry::Polygon.new
+	assert_kind_of(Geometry::Polygon, polygon)
+	assert_equal(0, polygon.edges.size)
+	assert_equal(0, polygon.vertices.size)
+    end
+
+    it "must create a Polygon object from array arguments" do
+	polygon = Geometry::Polygon.new([0,0], [1,0], [1,1], [0,1])
+	assert_kind_of(Geometry::Polygon, polygon)
+	assert_equal(4, polygon.edges.size)
+	assert_equal(4, polygon.vertices.size)
+    end
+
+    describe "when creating a Polygon from an array of Points" do
+	it "must ignore repeated Points" do
+	    polygon = Geometry::Polygon.new([0,0], [1,0], [1,1], [1,1], [0,1])
+	    polygon.must_be_kind_of Geometry::Polygon
+	    polygon.edges.size.must_equal 4
+	    polygon.vertices.size.must_equal 4
+	    polygon.must_equal Geometry::Polygon.new([0,0], [1,0], [1,1], [0,1])
+	end
+
+	it "must collapse collinear Edges" do
+	    polygon = Geometry::Polygon.new([0,0], [1,0], [1,1], [0.5,1], [0,1])
+	    polygon.must_equal Geometry::Polygon.new([0,0], [1,0], [1,1], [0,1])
+	end
+
+	it "must collapse backtracking Edges" do
+	    polygon = Geometry::Polygon.new [0,0], [2,0], [2,2], [1,2], [1,1], [1,2], [0,2]
+	    polygon.must_equal Geometry::Polygon.new([0,0], [2,0], [2,2], [0,2])
+	end
+    end
+
+    it "must compare identical polygons as equal" do
+	(unit_square.eql? unit_square).must_equal true
+    end
+
+    it "must create closed polygons" do
+	subject.closed?.must_equal true
+    end
+
+    it "must handle already closed polygons" do
+	polygon = Geometry::Polygon.new([0,0], [1,0], [1,1], [0,1], [0,0])
+	assert_kind_of(Geometry::Polygon, polygon)
+	assert_equal(4, polygon.edges.size)
+	assert_equal(4, polygon.vertices.size)
+	assert_equal(polygon.edges.first.first, polygon.edges.last.last)
+    end
+
+    it "must return itself on close" do
+	closed = subject.close
+	closed.closed?.must_equal true
+	closed.must_equal subject
+	closed.must_be_same_as subject
+    end
+
+    describe "orientation" do
+	it "must return true for clockwise" do
+	    Polygon.new([0,0], [0,1], [1,1], [1,0]).clockwise?.must_equal true
+	    Polygon.new([1,1], [1,3], [3,3], [3,1]).clockwise?.must_equal true
+	end
+
+	it "must return false for counterclockwise" do
+	    Polygon.new([0,0], [1,0], [1,1], [0,1]).clockwise?.must_equal false
+	    Polygon.new([1,1], [3,1], [3,3], [1,3]).clockwise?.must_equal false
+	end
+    end
+
+    it "must gift wrap a square polygon" do
+	polygon = Polygon.new [0,0], [1,0], [1,1], [0,1]
+	convex_hull = polygon.wrap
+	convex_hull.must_be_kind_of Geometry::Polygon
+	convex_hull.edges.size.must_equal 4
+	convex_hull.vertices.must_equal [[0,0], [0,1], [1,1], [1,0]].map {|a| Point[*a]}
+    end
+
+    it "must gift wrap another square polygon" do
+	polygon = Polygon.new [0,1], [0,0], [1,0], [1,1]
+	convex_hull = polygon.wrap
+	convex_hull.must_be_kind_of Geometry::Polygon
+	convex_hull.edges.size.must_equal 4
+	convex_hull.vertices.must_equal [[0,0], [0,1], [1,1], [1,0]].map {|a| Point[*a]}
+    end
+
+    it "must gift wrap a concave polygon" do
+	polygon = Polygon.new [0,0], [1,-1], [2,0], [1,1], [2,2], [0,1]
+	convex_hull = polygon.wrap
+	convex_hull.must_be_kind_of Geometry::Polygon
+	convex_hull.edges.size.must_equal 5
+	convex_hull.vertices.must_equal [Point[0, 0], Point[0, 1], Point[2, 2], Point[2, 0], Point[1, -1]]
+    end
+
+    it "must gift wrap a polygon" do
+	polygon = Polygon.new [0,0], [1,-1], [2,0], [2,1], [0,1]
+	convex_hull = polygon.wrap
+	convex_hull.must_be_kind_of Geometry::Polygon
+	convex_hull.edges.size.must_equal 5
+	convex_hull.vertices.must_equal [[0,0], [0,1], [2,1], [2,0], [1,-1]].map {|a| Point[*a]}
+    end
+
+    it "must generate spokes" do
+	unit_square.spokes.must_equal [Vector[-1,-1], Vector[1,-1], Vector[1,1], Vector[-1,1]]
+	cw_unit_square.spokes.must_equal [Vector[-1,-1], Vector[-1,1], Vector[1,1], Vector[1,-1]]
+	simple_concave.spokes.must_equal [Vector[-1,-1], Vector[1,-1], Vector[1,1], Vector[-1,1], Vector[-1,1], Vector[1,1], Vector[1,1], Vector[-1,1]]
+    end
+
+    describe "spaceship" do
+	it "with a Point" do
+	    (unit_square <=> Point[2,0]).must_equal -1
+	    (unit_square <=> Point[1,0]).must_equal 0
+	    (unit_square <=> Point[0.5,0.5]).must_equal 1
+	end
+
+	it "with a Point that lies on a horizontal edge" do
+	    (unit_square <=> Point[0.5,0]).must_equal 0
+	end
+    end
+
+    describe "when outsetting" do
+	it "must outset a unit square" do
+	    outset_polygon = unit_square.outset(1)
+	    expected_polygon = Polygon.new [-1.0,-1.0], [2.0,-1.0], [2.0,2.0], [-1.0,2.0]
+	    outset_polygon.must_equal expected_polygon
+	end
+
+	it "must outset a simple concave polygon" do
+	    concave_polygon = Polygon.new [0,0], [4,0], [4,2], [3,2], [3,1], [1,1], [1,2], [0,2]
+	    outset_polygon = concave_polygon.outset(1)
+	    outset_polygon.must_equal Polygon.new [-1,-1], [5,-1], [5,3], [-1,3]
+	end
+
+	it "must outset a concave polygon" do
+	    concave_polygon = Polygon.new [0,0], [4,0], [4,2], [3,2], [3,1], [1,1], [1,2], [0,2]
+	    outset_polygon = concave_polygon.outset(2)
+	    outset_polygon.must_equal Polygon.new [-2,-2], [6,-2], [6,4], [-2,4]
+	end
+
+	it "must outset an asymetric concave polygon" do
+	    concave_polygon = Polygon.new [0,0], [4,0], [4,3], [3,3], [3,1], [1,1], [1,2], [0,2]
+	    outset_polygon = concave_polygon.outset(2)
+	    outset_polygon.must_equal Polygon.new [-2,-2], [6,-2], [6,5], [1,5], [1,4], [-2,4]
+	end
+
+	it "must outset a concave polygon with multiply-intersecting edges" do
+	    concave_polygon = Polygon.new [0,0], [5,0], [5,2], [4,2], [4,1], [3,1], [3,2], [2,2], [2,1], [1,1], [1,2], [0,2]
+	    outset_polygon = concave_polygon.outset(1)
+	    outset_polygon.must_equal Polygon.new [-1,-1], [6,-1], [6,3], [-1,3]
+	end
+
+	it "must outset a concave polygon where the first outset edge intersects with the last outset edge" do
+	    polygon = Polygon.new [0,0], [0,1], [2,1], [2,2], [-1,2], [-1,-1], [2,-1], [2,0]
+	    polygon.edges.count.must_equal 8
+	    polygon.outset(1).must_equal Polygon.new [3, 0], [3, 3], [-2, 3], [-2, -2], [3, -2]
+	end
+
+	# Naturally, this test is very sensitive to the input coordinate values. This is a painfully contrived example that
+	#  checks for sensitivity to edges that are very close to horizontal, but not quite.
+	# When the test fails, the first point of the offset polygon is at [0,-1]
+	it "must not be sensitive to floating point rounding errors" do
+	    polygon = Polygon.new [0, 0], [0, -2], [10, -2], [10, 10], [-100, 10], [-100, -22], [-69, -22], [-69, 3.552713678800501e-15], [0,0]
+	    outset = polygon.outset(1)
+	    outset.edges.first.first.must_equal Geometry::Point[-1,-1]
+	end
+    end
+
+    describe "set operations" do
+	describe "union" do
+	    it "must union two adjacent squares" do
+		polygonA = Polygon.new [0,0], [1,0], [1,1], [0,1]
+		polygonB = Polygon.new [1,0], [2,0], [2,1], [1,1]
+		(polygonA.union polygonB).must_equal Polygon.new [0,0], [2,0], [2,1], [0,1]
+		(polygonA + polygonB).must_equal Polygon.new [0,0], [2,0], [2,1], [0,1]
+	    end
+
+	    it "must union two overlapping squares" do
+		polygonA = Polygon.new [0,0], [2,0], [2,2], [0,2]
+		polygonB = Polygon.new [1,1], [3,1], [3,3], [1,3]
+		expected_polygon = Polygon.new [0,0], [2,0], [2,1], [3,1], [3,3], [1,3], [1,2], [0,2]
+		union = polygonA.union polygonB
+		union.must_be_kind_of Polygon
+		union.must_equal expected_polygon
+	    end
+
+	    it "must union two overlapping clockwise squares" do
+		polygonA = Polygon.new [0,0], [0,2], [2,2], [2,0]
+		polygonB = Polygon.new [1,1], [1,3], [3,3], [3,1]
+		expected_polygon = Polygon.new [0, 0], [0, 2], [1, 2], [1, 3], [3, 3], [3, 1], [2, 1], [2, 0]
+		union = polygonA.union polygonB
+		union.must_be_kind_of Polygon
+		union.must_equal expected_polygon
+	    end
+
+	    it "must union two overlapping squares with collinear edges" do
+		polygonA = Polygon.new [0,0], [2,0], [2,2], [0,2]
+		polygonB = Polygon.new [1,0], [3,0], [3,2], [1,2]
+		union = polygonA + polygonB
+		union.must_be_kind_of Polygon
+		union.must_equal Polygon.new [0,0], [3,0], [3,2], [0,2]
+	    end
+	end
+    end
+end