aoc_rb_helpers 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be89f829468b5e0144844944ec0bd8a96973e45d9200cf32b8b23de30f3a0a4b
-  data.tar.gz: 2619c91954216ba37620673a97bdd3f27b74e47e8094a418444fa317363b5270
+  metadata.gz: 11c49beae72029532e7eff52f8b47b7a6d0c1f795b7d265403302d42345dedd2
+  data.tar.gz: 8fd94aa2f8998aa9a56523da3296feba48ce667ea44d71758e3c5b7176c68107
 SHA512:
-  metadata.gz: dd7f615183ca42cd9bc8fcc2febe8a2d688c781dde3cdff9819aae9cd2157e22ac0943c1076c647750ceb1cdd6aee303d80aa86abdf446f7bcc74fdddd3ef9c8
-  data.tar.gz: c0d45da087522c0a1ce92c43b946674c36e79bf1c2cc6d6e1aa65679b5c32b8141235b3dfe663f8c849ef065936725ccbb288fd3745557e432efa09b2087278d
+  metadata.gz: c9d8349d2f94ac316262f630ce90629a34cb6e0ca59b44382bd1b8b065dea5132ef7edb7ebca44d8e4e39d3653e5b9382952fcb5927b3e20c8f0beeee212b369
+  data.tar.gz: 98f8005d31c022ecd2064b976a39bfd601ae40a566b77f449f3e4e6654ea362deb67eeb07d196c0a58839645805d593cdf6d4ef6bf49b20bf4a4ad69e2c57ae4

data/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 - No unreleased changes!
 
+## [0.0.7]
+### Added
+- Grid#each_cell! - Iterates over each cell in the grid, calling the provided block with each cell and updating the cell with the returned value
+- Grid#neighbours - Accessor method to easily fetch the coordinates of cardinal and/or ordinal locations from the given coordinates
+
 ## [0.0.6]
 ### Added
 - AocInput#single_line - Strips newline characters from single line puzzle inputs
@@ -49,7 +54,8 @@ Initial release.
 ### Added
 - Created `AocInput` class with initial helper methods
 
-[Unreleased]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.6...HEAD
+[Unreleased]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.7...HEAD
+[0.0.7]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.6...v0.0.7
 [0.0.6]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.5...v0.0.6
 [0.0.5]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.4...v0.0.5
 [0.0.4]: https://github.com/pacso/aoc_rb_helpers/compare/v0.0.3...v0.0.4

data/lib/aoc_rb_helpers/grid.rb

@@ -35,6 +35,7 @@ class Grid
   def includes_coords?(row, column)
     row >= 0 && column >= 0 && row < @grid.length && column < @grid.first.length
   end
+
   alias_method(:within_grid?, :includes_coords?)
 
   # Returns the value stored at coordinates +(row, column)+ within the grid.
@@ -99,11 +100,11 @@ class Grid
   # @return [Array<Grid>] an array containing four {Grid} objects, one in each possible rotation
   def all_rotations
     rotations = []
-    current_grid = self.dup
+    grid = self.dup
 
     4.times do
-      rotations << current_grid.dup
-      current_grid.rotate!
+      rotations << grid.dup
+      grid.rotate!
     end
 
     rotations
@@ -112,7 +113,7 @@ class Grid
   # Returns a new {Grid} as a copy of self.
   # @return [Grid] a copy of +self+
   def dup
-    self.class.new(@grid.map { |row| row.map { |cell| cell } })
+    self.class.new Marshal.load(Marshal.dump(@grid))
   end
 
   # Updates +self+ with a rotated grid and returns +self+.
@@ -131,8 +132,8 @@ class Grid
   #
   # Returns an enumerator if no block is given
   #
+  # @return [Grid] if given a block, returns +self+ after calling block for each subgrid
   # @return [Enumerator] if no block is given.
-  # @return [self] after processing the provided block
   # @yield [subgrid] calls the provided block with each subgrid as a new {Grid} object
   # @yieldparam subgrid [Grid] a new {Grid} object containing a subgrid from the main grid
   def each_subgrid(rows, columns)
@@ -244,7 +245,8 @@ class Grid
   #   #   - The first item is the row index.
   #   #   - The second item is the column index.
   # @yieldparam value [Object] the value stored within the cell
-  # @return [self]
+  # @return [Grid] if given a block, returns +self+ after calling block for each cell
+  # @return [Enumerator] if no block is given
   def each_cell
     return to_enum(__callee__) unless block_given?
     @grid.each_with_index do |row, r_index|
@@ -255,6 +257,79 @@ class Grid
     self
   end
 
+  # Calls the block, if given, with each cell value; replaces the cell in the grid with the block's return value:
+  #
+  # Returns a new Enumerator if no block given
+  # @yieldparam value [Object] the value stored within the cell
+  # @yieldreturn new_value [Object] the updated value to replace cell with
+  # @return [Grid] if given a block, returns +self+ after calling block for each cell
+  # @return [Enumerator] if no block is given
+  def each_cell!
+    return to_enum(__callee__) unless block_given?
+    @grid.each_with_index do |row, r_index|
+      row.each_with_index do |cell, c_index|
+        @grid[r_index][c_index] = yield cell
+      end
+    end
+    self
+  end
+  alias_method :format_cells, :each_cell!
+
+  # For the given position indicated by the +row+ and +column+ provided, returns
+  # an array of coordinates which are direct neighbours. The returned coordinates are in
+  # clockwise order starting directly above the given cell:
+  #     g = Grid.new([
+  #           [0, 1, 2, 3],
+  #           [4, 5, 6, 7],
+  #           [8, 9, 10, 11]
+  #         ])
+  #     g.neighbours(1, 1) # => [[0, 1], [1, 2], [2, 1], [1, 0]]
+  #
+  # If the keyword argument +allow_diagonal: true+ is provided, diagonally accessible neighbours will also be included:
+  #     g = Grid.new([
+  #           [0, 1, 2, 3],
+  #           [4, 5, 6, 7],
+  #           [8, 9, 10, 11]
+  #         ])
+  #     g.neighbours(1, 1) # => [[0, 1], [0, 2], [1, 2], [2, 2], [2, 1], [2, 0], [1, 0], [0, 0]]
+  #
+  # If provided a block, each neighbour's cell value is yielded to the block, and only those neighbours for which the block
+  # returns a truthy value will be returned in the results:
+  #     g = Grid.new([
+  #           [0, 1, 2, 3],
+  #           [4, 5, 6, 7],
+  #           [8, 9, 10, 11]
+  #         ])
+  #     g.neighbours(1, 2) { |cell| cell.even? } # => [[0, 2], [2, 2]]
+  #     g.neighbours(1, 2, allow_diagonal: true) { |cell| cell <= 5 } # => [[0, 2], [0, 3], [1, 1], [0, 1]]
+  #
+  # @param row [Integer] the row index of the starting cell
+  # @param column [Integer] the column index of the starting cell
+  # @param cardinal [Boolean] permits the direct north/east/south/west directions
+  # @param ordinal [Boolean] permits diagonal north-east/south-east/south-west/north-west directions
+  # @return [Array<Array<Integer>>] an array of coordinates. Each coordinate is a 2-item array where:
+  #   - The first item is the row index.
+  #   - The second item is the column index.
+  def neighbours(row, column, cardinal: true, ordinal: false)
+    possible_neighbours = []
+    possible_neighbours << [row - 1, column] if cardinal
+    possible_neighbours << [row - 1, column + 1] if ordinal
+    possible_neighbours << [row, column + 1] if cardinal
+    possible_neighbours << [row + 1, column + 1] if ordinal
+    possible_neighbours << [row + 1, column] if cardinal
+    possible_neighbours << [row + 1, column - 1] if ordinal
+    possible_neighbours << [row, column - 1] if cardinal
+    possible_neighbours << [row - 1, column - 1] if ordinal
+
+    valid_neighbours = possible_neighbours.select { |r, c| includes_coords?(r, c) }
+
+    if block_given?
+      valid_neighbours.select { |r, c| yield cell(r, c) }
+    else
+      valid_neighbours
+    end
+  end
+
   private
 
   def locate_value(element)

data/lib/aoc_rb_helpers/version.rb

@@ -1,3 +1,3 @@
 module AocRbHelpers
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aoc_rb_helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jon Pascoe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aoc_rb