perfect-shape 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a7fef31137e74569d2a21ccb631fc968b0d1b78897d85a67f958c27833b910
-  data.tar.gz: 2335d8343628c9b599ea20a25c83a8986ebdd45a9fcdfd027312ccf05d44bd0f
+  metadata.gz: 81aba6992bb9cb98b1ce01764cb4cd0ca8e88690c56066e8282b4c0876421925
+  data.tar.gz: c63f14e43dfa8adff2bd525a77ca25ded5d1381953abb4a728770b22dab43323
 SHA512:
-  metadata.gz: 62a9db0050089a036fda899a076e8b5467519e03208a39f3da7faa11e940124c3b71738a3c6ed02bd2b15fc64723e8e851c844e63a727196200ab698f4f3c2fb
-  data.tar.gz: 16ec103325e93f584f3c4831951da95e4f92e6489a20dfd23ced5ce6c05f7e9e508fd824b5f3daffd4b98f3b9a3fd6f26ec3d941cd111197bba0d043c5f26827
+  metadata.gz: 6ff01e388f4fadc337792f45ddfc598fecaeb3816fe13d04f5db4a13ecc78c7e978e2ef9683e33e32711bda62373c77dd1f5f4c07d69cfc23e4867bfbba9ccca
+  data.tar.gz: b32a4c65a4101ffa61cdab257fa1af05d59e7ee1f8e12ac8598dbad92a32dd33299bda92add7781e3f9028278051ebda36d9164cde116d79fc70f6d8b297f8ed

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## 0.0.6
+
+- `PerfectShape::Circle`
+- `PerfectShape::Circle#contain?(x_or_point, y=nil)`
+
+## 0.0.5
+
+- `PerfectShape::Ellipse`
+- `PerfectShape::Ellipse#contain?(x_or_point, y=nil)`
+
+## 0.0.4
+
+- `PerfectShape::Arc#center_x` / `PerfectShape::Arc#center_y` / `PerfectShape::Arc#radius_x` / `PerfectShape::Arc#radius_y`
+- `PerfectShape::Rectangle#center_x` / `PerfectShape::Arc#center_y`
+- `PerfectShape::Square#center_x` / `PerfectShape::Square#center_y`
+- `PerfectShape::Arc#initialize(center_x: , center_y: , radius_x: , radius_y: )`
+- `PerfectShape::Math::normalize_degrees(degrees)` extracted from `PerfectShape::Arc`
+
+## 0.0.3
+
+- `PerfectShape::Square`
+- `PerfectShape::Square#contain?(x_or_point, y=nil)`
+
 ## 0.0.2
 
 - `PerfectShape::Rectangle`

data/README.md

@@ -1,8 +1,8 @@
-# Perfect Shape 0.0.2
+# Perfect Shape 0.0.6
 ## Geometric Algorithms
 [![Gem Version](https://badge.fury.io/rb/perfect-shape.svg)](http://badge.fury.io/rb/perfect-shape)
 
-`PerfectShape` is a collection of pure Ruby geometric algorithms that are mostly useful for GUI (Graphical User Interface) manipulation like checking containment of a mouse click point in popular geometry shapes such as rectangle, square, arc, ellipse, circle, polygon, polyline, polybezier, and paths containing lines, bezier curves, and quadratic curves.
+`PerfectShape` is a collection of pure Ruby geometric algorithms that are mostly useful for GUI (Graphical User Interface) manipulation like checking containment of a mouse click point in popular geometry shapes such as rectangle, square, arc (open, chord, and pie), ellipse, circle, polygon, polyline, polyquad, polycubic, and paths containing lines, bezier curves, and quadratic curves.
 
 Additionally, `PerfectShape::Math` contains some purely mathematical algorithms.
 
@@ -13,13 +13,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.0.2
+gem install perfect-shape -v 0.0.6
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.2'
+gem 'perfect-shape', '~> 0.0.6'
 ```
 
 And, run:
@@ -32,33 +32,141 @@ bundle
 
 ### `PerfectShape::Math`
 
-- `::degrees_to_radians(angle)`
-- `::radians_to_degrees(angle)`
-- `::ieee_remainder(x, y)` (alias: `ieee754_remainder`)
+Module
+
+- `::degrees_to_radians(angle)`: converts degrees to radians
+- `::radians_to_degrees(angle)`: converts radians to degrees
+- `::normalize_degrees(angle)`: normalizes the specified angle into the range -180 to 180.
+- `::ieee_remainder(x, y)` (alias: `ieee754_remainder`): [IEEE 754-1985 Remainder](https://en.wikipedia.org/wiki/IEEE_754-1985) (different from standard % modulo operator as it operates on floats and could return a negative result)
+
+### `PerfectShape::Shape`
+
+Class
+
+- `#normalize_point(x_or_point, y = nil)`: normalizes point into an `Array` of (x,y) coordinates
+
+### `PerfectShape::RectangularShape`
+
+Module
+
+- `#initialize(x: 0, y: 0, width: 1, height: 1)`: initializes a rectangular shape
+- `#x`: top-left x
+- `#y`: top-left y
+- `#width`: width
+- `#height`: height
+- `#center_x`: center x
+- `#center_y`: center y
 
 ### `PerfectShape::Line`
 
+Class
+Extends `PerfectShape::Shape`
+
 - `::relative_ccw(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)”.
 
 ### `PerfectShape::Rectangle`
 
+Class
+Extends `PerfectShape::Shape`
+Includes `PerfectShape::RectangularShape`
+
+![rectangle](images/rectangle.png)
+
 - `::new(x: 0, y: 0, width: 1, height: 1)`: constructs a rectangle
 - `#x`: top-left x
 - `#y`: top-left y
 - `#width`: width
 - `#height`: height
-- `#contain?(x_or_point, y=nil)`: checks if point inside
+- `#center_x`: center x
+- `#center_y`: center y
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
+
+### `PerfectShape::Square`
+
+Class
+Extends `PerfectShape::Rectangle`
+
+![square](images/square.png)
+
+- `::new(x: 0, y: 0, length: 1)`: constructs a square
+- `#x`: top-left x
+- `#y`: top-left y
+- `#length`: length
+- `#width`: width (equal to length)
+- `#height`: height (equal to length)
+- `#center_x`: center x
+- `#center_y`: center y
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ### `PerfectShape::Arc`
 
-- `::new(type: :open, x: 0, y: 0, width: 1, height: 1, start: 0, extent: 360)`: constructs an arc of type  `:open` (default), `:chord`, or `:pie`
-- `#x`: top-left x of arc
-- `#y`: top-left y of arc
-- `#width`: width of arc
-- `#height`: height of arc
+Class
+Extends `PerfectShape::Shape`
+Includes `PerfectShape::RectangularShape`
+
+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)
+
+- `::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`
+- `#x`: top-left x
+- `#y`: top-left y
+- `#width`: width
+- `#height`: height
 - `#start`: start angle in degrees
 - `#extent`: extent angle in degrees
-- `#contain?(x_or_point, y=nil)`: checks if point is in arc
+- `#center_x`: center x
+- `#center_y`: center y
+- `#radius_x`: radius along the x-axis
+- `#radius_y`: radius along the y-axis
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
+
+### `PerfectShape::Ellipse`
+
+Class
+Extends `PerfectShape::Arc`
+
+![ellipse](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
+- `#y`: top-left y
+- `#width`: width
+- `#height`: height
+- `#center_x`: center x
+- `#center_y`: center y
+- `#radius_x`: radius along the x-axis
+- `#radius_y`: radius along the y-axis
+- `#type`: always `:open`
+- `#start`: always `0`
+- `#extent`: always `360`
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
+
+### `PerfectShape::Circle`
+
+Class
+Extends `PerfectShape::Ellipse`
+
+![circle](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
+- `#y`: top-left y
+- `#diameter`: diameter
+- `#width`: width (equal to diameter)
+- `#height`: height (equal to diameter)
+- `#center_x`: center x
+- `#center_y`: center y
+- `#radius`: radius
+- `#radius_x`: radius along the x-axis (equal to radius)
+- `#radius_y`: radius along the y-axis (equal to radius)
+- `#type`: always `:open`
+- `#start`: always `0`
+- `#extent`: always `360`
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ## Process
 
@@ -77,7 +185,7 @@ bundle
 
 [CHANGELOG.md](CHANGELOG.md)
 
-## Contributing to perfect-shape
+## Contributing
 
 -   Check out the latest master to make sure the feature hasn't been
     implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.6

data/lib/perfect_shape/arc.rb

@@ -32,8 +32,15 @@ module PerfectShape
     attr_accessor :type
     attr_reader :start, :extent
     
-    def initialize(type: :open, x: 0, y: 0, width: 1, height: 1, start: 0, extent: 360)
-      super(x: x, y: y, width: width, height: height)
+    def initialize(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)
+      if center_x && center_y && radius_x && radius_y
+        self.center_x = center_x
+        self.center_y = center_y
+        self.radius_x = radius_x
+        self.radius_y = radius_y
+      else
+        super(x: x, y: y, width: width, height: height)
+      end
       @type = type
       self.start = start
       self.extent = extent
@@ -47,6 +54,86 @@ module PerfectShape
       @extent = BigDecimal(value.to_s)
     end
     
+    def x
+      @center_x && @radius_x ? @center_x - @radius_x : super
+    end
+    
+    def y
+      @center_y && @radius_y ? @center_y - @radius_y : super
+    end
+    
+    def width
+      @radius_x ? @radius_x * BigDecimal('2.0') : super
+    end
+    
+    def height
+      @radius_y ? @radius_y * BigDecimal('2.0') : super
+    end
+    
+    # Sets x, normalizing to BigDecimal
+    def x=(value)
+      super
+      @center_x = nil
+      self.width = width if @radius_x
+    end
+    
+    # Sets y, normalizing to BigDecimal
+    def y=(value)
+      super
+      @center_y = nil
+      self.height = height if @radius_y
+    end
+    
+    # Sets width, normalizing to BigDecimal
+    def width=(value)
+      super
+      @radius_x = nil
+    end
+    
+    # Sets height, normalizing to BigDecimal
+    def height=(value)
+      super
+      @radius_y = nil
+    end
+    
+    def center_x
+      super || @center_x
+    end
+    
+    def center_y
+      super || @center_y
+    end
+    
+    def radius_x
+      @width ? @width/BigDecimal('2.0') : @radius_x
+    end
+    
+    def radius_y
+      @height ? @height/BigDecimal('2.0') : @radius_y
+    end
+    
+    def center_x=(value)
+      @center_x = BigDecimal(value.to_s)
+      @x = nil
+      self.radius_x = radius_x if @width
+    end
+    
+    def center_y=(value)
+      @center_y = BigDecimal(value.to_s)
+      @y = nil
+      self.radius_y = radius_y if @height
+    end
+    
+    def radius_x=(value)
+      @radius_x = BigDecimal(value.to_s)
+      @width = nil
+    end
+    
+    def radius_y=(value)
+      @radius_y = BigDecimal(value.to_s)
+      @height = nil
+    end
+    
     # Checks if arc contains point denoted by point (two-number Array or x, y args)
     #
     # @param x The X coordinate of the point to test.
@@ -103,34 +190,11 @@ module PerfectShape
       ang_ext = -ang_ext if backwards
       return true if ang_ext >= 360.0
 
-      angle = normalize_degrees(angle) - normalize_degrees(start)
+      angle = Math.normalize_degrees(angle) - Math.normalize_degrees(start)
       angle = -angle if backwards
       angle += 360.0 if angle < 0.0
 
       (angle >= 0.0) && (angle < ang_ext)
     end
-    
-    # Normalizes the specified angle into the range -180 to 180.
-    # TODO refactor/extract to Math class
-    def normalize_degrees(angle)
-      if angle > 180.0
-        if angle <= (180.0 + 360.0)
-          angle = angle - 360.0
-        else
-          angle = Math.ieee_remainder(angle, 360.0)
-          # IEEEremainder can return -180 here for some input values...
-          angle = 180.0 if angle == -180.0
-        end
-      elsif angle <= -180.0
-        if angle > (-180.0 - 360.0)
-          angle = angle + 360.0
-        else
-          angle = Math.ieee_remainder(angle, 360.0)
-          # IEEEremainder can return -180 here for some input values...
-          angle = 180.0 if angle == -180.0
-        end
-      end
-      angle
-    end
   end
 end

data/lib/perfect_shape/circle.rb

@@ -0,0 +1,91 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'perfect_shape/ellipse'
+
+module PerfectShape
+  class Circle < Ellipse
+    MESSAGE_WIDTH_AND_HEIGHT_AND_DIAMETER_NOT_EQUAL = 'Circle width, height, and diameter must all be equal if more than one is specified; or otherwise keep only one of them in arguments!'
+    MESSAGE_RADIUS_X_AND_RADIUS_Y_AND_RADIUS_NOT_EQUAL = 'Circle radius_x, radius_y, and radius must all be equal if more than one is specified; or otherwise keep only one of them in arguments!'
+    
+    def initialize(x: 0, y: 0, width: nil, height: nil, diameter: nil, center_x: nil, center_y: nil, radius_x: nil, radius_y: nil, radius: nil)
+      raise MESSAGE_WIDTH_AND_HEIGHT_AND_DIAMETER_NOT_EQUAL if (diameter && width && diameter != width) || (diameter && height && diameter != height) || (width && height && width != height)
+      raise MESSAGE_RADIUS_X_AND_RADIUS_Y_AND_RADIUS_NOT_EQUAL if (radius && radius_x && radius != radius_x) || (radius && radius_y && radius != radius_y) || (radius_x && radius_y && radius_x != radius_y)
+      if center_x && center_y && (radius || radius_x || radius_y)
+        radius ||= radius_x || radius_y
+        self.radius = radius
+        super(center_x: center_x, center_y: center_y, radius_x: self.radius_x, radius_y: self.radius_y)
+      else
+        diameter ||= width || height || 1
+        self.diameter = diameter
+        super(x: x, y: y, width: self.width, height: self.height)
+      end
+    end
+    
+    def diameter
+      @radius ? @radius * BigDecimal('2.0') : @diameter
+    end
+    
+    def radius
+      @diameter ? @diameter / BigDecimal('2.0') : @radius
+    end
+    
+    # Sets length, normalizing to BigDecimal
+    def diameter=(value)
+      @diameter = BigDecimal(value.to_s)
+      @radius = nil
+      self.width = value unless width == value
+      self.height = value unless height == value
+    end
+    
+    # Sets radius, normalizing to BigDecimal
+    def radius=(value)
+      @radius = BigDecimal(value.to_s)
+      @diameter = nil
+      self.radius_x = value unless width == value
+      self.radius_y = value unless height == value
+    end
+    
+    def width=(value)
+      super
+      self.diameter = value unless diameter == value
+      self.height = value unless height == value
+    end
+    
+    def height=(value)
+      super
+      self.diameter = value unless diameter == value
+      self.width = value unless width == value
+    end
+    
+    def radius_x=(value)
+      super
+      self.radius = value unless radius == value
+      self.radius_y = value unless radius_y == value
+    end
+    
+    def radius_y=(value)
+      super
+      self.radius = value unless radius == value
+      self.radius_x = value unless radius_x == value
+    end
+  end
+end

data/lib/perfect_shape/ellipse.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'perfect_shape/arc'
+
+module PerfectShape
+  # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Ellipse2D.html
+  class Ellipse < Arc
+    MESSAGE_CANNOT_UPDATE_ATTRIUBTE = "Ellipse %s cannot be updated. If you want to update type, use Arc instead!"
+    
+    def initialize(x: 0, y: 0, width: 1, height: 1, center_x: nil, center_y: nil, radius_x: nil, radius_y: nil)
+      super
+      @initialized = true
+    end
+    
+    def type=(value)
+      if @initialized
+        raise MESSAGE_CANNOT_UPDATE_ATTRIUBTE % 'type'
+      else
+        super
+      end
+    end
+    
+    def start=(value)
+      if @initialized
+        raise MESSAGE_CANNOT_UPDATE_ATTRIUBTE % 'start'
+      else
+        super
+      end
+    end
+    
+    def extent=(value)
+      if @initialized
+        raise MESSAGE_CANNOT_UPDATE_ATTRIUBTE % 'extent'
+      else
+        super
+      end
+    end
+    
+    # Checks if ellipse contains point denoted by point (two-number Array or x, y args)
+    #
+    # @param x The X coordinate of the point to test.
+    # @param y The Y coordinate of the point to test.
+    #
+    # @return {@code true} if the point lies within the bound of
+    # the ellipse, {@code false} if the point lies outside of the
+    # ellipse's bounds.
+    def contain?(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      ellw = self.width
+      return false if ellw <= 0.0
+      normx = (x - self.x) / ellw - 0.5
+      ellh = self.height
+      return false if ellh <= 0.0
+      normy = (y - self.y) / ellh - 0.5
+      (normx * normx + normy * normy) < 0.25
+    end
+  end
+end

data/lib/perfect_shape/math.rb

@@ -15,6 +15,28 @@ module PerfectShape
       def degrees_to_radians(degrees)
         (Math::PI/180)*degrees
       end
+        
+      # Normalizes the specified angle into the range -180 to 180.
+      def normalize_degrees(angle)
+        if angle > 180.0
+          if angle <= (180.0 + 360.0)
+            angle = angle - 360.0
+          else
+            angle = Math.ieee_remainder(angle, 360.0)
+            # IEEEremainder can return -180 here for some input values...
+            angle = 180.0 if angle == -180.0
+          end
+        elsif angle <= -180.0
+          if angle > (-180.0 - 360.0)
+            angle = angle + 360.0
+          else
+            angle = Math.ieee_remainder(angle, 360.0)
+            # IEEEremainder can return -180 here for some input values...
+            angle = 180.0 if angle == -180.0
+          end
+        end
+        angle
+      end
 
       # Computes the remainder operation on two arguments as prescribed by the IEEE 754 standard.
       #

data/lib/perfect_shape/rectangle.rb

@@ -38,7 +38,7 @@ module PerfectShape
     def contain?(x_or_point, y = nil)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
-      x.between?(@x, @x + @width) && y.between?(@y, @y + @height)
+      x.between?(self.x, self.x + self.width) && y.between?(self.y, self.y + self.height)
     end
   end
 end

data/lib/perfect_shape/rectangular_shape.rb

@@ -53,5 +53,13 @@ module PerfectShape
     def height=(value)
       @height = BigDecimal(value.to_s)
     end
+    
+    def center_x
+      @x + (@width/BigDecimal('2.0')) if @x && @width
+    end
+    
+    def center_y
+      @y + (@height/BigDecimal('2.0')) if @y && @height
+    end
   end
 end

data/lib/perfect_shape/shape.rb

@@ -20,6 +20,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module PerfectShape
+  # Superclass of all shapes
   class Shape
     # Normalizes point args whether two-number Array or x, y args returning
     # normalized point array of two BigDecimal's

data/lib/perfect_shape/square.rb

@@ -0,0 +1,56 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'perfect_shape/rectangle'
+
+module PerfectShape
+  class Square < Rectangle
+    MESSAGE_WIDTH_AND_HEIGHT_AND_LENGTH_NOT_EQUAL = 'Square width, height, and length must all be equal if more than one is specified; or otherwise keep only one of them in arguments!'
+  
+    attr_reader :length
+    
+    # Constructs with x, y, length (optionally width or height can be passed as alias for length)
+    def initialize(x: 0, y: 0, length: nil, width: nil, height: nil)
+      raise MESSAGE_WIDTH_AND_HEIGHT_AND_LENGTH_NOT_EQUAL if (length && width && length != width) || (length && height && length != height) || (width && height && width != height)
+      length ||= width || height || 1
+      super(x: x, y: y, width: length, height: length)
+    end
+    
+    # Sets length, normalizing to BigDecimal
+    def length=(value)
+      @length = BigDecimal(value.to_s)
+      self.width = value unless width == value
+      self.height = value unless height == value
+    end
+    
+    def width=(value)
+      super
+      self.length = value unless length == value
+      self.height = value unless height == value
+    end
+    
+    def height=(value)
+      super
+      self.length = value unless length == value
+      self.width = value unless width == value
+    end
+  end
+end

data/perfect-shape.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.0.2 ruby lib
+# stub: perfect-shape 0.0.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.2"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2021-12-11"
-  s.description = "Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI manipulation like checking containment of a mouse click point in popular geometry shapes such as rectangle, square, arc, ellipse, circle, polygon, polyline, polybezier, and paths containing lines, bezier curves, and quadratic curves. Additionally, it contains some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).".freeze
+  s.date = "2021-12-16"
+  s.description = "Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI manipulation like checking containment of a mouse click point in popular geometry shapes such as rectangle, square, arc (open, chord, and pie), ellipse, circle, polygon, polyline, polyquad, polycubic, and paths containing lines, bezier curves, and quadratic curves. Additionally, it contains some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -26,11 +26,14 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/perfect-shape.rb",
     "lib/perfect_shape/arc.rb",
+    "lib/perfect_shape/circle.rb",
+    "lib/perfect_shape/ellipse.rb",
     "lib/perfect_shape/line.rb",
     "lib/perfect_shape/math.rb",
     "lib/perfect_shape/rectangle.rb",
     "lib/perfect_shape/rectangular_shape.rb",
     "lib/perfect_shape/shape.rb",
+    "lib/perfect_shape/square.rb",
     "perfect-shape.gemspec"
   ]
   s.homepage = "http://github.com/AndyObtiva/perfect-shape".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -82,10 +82,10 @@ dependencies:
         version: '0'
 description: Perfect Shape is a collection of pure Ruby geometric algorithms that
   are mostly useful for GUI manipulation like checking containment of a mouse click
-  point in popular geometry shapes such as rectangle, square, arc, ellipse, circle,
-  polygon, polyline, polybezier, and paths containing lines, bezier curves, and quadratic
-  curves. Additionally, it contains some purely mathematical algorithms like IEEEremainder
-  (also known as IEEE-754 remainder).
+  point in popular geometry shapes such as rectangle, square, arc (open, chord, and
+  pie), ellipse, circle, polygon, polyline, polyquad, polycubic, and paths containing
+  lines, bezier curves, and quadratic curves. Additionally, it contains some purely
+  mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -100,11 +100,14 @@ files:
 - VERSION
 - lib/perfect-shape.rb
 - lib/perfect_shape/arc.rb
+- lib/perfect_shape/circle.rb
+- lib/perfect_shape/ellipse.rb
 - lib/perfect_shape/line.rb
 - lib/perfect_shape/math.rb
 - lib/perfect_shape/rectangle.rb
 - lib/perfect_shape/rectangular_shape.rb
 - lib/perfect_shape/shape.rb
+- lib/perfect_shape/square.rb
 - perfect-shape.gemspec
 homepage: http://github.com/AndyObtiva/perfect-shape
 licenses: