perfect-shape 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b287e3d8aee766314feeccc80abe127dc1ec6e8d169af61e8c6efc1097a2b5c2
-  data.tar.gz: 96b934dde2686223634244d6ff550b578c15971b2198cb94fb0cec3ded97e06c
+  metadata.gz: 81aba6992bb9cb98b1ce01764cb4cd0ca8e88690c56066e8282b4c0876421925
+  data.tar.gz: c63f14e43dfa8adff2bd525a77ca25ded5d1381953abb4a728770b22dab43323
 SHA512:
-  metadata.gz: 6743fed8d87b2ceb4bd69b91fd2ecc3b6655eca986e4a67c2aa755d53f29de60ffbb6fcc539fc45e480f55e06c176cad1885dd3c4af0330a42218b8291837763
-  data.tar.gz: b3669ef0aabb19553bad2dc51cdca4b1c188d05cca41c73c13570f0faff19d03d373f7727c423531700cd85e562b340003995558f2c7e4c8c195947e44b232fa
+  metadata.gz: 6ff01e388f4fadc337792f45ddfc598fecaeb3816fe13d04f5db4a13ecc78c7e978e2ef9683e33e32711bda62373c77dd1f5f4c07d69cfc23e4867bfbba9ccca
+  data.tar.gz: b32a4c65a4101ffa61cdab257fa1af05d59e7ee1f8e12ac8598dbad92a32dd33299bda92add7781e3f9028278051ebda36d9164cde116d79fc70f6d8b297f8ed

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Change Log
 
+## 0.0.6
+
+- `PerfectShape::Circle`
+- `PerfectShape::Circle#contain?(x_or_point, y=nil)`
+
 ## 0.0.5
 
 - `PerfectShape::Ellipse`
-- `PerfectShape::Ellipse#contain?`
+- `PerfectShape::Ellipse#contain?(x_or_point, y=nil)`
 
 ## 0.0.4
 

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.0.5
+# Perfect Shape 0.0.6
 ## 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.5
+gem install perfect-shape -v 0.0.6
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.5'
+gem 'perfect-shape', '~> 0.0.6'
 ```
 
 And, run:
@@ -32,17 +32,42 @@ bundle
 
 ### `PerfectShape::Math`
 
+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)
@@ -58,6 +83,7 @@ Includes `PerfectShape::RectangularShape`
 
 ### `PerfectShape::Square`
 
+Class
 Extends `PerfectShape::Rectangle`
 
 ![square](images/square.png)
@@ -74,6 +100,8 @@ Extends `PerfectShape::Rectangle`
 
 ### `PerfectShape::Arc`
 
+Class
+Extends `PerfectShape::Shape`
 Includes `PerfectShape::RectangularShape`
 
 Arcs can be of type `:open`, `:chord`, or `:pie`
@@ -84,10 +112,10 @@ Open Arc | Chord Arc | Pie Arc
 
 - `::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
+- `#x`: top-left x
+- `#y`: top-left y
+- `#width`: width
+- `#height`: height
 - `#start`: start angle in degrees
 - `#extent`: extent angle in degrees
 - `#center_x`: center x
@@ -98,15 +126,16 @@ Open Arc | Chord Arc | Pie Arc
 
 ### `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 of arc
-- `#y`: top-left y of arc
-- `#width`: width of arc
-- `#height`: height of arc
+- `#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
@@ -116,6 +145,29 @@ Extends `PerfectShape::Arc`
 - `#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
 
 [Glimmer Process](https://github.com/AndyObtiva/glimmer/blob/master/PROCESS.md)
@@ -133,7 +185,7 @@ Extends `PerfectShape::Arc`
 
 [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.5
+0.0.6

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/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/perfect-shape.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.0.5 ruby lib
+# stub: perfect-shape 0.0.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.5"
+  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-15"
+  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 = [
@@ -26,6 +26,7 @@ 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",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -100,6 +100,7 @@ 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