perfect-shape 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a7fef31137e74569d2a21ccb631fc968b0d1b78897d85a67f958c27833b910
-  data.tar.gz: 2335d8343628c9b599ea20a25c83a8986ebdd45a9fcdfd027312ccf05d44bd0f
+  metadata.gz: 5f13ff7665704c6183553e3ba4391c1890b9ac9846177e8c31226689da7a13bf
+  data.tar.gz: 427d591daa1567bd4336aef61b35423cf63a8c41d9b8e9d7d3099b07db14ec41
 SHA512:
-  metadata.gz: 62a9db0050089a036fda899a076e8b5467519e03208a39f3da7faa11e940124c3b71738a3c6ed02bd2b15fc64723e8e851c844e63a727196200ab698f4f3c2fb
-  data.tar.gz: 16ec103325e93f584f3c4831951da95e4f92e6489a20dfd23ced5ce6c05f7e9e508fd824b5f3daffd4b98f3b9a3fd6f26ec3d941cd111197bba0d043c5f26827
+  metadata.gz: 87314aced3ca151bdefcf6e23af5ba3c3b340503d0b194c93e4b46cce2d1f7375fe79edecc588d394ccfcb7d915282dde45c6eb1f7c7ad8e8e22608876dd05ad
+  data.tar.gz: ad32f360bc0d2a3bab95b826a7946dc81f6fa0900c29fabbe93a67d238d0b449adc3d46ec26324bdfb9f3a3d61373192cc27b5ffa169c103dfcf1865dede58e5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.0.3
+
+- `PerfectShape::Square`
+- `PerfectShape::Square#contain?(x_or_point, y=nil)`
+
 ## 0.0.2
 
 - `PerfectShape::Rectangle`

data/README.md

@@ -1,4 +1,4 @@
-# Perfect Shape 0.0.2
+# Perfect Shape 0.0.3
 ## 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.2
+gem install perfect-shape -v 0.0.3
 ```
 
 Or include in Bundler `Gemfile`:
 
 ```ruby
-gem 'perfect-shape', '~> 0.0.2'
+gem 'perfect-shape', '~> 0.0.3'
 ```
 
 And, run:
@@ -47,7 +47,17 @@ bundle
 - `#y`: top-left y
 - `#width`: width
 - `#height`: height
-- `#contain?(x_or_point, y=nil)`: checks if point inside
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
+
+### `PerfectShape::Square`
+
+- `::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)
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ### `PerfectShape::Arc`
 
@@ -58,7 +68,7 @@ bundle
 - `#height`: height of arc
 - `#start`: start angle in degrees
 - `#extent`: extent angle in degrees
-- `#contain?(x_or_point, y=nil)`: checks if point is in arc
+- `#contain?(x_or_point, y=nil)`: checks if point is inside
 
 ## Process
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/perfect_shape/rectangle.rb

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

data/lib/perfect_shape/square.rb

@@ -0,0 +1,58 @@
+# 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/rectangle'
+
+module PerfectShape
+  class Square < Rectangle
+    MESSAGE_WIDTH_AND_HEIGHT_AND_LENGTH_NOT_EQUAL = 'Square width, height, and length must all be equal if more than one is specified; or otherwise keep only one of them in arguments!'
+  
+    attr_reader :length
+    
+    # Constructs with x, y, length (optionally width or height can be passed as alias for length)
+    def initialize(x: 0, y: 0, length: nil, width: nil, height: nil)
+      raise MESSAGE_WIDTH_AND_HEIGHT_AND_LENGTH_NOT_EQUAL if (length && width && length != width) || (length && height && length != height) || (width && height && width != height)
+      length ||= width || height || 1
+      super(x: x, y: y, width: length, height: length)
+    end
+    
+    # Sets length, normalizing to BigDecimal
+    def length=(value)
+      @length = BigDecimal(value.to_s)
+    end
+    
+    def width=(value)
+      self.length = value
+    end
+    
+    def height=(value)
+      self.length = value
+    end
+    
+    def width
+      length
+    end
+    
+    def height
+      length
+    end
+  end
+end

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.2 ruby lib
+# stub: perfect-shape 0.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "perfect-shape".freeze
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   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-11"
+  s.date = "2021-12-13"
   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 = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/perfect_shape/rectangle.rb",
     "lib/perfect_shape/rectangular_shape.rb",
     "lib/perfect_shape/shape.rb",
+    "lib/perfect_shape/square.rb",
     "perfect-shape.gemspec"
   ]
   s.homepage = "http://github.com/AndyObtiva/perfect-shape".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect-shape
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -105,6 +105,7 @@ files:
 - lib/perfect_shape/rectangle.rb
 - lib/perfect_shape/rectangular_shape.rb
 - lib/perfect_shape/shape.rb
+- lib/perfect_shape/square.rb
 - perfect-shape.gemspec
 homepage: http://github.com/AndyObtiva/perfect-shape
 licenses: