perfect-shape 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 934071723ece0f7ebe64e6e67880b5a1f4ec6781517d2ee2a7dea70ceae4a9be
-  data.tar.gz: d436da8745d7f4d971a7df04b5d54701e6e89abb9f8624273f79a6ac1d28ea77
+  metadata.gz: 373846069228dba8331891ba808511bfdb306bb8e3e29fad2cf053ab6c69fbaf
+  data.tar.gz: ccbc6e998e1f9809ebebd126ed6c613076fc8ad92cea012c08796e8e129ead28
 SHA512:
-  metadata.gz: bcea5c4c02f2e056c0e18a857404bbef4b411420c2c3a7e438a2f122df90a30466979c60cc7804c61b5d454ed2879cd81fd1fc750360839393c20a4561aebce6
-  data.tar.gz: c321b5b1697b28e9608c11d4bc5e04038c3e269df311b9c7263e468c6f952c60bec6ecf4244ff044eb8fb33cf68462e9d362326962c0473bbd72150847181e0e
+  metadata.gz: 66d9b3a6420a142bc35eaf1dbf80536f743b713eec9dc509764d8bc4dc87d528e214703e24c256977f38263df55cac715db8c6f1366c3d7a05d97fd0d892722c
+  data.tar.gz: 41c7ea46f7f9607e889f9ec04187a286333e593af6012099b74b19593806ae14e1b9d01e406bc1a4efa2e21035a096b0ca10ba53d9f74ab51721fd50a5ed44c5

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.10
+
+- `PerfectShape::Point`
+- `PerfectShape::Point#point_distance`
+- `PerfectShape::Point#contain?(x_or_point, y=nil, distance: 0)`
+- Refactor `PerfectShape::Point`,`PerfectShape::RectangularShape` to include shared `PerfectShape::PointLocation`
+
 ## 0.0.9
 
 - `PerfectShape::Line#contain?(x_or_point, y=nil, distance: 0)` (add a distance tolerance fuzz factor option)

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.0.9
+# Perfect Shape 0.0.10
 ## 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.9
+gem install perfect-shape -v 0.0.10
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.9'
+gem 'perfect-shape', '~> 0.0.10'
 ```
 
 And, run:
@@ -54,6 +54,16 @@ Class
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height just as those of shape
 - `#normalize_point(x_or_point, y = nil)`: normalizes point into an `Array` of (x,y) coordinates
 
+### `PerfectShape::PointLocation`
+
+Module
+
+- `#initialize(x: 0, y: 0)`: initializes a point location, usually representing the top-left point in a shape
+- `#x`: top-left x
+- `#y`: top-left y
+- `#min_x`: min x (x by default)
+- `#min_y`: min y (y by default)
+
 ### `PerfectShape::RectangularShape`
 
 Module
@@ -71,6 +81,30 @@ Module
 - `#center_y`: center y
 - `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
 
+### `PerfectShape::Point`
+
+Class
+
+Extends `PerfectShape::Shape`
+
+![point](images/point.png)
+
+Points are simply represented by an `Array` of (x,y) coordinates when used within other shapes, but when needing point-specific operations like `point_distance`, the `PerfectShape::Point` class can come in handy.
+
+- `::point_distance(x, y, px, py)`: Returns the distance from a point to another point
+- `::new(x_or_point=0, y=0, x: nil, y: nil)`: constructs a point with (x,y) pair whether specified as `Array` of (x,y) pair, flat `x,y` args, or `x:, y:` kwargs.
+- `#min_x`: min x (always x)
+- `#min_y`: min y (always y)
+- `#max_x`: max x (always x)
+- `#max_y`: max y (always y)
+- `#width`: width (always 0)
+- `#height`: height (always 0)
+- `#center_x`: center x (always x)
+- `#center_y`: center y (always y)
+- `#bounding_box`: bounding box is a rectangle with x = min x, y = min y, and width/height of shape
+- `#contain?(x_or_point, y=nil, distance: 0)`: checks if point matches self, with a distance tolerance (0 by default). Distance tolerance provides a fuzz factor that for example enables GUI users to mouse-click-select a point shape in a GUI more successfully.
+- `#point_distance(x_or_point, y=nil)`: Returns the distance from a point to another point
+
 ### `PerfectShape::Line`
 
 Class

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/lib/perfect_shape/arc.rb

@@ -135,7 +135,7 @@ module PerfectShape
       @height = nil
     end
     
-    # Checks if arc contains point denoted by point (two-number Array or x, y args)
+    # Checks if arc contains 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.

data/lib/perfect_shape/ellipse.rb

@@ -55,7 +55,7 @@ module PerfectShape
       end
     end
     
-    # Checks if ellipse contains point denoted by point (two-number Array or x, y args)
+    # Checks if ellipse contains 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.

data/lib/perfect_shape/line.rb

@@ -186,21 +186,20 @@ module PerfectShape
     
     include MultiPoint
     
-    # Checks if polygon contains point denoted by point (two-number Array or x, y args)
-    # using the Ray Casting Algorithm (aka Even-Odd Rule): https://en.wikipedia.org/wiki/Point_in_polygon
+    # Checks if line contains point (two-number Array or x, y args), with distance tolerance (0 by default)
     #
     # @param x The X coordinate of the point to test.
     # @param y The Y coordinate of the point to test.
+    # @param distance The distance from line to tolerate (0 by default)
     #
     # @return {@code true} if the point lies within the bound of
-    # the polygon, {@code false} if the point lies outside of the
-    # polygon's bounds.
+    # the line, {@code false} if the point lies outside of the
+    # line's bounds.
     def contain?(x_or_point, y = nil, distance: 0)
       x, y = normalize_point(x_or_point, y)
       return unless x && y
       distance = BigDecimal(distance.to_s)
-      # TODO implement contain?(point) with a fuzz factor to enable successfully selecting a line in a GUI application
-      Line.point_segment_distance(points[0][0], points[0][1], points[1][0], points[1][1], x, y) <= distance
+      point_segment_distance(x, y) <= distance
     end
     
     def point_segment_distance(x_or_point, y = nil)

data/lib/perfect_shape/multi_point.rb

@@ -55,13 +55,5 @@ module PerfectShape
     def max_y
       points.map(&:last).max
     end
-    
-    def width
-      max_x - min_x if min_x && max_x
-    end
-    
-    def height
-      max_y - min_y if min_y && max_y
-    end
   end
 end

data/lib/perfect_shape/point.rb

@@ -0,0 +1,81 @@
+# 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/point_location'
+
+module PerfectShape
+  class Point < Shape
+    class << self
+      def point_distance(x, y, px, py)
+        x = BigDecimal(x.to_s)
+        y = BigDecimal(y.to_s)
+        px = BigDecimal(px.to_s)
+        py = BigDecimal(py.to_s)
+        BigDecimal(Math.sqrt((px - x)**2 + (py - y)**2).to_s)
+      end
+    end
+    
+    include PointLocation
+    
+    def initialize(x_or_point = nil, y_arg = nil, x: nil, y: nil)
+      if x_or_point.is_a?(Array)
+        x, y = x_or_point
+        super(x: x, y: y)
+      elsif x_or_point && y_arg
+        super(x: x_or_point, y: y_arg)
+      else
+        x ||= 0
+        y ||= 0
+        super(x: x, y: y)
+      end
+    end
+    
+    def max_x
+      x
+    end
+    
+    def max_y
+      y
+    end
+    
+    # Checks if points match, with distance tolerance (0 by default)
+    #
+    # @param x The X coordinate of the point to test.
+    # @param y The Y coordinate of the point to test.
+    # @param distance The distance from point to tolerate (0 by default)
+    #
+    # @return {@code true} if the point is close enough within distance tolerance,
+    # {@code false} if the point is too far.
+    def contain?(x_or_point, y = nil, distance: 0)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      distance = BigDecimal(distance.to_s)
+      point_distance(x, y) <= distance
+    end
+    
+    def point_distance(x_or_point, y = nil)
+      x, y = normalize_point(x_or_point, y)
+      return unless x && y
+      Point.point_distance(self.x, self.y, x, y)
+    end
+  end
+end

data/lib/perfect_shape/point_location.rb

@@ -0,0 +1,53 @@
+# 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
+  module PointLocation
+    attr_reader :x, :y
+    
+    # Calls super before setting x,y (default: 0,0)
+    def initialize(x: 0, y: 0)
+      super()
+      self.x = x
+      self.y = y
+    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
+    
+    # Returns x by default. Subclasses may override.
+    def min_x
+      x
+    end
+    
+    # Returns y by default. Subclasses may override.
+    def min_y
+      y
+    end
+  end
+end

data/lib/perfect_shape/polygon.rb

@@ -27,7 +27,7 @@ module PerfectShape
   class Polygon < Shape
     include MultiPoint
     
-    # Checks if polygon contains point denoted by point (two-number Array or x, y args)
+    # Checks if polygon contains point (two-number Array or x, y args)
     # using the Ray Casting Algorithm (aka Even-Odd Rule): https://en.wikipedia.org/wiki/Point_in_polygon
     #
     # @param x The X coordinate of the point to test.

data/lib/perfect_shape/rectangle.rb

@@ -28,7 +28,7 @@ module PerfectShape
     include RectangularShape
     include Equalizer.new(:x, :y, :width, :height)
         
-    # Checks if rectangle contains point denoted by point (two-number Array or x, y args)
+    # Checks if rectangle contains 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.

data/lib/perfect_shape/rectangular_shape.rb

@@ -19,31 +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/point_location'
+
 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
+    include PointLocation
+    
+    attr_reader :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
+      super(x: x, 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)
@@ -54,14 +46,6 @@ module PerfectShape
       @height = BigDecimal(value.to_s)
     end
     
-    def min_x
-      @x
-    end
-    
-    def min_y
-      @y
-    end
-    
     def max_x
       @x + width if @x && width
     end

data/lib/perfect_shape/shape.rb

@@ -38,12 +38,16 @@ module PerfectShape
     def max_y
     end
     
-    # Subclasses must implement
+    # Default implementation is max_x - min_x
+    # Subclasses can override
     def width
+      max_x - min_x if max_x && min_x
     end
     
-    # Subclasses must implement
+    # Default implementation is max_y - min_y
+    # Subclasses can override
     def height
+      max_y - min_y if max_y && min_y
     end
     
     # center_x is min_x + width/2.0 by default

data/perfect-shape.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: perfect-shape 0.0.9 ruby lib
+# stub: perfect-shape 0.0.10 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.9"
+  s.version = "0.0.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -31,6 +31,8 @@ Gem::Specification.new do |s|
     "lib/perfect_shape/line.rb",
     "lib/perfect_shape/math.rb",
     "lib/perfect_shape/multi_point.rb",
+    "lib/perfect_shape/point.rb",
+    "lib/perfect_shape/point_location.rb",
     "lib/perfect_shape/polygon.rb",
     "lib/perfect_shape/rectangle.rb",
     "lib/perfect_shape/rectangular_shape.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Andy Maleh
@@ -120,6 +120,8 @@ files:
 - lib/perfect_shape/line.rb
 - lib/perfect_shape/math.rb
 - lib/perfect_shape/multi_point.rb
+- lib/perfect_shape/point.rb
+- lib/perfect_shape/point_location.rb
 - lib/perfect_shape/polygon.rb
 - lib/perfect_shape/rectangle.rb
 - lib/perfect_shape/rectangular_shape.rb