simple-polygons 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc6fcadcf4ca827ba3c74a34d09e83931b4258a5
-  data.tar.gz: 857fd2f142fb860cb72da58971d4a818983549f0
+  metadata.gz: 8c91ad54da3d72c94acde5e8049c4c5340e5dcc0
+  data.tar.gz: '069fa48df969bbe97efb18685c58780b6bae0706'
 SHA512:
-  metadata.gz: 9d765fd9acbddb5726aaa0c91410740c58dd27cc20a3176c25c53ac1c694e26baf387298f5df8bcc74e373de72800bea3ecf98061397f632f800d13068b97b82
-  data.tar.gz: 9a8b5c4fc4c127a7ddab47055d116b709dfdf2da1a27ee876e854399bd92e01934ca4c5e7a50f6946db702a897815ad10ab94419a5c155d9e79316c9a025ec45
+  metadata.gz: 7f0db22b943024df85af746cca2cebcd1d028da8a692277396341c24252f95eb16e7534d108f4a85bcee67ae6554aa78104ffc3f0a8c53e13f7a7d9cb14956b2
+  data.tar.gz: '09479c6793079a7ea00e0f8f27b94ef73671faa940752642e30ce59360670729a09582ce3a0e57d1e31f254a8729d9387d40b6769665c0928c88f208b87c625f'

data/lib/simple-polygons.rb

@@ -3,9 +3,11 @@ require ( 'locationclass' )
 
 #Main module.
 module SimplePolygons
+	#Base class for errors related to polygons.
 	class SimplePolygons::PolygonError < StandardError
 	
 	end
+	#Raised when an array of locations passed to a polygon constructor cannot form the specified type of polygon.
 	class SimplePolygons::InvalidLocationArrayError < PolygonError
 	
 	end
@@ -14,6 +16,7 @@ module SimplePolygons
 		
 	end
 
+	#Basic polygon class.
 	class SimplePolygons::Polygon
 		attr_accessor ( :points )
 		
@@ -29,16 +32,19 @@ module SimplePolygons
 		
 			@points = point_array
 		end
+
 		#Returns the number of points.
 		def number_of_points()
 			return @points.length()
 		end
 	end
+	#Represents a line.
 	class SimplePolygons::Line < Polygon
 		def initialize(start_loc, end_loc)
 			super([start_loc, end_loc])
 		end
 	end
+	#Represents a rectangle.
 	class SimplePolygons::Rectangle < Polygon
 		#Makes a new rectangle with the specified boundaries. start_loc should be a Location
 		#object and length and width parameters should be floats.
@@ -46,6 +52,7 @@ module SimplePolygons
 			super([start_loc, Location.new(start_loc.x() + length, start_loc.y() + width)])
 		end
 	end
+	#Represents a square.
 	class SimplePolygons::Square < Rectangle
 		#Creates a new square with the specified boundaries. start_loc should be a Location object and
 		#side_length should be a float.
@@ -55,9 +62,41 @@ module SimplePolygons
 	end
 	#NOT YET IMPLEMENTED. Represents a triangle. It can be any of the 3 kinds.
 	class SimplePolygons::Triangle < Polygon		
-		#All parameters should be Location objects.
-		def initialize(loc1, loc2, loc3)
-			raise NotImplementedError.new("SimplePolygons::Triangle is not yet implemented.")
+		#location_array should be an array of location objects. If they don't form a triangle, an
+		#InvalidLocationArrayError will be raised.
+		def initialize(location_array)
+			raise InvalidLocationArrayError.new() unless valid_points?(location_array)
+		end
+
+		def self.valid_points?(array)
+			return true
+		end
+	end
+	#Represents a circle object. Although it extends polygon, @points is never used and cannot be modified.
+	class SimplePolygons::Circle
+		attr_accessor ( :center )
+		attr_accessor ( :radius )
+
+		#center_loc should be a location and rad should be a float or integer.
+		def initialize(center_loc, rad)
+			@center = center_loc
+			@radius = rad
+		end
+
+		#Always returns 0.
+		def points()
+			return 0
+		end
+		#This does not do anything.
+		def points=(value)
+
+		end
+
+		def diameter()
+			return @radius * 2
+		end
+		def diameter=(value)
+  			@radius = (value / 2)
 		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-polygons
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - SugarRush
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: locationclass
@@ -16,15 +16,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-description: Simple polygon classes.
+        version: '1.1'
+description: Simple polygon classes. Development is being moved to ultra_polygons.
 email: 
 executables: []
 extensions: []