perfect-shape 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373846069228dba8331891ba808511bfdb306bb8e3e29fad2cf053ab6c69fbaf
-  data.tar.gz: ccbc6e998e1f9809ebebd126ed6c613076fc8ad92cea012c08796e8e129ead28
+  metadata.gz: '097e027a1c0c026611e480d05bf6281c74db9228964f6f06c414637bb60af8b0'
+  data.tar.gz: e2bab91460ec298a74e4735a13a123bf7b5f0ae9d15f8b5544a77aa7733cd312
 SHA512:
-  metadata.gz: 66d9b3a6420a142bc35eaf1dbf80536f743b713eec9dc509764d8bc4dc87d528e214703e24c256977f38263df55cac715db8c6f1366c3d7a05d97fd0d892722c
-  data.tar.gz: 41c7ea46f7f9607e889f9ec04187a286333e593af6012099b74b19593806ae14e1b9d01e406bc1a4efa2e21035a096b0ca10ba53d9f74ab51721fd50a5ed44c5
+  metadata.gz: a532c231809348346907d2f369df7380cbac384772c3fc6d9858bfa423f5da6f0fd15e9eda3f94404f5579ed3572cab87d3c8d99b19c50d776ae6e999a7ff5a1
+  data.tar.gz: 4d7b76430666115f21053b7417c290f6260fb99f278eb8397d53ddf1c5c4a84b48b1c87d49c977bdfc54cd513c801be49ca1e586d9c0d7501e4d2a5eb648f8e4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.0.11
+
+- `PerfectShape::Polygon#==`
+- `PerfectShape::Line#==`
+- `PerfectShape::Point#==`
+
 ## 0.0.10
 
 - `PerfectShape::Point`

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.0.10
+# Perfect Shape 0.0.11
 ## Geometric Algorithms
 [![Gem Version](https://badge.fury.io/rb/perfect-shape.svg)](http://badge.fury.io/rb/perfect-shape)
 
@@ -13,13 +13,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.0.10
+gem install perfect-shape -v 0.0.11
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.10'
+gem 'perfect-shape', '~> 0.0.11'
 ```
 
 And, run:
@@ -43,6 +43,8 @@ Module
 
 Class
 
+This is a base class for all shapes. It is not meant to be used directly. Subclasses implement/override its methods as needed.
+
 - `#min_x`: min x
 - `#min_y`: min y
 - `#max_x`: max x
@@ -53,6 +55,7 @@ Class
 - `#center_y`: center y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height just as those of shape
 - `#normalize_point(x_or_point, y = nil)`: normalizes point into an `Array` of (x,y) coordinates
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::PointLocation`
 
@@ -68,6 +71,8 @@ Module
 
 Module
 
+Includes `PerfectShape::PointLocation`
+
 - `#initialize(x: 0, y: 0, width: 1, height: 1)`: initializes a rectangular shape
 - `#x`: top-left x
 - `#y`: top-left y
@@ -87,12 +92,14 @@ Class
 
 Extends `PerfectShape::Shape`
 
-![point](images/point.png)
+Includes `PerfectShape::PointLocation`
+
+![point](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/point.png)
 
 Points are simply represented by an `Array` of (x,y) coordinates when used within other shapes, but when needing point-specific operations like `point_distance`, the `PerfectShape::Point` class can come in handy.
 
 - `::point_distance(x, y, px, py)`: Returns the distance from a point to another point
-- `::new(x_or_point=0, y=0, x: nil, y: nil)`: constructs a point with (x,y) pair whether specified as `Array` of (x,y) pair, flat `x,y` args, or `x:, y:` kwargs.
+- `::new(x_or_point=nil, y_arg=nil, x: nil, y: nil)`: constructs a point with (x,y) pair (default: 0,0) whether specified as `Array` of (x,y) pair, flat `x,y` args, or `x:, y:` kwargs.
 - `#min_x`: min x (always x)
 - `#min_y`: min y (always y)
 - `#max_x`: max x (always x)
@@ -104,6 +111,7 @@ Points are simply represented by an `Array` of (x,y) coordinates when used withi
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil, distance: 0)`: checks if point matches self, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a point shape in a GUI more successfully.
 - `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to another point
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Line`
 
@@ -111,7 +119,7 @@ Class
 
 Extends `PerfectShape::Shape`
 
-![line](images/line.png)
+![line](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/line.png)
 
 - `::relative_counterclockwise(x1, y1, x2, y2, px, py)`: Returns an indicator of where the specified point (px,py) lies with respect to the line segment from (x1,y1) to (x2,y2). The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, (x1,y1), in order to point at the specified point (px,py). A return value of 1 indicates that the line segment must turn in the direction that takes the positive X axis towards the negative Y axis. In the default coordinate system used by Java 2D, this direction is counterclockwise. A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise. A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining collinearity because of floating point rounding issues. If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies “beyond (x1,y1)” or 1 if the point lies “beyond (x2,y2)”.
 - `::point_segment_distance_square(x1, y1, x2, y2, px, py)`: Returns the square of distance from a point to a line segment.
@@ -129,6 +137,7 @@ Extends `PerfectShape::Shape`
 - `#contain?(x_or_point, y=nil, distance: 0)`: checks if point lies on line, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a line shape in a GUI more successfully.
 - `#relative_counterclockwise(x_or_point, y=nil)`: Returns an indicator of where the specified point (px,py) lies with respect to the line segment from (x1,y1) to (x2,y2). The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, (x1,y1), in order to point at the specified point (px,py). A return value of 1 indicates that the line segment must turn in the direction that takes the positive X axis towards the negative Y axis. In the default coordinate system used by Java 2D, this direction is counterclockwise. A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise. A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining collinearity because of floating point rounding issues. If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies “beyond (x1,y1)” or 1 if the point lies “beyond (x2,y2)”.
 - `#point_segment_distance(x_or_point, y=nil)`: Returns the distance from a point to a line segment.
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Rectangle`
 
@@ -138,7 +147,7 @@ Extends `PerfectShape::Shape`
 
 Includes `PerfectShape::RectangularShape`
 
-![rectangle](images/rectangle.png)
+![rectangle](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/rectangle.png)
 
 - `::new(x: 0, y: 0, width: 1, height: 1)`: constructs a rectangle
 - `#x`: top-left x
@@ -153,6 +162,7 @@ Includes `PerfectShape::RectangularShape`
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Square`
 
@@ -160,7 +170,7 @@ Class
 
 Extends `PerfectShape::Rectangle`
 
-![square](images/square.png)
+![square](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/square.png)
 
 - `::new(x: 0, y: 0, length: 1)`: constructs a square
 - `#x`: top-left x
@@ -176,6 +186,7 @@ Extends `PerfectShape::Rectangle`
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Arc`
 
@@ -189,7 +200,7 @@ Arcs can be of type `:open`, `:chord`, or `:pie`
 
 Open Arc | Chord Arc | Pie Arc
 ---------|-----------|--------
-![arc-open](images/arc-open.png) | ![arc-chord](images/arc-chord.png) | ![arc-pie](images/arc-pie.png)
+![arc-open](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/arc-open.png) | ![arc-chord](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/arc-chord.png) | ![arc-pie](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/arc-pie.png)
 
 - `::new(type: :open, x: 0, y: 0, width: 1, height: 1, start: 0, extent: 360, center_x: nil, center_y: nil, radius_x: nil, radius_y: nil)`: constructs an arc of type  `:open` (default), `:chord`, or `:pie`
 - `#type`: `:open`, `:chord`, or `:pie`
@@ -209,6 +220,7 @@ Open Arc | Chord Arc | Pie Arc
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Ellipse`
 
@@ -216,7 +228,7 @@ Class
 
 Extends `PerfectShape::Arc`
 
-![ellipse](images/ellipse.png)
+![ellipse](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/ellipse.png)
 
 - `::new(x: 0, y: 0, width: 1, height: 1, center_x: nil, center_y: nil, radius_x: nil, radius_y: nil)`: constructs an ellipse
 - `#x`: top-left x
@@ -236,6 +248,7 @@ Extends `PerfectShape::Arc`
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Circle`
 
@@ -243,7 +256,7 @@ Class
 
 Extends `PerfectShape::Ellipse`
 
-![circle](images/circle.png)
+![circle](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/circle.png)
 
 - `::new(x: 0, y: 0, diameter: 1, width: 1, height: 1, center_x: nil, center_y: nil, radius: nil, radius_x: nil, radius_y: nil)`: constructs a circle
 - `#x`: top-left x
@@ -265,6 +278,7 @@ Extends `PerfectShape::Ellipse`
 - `#max_y`: max y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ### `PerfectShape::Polygon`
 
@@ -272,7 +286,7 @@ Class
 
 Extends `PerfectShape::Shape`
 
-![polygon](images/polygon.png)
+![polygon](https://raw.githubusercontent.com/AndyObtiva/perfect-shape/master/images/polygon.png)
 
 - `::new(points: nil)`: constructs a polygon with `points` as `Array` of `Array`s of (x,y) pairs or flattened `Array` of alternating x and y values
 - `#min_x`: min x
@@ -285,6 +299,7 @@ Extends `PerfectShape::Shape`
 - `#center_y`: center y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 - `#contain?(x_or_point, y=nil)`: checks if point is inside using the [Ray Casting Algorithm](https://en.wikipedia.org/wiki/Point_in_polygon) (aka [Even-Odd Rule](https://en.wikipedia.org/wiki/Even%E2%80%93odd_rule))
+- `#==(other)`: Returns `true` if equal to `other` or `false` otherwise
 
 ## Process
 

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/perfect_shape/line.rb

@@ -185,6 +185,7 @@ module PerfectShape
     end
     
     include MultiPoint
+    include Equalizer.new(:points)
     
     # Checks if line contains point (two-number Array or x, y args), with distance tolerance (0 by default)
     #

data/lib/perfect_shape/point.rb

@@ -35,6 +35,7 @@ module PerfectShape
     end
     
     include PointLocation
+    include Equalizer.new(:x, :y)
     
     def initialize(x_or_point = nil, y_arg = nil, x: nil, y: nil)
       if x_or_point.is_a?(Array)

data/lib/perfect_shape/polygon.rb

@@ -26,6 +26,7 @@ module PerfectShape
   # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/Polygon.html
   class Polygon < Shape
     include MultiPoint
+    include Equalizer.new(:points)
     
     # Checks if polygon contains point (two-number Array or x, y args)
     # using the Ray Casting Algorithm (aka Even-Odd Rule): https://en.wikipedia.org/wiki/Point_in_polygon

data/lib/perfect_shape/shape.rb

@@ -20,7 +20,8 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module PerfectShape
-  # Superclass of all shapes
+  # Superclass of all shapes. Not meant to be used directly.
+  # Subclasses must implement/override methods as needed.
   class Shape
     # Subclasses must implement
     def min_x
@@ -82,5 +83,9 @@ module PerfectShape
       y = BigDecimal(y.to_s)
       [x, y]
     end
+    
+    # Subclasses must implement
+    def ==(other)
+    end
   end
 end

data/perfect-shape.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.0.10 ruby lib
+# stub: perfect-shape 0.0.11 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Andy Maleh