slippy_tiles_scorer 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce623fd11c56fc5615043d62fd196810c7c0caccd5f9d9789dfaa864954ed2ee
-  data.tar.gz: 0b7296978405915b2ee53d79da2a8e8c0cc15445f2b71ce5e396ca5fc7af5a39
+  metadata.gz: 3a911e3fb4c9a3d30d90e52664a3619f2c208581a0a31ee938ab4c44444d9608
+  data.tar.gz: 8093375ef475c76b1c996b31335a7b151e850778c8cd9c285411b0d33926e7a7
 SHA512:
-  metadata.gz: 746ffc5f6d06857aec00c471b3c671612debe31c22a2cdb1d73b1da3583ba253008cbea5e886addf44961019cd2435db6eccb7f70086f182e3cfa3440247a88a
-  data.tar.gz: 7e6bacaaab5a06b40d0fee46a3494f436a96b04e042a90bae45ae567ab1860b99499999e66089a372be84d733ae4f15683316748ee1835604c3358acdb3b2da8
+  metadata.gz: ad02a2cbdda34c8976cdd4cea4a9d90c5c9b80afe3c77c55eec578f054de4c4d89272b1e10eaa47f253184ea96d4fa2716fc16873d7ae51dfe2bf836e47d61e4
+  data.tar.gz: c55a90cf772a57db236e2b182ac6853bc0137685ca92567c48883a1e897e05d5e0bb38bde02e50a63832793b117b1ba619c2bdf255530668fd51b4031d1d9d9d

data/.rubocop.yml

@@ -1,5 +1,6 @@
 require:
   - rubocop-rake
+plugins:
   - rubocop-performance
 
 AllCops:

data/CHANGELOG.md

@@ -1,15 +1,21 @@
 ## [Unreleased]
 
+- [#5](https://github.com/simonneutert/slippy_tiles_scorer/pull/5) - Reworks maximum-square detection with a sparse dynamic-programming algorithm. Adds validation for negative coordinates and minimum square sizes, and expands coverage for multiple and incomplete squares.
+- [#4](https://github.com/simonneutert/slippy_tiles_scorer/pull/4) - Runs a benchmark before running the tests.
+- [#3](https://github.com/simonneutert/slippy_tiles_scorer/pull/3) - 100 % test coverage: lines and branches. Adds a badge to the README. Adds gem release notes to the README.
+
 ## [0.0.3] - 2024-11-26
 
 - More tests, like a json file with test data.
 - The `Rakefile` can be used to run the tests and check the code style.
-- A CI pipeline runs the test suite and checks the code style for multiple Ruby versions >= v3.
+- A CI pipeline runs the test suite and checks the code style for multiple Ruby
+  versions >= v3.
 - Rubocop was configured and some plugins were added to the `.rubocop.yml` file.
 
 ## [0.0.2] - 2024-11-26
 
-- The result `Hash` of `#clusters` under the key `:clusters` is now an array of `[x, y]` and `x` and `y` being integer values.
+- The result `Hash` of `#clusters` under the key `:clusters` is now an array of
+  `[x, y]` and `x` and `y` being integer values.
 
 ## [0.0.1] - 2024-11-25
 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Simon Neutert
+
+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.

data/README.md

@@ -1,10 +1,11 @@
 # SlippyTilesScorer
 
-> [!NOTE]  
-> This gem's API is not considered stable yet.
-> Things might change in the future.
+> [!NOTE]\
+> This gem's API is not considered stable yet. Things might change in the
+> future.
 
-[![Gem Version](https://badge.fury.io/rb/slippy_tiles_scorer.svg)](https://badge.fury.io/rb/slippy_tiles_scorer) \
+[![Gem Version](https://badge.fury.io/rb/slippy_tiles_scorer.svg)](https://badge.fury.io/rb/slippy_tiles_scorer)\
+![Coverage](https://github.com/simonneutert/slippy_tiles_scorer/blob/main/coverage_badge.svg)\
 [![Ruby](https://github.com/simonneutert/slippy_tiles_scorer/actions/workflows/main.yml/badge.svg)](https://github.com/simonneutert/slippy_tiles_scorer/actions/workflows/main.yml)
 
 Calculate scores of map tiles (x, y) on a map. The scores are total, (max)
@@ -12,6 +13,8 @@ clusters, and max squares.
 
 To experiment with that code, run `bin/console` for an interactive prompt.
 
+Supports Ruby >= 3.0, JRuby >= 9.4 and latest TruffleRuby (with GraalVM).
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -20,7 +23,8 @@ Install the gem and add to the application's Gemfile by executing:
 bundle add slippy_tiles_scorer
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If bundler is not being used to manage dependencies, install the gem by
+executing:
 
 ```bash
 gem install slippy_tiles_scorer
@@ -35,7 +39,7 @@ Find some examples below.
 A simple example of how to use the `TileScorer` class, when tinkering in a REPL.
 
 ```ruby
-require 'tile_scorer'
+require 'slippy_tiles_scorer'
 
 collection_of_tiles = Set.new
 collection_of_tiles.add([0, 0])
@@ -75,7 +79,8 @@ tile_scorer.max_squares(min_size: 4) # => {:size=>0, top_left_tile_x_y=>#<Set: {
 
 ### Optimized
 
-An more computationally optimized example of how to use the `TileScorer` class, when using the code in production.
+An more computationally optimized example of how to use the `TileScorer` class,
+when using the code in production.
 
 ```ruby
 ### OPTIMIZE COMPUTATION ###
@@ -101,10 +106,46 @@ puts max_squares # =>[{:size=>3, top_left_tile_x_y=>#<Set: {[0, 0]}>}]
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/simonneutert/slippy_tiles_scorer.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/simonneutert/slippy_tiles_scorer.
+
+## Release new Gem version
+
+To release a new version of the gem, follow these steps:
+
+### Pre-release
+
+1. Make sure the tests pass and coverage badge is updated: `$ bundle exec rake`.
+2. Update the version number in `lib/slippy_tiles_scorer/version.rb`.
+3. Run `$ bundle install`.
+4. Check the `README.md` for correctness.
+5. Make sure the `CHANGELOG.md` is up to date.
+6. All changes are committed and pushed to the main branch.
+
+### Release
+
+1. Checkout the main branch: `$ git checkout main`.
+2. Run the tests: `$ bundle exec rake` (just for safety).
+3. Run `$ bundle exec rake release`.
+
+### Post-release
+
+Still being on the main branch:
+
+1. Update the version number in `lib/slippy_tiles_scorer/version.rb` to the next
+   development version.
+2. Run `$ bundle install`.
+3. Commit the changes: `$ git commit -am "Bump version to vX.Y.Z"`.
+4. Push the changes: `$ git push`.

data/Rakefile

@@ -4,9 +4,14 @@ require "bundler/gem_tasks"
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+task default: %i[test rubocop copy_coverage]
 
 desc "Run tests"
 task :test do
   sh "ruby test_runner.rb"
 end
+
+desc "Copy coverage report to public"
+task :copy_coverage do
+  FileUtils.cp("coverage/coverage_badge_total.svg", "./coverage_badge.svg")
+end

data/Rakefile.alt-legacy

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: %i[test]
+
+desc "Run tests"
+task :test do
+  sh "ruby test_runner.rb"
+end

data/coverage_badge.svg

@@ -0,0 +1,35 @@
+<svg contentScriptType="text/ecmascript" contentStyleType="text/css" preserveAspectRatio="xMidYMid meet" version="1.0" height="20" width="120"
+  xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink">
+
+
+<linearGradient id="smooth" x2="0" y2="120">
+<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+<stop offset="1" stop-opacity=".1"/>
+</linearGradient>
+<clipPath id="round">
+<rect height="20" width="120" rx="3" fill="#fff"/>
+</clipPath>
+<g clip-path="url(#round)">
+<rect height="20" width="60" fill="#555"/>
+<rect x="60" height="20" width="60" fill="#cccc00"/>
+<rect height="20" width="120" fill="url(#smooth)"/>
+</g>
+<g fill="#fff" text-anchor="middle" font-family="Verdana,sans-serif" font-size="11">
+<text x="30" y="15" fill="#010101" fill-opacity="0.3">
+scov total
+</text>
+<text x="30" y="14">
+scov total
+</text>
+</g>
+<g fill="#fff" text-anchor="middle" font-family="Verdana,sans-serif" font-size="11">
+<text x="90" y="15" fill="#010101" fill-opacity="0.3">
+100%
+</text>
+<text x="90" y="14">
+100%
+</text>
+</g>
+
+</svg>

data/lib/slippy_tiles_scorer/cluster.rb

@@ -35,7 +35,7 @@ module SlippyTilesScorer
       todo = [start]
       broad_search!(todo, cluster)
 
-      @clusters.push(cluster) if cluster.size.positive?
+      @clusters.push(cluster)
       cluster
     end
 

data/lib/slippy_tiles_scorer/max_square.rb

@@ -3,105 +3,155 @@
 require "set"
 
 module SlippyTilesScorer
-  # finds the maximum square in a collection/tiles_x_y of points (x, y)
+  # Finds the maximum fully-filled square in a collection of x/y tiles.
   class MaxSquare
-    attr_accessor :tiles_x_y
+    attr_reader :tiles_x_y
 
     def initialize(tiles_x_y: Set.new)
+      self.tiles_x_y = tiles_x_y
+    end
+
+    def tiles_x_y=(tiles_x_y)
       @tiles_x_y = tiles_x_y
-      @tiles_lut = nil
+      @square_scores = nil
     end
 
-    # @param min_size [Integer] The minimum size of the square, should be 3 or greater.
-    #   As the smallest square is 3x3 and therefor a cluster tile needs to be the center.
-    # @return [Hash] The size of the square and the points of the square.
+    # Finds all largest fully-filled squares.
+    #
+    # @param min_size [Integer] Minimum square size to report.
+    # @return [Hash] Maximum size and its top-left tile coordinates.
     def max_squares(min_size: 3)
-      @max_size_found = 0
-      raise ArgumentError, "min_size must be 2 or greater" if min_size < 2
+      # Rebuild for every scoring run because tiles_x_y may be a mutable Set.
+      @square_scores = nil
 
-      result = max_square_result(min_size: min_size)
-      @max_size_found = 0
-      @tiles_lut = nil
-      result
+      max_square_result(min_size: min_size)
     end
 
-    # @param min_size [Integer] The minimum size of the square, should be 3 or greater.
-    # @return [Hash] The size of the square and the points of the square.
-    def max_square_result(min_size: 3)
-      result = { size: @max_size_found, top_left_tile_x_y: Set.new }
-      @tiles_x_y.each do |(x, y)|
-        raise ArgumentError, "x and y must be greater than or equal to 0" if x.negative? || y.negative?
+    # @param min_size [Integer] Minimum square size to report.
+    # @return [Hash] Maximum size and its top-left tile coordinates.
+    def max_square_result(min_size: 3) # rubocop:disable Metrics/MethodLength
+      raise ArgumentError, "min_size must be 2 or greater" if min_size < 2
 
-        steps = max_square(x: x, y: y)
-        result = track_result(result: result, steps: steps, x: x, y: y) if steps >= min_size
+      max_size = 0
+      top_left_tiles = Set.new
+
+      square_scores.each do |y, row|
+        row.each do |x, size|
+          next if size < min_size
+
+          if size > max_size
+            max_size = size
+            top_left_tiles.clear
+            top_left_tiles << [x, y]
+          elsif size == max_size
+            top_left_tiles << [x, y]
+          end
+        end
       end
-      result
+
+      {
+        size: max_size,
+        top_left_tile_x_y: top_left_tiles
+      }
     end
 
-    # @param x [Integer] The x coordinate of the top left tile.
-    # @param y [Integer] The y coordinate of the top left tile.
-    # @return [Integer] The size of the square.
+    # Returns the size of the largest fully-filled square whose
+    # top-left tile is x/y.
+    #
+    # @param x [Integer] X coordinate of the top-left tile.
+    # @param y [Integer] Y coordinate of the top-left tile.
+    # @return [Integer] Square size, or 0 if the tile does not exist.
     def max_square(x:, y:)
-      steps = 1
-      steps += 1 while steps_fulfilled?(x: x, y: y, steps: steps)
-      steps
+      row = square_scores[y]
+
+      return 0 unless row
+
+      row[x] || 0
     end
 
-    # @param x [Integer] The x coordinate of the top left tile.
-    # @param y [Integer] The y coordinate of the top left tile.
-    # @param steps [Integer] The size of the square.
-    # @return [Boolean] True if all steps are fulfilled.
+    # Reports whether the square starting at x/y can grow beyond +steps+.
+    #
+    # For example:
+    #   steps_fulfilled?(x: 0, y: 0, steps: 2)
+    #
+    # is true when a fully-filled square of at least 3x3 exists there.
+    #
+    # @param x [Integer] X coordinate of the top-left tile.
+    # @param y [Integer] Y coordinate of the top-left tile.
+    # @param steps [Integer] Current square size.
+    # @return [Boolean]
     def steps_fulfilled?(x:, y:, steps:)
-      in_lut?(x: x + steps, y: y + steps) &&
-        (0...steps).all? do |i|
-          in_lut?(x: x + steps, y: y + i) &&
-            in_lut?(x: x + i, y: y + steps)
-        end
+      max_square(x: x, y: y) > steps
     end
 
     private
 
-    # This is as fast as it gets! Do not implement `#nil?
+    # Builds a sparse dynamic-programming lookup.
+    #
+    # For every existing tile:
     #
-    # @param x [Integer] The x coordinate of the top left tile.
-    # @param y [Integer] The y coordinate of the top left tile.
-    # @return [Boolean|Nil] True if the tile is in the tiles_lut.
-    def in_lut?(x:, y:)
-      unless @tiles_lut
-        @tiles_lut = {}
-        @tiles_x_y.each do |(x, y)|
-          @tiles_lut[x] ||= {}
-          @tiles_lut[x][y] = true
+    #   score(x, y) =
+    #     1 + min(
+    #       score(x + 1, y),
+    #       score(x, y + 1),
+    #       score(x + 1, y + 1)
+    #     )
+    #
+    # A score of N guarantees that every tile in the N x N square
+    # beginning at x/y exists.
+    #
+    # @return [Hash<Integer, Hash<Integer, Integer>>]
+    def square_scores
+      @square_scores ||= build_square_scores
+    end
+
+    def build_square_scores # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+      rows = {}
+
+      @tiles_x_y.each do |x, y|
+        if x.negative? || y.negative?
+          raise ArgumentError,
+                "x and y must be greater than or equal to 0"
         end
+
+        (rows[y] ||= []) << x
       end
-      @tiles_lut.dig(x, y)
-    end
 
-    # @param result [Hash] The result hash.
-    # @param steps [Integer] The size of the square.
-    # @param x [Integer] The x coordinate of the top left tile.
-    # @param y [Integer] The y coordinate of the top left tile.
-    # @return [Hash] The updated result hash.
-    def track_result(result:, steps:, x:, y:)
-      if steps > @max_size_found
-        @max_size_found = steps
-        result = { size: @max_size_found, top_left_tile_x_y: Set.new }
-        update_result!(result: result, steps: steps, x: x, y: y)
-      elsif steps == @max_size_found
-        update_result!(result: result, steps: steps, x: x, y: y)
+      scores = {}
+
+      next_row = nil
+      next_y = nil
+
+      rows.keys.sort.reverse_each do |y|
+        # A gap between rows means no square can continue downward.
+        next_row = nil unless next_y == y + 1
+
+        current_row = {}
+
+        rows[y].sort!.reverse_each do |x|
+          right = current_row[x + 1] || 0
+
+          if next_row
+            below = next_row[x] || 0
+            diagonal = next_row[x + 1] || 0
+          else
+            below = 0
+            diagonal = 0
+          end
+
+          # Avoid allocating [right, below, diagonal] for every tile.
+          min = [right, below].min
+          min = diagonal if diagonal < min
+
+          current_row[x] = min + 1
+        end
+
+        scores[y] = current_row
+        next_row = current_row
+        next_y = y
       end
-      result
-    end
 
-    # @param result [Hash] The result hash.
-    # @param steps [Integer] The size of the square.
-    # @param x [Integer] The x coordinate of the top left tile.
-    # @param y [Integer] The y coordinate of the top left tile.
-    # @return [Hash] The updated result hash.
-    def update_result!(result:, steps:, x:, y:)
-      result[:size] = steps
-      result[:top_left_tile_x_y] << [x, y]
-      result
+      scores
     end
   end
 end

data/lib/slippy_tiles_scorer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SlippyTilesScorer
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/slippy_tiles_scorer.rb

@@ -20,7 +20,7 @@ module SlippyTilesScorer
       return true if @tiles_x_y.empty?
       raise ArgumentError, "@tiles_x_y must be a Set" unless @tiles_x_y.is_a?(Set)
 
-      set_of_arrays? && set_of_arrays_of_integers?
+      set_of_arrays_with_two_positive_integers?
     end
 
     def clusters(tiles_x_y: @tiles_x_y)
@@ -49,16 +49,13 @@ module SlippyTilesScorer
 
     private
 
-    def set_of_arrays?
-      return true if @tiles_x_y.all? { |point| point.is_a?(Array) && point.size == 2 }
+    def set_of_arrays_with_two_positive_integers?
+      return true if @tiles_x_y.all? do |points|
+        points.is_a?(Array) && points.size == 2 &&
+        points.all? { |point| point.is_a?(Integer) && point >= 0 }
+      end
 
-      raise ArgumentError, "each point must be an array with two elements"
-    end
-
-    def set_of_arrays_of_integers?
-      return true if @tiles_x_y.all? { |point| point.all?(Integer) }
-
-      raise ArgumentError, "each point must be an array with two integers"
+      raise ArgumentError, "each point must be an array with two integers >= 0"
     end
   end
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "jruby-10"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: slippy_tiles_scorer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Simon Neutert
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: set
@@ -34,12 +33,16 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
+- LICENSE
 - README.md
 - Rakefile
+- Rakefile.alt-legacy
+- coverage_badge.svg
 - lib/slippy_tiles_scorer.rb
 - lib/slippy_tiles_scorer/cluster.rb
 - lib/slippy_tiles_scorer/max_square.rb
 - lib/slippy_tiles_scorer/version.rb
+- mise.toml
 - sig/slippy_tiles_scorer.rbs
 - test_helper.rb
 homepage: https://github.com/simonneutert/slippy_tiles_scorer
@@ -48,7 +51,6 @@ metadata:
   homepage_uri: https://github.com/simonneutert/slippy_tiles_scorer
   source_code_uri: https://github.com/simonneutert/slippy_tiles_scorer
   changelog_uri: https://github.com/simonneutert/slippy_tiles_scorer/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,15 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.13
 specification_version: 4
 summary: A gem to score a set of slippy tiles.
 test_files: []