geometry 1 → 2

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+.yardoc
 Gemfile.lock
 pkg/*
 doc

data/README.markdown

@@ -20,6 +20,7 @@ Primitives
 
 - Point
 - Line
+- Circle
 
 Examples
 --------
@@ -27,7 +28,7 @@ Examples
 ### Point
 ```ruby
     point = Geometry::Point[3,4]    # 2D Point at coordinate 3, 4
-    point = Geometry.Point(1,2)	    # Functional constructor
+    point = Geometry.point(1,2)	    # Functional constructor
 
     # Copy constructors
     point2 = Geometry::Point[point]
@@ -57,4 +58,10 @@ Examples
     # Special constructors (2D only)
     Geometry::Line.horizontal(y=0)
     Geometry::Line.vertical(x=0)
-```
+```
+
+### Circle
+```ruby
+    # A circle at Point[1,2] with a radius of 3
+    circle = Geometry::Circle [1,2], 3
+```

data/Rakefile

@@ -1 +1,19 @@
 require "bundler/gem_tasks"
+
+task :fixdates do
+    branch = `git branch --no-color -r --merged`.strip
+    `git fix-dates #{branch}..HEAD`
+end
+
+task :fixdates_f do
+    branch = `git branch --no-color -r --merged`.strip
+    `git fix-dates -f #{branch}..HEAD`
+end
+
+task :trim_whitespace do
+  system(%Q[git status --short | awk '{if ($1 != "D" && $1 != "R") print $2}' | grep -e '.*\.rb$' | xargs sed -i '' -e 's/[ \t]*$//g;'])
+end
+
+task :uninstall do
+    `gem uninstall geometry`
+end

data/geometry.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "geometry"
-  s.version     = '1'
+  s.version     = '2'
   s.authors     = ["Brandon Fosdick"]
   s.email       = ["bfoz@bfoz.net"]
   s.homepage    = "http://github.com/bfoz/geometry"

data/lib/geometry.rb

@@ -1,22 +1,40 @@
+require_relative 'geometry/circle'
 require_relative 'geometry/point'
 require_relative 'geometry/line'
+require_relative 'geometry/polygon'
 
 module Geometry
-    # :call-seq:
-    #   Line[Array, Array]	    -> TwoPointLine
-    #   Line[Point, Point]	    -> TwoPointLine
-    #   Line[Vector, Vector]	    -> TwoPointLine
-    #   Line[y-intercept, slope]    -> SlopeInterceptLine
-    #   Line[point, slope]	    -> PointSlopeLine
-    def self.Line(*args)
-	Geometry::Line[*args]
+    # @overload Line(array0, array1)
+    #   @param [Array] array0 First endpoint
+    #   @param [Array] array1 Second endpoint
+    #   @return [TwoPointLine]
+    # @overload Line(point0, point1)
+    #   @param [Point] point0 First endpoint
+    #   @param [Point] point1 Second endpoint
+    #   @return [TwoPointLine]
+    # @overload Line(vector0, vector1)
+    #   @param [Vector] vector0 First endpoint
+    #   @param [Vector] vector1 Second endpoint
+    #   @return [TwoPointLine]
+    # @overload Line(y_intercept, slope)
+    #   @param [Numeric] y_intercept Y-intercept
+    #   @param [Numeric] slope Slope
+    #   @return [SlopeInterceptLine]
+    # @overload Line(point, slope)
+    #   @param [Point] point Starting point
+    #   @param [Numeric] slope Slope
+    #   @return [PointSlopeLine]
+    def self.line(*args)
+	Line[*args]
     end
 
-    # :call-seq:
-    #   Point[x,y,z,...]
-    #   Point[Point]
-    #   Point[Vector]
-    def self.Point(*args)
-	Geometry::Point[*args]
+    # @overload Point(x,y,z,...)
+    #   @return [Point]
+    # @overload Point(Point)
+    #   @return [Point]
+    # @overload Point(Vector)
+    #   @return [Point]
+    def self.point(*args)
+	Point[*args]
     end
 end

data/lib/geometry/circle.rb

@@ -0,0 +1,24 @@
+require_relative 'point'
+
+module Geometry
+
+=begin rdoc
+Circles come in all shapes and sizes, but they're usually round.
+ 
+== Usage
+    circle = Geometry::Circle [1,1], 2
+=end
+    
+    class Circle
+	attr_reader :center, :radius
+	
+	# Construct a new {Circle} from a centerpoint and radius
+	# @param    [Point]	center  The center point of the Circle
+	# @param    [Number]	radius  The radius of the Circle
+	# @return   [Circle]	A new Circle object
+	def initialize(center, radius)
+	    @center = center.is_a?(Point) ? center : Point[center]
+	    @radius = radius
+	end
+    end
+end

data/lib/geometry/edge.rb

@@ -0,0 +1,57 @@
+require_relative 'point'
+
+module Geometry
+
+=begin rdoc
+An edge. It's a line segment between 2 points. Generally part of a {Polygon}.
+
+== Usage
+    edge = Geometry::Edge([1,1], [2,2])
+
+=end
+
+    class Edge
+	attr_reader :first, :last
+
+	# Construct a new {Edge} object from any two things that can be converted
+	# to a {Point}.
+	def initialize(point0, point1)
+	    @first, @last = [point0, point1].map {|p| p.is_a?(Point) ? p : Point[p] }
+	end
+
+	# Two Edges are equal if both have equal {Point}s in the same order
+	def ==(other)
+	    (@first == other.first) && (@last == other.last)
+	end
+
+	# Return a new {Edge} with swapped endpoints
+	def reverse
+	    Edge.new(@last, @first)
+	end
+
+	# In-place swap the endpoints
+	def reverse!
+	    @first, @last = @last, @first
+	    self
+	end
+
+	# Return the {Edge}'s length along the Y axis
+	def height
+	    (@first.y - @last.y).abs
+	end
+
+	# Return the {Edge}'s length along the X axis
+	def width
+	    (@first.x - @last.x).abs
+	end
+
+	def inspect
+	    'Edge(' + @first.inspect + ', ' + @last.inspect + ')'
+	end
+	alias :to_s :inspect
+
+	def to_a
+	    [@first, @last]
+	end
+    end
+end

data/lib/geometry/line.rb

@@ -26,14 +26,19 @@ Supports two-point, slope-intercept, and point-slope initializer forms
     Geometry::Line.horizontal(y=0)
     Geometry::Line.vertical(x=0)
 =end
+
     class Line
 
-	# :call-seq:
-	#   Line[Array, Array]		-> TwoPointLine
-	#   Line[Point, Point]		-> TwoPointLine
-	#   Line[Vector, Vector]	-> TwoPointLine
-	#   Line[y-intercept, slope]    -> SlopeInterceptLine
-	#   Line[point, slope]		-> PointSlopeLine
+	# @overload [](Array, Array)
+	#   @return [TwoPointLine]
+	# @overload [](Point, Point)
+	#   @return [TwoPointLine]
+	# @overload [](Vector, Vector)
+	#   @return [TwoPointLine]
+	# @overload [](y-intercept, slope)
+	#   @return [SlopeInterceptLine]
+	# @overload [](point, slope)
+	#   @return [PointSlopeLine]
 	def self.[](*args)
 	    if( 2 == args.size )
 		args.map! {|x| x.is_a?(Array) ? Point[*x] : x}
@@ -59,7 +64,8 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	end
     end
 
-    class PointSlopeLine < Line		# :nodoc:
+    # @private
+    class PointSlopeLine < Line
 	def initialize(point, slope)
 	    @point = point.is_a?(Geometry::Point) ? point : Geometry.Point(point)
 	    @slope = slope
@@ -69,7 +75,8 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	end
     end
 
-    class SlopeInterceptLine < Line	# :nodoc:
+    # @private
+    class SlopeInterceptLine < Line
 	def initialize(slope, intercept)
 	    @slope = slope
 	    @intercept = intercept
@@ -99,14 +106,15 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	end
     end
 
-    class TwoPointLine < Line		# :nodoc:
+    # @private
+    class TwoPointLine < Line
 	attr_reader :first, :last
 
 	def initialize(point0, point1)
 	    @first, @last = [point0, point1].map {|p| p.is_a?(Point) ? p : Point[p] }
 	end
 	def inspect
-	    'Line(' + @first.to_s + ', ' + @last.to_s + ')'
+	    'Line(' + @first.inspect + ', ' + @last.inspect + ')'
 	end
 	alias :to_s :inspect
     end

data/lib/geometry/point.rb

@@ -1,43 +1,57 @@
 require 'matrix'
 
 module Geometry
+=begin rdoc
+An object repesenting a Point in N-dimensional space
+
+Supports all of the familiar Vector methods and adds convenience
+accessors for those variables you learned to hate in your high school
+geometry class (x, y, z).
+
+== Usage
+
+=== Constructor
+    point = Geometry::Point[x,y]
+=end
     class Point < Vector
-	# An object repesenting a Point in N-dimensional space
-	#
-	# Supports all of the familiar Vector methods and adds convenience
-	# accessors for those variables you learned to hate in your high school
-	# geometry class (x, y, z).
-	#
-	# *Usage*
-	#
-	# point = Geometry::Point[x,y]
+	attr_reader :x, :y, :z
 
-	# :call-seq:
-	#   Point[x,y,z,...]
-	#   Point[Point]
-	#   Point[Vector]
-	#
 	# Allow vector-style initialization, but override to support copy-init
 	# from Vector or another Point
+	#
+	# @overload [](x,y,z,...)
+	# @overload [](Point)
+	# @overload [](Vector)
 	def self.[](*array)
 	    array = array[0] if array[0].is_a?(Array)
 	    array = array[0].to_a if array[0].is_a?(Vector)
 	    super *array
 	end
 
-	def inspect # :nodoc:
+	# Allow comparison with an Array, otherwise do the normal thing
+	def ==(other)
+	    return @elements == other if other.is_a?(Array)
+	    super other
+	end
+
+	def inspect
 	    'Point' + @elements.inspect
 	end
-	def to_s    # :nodoc:
+	def to_s
 	    'Point' + @elements.to_s
 	end
 
+	# @return [Numeric] X-component
 	def x
 	    @elements[0]
 	end
+
+	# @return [Numeric] Y-component
 	def y
 	    @elements[1]
 	end
+
+	# @return [Numeric] Z-component
 	def z
 	    @elements[2]
 	end

data/lib/geometry/polygon.rb

@@ -0,0 +1,82 @@
+require_relative 'edge'
+
+module Geometry
+
+=begin rdoc
+An object representing a closed set of vertices and edges.
+
+{http://en.wikipedia.org/wiki/Polygon}
+
+== Usage
+
+=end
+
+    class Polygon
+	attr_reader :edges, :vertices
+
+	# Construct a new Polygon from Points and/or Edges
+	#  The constructor will try to convert all of its arguments into Points and
+	#   Edges. Then successive Points will be collpased into Edges. Successive
+	#   Edges that share a common vertex will be added to the new Polygon. If
+	#   there's a gap between Edges it will be automatically filled with a new
+	#   Edge. The resulting Polygon will then be closed if it isn't already.
+	# @overload new(Array, Array, ...)
+	#   @return [Polygon]
+	# @overload new(Edge, Edge, ...)
+	#   @return [Polygon]
+	# @overload new(Point, Point, ...)
+	#   @return [Polygon]
+	# @overload new(Vector, Vector, ...)
+	#   @return [Polygon]
+	def initialize(*args)
+	    args.map! {|a| (a.is_a?(Array) || a.is_a?(Vector)) ? Point[a] : a}
+	    raise(ArgumentError,'Unknown argument type') unless args.all? {|a| a.is_a?(Point) || a.is_a?(Edge) }
+
+	    @edges = [];
+	    @vertices = [];
+
+	    first = args.shift
+	    if first.is_a?(Point)
+		@vertices.push first
+	    elsif first.is_a?(Edge)
+		@edges.push first
+		@vertices.push *(first.to_a)
+	    end
+
+	    args.reduce(@vertices.last) do |previous,n|
+		if n.is_a?(Point)
+		    push_edge Edge.new(previous, n)
+		    push_vertex n
+		    n
+		elsif n.is_a?(Edge)
+		    if previous == n.first
+			push_edge n
+			push_vertex n.last
+		    elsif previous == n.last
+			push_edge n.reverse!
+			push_vertex n.last
+		    else
+			e = Edge.new(previous, n.first)
+			push_edge e, n
+			push_vertex *(e.to_a), *(n.to_a)
+		    end
+		    n.last
+		end
+	    end
+
+	    # Close the polygon if needed
+	    @edges.push Edge.new(@edges.last.last, @edges.first.first) unless @edges.empty? || (@edges.last.last == @edges.first.first)
+	end
+
+	private
+
+	def push_edge(*e)
+	    @edges.push *e
+	    @edges.uniq!
+	end
+	def push_vertex(*v)
+	    @vertices.push *v
+	    @vertices.uniq!
+	end
+    end
+end

data/test/geometry/circle.rb

@@ -0,0 +1,23 @@
+require_relative '../helper'
+require_relative '../../lib/geometry/circle'
+
+def Circle(*args)
+    Geometry::Circle.new(*args)
+end
+
+class CircleTest < Test::Unit::TestCase
+    must "create a Circle object from a Point and a radius" do
+	circle = Circle [1,2], 3
+	assert_kind_of(Geometry::Circle, circle)
+    end
+
+    must "have a center point accessor" do
+	circle = Circle [1,2], 3
+	assert_equal(circle.center, [1,2])
+    end
+
+    must "have a radius accessor" do
+	circle = Circle [1,2], 3
+	assert_equal(3, circle.radius)
+    end
+end

data/test/geometry/edge.rb

@@ -0,0 +1,41 @@
+require_relative '../helper'
+require_relative '../../lib/geometry/edge'
+
+def Edge(*args)
+    Geometry::Edge.new(*args)
+end
+
+class EdgeTest < Test::Unit::TestCase
+    Edge = Geometry::Edge
+
+    must "create an Edge object" do
+	edge = Geometry::Edge.new([0,0], [1,0])
+	assert_kind_of(Geometry::Edge, edge)
+	assert_equal(Geometry::Point[0,0], edge.first)
+	assert_equal(Geometry::Point[1,0], edge.last)
+    end
+    must "create swap endpoints in place" do
+	edge = Geometry::Edge.new([0,0], [1,0])
+	assert_kind_of(Geometry::Edge, edge)
+	edge.reverse!
+	assert_equal(Geometry::Point[1,0], edge.first)
+	assert_equal(Geometry::Point[0,0], edge.last)
+    end
+    must "handle equality" do
+	edge1 = Geometry::Edge.new([1,0], [0,1])
+	edge2 = Geometry::Edge.new([1,0], [0,1])
+	edge3 = Geometry::Edge.new([1,1], [5,5])
+	assert_equal(edge1, edge2)
+	assert_not_equal(edge1, edge3)
+    end
+
+    must "return the height of the edge" do
+	edge = Edge([0,0], [1,1])
+	assert_equal(1, edge.height)
+    end
+
+    must "return the width of the edge" do
+	edge = Edge([0,0], [1,1])
+	assert_equal(1, edge.width)
+    end
+end

data/test/{test_point.rb → geometry/point.rb}

@@ -1,8 +1,9 @@
-require 'test/unit'
-require_relative 'test_unit_extensions'
+require_relative 'helper'
 require_relative '../lib/geometry/point'
 
 class PointTest < Test::Unit::TestCase
+    Point = Geometry::Point
+
     must "create a Point object using list syntax" do
 	point = Geometry::Point[2,1]
 	assert_equal(2, point.size)
@@ -58,6 +59,24 @@ class PointTest < Test::Unit::TestCase
 	assert_equal(6, point.y)
 	assert_equal(7, point.z)
     end
+    must "compare equal" do
+	point1 = Geometry::Point[1,2]
+	point2 = Geometry::Point[1,2]
+	point3 = Geometry::Point[3,4]
+	assert_equal(point1, point2)
+	assert_not_equal(point2, point3)
+    end
+
+    must "compare equal to an array with equal elements" do
+	point1 = Point[1,2]
+	assert_equal(point1, [1,2])
+    end
+
+    must "not compare equal to an array with unequal elements" do
+	point1 = Point[1,2]
+	assert_not_equal(point1, [3,2])
+    end
+
     must "implement inspect" do
 	point = Geometry::Point[8,9]
 	assert_equal('Point[8, 9]', point.inspect)

data/test/geometry/polygon.rb

@@ -0,0 +1,28 @@
+require_relative '../helper'
+require_relative '../../lib/geometry/polygon'
+
+class PolygonTest < Test::Unit::TestCase
+    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
+    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
+    must "create closed polygons" do
+	polygon = Geometry::Polygon.new([0,0], [1,0], [1,1], [0,1])
+	assert_equal(polygon.edges.first.first, polygon.edges.last.last)
+    end
+    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
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require_relative 'test_unit_extensions'

data/test/test_geometry.rb

@@ -1,14 +1,13 @@
-require 'test/unit'
-require_relative 'test_unit_extensions'
+require_relative 'helper'
 require_relative '../lib/geometry'
 
 class GeometryTest < Test::Unit::TestCase
     must "create a Point object" do
-	point = Geometry.Point(2,1)
+	point = Geometry.point(2,1)
 	assert_kind_of(Geometry::Point, point)
     end
     must "create a Line object" do
-	line = Geometry.Line([0,0], [10,10])
+	line = Geometry.line([0,0], [10,10])
 	assert_kind_of(Geometry::Line, line)
 	assert_kind_of(Geometry::TwoPointLine, line)
     end

data/test/test_line.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require_relative 'test_unit_extensions'
+require_relative 'helper'
 require_relative '../lib/geometry/line'
 
 class PointTest < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geometry
 version: !ruby/object:Gem::Version
-  version: '1'
+  version: '2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000 Z
+date: 2012-04-22 00:00:00.000000000 Z
 dependencies: []
 description: Geometric primitives and algorithms for Ruby
 email:
@@ -25,11 +25,18 @@ files:
 - Rakefile
 - geometry.gemspec
 - lib/geometry.rb
+- lib/geometry/circle.rb
+- lib/geometry/edge.rb
 - lib/geometry/line.rb
 - lib/geometry/point.rb
+- lib/geometry/polygon.rb
+- test/geometry/circle.rb
+- test/geometry/edge.rb
+- test/geometry/point.rb
+- test/geometry/polygon.rb
+- test/helper.rb
 - test/test_geometry.rb
 - test/test_line.rb
-- test/test_point.rb
 - test/test_unit_extensions.rb
 homepage: http://github.com/bfoz/geometry
 licenses: []
@@ -56,7 +63,12 @@ signing_key:
 specification_version: 3
 summary: Geometric primitives and algoritms
 test_files:
+- test/geometry/circle.rb
+- test/geometry/edge.rb
+- test/geometry/point.rb
+- test/geometry/polygon.rb
+- test/helper.rb
 - test/test_geometry.rb
 - test/test_line.rb
-- test/test_point.rb
 - test/test_unit_extensions.rb
+has_rdoc: