perfect-shape 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c1add66582b68b1c6ec2d15b91c9af7840daf97b7e40662210683690d1a082
-  data.tar.gz: 2b789617e71a321cd7b736abfcfd59d7c46dbbf91fa0b4e2e5f581704e28527a
+  metadata.gz: 27a7fef31137e74569d2a21ccb631fc968b0d1b78897d85a67f958c27833b910
+  data.tar.gz: 2335d8343628c9b599ea20a25c83a8986ebdd45a9fcdfd027312ccf05d44bd0f
 SHA512:
-  metadata.gz: 6c7b3efef675a42f6d33aae8d2d208e7224c44f9d8e64064dc9f18b0a3594b4cf2b3addb360376e5837f9478c5e61b18d85b989a16c122ed1d762f88c849075a
-  data.tar.gz: 6b87d053a77eab1900c67ffb1a5800a878f9f06de7e9713d72f9ecedf5fc6e463e2cb885d1f6e1cfd7eca9eeb08b1321e6e97009564d6c4082a7a542db2d8ea2
+  metadata.gz: 62a9db0050089a036fda899a076e8b5467519e03208a39f3da7faa11e940124c3b71738a3c6ed02bd2b15fc64723e8e851c844e63a727196200ab698f4f3c2fb
+  data.tar.gz: 16ec103325e93f584f3c4831951da95e4f92e6489a20dfd23ced5ce6c05f7e9e508fd824b5f3daffd4b98f3b9a3fd6f26ec3d941cd111197bba0d043c5f26827

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 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.2
 ## 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, ellipse, circle, polygon, polyline, polybezier, 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.2
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.1'
+gem 'perfect-shape', '~> 0.0.2'
 ```
 
 And, run:
@@ -37,7 +38,16 @@ bundle
 
 ### `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`
+
+- `::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
 
 ### `PerfectShape::Arc`
 
@@ -48,7 +58,16 @@ bundle
 - `#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
+- `#contain?(x_or_point, y=nil)`: checks if point is in arc
+
+## 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.2

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,40 +19,26 @@
 # 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)
+      super(x: x, y: y, width: width, height: height)
       @type = type
-      self.x = x
-      self.y = y
-      self.width = width
-      self.height = height
       self.start = start
       self.extent = extent
     end
     
-    def x=(value)
-      @x = BigDecimal(value.to_s)
-    end
-    
-    def y=(value)
-      @y = BigDecimal(value.to_s)
-    end
-    
-    def width=(value)
-      @width = BigDecimal(value.to_s)
-    end
-    
-    def height=(value)
-      @height = BigDecimal(value.to_s)
-    end
-    
     def start=(value)
       @start = BigDecimal(value.to_s)
     end
@@ -62,11 +48,15 @@ module PerfectShape
     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,6 +95,8 @@ 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
@@ -118,6 +110,8 @@ module PerfectShape
       (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)

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
@@ -15,16 +17,20 @@ module PerfectShape
       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?(@x, @x + @width) && y.between?(@y, @y + @height)
+    end
+  end
+end

data/lib/perfect_shape/rectangular_shape.rb

@@ -0,0 +1,57 @@
+# 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.
+
+module PerfectShape
+  # Mixin Module for Rectangular Shapes (having x, y, width, height)
+  # Can only be mixed into a class extending Shape or another module
+  module RectangularShape
+    attr_reader :x, :y, :width, :height
+    
+    # Calls super before setting x, y, width, height
+    def initialize(x: 0, y: 0, width: 1, height: 1)
+      super()
+      self.x = x
+      self.y = y
+      self.width = width
+      self.height = height
+    end
+    
+    # Sets x, normalizing to BigDecimal
+    def x=(value)
+      @x = BigDecimal(value.to_s)
+    end
+    
+    # Sets y, normalizing to BigDecimal
+    def y=(value)
+      @y = BigDecimal(value.to_s)
+    end
+    
+    # Sets width, normalizing to BigDecimal
+    def width=(value)
+      @width = BigDecimal(value.to_s)
+    end
+    
+    # Sets height, normalizing to BigDecimal
+    def height=(value)
+      @height = BigDecimal(value.to_s)
+    end
+  end
+end

data/lib/perfect_shape/shape.rb

@@ -0,0 +1,39 @@
+# 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.
+
+module PerfectShape
+  class Shape
+    # Normalizes point args whether two-number Array or x, y args returning
+    # normalized point array of two BigDecimal's
+    #
+    # @param x_or_point The point or X coordinate of the point to test.
+    # @param y The Y coordinate of the point to test.
+    #
+    # @return Array of x and y BigDecimal's representing point
+    def normalize_point(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]
+    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.1 ruby lib
+# stub: perfect-shape 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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-06"
-  s.description = "Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI 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. Additionally, it contains some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).".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.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -20,24 +20,18 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".document",
-    ".ruby-gemset",
-    ".ruby-version",
     "CHANGELOG.md",
-    "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
-    "Rakefile",
-    "TODO.md",
     "VERSION",
     "lib/perfect-shape.rb",
     "lib/perfect_shape/arc.rb",
     "lib/perfect_shape/line.rb",
     "lib/perfect_shape/math.rb",
-    "perfect-shape.gemspec",
-    "test/lib/perfect_shape/test_arc.rb",
-    "test/lib/perfect_shape/test_math.rb"
+    "lib/perfect_shape/rectangle.rb",
+    "lib/perfect_shape/rectangular_shape.rb",
+    "lib/perfect_shape/shape.rb",
+    "perfect-shape.gemspec"
   ]
   s.homepage = "http://github.com/AndyObtiva/perfect-shape".freeze
   s.licenses = ["MIT".freeze]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -81,10 +81,11 @@ dependencies:
       - !ruby/object:Gem::Version
         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 point in popular
-  geometric shapes such as rectangle, square, arc, circle, polygon, polyline, and
-  paths containing lines, bezier curves, and quadratic curves. Additionally, it contains
-  some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).
+  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).
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -93,24 +94,18 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".document"
-- ".ruby-gemset"
-- ".ruby-version"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- TODO.md
 - VERSION
 - lib/perfect-shape.rb
 - lib/perfect_shape/arc.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
 - perfect-shape.gemspec
-- test/lib/perfect_shape/test_arc.rb
-- test/lib/perfect_shape/test_math.rb
 homepage: http://github.com/AndyObtiva/perfect-shape
 licenses:
 - MIT

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.ruby-gemset

@@ -1 +0,0 @@
-perfect-shape

data/.ruby-version

@@ -1 +0,0 @@
-ruby-3.0.2

data/Gemfile

@@ -1,14 +0,0 @@
-source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rdoc", "~> 3.12"
-  gem "juwelier", "~> 2.1.0"
-  gem 'minitest', '~> 5.14.4'
-  gem 'puts_debuggerer', '~> 0.13.1'
-  gem 'rake-tui', '> 0'
-end

data/Gemfile.lock

@@ -1,102 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    awesome_print (1.9.2)
-    builder (3.2.4)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    git (1.9.1)
-      rchardet (~> 1.8)
-    github_api (0.19.0)
-      addressable (~> 2.4)
-      descendants_tracker (~> 0.0.4)
-      faraday (>= 0.8, < 2)
-      hashie (~> 3.5, >= 3.5.2)
-      oauth2 (~> 1.0)
-    hashie (3.6.0)
-    highline (2.0.3)
-    json (1.8.6)
-    juwelier (2.1.3)
-      builder
-      bundler (>= 1.13)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    jwt (2.3.0)
-    minitest (5.14.4)
-    multi_json (1.15.0)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    nokogiri (1.12.5-x86_64-darwin)
-      racc (~> 1.4)
-    oauth2 (1.4.7)
-      faraday (>= 0.8, < 2.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    pastel (0.8.0)
-      tty-color (~> 0.5)
-    public_suffix (4.0.6)
-    puts_debuggerer (0.13.1)
-      awesome_print (~> 1.9.2)
-    racc (1.6.0)
-    rack (2.2.3)
-    rake (13.0.6)
-    rake-tui (0.2.3)
-      tty-prompt
-    rchardet (1.8.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    ruby2_keywords (0.0.5)
-    semver (1.0.1)
-    thread_safe (0.3.6)
-    tty-color (0.6.0)
-    tty-cursor (0.7.1)
-    tty-prompt (0.23.1)
-      pastel (~> 0.8)
-      tty-reader (~> 0.8)
-    tty-reader (0.9.0)
-      tty-cursor (~> 0.7)
-      tty-screen (~> 0.8)
-      wisper (~> 2.0)
-    tty-screen (0.8.1)
-    wisper (2.0.1)
-
-PLATFORMS
-  x86_64-darwin-19
-
-DEPENDENCIES
-  juwelier (~> 2.1.0)
-  minitest (~> 5.14.4)
-  puts_debuggerer (~> 0.13.1)
-  rake-tui (> 0)
-  rdoc (~> 3.12)
-
-BUNDLED WITH
-   2.2.31

data/Rakefile

@@ -1,46 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-require 'juwelier'
-Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "perfect-shape"
-  gem.homepage = "http://github.com/AndyObtiva/perfect-shape"
-  gem.license = "MIT"
-  gem.summary = %Q{Perfect Shape - Geometric Algorithms}
-  gem.description = %Q{Perfect Shape is a collection of pure Ruby geometric algorithms that are mostly useful for GUI 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. Additionally, it contains some purely mathematical algorithms like IEEEremainder (also known as IEEE-754 remainder).}
-  gem.email = "andy.am@gmail.com"
-  gem.authors = ["Andy Maleh"]
-
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "perfect-shape #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/TODO.md

@@ -1,31 +0,0 @@
-# TODO
-
-## Geometry
-
-Mostly inspired by java.awt.geom: https://docs.oracle.com/javase/8/docs/api/java/awt/geom/package-summary.html
-
-- Polygon
-- CubicCurve
-- QuadCurve
-- Line
-- Path: flexible shape which represents an arbitrary geometric path
-- GeneralPath: represents a geometric path constructed from straight lines, and quadratic and cubic (Bézier) curves. It can contain multiple subpaths.
-- Rectangle
-- RoundRectangle
-- Point
-- Ellipse
-- Polybezier
-- Polyline
-- Area: aggregate of multiple shapes
-- AffineTransform: represents a 2D affine transform that performs a linear mapping from 2D coordinates to other 2D coordinates that preserves the "straightness" and "parallelness" of lines.
-
-## Miscellaneous
-
-- Include screenshots of the supported shapes in README
-
-## Maybe
-
-- Consider the idea of having tests run in JRuby and check against java.awt.geom and compare result with perfect-shape
-- Consider contributing IEEEremainder to Ruby
-- Contribute this type of expectation: _(arc).must_be :contain?, *point to Minitest Expectations
-- Maybe contribute xit to minitest expectations

data/test/lib/perfect_shape/test_arc.rb

@@ -1,184 +0,0 @@
-require 'puts_debuggerer'
-require 'minitest/autorun'
-
-require_relative '../../../lib/perfect-shape'
-
-describe PerfectShape do
-  describe PerfectShape::Arc do
-    it 'constructs with chord type and dimensions' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50, height: 60, start: 30, extent: 90)
-
-      _(arc.type).must_equal :chord
-      _(arc.y).must_equal 3
-      _(arc.y).must_equal 3
-      _(arc.width).must_equal 50
-      _(arc.height).must_equal 60
-      _(arc.start).must_equal 30
-      _(arc.extent).must_equal 90
-    end
-
-    it 'constructs with open type defaults' do
-      arc = PerfectShape::Arc.new
-
-      _(arc.type).must_equal :open
-      _(arc.x).must_equal 0
-      _(arc.y).must_equal 0
-      _(arc.width).must_equal 1
-      _(arc.height).must_equal 1
-      _(arc.start).must_equal 0
-      _(arc.extent).must_equal 360
-    end
-
-    it 'updates attributes' do
-      arc = PerfectShape::Arc.new
-      arc.type = :chord
-      arc.x = 2
-      arc.y = 3
-      arc.width = 50
-      arc.height = 60
-      arc.start = 30
-      arc.extent = 90
-
-      _(arc.type).must_equal :chord
-      _(arc.y).must_equal 3
-      _(arc.y).must_equal 3
-      _(arc.width).must_equal 50
-      _(arc.height).must_equal 60
-      _(arc.start).must_equal 30
-      _(arc.extent).must_equal 90
-    end
-
-    it 'contains point with chord type circle' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [arc.x + arc.width / 2.0, arc.y + arc.height / 2.0]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-
-    it 'contains point with chord type arc' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50.5, height: 60.75, start: 45, extent: 270)
-      point = [arc.x + arc.width*3/4.0, arc.y + (arc.height / 2.0)]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-    
-    it 'does not contain point within bounding box with chord type arc' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 67, height: 46, start: 45, extent: 270)
-      point = [arc.x + arc.width*(3.9/4.0), arc.y + (arc.height / 2.0)]
-      
-      _(arc.contain?(point)).must_equal false
-    end
-    
-    it 'does not contain point in center of chord type arc' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 145)
-      point = [arc.x + arc.width / 2.0, arc.y + arc.height / 2.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point within bounding box with chord type circle' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [3.0, 4.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point outside bounding box with chord type circle' do
-      arc = PerfectShape::Arc.new(type: :chord, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [1.0, 2.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'contains point with open type circle' do
-      arc = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [arc.x + arc.width / 2.0, arc.y + arc.height / 2.0]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-
-    it 'contains point with open type arc' do
-      arc = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50.5, height: 60.75, start: 45, extent: 270)
-      point = [arc.x + arc.width*3/4.0, arc.y + (arc.height / 2.0)]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-
-    it 'does not contain point within bounding box with open type arc' do
-      arc = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 67, height: 46, start: 45, extent: 270)
-      point = [arc.x + arc.width*(3.9/4.0), arc.y + (arc.height / 2.0)]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point in center of open type arc' do
-      arc = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 145)
-      point = [arc.x + arc.width / 2.0, arc.y + arc.height / 2.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point within bounding box with open type circle' do
-      arc = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [3.0, 4.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point outside bounding box with open type circle' do
-      arc = PerfectShape::Arc.new(type: :open, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [1.0, 2.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'contains point with pie type circle' do
-      arc = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [arc.x + arc.width / 2.0, arc.y + arc.height / 2.0]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-
-    it 'contains point in center of pie type arc' do
-      arc = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 145)
-      point = [arc.x + arc.width / 2.0, arc.y + arc.height / 2.0]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-
-    it 'contains point with pie type arc' do
-      arc = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 145)
-      point = [arc.x + arc.width / 2.0 + (arc.width / 4.0), arc.y + (arc.height / 2.0) - (arc.height / 4.0)]
-
-      _(arc).must_be :contain?, point
-      _(arc.contain?(point)).must_equal arc.contain?(*point)
-    end
-
-    it 'does not contain point within bounding box with pie type arc' do
-      arc = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 145)
-      point = [arc.x + (arc.width / 2.0) - (arc.width / 4.0), arc.y + arc.height / 2.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point within bounding box with pie type circle' do
-      arc = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [3.0, 4.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-
-    it 'does not contain point outside bounding box with pie type circle' do
-      arc = PerfectShape::Arc.new(type: :pie, x: 2, y: 3, width: 50.5, height: 60.75, start: 0, extent: 360)
-      point = [1.0, 2.0]
-
-      _(arc.contain?(point)).must_equal false
-    end
-  end
-end

data/test/lib/perfect_shape/test_math.rb

@@ -1,76 +0,0 @@
-require 'puts_debuggerer'
-require 'minitest/autorun'
-
-require_relative '../../../lib/perfect-shape'
-
-describe PerfectShape do
-  describe PerfectShape::Math do
-    describe '#ieee754_remainder' do
-      it 'returns a negative number rounding ceiling' do
-        result = PerfectShape::Math.ieee754_remainder(7.5, 4.5)
-        
-        _(result).must_equal -1.5
-      end
-      
-      it 'returns a positive number rounding floor' do
-        result = PerfectShape::Math.ieee754_remainder(7.5, 3.5)
-        
-        _(result).must_equal 0.5
-      end
-      
-      it 'returns a positive number rounding halfway to floor even number' do
-        result = PerfectShape::Math.ieee754_remainder(5, 10)
-        
-        _(result).must_equal 5
-      end
-      
-      it 'returns a negative number rounding halfway to ceiling even number' do
-        result = PerfectShape::Math.ieee754_remainder(15, 10)
-        
-        _(result).must_equal -5
-      end
-      
-      it 'returns NaN for x=NaN' do
-        result = PerfectShape::Math.ieee754_remainder(Float::NAN, 10)
-
-        _(result).must_be :nan?
-      end
-      
-      it 'returns NaN for x=Infinity' do
-        result = PerfectShape::Math.ieee754_remainder(Float::INFINITY, 10)
-
-        _(result).must_be :nan?
-      end
-      
-      it 'returns NaN for y=NaN' do
-        result = PerfectShape::Math.ieee754_remainder(10, Float::NAN)
-
-        _(result).must_be :nan?
-      end
-      
-      it 'returns NaN for y=0' do
-        result = PerfectShape::Math.ieee754_remainder(10, 0)
-
-        _(result).must_be :nan?
-      end
-      
-      it 'returns NaN for y=+0.0' do
-        result = PerfectShape::Math.ieee754_remainder(10, 0.0)
-
-        _(result).must_be :nan?
-      end
-      
-      it 'returns NaN for y=-0.0' do
-        result = PerfectShape::Math.ieee754_remainder(10, -0.0)
-
-        _(result).must_be :nan?
-      end
-      
-      it 'returns x for y=Infinity' do
-        result = PerfectShape::Math.ieee754_remainder(10, Float::INFINITY)
-
-        _(result).must_equal 10
-      end
-    end
-  end
-end