geometry 0 → 1

data/.gitignore

@@ -2,6 +2,7 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc
 
 .DS_Store
 *.xcodeproj

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012, Brandon Fosdick <bfoz@bfoz.net>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided 
+that the following conditions are met:
+
+    Redistributions of source code must retain the above copyright notice, this list of conditions and the
+    following disclaimer.
+    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
+    the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/geometry.gemspec

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

data/lib/geometry.rb

@@ -1,6 +1,22 @@
-require_relative 'point'
-require_relative 'line'
+require_relative 'geometry/point'
+require_relative 'geometry/line'
 
 module Geometry
-  # Your code goes here...
+    # :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]
+    end
+
+    # :call-seq:
+    #   Point[x,y,z,...]
+    #   Point[Point]
+    #   Point[Vector]
+    def self.Point(*args)
+	Geometry::Point[*args]
+    end
 end

data/lib/geometry/line.rb

@@ -0,0 +1,114 @@
+require_relative 'point'
+
+module Geometry
+
+=begin rdoc
+A cluster of objects representing a Line of infinite length
+
+Supports two-point, slope-intercept, and point-slope initializer forms
+
+== Usage
+
+=== Two-point constructors
+    line = Geometry::Line[[0,0], [10,10]]
+    line = Geometry::Line[Geometry::Point[0,0], Geometry::Point[10,10]]
+    line = Geometry::Line[Vector[0,0], Vector[10,10]]
+
+=== Slope-intercept constructors
+    Geometry::Line[Rational(3,4), 5]	# Slope = 3/4, Intercept = 5
+    Geometry::Line[0.75, 5]
+
+=== Point-slope constructors
+    Geometry::Line(Geometry::Point[0,0], 0.75)
+    Geometry::Line(Vector[0,0], Rational(3,4))
+
+===  Special constructors (2D only)
+    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
+	def self.[](*args)
+	    if( 2 == args.size )
+		args.map! {|x| x.is_a?(Array) ? Point[*x] : x}
+
+		# If both args are Points, create a TwoPointLine
+		return TwoPointLine.new(*args) if args.all? {|x| x.is_a?(Vector)}
+
+		# If only the first arg is a Point, create a PointSlopeLine
+		return PointSlopeLine.new(*args) if args.first.is_a?(Vector)
+
+		# Otherise, create a SlopeInterceptLine
+		return SlopeInterceptLine.new(*args)
+	    else
+		nil
+	    end
+	end
+
+	def self.horizontal(y_intercept=0)
+	    SlopeInterceptLine.new(0, y_intercept)
+	end
+	def self.vertical(x_intercept=0)
+	    SlopeInterceptLine.new(1/0.0, x_intercept)
+	end
+    end
+
+    class PointSlopeLine < Line		# :nodoc:
+	def initialize(point, slope)
+	    @point = point.is_a?(Geometry::Point) ? point : Geometry.Point(point)
+	    @slope = slope
+	end
+	def to_s
+	    'Line(' + @slope.to_s + ',' + @point.to_s + ')'
+	end
+    end
+
+    class SlopeInterceptLine < Line	# :nodoc:
+	def initialize(slope, intercept)
+	    @slope = slope
+	    @intercept = intercept
+	end
+
+	def horizontal?
+	    0 == @slope
+	end
+	def vertical?
+	    (1/0.0) == @slope
+	end
+
+	def intercept(axis=:y)
+	    case axis
+		when :x
+		    vertical? ? @intercept : (horizontal? ? nil : (-@intercept/@slope))
+		when :y
+		    vertical? ? nil : @intercept
+	    end
+	end
+	def slope
+	    @slope
+	end
+
+	def to_s
+	    'Line(' + @slope.to_s + ',' + @intercept.to_s + ')'
+	end
+    end
+
+    class TwoPointLine < Line		# :nodoc:
+	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 + ')'
+	end
+	alias :to_s :inspect
+    end
+end
+

data/lib/geometry/point.rb

@@ -0,0 +1,45 @@
+require 'matrix'
+
+module Geometry
+    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]
+
+	# :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
+	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:
+	    'Point' + @elements.inspect
+	end
+	def to_s    # :nodoc:
+	    'Point' + @elements.to_s
+	end
+
+	def x
+	    @elements[0]
+	end
+	def y
+	    @elements[1]
+	end
+	def z
+	    @elements[2]
+	end
+    end
+end

data/test/test_geometry.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+require_relative 'test_unit_extensions'
+require_relative '../lib/geometry'
+
+class GeometryTest < Test::Unit::TestCase
+    must "create a Point object" do
+	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])
+	assert_kind_of(Geometry::Line, line)
+	assert_kind_of(Geometry::TwoPointLine, line)
+    end
+end

data/test/test_line.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
 require_relative 'test_unit_extensions'
-require_relative '../lib/line'
+require_relative '../lib/geometry/line'
 
 class PointTest < Test::Unit::TestCase
     must "create a Line object from 2 Points" do

data/test/test_point.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
 require_relative 'test_unit_extensions'
-require_relative '../lib/point'
+require_relative '../lib/geometry/point'
 
 class PointTest < Test::Unit::TestCase
     must "create a Point object using list syntax" do
@@ -10,31 +10,25 @@ class PointTest < Test::Unit::TestCase
 	assert_equal(1, point.y)
     end
     must "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
-    must "create a Point object from an array using list syntax" do
 	point = Geometry::Point[[3,4]]
 	assert_equal(2, point.size)
 	assert_equal(3, point.x)
 	assert_equal(4, point.y)
     end
     must "create a Point object from individual parameters" do
-	point = Geometry.Point(3,4)
+	point = Geometry::Point[3,4]
 	assert_equal(2, point.size)
 	assert_equal(3, point.x)
 	assert_equal(4, point.y)
     end
     must "create a Point object from a Vector" do
-	point = Geometry.Point(Vector[3,4])
+	point = Geometry::Point[Vector[3,4]]
 	assert_equal(2, point.size)
 	assert_equal(3, point.x)
 	assert_equal(4, point.y)
     end
     must "create a Point object from a Point" do
-	point = Geometry.Point(Geometry::Point[3,4])
+	point = Geometry::Point[Geometry::Point[3,4]]
 	assert_equal(2, point.size)
 	assert_equal(3, point.x)
 	assert_equal(4, point.y)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geometry
 version: !ruby/object:Gem::Version
-  version: '0'
+  version: '1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000 Z
+date: 2012-03-09 00:00:00.000000000 Z
 dependencies: []
 description: Geometric primitives and algorithms for Ruby
 email:
@@ -20,12 +20,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
+- LICENSE
+- README.markdown
 - Rakefile
 - geometry.gemspec
 - lib/geometry.rb
-- lib/line.rb
-- lib/point.rb
+- lib/geometry/line.rb
+- lib/geometry/point.rb
+- test/test_geometry.rb
 - test/test_line.rb
 - test/test_point.rb
 - test/test_unit_extensions.rb
@@ -54,6 +56,7 @@ signing_key:
 specification_version: 3
 summary: Geometric primitives and algoritms
 test_files:
+- test/test_geometry.rb
 - test/test_line.rb
 - test/test_point.rb
 - test/test_unit_extensions.rb

data/lib/line.rb

@@ -1,85 +0,0 @@
-require_relative 'point'
-
-module Geometry
-    class Line
-	def self.[](*args)
-	    Geometry.Line(*args)
-	end
-	def self.horizontal(y_intercept=0)
-	    SlopeInterceptLine.new(0, y_intercept)
-	end
-	def self.vertical(x_intercept=0)
-	    SlopeInterceptLine.new(1/0.0, x_intercept)
-	end
-    end
-
-    class PointSlopeLine < Line
-	def initialize(point, slope)
-	    @point = point.is_a?(Geometry::Point) ? point : Geometry.Point(point)
-	    @slope = slope
-	end
-	def to_s
-	    'Line(' + @slope.to_s + ',' + @point.to_s + ')'
-	end
-    end
-
-    class SlopeInterceptLine < Line
-	def initialize(slope, intercept)
-	    @slope = slope
-	    @intercept = intercept
-	end
-	
-	def horizontal?
-	    0 == @slope
-	end
-	def vertical?
-	    (1/0.0) == @slope
-	end
-
-	def intercept(axis=:y)
-	    case axis
-		when :x
-		    vertical? ? @intercept : (horizontal? ? nil : (-@intercept/@slope))
-		when :y
-		    vertical? ? nil : @intercept
-	    end
-	end
-	def slope
-	    @slope
-	end
-
-	def to_s
-	    'Line(' + @slope.to_s + ',' + @intercept.to_s + ')'
-	end
-    end
-
-    class TwoPointLine < Line
-	attr_reader :first, :last
-
-	def initialize(point0, point1)
-	    @first, @last = [point0, point1].map {|p| p.is_a?(Point) ? p : Geometry.Point(p) }
-	end
-	def inspect
-	    'Line(' + @first.to_s + ', ' + @last.to_s + ')'
-	end
-	alias :to_s :inspect
-    end
-
-    def self.Line(*args)
-	if( 2 == args.size )
-	    args.map! {|x| x.is_a?(Array) ? Point[*x] : x}
-
-	    # If both args are Points, create a TwoPointLine
-	    return TwoPointLine.new(*args) if args.all? {|x| x.is_a?(Vector)}
-
-	    # If only the first arg is a Point, create a PointSlopeLine
-	    return PointSlopeLine.new(*args) if args.first.is_a?(Vector)
-
-	    # Otherise, create a SlopeInterceptLine
-	    return SlopeInterceptLine.new(*args)
-	else
-	    nil
-	end
-    end
-end
-

data/lib/point.rb

@@ -1,39 +0,0 @@
-require 'matrix'
-
-module Geometry
-    class Point < Vector
-	
-	# Custom accessors to enable a more natural notation
-	def x
-	    @elements[0]
-	end
-	def y
-	    @elements[1]
-	end
-	def z
-	    @elements[2]
-	end
-
-	# Allow vector-style initialization, but override to
-	#  support copy-init from another Vector or Point
-	def self.[](*array)
-	    array = array[0] if array[0].is_a?(Array)
-	    return Point[*(array[0].to_a)] if array[0].is_a?(Vector)
-	    super *array
-	end
-
-	def inspect
-	    'Point' + @elements.inspect
-	end
-	def to_s
-	    'Point' + @elements.to_s
-	end
-    end
-    
-end
-
-def Geometry.Point(*args)
-    args[0] = args[0].to_a if args[0].is_a?(Vector)
-    args = args[0] if args[0].is_a?(Array)
-    Geometry::Point[*args]
-end