subparry_labyrinth_solver 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73679ebec7ed8d1f1a435bf025892af34ccf8acdaf95937d97837e96b15cb77a
-  data.tar.gz: 78551e9bb1b47cb0476ed233062a9458afb1497b8ec227e081028bf4d51846e7
+  metadata.gz: d0bf1b3d99443815ae5ff546b0abbd55512351f75ddb9d7de6299a2166c6f796
+  data.tar.gz: 4c7f159471b6f6e9c24178cd8d165f60e8a593f6f89160e92720e6c826e9a747
 SHA512:
-  metadata.gz: 35642607e49c14134a39ac9f39071e93b96d1448a8c2ac93983c2b2549d9c382e9c84252505f32fdfd05d6d0d35db9e98888fb46a9b17270509b933f6e012cac
-  data.tar.gz: bc88bea336a11ce1b277f6c270670e438aa9d841ca6a2669122afd0b92107c379f54d55a44603742f4de3943e119a7721672e3a85125876f22f61da480e2a819
+  metadata.gz: 2efa961d309f5b2c729adb7f8c2c4b8a576195566fd27605401e2c9882bdedfdcf15a7562b47bf0a65e96ef5ffc0788ed358c29353abab9169440f33787278dd
+  data.tar.gz: 566eb78c672a2bec211480ac09651dbdf458f7674983dbae0b4079691d553410ca71dfa9f4f7753a91a9cae1d59e13b5e55b7a18bdc37ab707690ad56a0d232f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.4 2021-01-22
+
+- First fully functional release
+
 ## 1.0.0 2021-01-21
 
 - Initial release

data/README.md

@@ -6,4 +6,72 @@
 
 ## Description
 
-Fun little project about labyrinth solving.
+Fun little project about labyrinth solving inspired in mice that find cheese in a maze.
+
+It exposes some classes to create a labyrinth and then find the path to the cheese.
+
+Be advised: **It does not support labyrinths with circular paths and if you try to solve one of these, it will result in an infinite loop**.
+
+That being said, I plan to support that kind of labyrinths soon.
+
+## Usage
+
+```
+gem install subparry_labyrinth_solver
+```
+
+```ruby
+require 'subparry_labyrinth_solver'
+
+# First define labyrinth data as a 2 dimensional array where
+# each square is represented by a hash with :up, :down, :left and :right
+# as keys and an optional key :cheese representing the "goal" square.
+# A value of true for a direction represents an open path, and false
+# represents a wall.
+
+data = [
+  [ # The first row
+    { up: false, right: false, left: false, down: true },
+    { up: false, right: false, left: false, down: true, cheese: true },
+  ],
+  [ # The second row
+    { up: true, down: false, right: true, left: false },
+    { up: true, down: false, right: false, left: true }
+  ]
+]
+
+# This data represents this maze:
+#      ___ ___
+#     |   | 🧀|
+#     |   |   |
+#     |       |
+#     |_______|
+
+# Then initialize the labyrinth:
+lab = LabyrinthSolver::Labyrinth.new(data)
+
+# Then initialize the solver:
+solver = LabyrinthSolver::Solver.new(lab)
+
+# And call solve on the instance. This call will trigger
+# the cheese-finding loop and record the right path.
+solver.solve
+
+# Confirm that cheese was found:
+solver.cheese? # => true
+
+# Retrieve the path:
+solver.path # => [:down, :right, :up]
+
+# Get the coordinates of the cheese:
+solver.position # => <struct x: 1, y: 0>
+
+# Note that the coordinates are like image coordinates where top-left
+# corner is x: 0, y: 0 and bottom-right is x: width, y: length
+```
+
+## Pending
+
+- Support labyrinths with circular paths
+- Create a labyrinth maker class
+- Visual representation of labyrinths

data/labyrinth.gemspec

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/subparry_labyrinth_solver/version', __dir__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subparry_labyrinth_solver/version'
 
 Gem::Specification.new do |spec|
   spec.name                   = 'subparry_labyrinth_solver'
@@ -8,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors                = ['Adrian Parry']
   spec.email                  = ['subparry@gmail.com']
   spec.summary                = 'An exercise for gem creation based on solving a labyrinth'
-  spec.description            = 'This gem allows to find path for exiting a labyrinth'
+  spec.description            = 'This gem allows to find path to cheese in a labyrinth'
   spec.homepage               = 'https://github.com/subparry/subparry-labyrinth-solver'
   spec.license                = 'MIT'
   spec.platform               = Gem::Platform::RUBY
@@ -23,8 +25,8 @@ Gem::Specification.new do |spec|
                                   'lib/**/*.rb',
                                   'labyrinth.gemspec'
                                 ]
-  spec.extra_rdoc_files = ['README.md']
-  
+  spec.extra_rdoc_files       = ['README.md']
+
   spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 1.8'

data/lib/subparry_labyrinth_solver.rb

@@ -0,0 +1,8 @@
+require 'subparry_labyrinth_solver/node'
+require 'subparry_labyrinth_solver/labyrinth'
+require 'subparry_labyrinth_solver/solver'
+module LabyrinthSolver
+  class MissingPathsError < ArgumentError; end
+  class InvalidMoveError < RuntimeError; end
+  class MissingCheeseError < ArgumentError; end
+end

data/lib/subparry_labyrinth_solver/labyrinth.rb

@@ -2,47 +2,49 @@
 
 require 'forwardable'
 
-Point = Struct.new(:x, :y)
-# Labyrinth class in charge of keeping track of all nodes and performing movements
-class Labyrinth
-  attr_reader :height, :width, :position
+module LabyrinthSolver
+  Point = Struct.new(:x, :y)
+  # Labyrinth class in charge of keeping track of all nodes and performing movements
+  class Labyrinth
+    attr_reader :height, :width, :position
 
-  extend Forwardable
+    extend Forwardable
 
-  def_delegators :current_node, :open?, :cheese?, :close
+    def_delegators :current_node, :open?, :cheese?, :close
 
-  def self.validate_data data 
-    raise ArgumentError unless data.respond_to?(:each) && data.first.respond_to?(:each)
-    raise MissingCheeseError unless data.any? { |rows| rows.any? {|paths| paths[:cheese]} }
-  end
+    def self.validate_data data 
+      raise ArgumentError unless data.respond_to?(:each) && data.first.respond_to?(:each)
+      raise MissingCheeseError unless data.any? { |rows| rows.any? {|paths| paths[:cheese]} }
+    end
 
-  def initialize(data)
-    Labyrinth.validate_data data
+    def initialize(data)
+      Labyrinth.validate_data data
 
-    @height = data.size
-    @width = data.first.size
-    @position = Point.new(0, 0)
-    @nodes = data.collect { |row| row.collect { |cell| Node.new(cell) } }
-  end
+      @height = data.size
+      @width = data.first.size
+      @position = Point.new(0, 0)
+      @nodes = data.collect { |row| row.collect { |cell| Node.new(cell) } }
+    end
 
-  def go direction
-    raise InvalidMoveError, "Attempted to move #{direction}" unless open? direction
-
-    case direction
-    when :up
-      @position.y -= 1
-    when :down
-      @position.y += 1
-    when :left
-      @position.x -= 1
-    when :right
-      @position.x += 1
+    def go direction
+      raise InvalidMoveError, "Attempted to move #{direction}" unless open? direction
+
+      case direction
+      when :up
+        @position.y -= 1
+      when :down
+        @position.y += 1
+      when :left
+        @position.x -= 1
+      when :right
+        @position.x += 1
+      end
     end
-  end
 
-  private
+    private
 
-  def current_node
-    @nodes[@position.y][@position.x]
+    def current_node
+      @nodes[@position.y][@position.x]
+    end
   end
-end
+end

data/lib/subparry_labyrinth_solver/node.rb

@@ -1,23 +1,25 @@
 # frozen_string_literal: true
 
 # Class to represent a single labyrinth square or node
-class Node
-  def initialize(paths)
-    raise MissingPathsError if paths[:up].nil? || paths[:down].nil? || paths[:left].nil? || paths[:right].nil?
+module LabyrinthSolver
+  class Node
+    def initialize(paths)
+      raise MissingPathsError if paths[:up].nil? || paths[:down].nil? || paths[:left].nil? || paths[:right].nil?
 
-    @paths = paths
-    @cheese = paths[:cheese] || false
-  end
+      @paths = paths
+      @cheese = paths[:cheese] || false
+    end
 
-  def open? direction
-    @paths[direction]
-  end
+    def open? direction
+      @paths[direction]
+    end
 
-  def cheese?
-    @cheese
-  end
+    def cheese?
+      @cheese
+    end
 
-  def close direction
-    @paths[direction] = false
+    def close direction
+      @paths[direction] = false
+    end
   end
-end
+end

data/lib/subparry_labyrinth_solver/solver.rb

@@ -1,41 +1,42 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+module LabyrinthSolver
+  # Takes a labyrinth and attempts to solve it saving the path taken
+  class Solver
+    attr_reader :path
 
-# Takes a labyrinth and attempts to solve it saving the path taken
-class Solver
-  attr_reader :path
+    extend Forwardable
 
-  extend Forwardable
+    OPPOSITE_DIRECTIONS = { up: :down, right: :left, down: :up, left: :right }.freeze
 
-  OPPOSITE_DIRECTIONS = { up: :down, right: :left, down: :up, left: :right }.freeze
+    def_delegators :@labyrinth, :position, :cheese?, :go, :close
 
-  def_delegators :@labyrinth, :position, :cheese?, :go, :close
+    def initialize labyrinth
+      raise ArgumentError unless labyrinth.instance_of? Labyrinth
 
-  def initialize labyrinth
-    raise ArgumentError unless labyrinth.instance_of? Labyrinth
+      @labyrinth = labyrinth
+      @path = []
+    end
 
-    @labyrinth = labyrinth
-    @path = []
-  end
-
-  def go_next
-    next_dir = OPPOSITE_DIRECTIONS.find { |dir, opp| @labyrinth.open?(dir) && opp != @path.last }
-    return dead_end unless next_dir
+    def go_next
+      next_dir = OPPOSITE_DIRECTIONS.find { |dir, opp| @labyrinth.open?(dir) && opp != @path.last }
+      return dead_end unless next_dir
 
-    go(next_dir.first)
-    @path.push(next_dir.first)
-  end
+      go(next_dir.first)
+      @path.push(next_dir.first)
+    end
 
-  def solve
-    go_next until cheese?
-  end
+    def solve
+      go_next until cheese?
+    end
 
-  private
-  
-  def dead_end
-    to_close = path.pop
-    go(OPPOSITE_DIRECTIONS[to_close])
-    close(to_close)
+    private
+    
+    def dead_end
+      to_close = path.pop
+      go(OPPOSITE_DIRECTIONS[to_close])
+      close(to_close)
+    end
   end
-end
+end

data/lib/subparry_labyrinth_solver/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LabyrinthSolver
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: subparry_labyrinth_solver
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Adrian Parry
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
-description: This gem allows to find path for exiting a labyrinth
+description: This gem allows to find path to cheese in a labyrinth
 email:
 - subparry@gmail.com
 executables: []
@@ -109,7 +109,6 @@ files:
 - Rakefile
 - labyrinth.gemspec
 - lib/subparry_labyrinth_solver.rb
-- lib/subparry_labyrinth_solver/exceptions.rb
 - lib/subparry_labyrinth_solver/labyrinth.rb
 - lib/subparry_labyrinth_solver/node.rb
 - lib/subparry_labyrinth_solver/solver.rb

data/lib/subparry_labyrinth_solver/exceptions.rb

@@ -1,3 +0,0 @@
-class MissingPathsError < ArgumentError; end
-class InvalidMoveError < RuntimeError; end
-class MissingCheeseError < ArgumentError; end