subparry_labyrinth_solver 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b17cd6a8c8688ea730f7e22376498be890519374be6864366b9c84bd1b4b2a0
+  data.tar.gz: cc2d7cfe598d99a276b448babf7b1688b3618dca31567d62780ecb3907e5f756
+SHA512:
+  metadata.gz: aed1745011a6b6308acee72a4b2713bd9cb940422266fe4b2986688fecf5bb46b0734472d1477131f553cdfed5e723c63b9bd673ae87781ce90fae54306f2670
+  data.tar.gz: 72affed219ac055ff39e4215e2586151c90dff1c19ff1bffdd56026ea866464d86f6f1d0d2bd8ddf3b03092027795743898df955987453acf52642740265bfd6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 2021-01-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c), Adrian Parry
+
+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

@@ -0,0 +1,8 @@
+# subparry_labyrinth_solver
+
+[![codecov](https://codecov.io/gh/subparry/subparry-labyrinth-solver/branch/master/graph/badge.svg?token=AHG1N8FZA0)](https://codecov.io/gh/subparry/subparry-labyrinth-solver)
+[![Build Status](https://travis-ci.com/subparry/subparry-labyrinth-solver.svg?branch=master)](https://travis-ci.com/subparry/subparry-labyrinth-solver)
+
+## Description
+
+Fun little project about labyrinth solving.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/labyrinth.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/subparry_labyrinth_solver/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                   = 'subparry_labyrinth_solver'
+  spec.version                = LabyrinthSolver::VERSION
+  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.homepage               = 'https://github.com/subparry/subparry-labyrinth-solver'
+  spec.license                = 'MIT'
+  spec.platform               = Gem::Platform::RUBY
+  spec.required_ruby_version  = '>= 2.7.1'
+
+  spec.files                  = Dir[
+                                  'README.md',
+                                  'LICENSE',
+                                  'CHANGELOG.md',
+                                  'Gemfile',
+                                  'Rakefile',
+                                  'lib/**/*.rb',
+                                  'labyrinth.gemspec'
+                                ]
+  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'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/lib/subparry_labyrinth_solver/exceptions.rb

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

data/lib/subparry_labyrinth_solver/labyrinth.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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
+
+  extend Forwardable
+
+  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 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
+
+  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
+
+  private
+
+  def current_node
+    @nodes[@position.y][@position.x]
+  end
+end

data/lib/subparry_labyrinth_solver/node.rb

@@ -0,0 +1,23 @@
+# 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?
+
+    @paths = paths
+    @cheese = paths[:cheese] || false
+  end
+
+  def open? direction
+    @paths[direction]
+  end
+
+  def cheese?
+    @cheese
+  end
+
+  def close direction
+    @paths[direction] = false
+  end
+end

data/lib/subparry_labyrinth_solver/solver.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+# Takes a labyrinth and attempts to solve it saving the path taken
+class Solver
+  attr_reader :path
+
+  extend Forwardable
+
+  OPPOSITE_DIRECTIONS = { up: :down, right: :left, down: :up, left: :right }.freeze
+
+  def_delegators :@labyrinth, :position, :cheese?, :go, :close
+
+  def initialize labyrinth
+    raise ArgumentError unless labyrinth.instance_of? Labyrinth
+
+    @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
+
+    go(next_dir.first)
+    @path.push(next_dir.first)
+  end
+
+  def solve
+    go_next until cheese?
+  end
+
+  private
+  
+  def dead_end
+    to_close = path.pop
+    go(OPPOSITE_DIRECTIONS[to_close])
+    close(to_close)
+  end
+end

data/lib/subparry_labyrinth_solver/version.rb

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: subparry_labyrinth_solver
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adrian Parry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: This gem allows to find path for exiting a labyrinth
+email:
+- subparry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- 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
+- lib/subparry_labyrinth_solver/version.rb
+homepage: https://github.com/subparry/subparry-labyrinth-solver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.6
+signing_key: 
+specification_version: 4
+summary: An exercise for gem creation based on solving a labyrinth
+test_files: []