perfect-shape 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c1add66582b68b1c6ec2d15b91c9af7840daf97b7e40662210683690d1a082
-  data.tar.gz: 2b789617e71a321cd7b736abfcfd59d7c46dbbf91fa0b4e2e5f581704e28527a
+  metadata.gz: b287e3d8aee766314feeccc80abe127dc1ec6e8d169af61e8c6efc1097a2b5c2
+  data.tar.gz: 96b934dde2686223634244d6ff550b578c15971b2198cb94fb0cec3ded97e06c
 SHA512:
-  metadata.gz: 6c7b3efef675a42f6d33aae8d2d208e7224c44f9d8e64064dc9f18b0a3594b4cf2b3addb360376e5837f9478c5e61b18d85b989a16c122ed1d762f88c849075a
-  data.tar.gz: 6b87d053a77eab1900c67ffb1a5800a878f9f06de7e9713d72f9ecedf5fc6e463e2cb885d1f6e1cfd7eca9eeb08b1321e6e97009564d6c4082a7a542db2d8ea2
+  metadata.gz: 6743fed8d87b2ceb4bd69b91fd2ecc3b6655eca986e4a67c2aa755d53f29de60ffbb6fcc539fc45e480f55e06c176cad1885dd3c4af0330a42218b8291837763
+  data.tar.gz: b3669ef0aabb19553bad2dc51cdca4b1c188d05cca41c73c13570f0faff19d03d373f7727c423531700cd85e562b340003995558f2c7e4c8c195947e44b232fa

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## 0.0.5
+
+- `PerfectShape::Ellipse`
+- `PerfectShape::Ellipse#contain?`
+
+## 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`
+- `PerfectShape::Rectangle#contain?(x_or_point, y=nil)`
+
 ## 0.0.1
 
 - `PerfectShape::Math`

data/README.md

@@ -1,7 +1,8 @@
-# Perfect Shape 0.0.1
+# Perfect Shape 0.0.5
 ## 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 point in popular geometric shapes such as rectangle, square, arc, circle, polygon, polyline, 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.
 
@@ -12,13 +13,13 @@ To ensure high accuracy, this library does all its mathematical operations with
 Run:
 
 ```
-gem install perfect-shape -v 0.0.1
+gem install perfect-shape -v 0.0.5
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.1'
+gem 'perfect-shape', '~> 0.0.5'
 ```
 
 And, run:
@@ -31,24 +32,98 @@ bundle
 
 ### `PerfectShape::Math`
 
-- `::degrees_to_radians(angle)`
-- `::radians_to_degrees(angle)`
-- `::ieee_remainder(x, y)` (alias: `ieee754_remainder`)
+- `::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::Line`
 
-- `::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
+- `::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`
+
+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
+- `#center_x`: center x
+- `#center_y`: center y
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
+
+### `PerfectShape::Square`
+
+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`
+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 of arc
 - `#y`: top-left y of arc
 - `#width`: width of arc
 - `#height`: height of arc
 - `#start`: start angle in degrees
 - `#extent`: extent angle in degrees
-- `#contain?(x_or_point, y=0)`: 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`
+
+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 of arc
+- `#y`: top-left y of arc
+- `#width`: width of arc
+- `#height`: height of arc
+- `#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
+
+## Process
+
+[Glimmer Process](https://github.com/AndyObtiva/glimmer/blob/master/PROCESS.md)
+
+## Resources
+
+- Rubydoc: https://www.rubydoc.info/gems/perfect-shape
+- AWT Geom JavaDoc: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
 
 ## TODO
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.5

data/lib/perfect-shape.rb

@@ -19,6 +19,8 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+$LOAD_PATH.unshift File.expand_path('.', __dir__)
+
 require 'bigdecimal'
 
 # Perfect Shape algorithms are mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html

data/lib/perfect_shape/arc.rb

@@ -19,54 +19,131 @@
 # 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_relative 'line'
+require 'perfect_shape/shape'
+require 'perfect_shape/rectangular_shape'
+require 'perfect_shape/line'
 
 module PerfectShape
   # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Arc2D.html
-  class Arc
+  class Arc < Shape
+    include RectangularShape
+    
     TYPES = [:open, :chord, :pie]
-    attr_accessor :type, :x, :y, :width, :height, :start, :extent
+    attr_accessor :type
+    attr_reader :start, :extent
     
-    def initialize(type: :open, x: 0, y: 0, width: 1, height: 1, start: 0, extent: 360)
+    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.x = x
-      self.y = y
-      self.width = width
-      self.height = height
       self.start = start
       self.extent = extent
     end
     
+    def start=(value)
+      @start = BigDecimal(value.to_s)
+    end
+    
+    def extent=(value)
+      @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)
-      @x = BigDecimal(value.to_s)
+      super
+      @center_x = nil
+      self.width = width if @radius_x
     end
     
+    # Sets y, normalizing to BigDecimal
     def y=(value)
-      @y = BigDecimal(value.to_s)
+      super
+      @center_y = nil
+      self.height = height if @radius_y
     end
     
+    # Sets width, normalizing to BigDecimal
     def width=(value)
-      @width = BigDecimal(value.to_s)
+      super
+      @radius_x = nil
     end
     
+    # Sets height, normalizing to BigDecimal
     def height=(value)
-      @height = BigDecimal(value.to_s)
+      super
+      @radius_y = nil
     end
     
-    def start=(value)
-      @start = BigDecimal(value.to_s)
+    def center_x
+      super || @center_x
     end
     
-    def extent=(value)
-      @extent = BigDecimal(value.to_s)
+    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.
+    # @param y The Y coordinate of the point to test.
+    #
+    # @return {@code true} if the point lies within the bound of
+    # the arc, {@code false} if the point lies outside of the
+    # arc's bounds.
     def contain?(x_or_point, y = nil)
-      x = x_or_point
-      x, y = x if y.nil? && x_or_point.is_a?(Array) && x_or_point.size == 2
-      x = BigDecimal(x.to_s)
-      y = BigDecimal(y.to_s)
+      x, y = normalize_point(x_or_point, y)
       return unless x && y
       # Normalize the coordinates compared to the ellipse
       # having a center at 0,0 and a radius of 0.5.
@@ -105,38 +182,19 @@ module PerfectShape
       inarc ? !inside : inside
     end
     
+    # Determines whether or not the specified angle is within the
+    # angular extents of the arc.
     def contain_angle?(angle)
       ang_ext = self.extent
       backwards = ang_ext < 0.0
       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
-    
-    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/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/line.rb

@@ -19,33 +19,23 @@
 # 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/shape'
+
 module PerfectShape
   # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Line2D.html
-  class Line
+  class Line < Shape
     class << self
-      # Returns an indicator of where the specified point
-      # {@code (px,py)} lies with respect to the line segment from
-      # {@code (x1,y1)} to {@code (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, {@code (x1,y1)}, in order to point at the
-      # specified point {@code (px,py)}.
-      # <p>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.
-      # <p>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.
-      # <p>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.
-      # <p>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 {@code (x1,y1)}" or 1 if the point lies
-      # "beyond {@code (x2,y2)}".
+      # 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)”.
       #
       # @param x1 the X coordinate of the start point of the
       #           specified line segment
@@ -62,7 +52,6 @@ module PerfectShape
       # @return an integer that indicates the position of the third specified
       #                  coordinates with respect to the line segment formed
       #                  by the first two specified coordinates.
-      # @since 1.2
       def relative_ccw(x1, y1, x2, y2, px, py)
         x2 -= x1;
         y2 -= y1;

data/lib/perfect_shape/math.rb

@@ -1,6 +1,8 @@
 module PerfectShape
   # Perfect Shape Math utility methods
+  #
   # Mostly ported from java.lang.Math: https://docs.oracle.com/javase/8/docs/api/java/lang/Math.html
+  #
   # Also includes standard Ruby ::Math utility methods
   module Math
     class << self
@@ -13,18 +15,44 @@ 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.
-      # Algorithm: x – (round(x/y)*y).
+      #
+      # Algorithm is exactly: x – (round(x/y)*y)
+      #
       # The `round` part rounds to the nearest even number when it is a halfway between n & y (integer + 0.5 number)
+      #
       # The remainder value is mathematically equal to x - y × n, where n is the mathematical integer closest to the exact mathematical value of the quotient x/y, and if two mathematical integers are equally close to x/y, then n is the integer that is even. If the remainder is zero, its sign is the same as the sign of the first argument. Special cases:
+      #
       # If either argument is NaN, or the first argument is infinite, or the second argument is positive zero or negative zero, then the result is NaN.
+      #
       # If the first argument is finite and the second argument is infinite, then the result is the same as the first argument.
-      # Parameters:
-      # x - the dividend.
-      # y - the divisor.
-      # Returns:
-      # the remainder when x is divided by y.
+      #
+      # @param x the dividend.
+      # @param y the divisor.
+      # @return the remainder when x is divided by y.
       def ieee754_remainder(x, y)
         x = BigDecimal(x.to_s)
         y = BigDecimal(y.to_s)

data/lib/perfect_shape/rectangle.rb

@@ -0,0 +1,44 @@
+# 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/shape'
+require 'perfect_shape/rectangular_shape'
+
+module PerfectShape
+  # Mostly ported from java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Rectangle2D.html
+  class Rectangle < Shape
+    include RectangularShape
+    
+    # Checks if rectangle 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 rectangle, {@code false} if the point lies outside of the
+    # rectangle's bounds.
+    def contain?(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      x.between?(self.x, self.x + self.width) && y.between?(self.y, self.y + self.height)
+    end
+  end
+end