geometry 5 → 6

data/lib/geometry/regular_polygon.rb

@@ -0,0 +1,104 @@
+require_relative 'cluster_factory'
+require_relative 'polygon'
+
+module Geometry
+=begin rdoc
+A {RegularPolygon} is a lot like a {Polygon}, but more regular.
+
+{http://en.wikipedia.org/wiki/Regular_polygon}
+
+== Usage
+    polygon = Geometry::RegularPolygon.new sides:4, center:[1,2], radius:3
+    polygon = Geometry::RegularPolygon.new sides:6, center:[1,2], diameter:6
+=end
+
+    class RegularPolygon < Polygon
+	include ClusterFactory
+
+	# @return [Point]   The {RegularPolygon}'s center point
+	attr_reader :center
+
+	# @return [Number]  The {RegularPolygon}'s number of sides
+	attr_reader :edge_count
+
+	# @return [Number]  The {RegularPolygon}'s radius
+	attr_reader :radius
+
+	# @overload new(sides, center, radius)
+	#   Construct a {RegularPolygon} using a center point and radius
+	#   @option options [Number]	:sides	The number of edges
+	#   @option options [Point]	:center	The center point of the {RegularPolygon}
+	#   @option options [Number]	:radius The radius of the {RegularPolygon}
+	# @overload new(sides, center, diameter)
+	#   Construct a {RegularPolygon} using a center point and diameter
+	#   @option options [Number]	:sides  The number of edges
+	#   @option options [Point]	:center	The center point of the {RegularPolygon}
+	#   @option options [Number]	:diameter   The diameter of the {RegularPolygon}
+	def self.new(options={}, &block)
+	    raise ArgumentError, "RegularPolygon requires an edge count" unless options[:sides]
+
+	    center = options[:center]
+	    center = center ? Point[center] : nil
+
+	    if options.has_key?(:radius)
+		self.allocate.tap {|polygon| polygon.send :initialize, options[:sides], center, options[:radius], &block }
+	    elsif options.has_key?(:diameter)
+		DiameterRegularPolygon.new options[:sides], center, options[:diameter], &block
+	    else
+		raise ArgumentError, "RegularPolygon.new requires a radius or a diameter"
+	    end
+	end
+
+	# Construct a new {RegularPolygon} from a centerpoint and radius
+	# @param    [Number]	edge_count  The number of edges
+	# @param    [Point]	center  The center point of the {Circle}
+	# @param    [Number]	radius  The radius of the {Circle}
+	# @return   [RegularPolygon]	A new {RegularPolygon} object
+	def initialize(edge_count, center, radius)
+	    @center = Point[center]
+	    @edge_count = edge_count
+	    @radius = radius
+	end
+
+	def eql?(other)
+	    (self.center == other.center) && (self.edge_count == other.edge_count) && (self.radius == other.radius)
+	end
+	alias :== :eql?
+
+# @!group Accessors
+	# @!attribute [r] diameter
+	#   @return [Numeric] The diameter of the {RegularPolygon}
+	def diameter
+	    @radius*2
+	end
+# @!endgroup
+    end
+
+    class DiameterRegularPolygon < RegularPolygon
+	# @return [Number]  The {RegularPolygon}'s diameter
+	attr_reader :diameter
+
+	# Construct a new {RegularPolygon} from a centerpoint and a diameter
+	# @param    [Number]	edge_count  The number of edges
+	# @param    [Point]	center  The center point of the {RegularPolygon}
+	# @param    [Number]	diameter  The radius of the {RegularPolygon}
+	# @return   [RegularPolygon]	A new {RegularPolygon} object
+	def initialize(edge_count, center, diameter)
+	    @center = center ? Point[center] : nil
+	    @edge_count = edge_count
+	    @diameter = diameter
+	end
+
+	def eql?(other)
+	    (self.center == other.center) && (self.edge_count == other.edge_count) && (self.diameter == other.diameter)
+	end
+	alias :== :eql?
+
+# @!group Accessors
+	# @return [Number] The {RegularPolygon}'s radius
+	def radius
+	    @diameter/2
+	end
+# @!endgroup
+    end
+end

data/lib/geometry/rotation.rb

@@ -43,6 +43,11 @@ A generalized representation of a rotation transformation.
 	    end
 	end
 
+	def eql?(other)
+	    (self.x.eql? other.x) && (self.y.eql? other.y) && (self.z.eql? other.z)
+	end
+	alias :== :eql?
+
 	def identity?
 	    (!@x && !@y && !@z) || ([@x, @y, @z].select {|a| a}.all? {|a| a.respond_to?(:magnitude) ? (1 == a.magnitude) : (1 == a.size)})
 	end

data/lib/geometry/square.rb

@@ -8,23 +8,33 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 
 == Constructors
 
-    square = Square.new [1,2], [2,3]	# Using two corners
-    square = Square.new [3,4], 5	# Using an origin point and a size
-    square = Square.new 6		# Using a size and an origin of [0,0]
+    square = Square.new from:[1,2], to:[2,3]	# Using two corners
+    square = Square.new origin:[3,4], size:5	# Using an origin point and a size
 =end
     class Square
 	attr_reader :origin
 
 	# Creates a {Square} given two {Point}s
-	# @param [Point] point0	A corner (ie. bottom-left)
-	# @param [Point] point1	The other corner (ie. top-right)
-	def initialize(point0, point1)
-	    point0, point1 = Point[point0], Point[point1]
-	    raise(ArgumentError, "Point sizes must match (#{point0.size} != #{point1.size}") unless point0.size == point1.size
+	# @option options [Point] :from	A corner (ie. bottom-left)
+	# @option options [Point] :to	The other corner (ie. top-right)
+	# @option options [Point] :origin   The lower left corner
+	# @option options [Number] :size    Bigness
+	def initialize(options={})
+	    origin = options[:from] || options[:origin]
+	    origin = origin ? Point[origin] : PointZero.new
+
+	    if options.has_key? :to
+		point1 = options[:to]
+	    elsif options.has_key? :size
+		point1 = origin + options[:size]
+	    end
+
+	    point1 = Point[point1]
+	    raise(ArgumentError, "Point sizes must match (#{origin.size} != #{point1.size})") unless origin.is_a?(PointZero) || (origin.size == point1.size)
 
 	    # Reorder the points to get lower-left and upper-right
-	    minx, maxx = [point0.x, point1.x].minmax
-	    miny, maxy = [point0.y, point1.y].minmax
+	    minx, maxx = [origin.x, point1.x].minmax
+	    miny, maxy = [origin.y, point1.y].minmax
 	    @points = [Point[minx, miny], Point[maxx, maxy]]
 
 	    raise(NotSquareError) if height != width
@@ -70,7 +80,7 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 	end
 
 	# @attribute [r] points
-	# @return [Array<Point>]    The {Square}'s four points (clockwise)
+	# @return [Array<Point>]    The {Square}'s four points (counterclockwise)
 	def points
 	    half_size = @size/2
 	    minx = @center.x - half_size
@@ -78,7 +88,7 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 	    miny = @center.y - half_size
 	    maxy = @center.y + half_size
 
-	    [Point[minx,miny], Point[minx,maxy], Point[maxx, maxy], Point[maxx, miny]]
+	    [Point[minx,miny], Point[maxx, miny], Point[maxx, maxy], Point[minx,maxy]]
 	end
 
 	def height

data/lib/geometry/transformation.rb

@@ -82,6 +82,11 @@ system's X-axis:
 	    @rotation.identity? && !(@scale || @translation)
 	end
 
+	def eql?(other)
+	    (self.rotation.eql? other.rotation) && (self.scale.eql? other.scale) && (self.translation.eql? other.translation)
+	end
+	alias :== :eql?
+
 	# Compose the current {Transformation} with another one
 	def +(other)
 	    if other.is_a?(Array) or other.is_a?(Vector)
@@ -102,5 +107,12 @@ system's X-axis:
 		end
 	    end
 	end
+
+	# Transform and return a new {Point}
+	# @param [Point] point	The {Point} to transform
+	# @return [Point]   The transformed {Point}
+	def transform(point)
+	    @translation + point
+	end
     end
 end

data/lib/geometry/vector.rb

@@ -2,6 +2,10 @@ require 'matrix'
 
 # Monkeypatch Vector to overcome some deficiencies
 class Vector
+    X = Vector[1,0,0]
+    Y = Vector[0,1,0]
+    Z = Vector[0,0,1]
+
 # @group Unary operators
     def +@
 	self

data/test/geometry.rb

@@ -2,14 +2,4 @@ require 'minitest/autorun'
 require 'geometry'
 
 describe Geometry do
-    it "create a Point object" do
-	point = Geometry.point(2,1)
-	assert_kind_of(Geometry::Point, point)
-    end
-
-    it "create a Line object" do
-	line = Geometry.line([0,0], [10,10])
-	assert_kind_of(Geometry::Line, line)
-	assert_kind_of(Geometry::TwoPointLine, line)
-    end
 end

data/test/geometry/arc.rb

@@ -2,21 +2,24 @@ require 'minitest/autorun'
 require 'geometry/arc'
 
 describe Geometry::Arc do
-    it "must create an Arc object from a Point and a radius" do
-	arc = Geometry::Arc.new [1,2], 3, 0, 90
-	arc.must_be_kind_of Geometry::Arc
-	arc.center.must_equal Point[1,2]
-	arc.radius.must_equal 3
-	arc.start_angle.must_equal 0
-	arc.end_angle.must_equal 90
-    end
+    Arc = Geometry::Arc
 
-    it "must create an Arc from center, start and end points" do
-	arc = Geometry::Arc.new [1,2], [3,4], [5,6]
-	arc.must_be_kind_of Geometry::Arc
-	arc.center.must_equal Point[1,2]
-	arc.first.must_equal Point[3,4]
-	arc.last.must_equal Point[5,6]
-    end
+    describe "when constructed" do
+	it "must accept a center point, radius, start and end angles" do
+	    arc = Geometry::Arc.new center:[1,2], radius:3, start:0, end:90
+	    arc.must_be_kind_of Geometry::Arc
+	    arc.center.must_equal Point[1,2]
+	    arc.radius.must_equal 3
+	    arc.start_angle.must_equal 0
+	    arc.end_angle.must_equal 90
+	end
 
+	it "must create an Arc from center, start and end points" do
+	    arc = Geometry::Arc.new center:[1,2], start:[3,4], end:[5,6]
+	    arc.must_be_kind_of Geometry::Arc
+	    arc.center.must_equal Point[1,2]
+	    arc.first.must_equal Point[3,4]
+	    arc.last.must_equal Point[5,6]
+	end
+    end
 end

data/test/geometry/circle.rb

@@ -18,6 +18,10 @@ describe Geometry::Circle do
 	it "must have a radius accessor" do
 	    circle.radius.must_equal 3
 	end
+
+	it "must compare equal" do
+	    circle.must_equal Circle.new([1,2], 3)
+	end
     end
 
     describe "when constructed with named center and radius arguments" do
@@ -34,10 +38,14 @@ describe Geometry::Circle do
 	it "must have a radius accessor" do
 	    circle.radius.must_equal 3
 	end
+
+	it "must compare equal" do
+	    (circle == Circle.new(:center => [1,2], :radius => 3)).must_equal true
+	end
     end
 
-    describe "when constructed with a center and diameter" do
-	let(:circle) { Circle.new [1,2], :diameter => 4 }
+    describe "when constructed with named center and diameter arguments" do
+	let(:circle) { Circle.new center:[1,2], diameter:4 }
 
 	it "must be a CenterDiameterCircle" do
 	    circle.must_be_instance_of(Geometry::CenterDiameterCircle)
@@ -55,5 +63,50 @@ describe Geometry::Circle do
 	it "must calculate the correct radius" do
 	    circle.radius.must_equal 2
 	end
+
+	it "must compare equal" do
+	    circle.must_equal Circle.new([1,2], :diameter => 4)
+	end
+    end
+
+    describe "when constructed with a diameter and no center" do
+	let(:circle) { Circle.new :diameter => 4 }
+
+	it "must be a CenterDiameterCircle" do
+	    circle.must_be_instance_of(Geometry::CenterDiameterCircle)
+	    circle.must_be_kind_of(Circle)
+	end
+
+	it "must have a nil center" do
+	    circle.center.must_be_kind_of Geometry::PointZero
+	end
+
+	it "must have a diameter" do
+	    circle.diameter.must_equal 4
+	end
+
+	it "must calculate the correct radius" do
+	    circle.radius.must_equal 2
+	end
+    end
+
+    describe "properties" do
+	subject { Circle.new center:[1,2], :diameter => 4 }
+
+	it "must have a bounds property that returns a Rectangle" do
+	    subject.bounds.must_equal Rectangle.new([-1,0], [3,4])
+	end
+
+	it "must have a minmax property that returns the corners of the bounding rectangle" do
+	    subject.minmax.must_equal [Point[-1,0], Point[3,4]]
+	end
+
+	it "must have a max property that returns the upper right corner of the bounding rectangle" do
+	    subject.max.must_equal Point[3,4]
+	end
+
+	it "must have a min property that returns the lower left corner of the bounding rectangle" do
+	    subject.min.must_equal Point[-1,0]
+	end
     end
 end

data/test/geometry/edge.rb

@@ -58,6 +58,24 @@ describe Geometry::Edge do
 	Edge.new([0,0], [2,0]).parallel?(Edge.new([1,-1], [1,1])).must_equal false
     end
 
+    describe "spaceship" do
+	it "ascending with a Point" do
+	    edge = Edge.new [0,0], [1,1]
+	    (edge <=> Point[0,0]).must_equal 0
+	    (edge <=> Point[1,0]).must_equal -1
+	    (edge <=> Point[0,1]).must_equal 1
+	    (edge <=> Point[2,2]).must_equal nil
+	end
+
+	it "descending with a Point" do
+	    edge = Edge.new [1,1], [0,0]
+	    (edge <=> Point[0,0]).must_equal 0
+	    (edge <=> Point[1,0]).must_equal 1
+	    (edge <=> Point[0,1]).must_equal -1
+	    (edge <=> Point[2,2]).must_equal nil
+	end
+    end
+
     describe "when finding an intersection" do
 	it "must find the intersection of two end-intersecting Edges" do
 	    intersection = Edge.new([0,0],[1,1]).intersection(Edge.new([0,1],[1,1]))
@@ -65,6 +83,16 @@ describe Geometry::Edge do
 	    intersection.must_equal Geometry::Point[1,1]
 	end
 
+	it "must find the intersection of two collinear end-intersecting Edges" do
+	    intersection = Edge.new([2,2], [0,2]).intersection(Edge.new([3,2], [2,2]))
+	    intersection.must_be_kind_of Geometry::Point
+	    intersection.must_equal Geometry::Point[2,2]
+
+	    intersection = Edge.new([0,2], [2,2]).intersection(Edge.new([2,2], [3,2]))
+	    intersection.must_be_kind_of Geometry::Point
+	    intersection.must_equal Geometry::Point[2,2]
+	end
+
 	it "must find the itersection of two crossed Edges" do
 	    edge1 = Edge.new [0.0, 0], [2.0, 2.0]
 	    edge2 = Edge.new [2.0, 0], [0.0, 2.0]
@@ -90,5 +118,8 @@ describe Geometry::Edge do
 	    Edge.new([0,0],[2,0]).intersection(Edge.new([1,1],[3,1])).must_equal nil
 	end
 
+	it "must return nil for two perpendicular but not interseting edges" do
+	    Edge.new([0, 0], [2, 0]).intersection(Edge.new([3, 3], [3, 1])).must_equal nil
+	end
     end
 end

data/test/geometry/line.rb

@@ -2,6 +2,31 @@ require 'minitest/autorun'
 require 'geometry/line'
 
 describe Geometry::Line do
+    Line = Geometry::Line
+    Point = Geometry::Point
+
+    describe "when initializing" do
+	it "must accept two named points" do
+	    line = Line.new(from:Point[0,0], to:Point[10,10])
+	    line.must_be_kind_of(Line)
+	    line.must_be_instance_of(Geometry::TwoPointLine)
+	    line.first.must_equal Point[0,0]
+	    line.last.must_equal Point[10,10]
+	end
+
+	it "must accept named start and end points" do
+	    line = Line.new(start:Point[0,0], end:Point[10,10])
+	    line.must_be_kind_of(Line)
+	    line.must_be_instance_of(Geometry::TwoPointLine)
+	    line.first.must_equal Point[0,0]
+	    line.last.must_equal Point[10,10]
+	end
+
+	it "must raise an exception when no arguments are given" do
+	    -> { Line.new }.must_raise ArgumentError
+	end
+    end
+
     it "create a Line object from 2 Points" do
 	line = Geometry::Line[Geometry::Point[0,0], Geometry::Point[10,10]]
 	assert_kind_of(Geometry::Line, line)

data/test/geometry/obround.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'geometry/obround'
+
+describe Geometry::Obround do
+    Obround = Geometry::Obround
+
+    describe "when constructed" do
+	it "must accept two Points" do
+	    obround = Geometry::Obround.new [1,2], [3,4]
+	    obround.must_be_kind_of Geometry::Obround
+	end
+
+	it "must accept a width and height" do
+	    obround = Geometry::Obround.new 2, 3
+	    obround.must_be_kind_of Geometry::Obround
+	    obround.height.must_equal 3
+	    obround.width.must_equal 2
+	end
+
+	it "must compare equal" do
+	    obround = Geometry::Obround.new [1,2], [3,4]
+	    obround.must_equal Obround.new([1,2], [3,4])
+	end
+    end
+end