perfect-shape 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165108ad6899bfc0e001ba5ebbf2447a82e8173b03cdb3b08cf16b79f4287147
-  data.tar.gz: b2357efaa2e903edd66a212b06add8e6b3f6cec4a060f36b43eeb2f16bdb8072
+  metadata.gz: b287e3d8aee766314feeccc80abe127dc1ec6e8d169af61e8c6efc1097a2b5c2
+  data.tar.gz: 96b934dde2686223634244d6ff550b578c15971b2198cb94fb0cec3ded97e06c
 SHA512:
-  metadata.gz: ded5da995dd9517acf3987c18f1410b1704c23b349a082791fdae91dd3f63bab91df89d5aa0b7b63b67f8d699e86b98905f80f30ef741e8570252f321ed7f7b8
-  data.tar.gz: 33f27f98eef7fee0f370f7f9003b73b26b27fb0c5c596b9a325bef6566669be6710b4fab5f4ab67e2be9728470b0b08369079b0924ca89544813b3b386e31f7d
+  metadata.gz: 6743fed8d87b2ceb4bd69b91fd2ecc3b6655eca986e4a67c2aa755d53f29de60ffbb6fcc539fc45e480f55e06c176cad1885dd3c4af0330a42218b8291837763
+  data.tar.gz: b3669ef0aabb19553bad2dc51cdca4b1c188d05cca41c73c13570f0faff19d03d373f7727c423531700cd85e562b340003995558f2c7e4c8c195947e44b232fa

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 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`

data/README.md

@@ -1,8 +1,8 @@
-# Perfect Shape 0.0.4
+# 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 mouse click point in popular geometry shapes such as rectangle, square, arc (open, chord, and pie), 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.4
+gem install perfect-shape -v 0.0.5
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.4'
+gem 'perfect-shape', '~> 0.0.5'
 ```
 
 And, run:
@@ -43,6 +43,8 @@ bundle
 
 ### `PerfectShape::Rectangle`
 
+Includes `PerfectShape::RectangularShape`
+
 ![rectangle](images/rectangle.png)
 
 - `::new(x: 0, y: 0, width: 1, height: 1)`: constructs a rectangle
@@ -56,6 +58,8 @@ bundle
 
 ### `PerfectShape::Square`
 
+Extends `PerfectShape::Rectangle`
+
 ![square](images/square.png)
 
 - `::new(x: 0, y: 0, length: 1)`: constructs a square
@@ -70,6 +74,8 @@ bundle
 
 ### `PerfectShape::Arc`
 
+Includes `PerfectShape::RectangularShape`
+
 Arcs can be of type `:open`, `:chord`, or `:pie`
 
 Open Arc | Chord Arc | Pie Arc
@@ -77,6 +83,7 @@ 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
@@ -89,6 +96,26 @@ Open Arc | Chord Arc | Pie Arc
 - `#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)

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

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/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.4 ruby lib
+# stub: perfect-shape 0.0.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   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.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, 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.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,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/perfect-shape.rb",
     "lib/perfect_shape/arc.rb",
+    "lib/perfect_shape/ellipse.rb",
     "lib/perfect_shape/line.rb",
     "lib/perfect_shape/math.rb",
     "lib/perfect_shape/rectangle.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andy Maleh
@@ -83,9 +83,9 @@ dependencies:
 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, 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).
+  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,6 +100,7 @@ files:
 - VERSION
 - lib/perfect-shape.rb
 - lib/perfect_shape/arc.rb
+- lib/perfect_shape/ellipse.rb
 - lib/perfect_shape/line.rb
 - lib/perfect_shape/math.rb
 - lib/perfect_shape/rectangle.rb