geom2d 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6b6f6aa211080908b25652229199e279f5785b45
-  data.tar.gz: a3ea69fb6a9b81edbf18455ba6002dcca224f5ff
+SHA256:
+  metadata.gz: 043eb93cd10b8d15d014db835f2ecaed3ec495a600b9c59dcb10f86335ceb22e
+  data.tar.gz: 97dfa82e0c56cb6e2a02dc3d9e3b2df2a8402ee9923cc7caf13ee75927a71e41
 SHA512:
-  metadata.gz: 126e02e2e6a2b7ae9a4c0d78a9a48fbdedf3f6a7304d4cb67eee2b3da9d5160512d69ee99c1227dc3939eb4c883b19553c4a75da478158722cdb94f7713b2cf4
-  data.tar.gz: 3e10879164f0785613aec700fb16cd4d1233605518166dd473b24e60e30212be18bf586dc1a14829b218964631febdd0f3c2add5410d489dfa51de65ae6ebe16
+  metadata.gz: e507dc3dab4bb5cc4b47e7067a74c89fa11622fa98aefb204a9953d8a2bb84b36caac9e810276723f086b01f6a921de7a99290f5f85d04bc965e6017d56bf8cb
+  data.tar.gz: daab0a906fa57068d9444c004ac06839fcb2fa1935c08042d8364e68bb79c23051df440e1cde2600e9ac8be939fb9caf3ba68fc7fe529b98588e27be2f4263cc

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.4.0 - 2023-07-31
+
+### Added
+
+* Class Geom2D::Rectangle for a more compact rectangle representation
+
+### Changed
+
+* Require at least Ruby 2.6
+
+
 ## 0.3.1 - 2019-11-27
 
 ### Fixed

data/CONTRIBUTERS

@@ -1,3 +1,3 @@
   Count Name
 ======= ====
-     21 Thomas Leitner <t_leitner@gmx.at>
+     26 Thomas Leitner <t_leitner@gmx.at>

data/LICENSE

@@ -1,5 +1,5 @@
 geom2d - 2D Geometry Objects and Algorithms
-Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the

data/README.md

@@ -7,8 +7,8 @@ by Bézier curves.
 
 ## License
 
-Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>, licensed under the MIT - see the **LICENSE**
-file.
+Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>, licensed under the MIT - see the
+**LICENSE** file.
 
 
 ## Features
@@ -18,6 +18,7 @@ file.
   * Segment
   * Polygon
   * PolygonSet
+  * Rectangle
   * Polyline (TODO)
   * Rectangle (TODO)
   * QuadraticCurve (TODO)

data/Rakefile

@@ -51,8 +51,8 @@ namespace :dev do
     s.files = PKG_FILES.to_a
 
     s.require_path = 'lib'
-    s.required_ruby_version = '>= 2.4'
-    s.add_development_dependency('rubocop', '~> 0.58', '>= 0.58.2')
+    s.required_ruby_version = '>= 2.6'
+    s.add_development_dependency('rubocop', '~> 1.0', '>= 1.41.1')
 
     s.author = 'Thomas Leitner'
     s.email = 't_leitner@gmx.at'
@@ -78,7 +78,7 @@ namespace :dev do
     statement = <<~STATEMENT
       #--
       # geom2d - 2D Geometric Objects and Algorithms
-      # Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+      # Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
       #
       # This software may be modified and distributed under the terms
       # of the MIT license.  See the LICENSE file for details.
@@ -91,7 +91,7 @@ namespace :dev do
         inserted = true
         puts "Updating file #{file}"
         old = File.read(file)
-        old.sub!(/^#--.*?\n#\+\+\n|\A/m, statement)
+        old.sub!(/^#--.*?\n#\+\+\n/m, statement)
         File.write(file, old)
       end
     end

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/geom2d/algorithms/polygon_operation.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -240,17 +240,19 @@ module Geom2D
       # Returns +true+ if the operation is a trivial one, e.g. if one polygon set is empty.
       def trivial_operation(subject_bb, clipping_bb)
         if @subject.nr_of_contours * @clipping.nr_of_contours == 0
-          if @operation == :difference
+          case @operation
+          when :difference
             @result = @subject
-          elsif @operation == :union || @operation == :xor
+          when :union, :xor
             @result = (@subject.nr_of_contours == 0 ? @clipping : @subject)
           end
           true
         elsif subject_bb.min_x > clipping_bb.max_x || clipping_bb.min_x > subject_bb.max_x ||
             subject_bb.min_y > clipping_bb.max_y || clipping_bb.min_y > subject_bb.max_y
-          if @operation == :difference
+          case @operation
+          when :difference
             @result = @subject
-          elsif @operation == :union || @operation == :xor
+          when :union, :xor
             @result = @subject + @clipping
           end
           true

data/lib/geom2d/algorithms.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.

data/lib/geom2d/bounding_box.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -75,7 +75,7 @@ module Geom2D
       [@min_x, @min_y, @max_x, @max_y]
     end
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "BBox[#{min_x}, #{min_y}, #{max_x}, #{max_y}]"
     end
 

data/lib/geom2d/point.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -135,7 +135,7 @@ module Geom2D
     end
     alias to_a to_ary
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "(#{x}, #{y})"
     end
     alias to_s inspect

data/lib/geom2d/polygon.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -96,7 +96,7 @@ module Geom2D
     end
     alias to_a to_ary
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "Polygon#{@vertices}"
     end
     alias to_s inspect

data/lib/geom2d/polygon_set.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -57,7 +57,7 @@ module Geom2D
       result
     end
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "PolygonSet#{@polygons}"
     end
     alias to_s inspect

data/lib/geom2d/rectangle.rb

@@ -0,0 +1,100 @@
+#--
+# geom2d - 2D Geometric Objects and Algorithms
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+#++
+# -*- frozen_string_literal: true -*-
+#
+#--
+# geom2d - 2D Geometric Objects and Algorithms
+# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+#++
+
+require 'geom2d'
+
+module Geom2D
+
+  # Represents an axis aligned rectangle.
+  class Rectangle
+
+    # The x-coordinate of the bottom-left corner of the rectangle.
+    attr_reader :x
+
+    # The y-coordinate of the bottom-left corner of the rectangle.
+    attr_reader :y
+
+    # The width of the rectangle.
+    attr_reader :width
+
+    # The height of the rectangle.
+    attr_reader :height
+
+    # Creates a new Rectangle object, with (x, y) specifying the bottom-left corner of the rectangle.
+    def initialize(x, y, width, height)
+      @x = x
+      @y = y
+      @width = width
+      @height = height
+    end
+
+    # Returns one since a rectangle object is a single polygon.
+    def nr_of_contours
+      1
+    end
+
+    # Returns four since a rectangle has four vertices.
+    def nr_of_vertices
+      4
+    end
+
+    # Calls the given block once for each corner of the rectangle.
+    #
+    # If no block is given, an Enumerator is returned.
+    def each_vertex(&block)
+      return to_enum(__method__) unless block_given?
+      vertices.each(&block)
+    end
+
+    # Calls the given block once for each segment of the rectangle.
+    #
+    # If no block is given, an Enumerator is returned.
+    def each_segment
+      return to_enum(__method__) unless block_given?
+
+      v = vertices
+      v.each_cons(2) {|v1, v2| yield(Geom2D::Segment.new(v1, v2)) }
+      yield(Geom2D::Segment.new(v[-1], v[0]))
+    end
+
+    # Returns the BoundingBox of this rectangle.
+    def bbox
+      BoundingBox.new(x, y, x + width, y + height)
+    end
+
+    # Returns +true+ since the vertices of the rectangle are always ordered in a counterclockwise
+    # fashion.
+    def ccw?
+      true
+    end
+
+    def inspect # :nodoc:
+      "Rectangle[(#{@x},#{@y}),width=#{@width},height=#{@height}]"
+    end
+    alias to_s inspect
+
+    private
+
+    # Returns an array with the four corners of the rectangle.
+    def vertices
+      [Geom2D::Point(x, y), Geom2D::Point(x + width, y),
+       Geom2D::Point(x + width, y + height), Geom2D::Point(x, y + height)]
+    end
+
+  end
+
+end

data/lib/geom2d/segment.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -197,7 +197,7 @@ module Geom2D
       start_point == other.start_point && end_point == other.end_point
     end
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "Segment[#{start_point}-#{end_point}]"
     end
     alias to_s inspect

data/lib/geom2d/utils/sorted_list.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -40,7 +40,7 @@ module Geom2D
       # Yields each value in sorted order.
       #
       # If no block is given, an enumerator is returned.
-      def each(&block) #:yield: value
+      def each(&block) # :yield: value
         @list.each(&block)
       end
 
@@ -76,7 +76,7 @@ module Geom2D
         @list.pop
       end
 
-      def inspect #:nodoc:
+      def inspect # :nodoc:
         "#<#{self.class.name}:0x#{object_id.to_s(16).rjust(0.size * 2, '0')} #{to_a}>"
       end
 

data/lib/geom2d/utils.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.

data/lib/geom2d/version.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -11,6 +11,6 @@
 module Geom2D
 
   # The version of Geom2D
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 
 end

data/lib/geom2d.rb

@@ -2,7 +2,7 @@
 #
 #--
 # geom2d - 2D Geometric Objects and Algorithms
-# Copyright (C) 2018 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2018-2023 Thomas Leitner <t_leitner@gmx.at>
 #
 # This software may be modified and distributed under the terms
 # of the MIT license.  See the LICENSE file for details.
@@ -19,6 +19,7 @@ module Geom2D
   autoload(:Segment, 'geom2d/segment')
   autoload(:Polygon, 'geom2d/polygon')
   autoload(:PolygonSet, 'geom2d/polygon_set')
+  autoload(:Rectangle, 'geom2d/rectangle')
 
   autoload(:BoundingBox, 'geom2d/bounding_box')
   autoload(:Algorithms, 'geom2d/algorithms')
@@ -67,4 +68,12 @@ module Geom2D
     PolygonSet.new(polygons)
   end
 
+  # Creates a Rectangle from the given bottom-left point (x, y) and the provided +width+ and
+  # +height+.
+  #
+  # See: Rectangle.new
+  def self.Rectangle(x, y, width, height)
+    Rectangle.new(x, y, width, height)
+  end
+
 end

data/test/geom2d/test_bounding_box.rb

@@ -21,7 +21,7 @@ describe Geom2D::BoundingBox do
     end
 
     it "fails if an invalid argument is given" do
-      assert_raises(ArgumentError) { @bbox + "string" }
+      assert_raises(ArgumentError) { @bbox + :string }
     end
   end
 

data/test/geom2d/test_point.rb

@@ -66,7 +66,7 @@ describe Geom2D::Point do
     end
 
     it "fails if the argument class is invalid" do
-      assert_raises(ArgumentError) { @point + "str" }
+      assert_raises(ArgumentError) { @point + :test }
     end
   end
 

data/test/geom2d/test_rectangle.rb

@@ -0,0 +1,47 @@
+# -*- frozen_string_literal: true -*-
+
+require 'test_helper'
+require 'geom2d/rectangle'
+
+describe Geom2D::Rectangle do
+  before do
+    @rectangle = Geom2D::Rectangle(10, 20, 100, 50)
+  end
+
+  it "creates a rectangle using the bottom-left corner and its width and height" do
+    assert_equal(10, @rectangle.x)
+    assert_equal(20, @rectangle.y)
+    assert_equal(100, @rectangle.width)
+    assert_equal(50, @rectangle.height)
+  end
+
+  it "returns one for the number of contours" do
+    assert_equal(1, @rectangle.nr_of_contours)
+  end
+
+  it "returns four for the number of vertices" do
+    assert_equal(4, @rectangle.nr_of_vertices)
+  end
+
+  it "iterates over all corners of the rectangle" do
+    assert_equal([[10, 20], [110, 20], [110, 70], [10, 70]], @rectangle.each_vertex.to_a)
+  end
+
+  it "iterates over all four edges of the rectangle" do
+    segments = [Geom2D::Segment([10, 20], [110, 20]), Geom2D::Segment([110, 20], [110, 70]),
+                Geom2D::Segment([110, 70], [10, 70]), Geom2D::Segment([10, 70], [10, 20])]
+    assert_equal(segments, @rectangle.each_segment.to_a)
+  end
+
+  it "returns the bounding box" do
+    assert_equal([10, 20, 110, 70], @rectangle.bbox.to_a)
+  end
+
+  it "returns true when asked whether the corners are counterclockwise ordered" do
+    assert(@rectangle.ccw?)
+  end
+
+  it "returns a useful inspection string" do
+    assert_equal("Rectangle[(10,20),width=100,height=50]", @rectangle.inspect)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geom2d
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Thomas Leitner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,21 +16,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.58.2
-description: 
+        version: 1.41.1
+description:
 email: t_leitner@gmx.at
 executables: []
 extensions: []
@@ -49,6 +49,7 @@ files:
 - lib/geom2d/point.rb
 - lib/geom2d/polygon.rb
 - lib/geom2d/polygon_set.rb
+- lib/geom2d/rectangle.rb
 - lib/geom2d/segment.rb
 - lib/geom2d/utils.rb
 - lib/geom2d/utils/sorted_list.rb
@@ -59,6 +60,7 @@ files:
 - test/geom2d/test_point.rb
 - test/geom2d/test_polygon.rb
 - test/geom2d/test_polygon_set.rb
+- test/geom2d/test_rectangle.rb
 - test/geom2d/test_segment.rb
 - test/geom2d/utils/test_sorted_list.rb
 - test/test_helper.rb
@@ -66,7 +68,7 @@ homepage: https://geom2d.gettalong.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,16 +76,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Objects and Algorithms for 2D Geometry
 test_files: []