mazemap 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1de2a8d8c405234dd72965b2791be516d8a29624
+  data.tar.gz: bbcee69ecb9a45efe837cfc08eb6ab4fb1144704
+SHA512:
+  metadata.gz: '0978d9f462c4aacab6d8cb61fdc1413f1edd8014a9b9d6dc0be1957aff14a8d875c7169d1e93165ceccbe341f624d72b3cd122c9ad2c759fb433947ef1ecbeb2'
+  data.tar.gz: dcad932c2f9910bbc4703e54846f507d5e37f8b9c07b6368e190eeebf943bfa74037bedf63deb60d37b0777c269a6974a960afc4dd1e5b25b8f058552f79759a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rpsec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in my_gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Evgeniy
+
+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,46 @@
+## Mazemap Pathfinder
+Mazemap allows you to search for a shortest path in the given 2D map(check tmp/maze.txt for examples)  
+
+Mazemap has built-in command line tool  
+So after the gem installation you can just type  
+`bundle exec mazemap maze.txt`  
+to execute a search  
+
+#### Usage
+Gemfile  
+`gem 'mazemap', github: 'leafmind/mazemap'`  
+
+`bundle install`  
+
+In your code:  
+`Mazemap.read_and_search(filename)`  
+
+Also you can use mazemap command line tool:  
+`bundle exec mazemap maze.txt`  
+
+#### Maze file format example
+
+```
+******************************************
+*               ******            ***    *
+*   ***   ***   ******      * B   ***    *
+*   ***   ***   ******     ***           *
+*   ***                   *****   ***    *
+*   *********             *****   ***    *
+*   *******      ****      ***    ***    *
+*               ******                   *
+*     ***        ****       **********   *
+*     ***                  ***********   *
+*     *******             ************   *
+*     *******    ****                    *
+*      A         ****               ******
+******************************************
+```
+
+
+Known issues on MAC OS X  
+https://github.com/SciRuby/nmatrix/issues/426  
+
+Workaround  
+https://github.com/SciRuby/nmatrix/issues/426#issuecomment-218122512
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/mazemap

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'mazemap'
+
+filename = ARGV[0]
+
+if filename
+  puts Mazemap.read_and_search(filename).inspect
+else
+  puts <<-EOF
+      Please specify input file as command line parameter
+      USAGE: bundle exec mazemap /path/to/your/file
+      File should contain maze in described format(see tmp/maze.txt)
+    EOF
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mazemap.rb

@@ -0,0 +1,22 @@
+require 'nmatrix'
+require 'mazemap/graph'
+require 'mazemap/pathfinder'
+require 'mazemap/version'
+
+# Tries to find the shortest path
+# 
+# @author Evgenii Shevchenko
+# @since 0.0.1
+module Mazemap
+  # Search for a shortest paths
+  #
+  # @example Run search
+  #   >> Mazemap.read_and_search(filename)
+  #   => [[6, 11], [7, 11], [8, 11], [9, 11], [10, 11]]
+  def read_and_search(filename)
+    pathfinder = Pathfinder.new(filename)
+    pathfinder.solution
+  end
+
+  module_function :read_and_search
+end

data/lib/mazemap/graph.rb

@@ -0,0 +1,104 @@
+module Mazemap
+  # Graph object class
+  # 
+  # @author Evgenii Shevchenko
+  # @!attribute [r] graph
+  #   @return [NMatrix] graph map matrix
+  # @!attribute [r] queue
+  #   @return [Queue] progress queue
+  # @!attribute [r] rows
+  #   @return [Integer] number of the rows
+  # @!attribute [r] cols
+  #   @return [Integer] number of the cols
+  class Graph
+    attr_reader :graph
+    attr_reader :queue
+    attr_reader :rows
+    attr_reader :cols
+  
+    INF = Float::INFINITY
+    BLANK = -Float::INFINITY
+    VISITED = Float::MAX
+    START = 1
+    FINISH = 2
+  
+    # Initializes Graph object, sets rows and cols, graph map
+    #
+    # @param n [Integer] number of rows
+    # @param m [Integer] number of columns
+    # @param graph_map [Array] prepared vector of the graph map
+    def initialize(n, m, graph_map)
+      @rows, @cols = n, m
+      @graph = NMatrix.new([n, m], graph_map)
+      @queue = Queue.new
+    end
+  
+    # Starts a search for the shortest path
+    #
+    # @param start [Array] start vertex coords
+    # @param finish [Array] finish vertex coords
+    def shortest_path(start, finish)
+      queue << [start, 0]
+      loop do
+        break if queue.empty?
+        vertex, d = queue.pop
+        graph[*vertex] = d
+        break if vertex == finish
+        enqueue_neighbours(*vertex, d + 1)
+      end
+      queue.clear
+      !blank?(finish) ? build_path(start, finish) : []
+    end
+  
+    private
+  
+    # Checks if vertex is blank
+    #
+    # @param vertex [Array] vertex coords
+    def blank?(vertex)
+      graph[*vertex] == BLANK
+    end
+  
+    # Builds the shortest path from the processed graph
+    #
+    # @param start [Array] start vertex coords
+    # @param finish [Array] finish vertex coords
+    def build_path(start, finish)
+      path = [finish]
+      loop do
+        vertex = path.last
+        d = graph[*vertex]
+        neighbours = get_neighbours(*vertex)
+        next_vertex = neighbours.select{|n_vert| graph[*n_vert] == d - 1}.first
+        path << next_vertex if next_vertex
+        break if vertex == start
+      end
+      path
+    end
+  
+    # Collects the neighbours of the given vertex
+    #
+    # @param n [Integer] row number of vertex
+    # @param m [Integer] column number of vertex
+    def get_neighbours(n, m)
+      [[n - 1, m],[n + 1, m],[n, m - 1],[n, m + 1]].select do |coords| 
+        coords.first.between?(0, rows - 1) && coords.last.between?(0, cols - 1)
+      end
+    end
+  
+    # Adds the neighbours of the given vertex to the queue and marks them
+    #
+    # @param n [Integer] row number of vertex
+    # @param m [Integer] column number of vertex
+    # @param d [Integer] distance mark of vertex
+    def enqueue_neighbours(n, m, d)
+      get_neighbours(n, m).each do |vertex|
+        if blank?(vertex)
+          graph[*vertex] = VISITED
+          queue << [vertex, d] 
+        end
+      end
+    end
+  
+  end
+end

data/lib/mazemap/pathfinder.rb

@@ -0,0 +1,78 @@
+module Mazemap
+  # Pathfinder object class
+  # 
+  # @author Evgenii Shevchenko
+  # @!attribute [r] lines
+  #   @return [Array] maze representation
+  # @!attribute [r] rows
+  #   @return [Integer] number of the rows
+  # @!attribute [r] cols
+  #   @return [Integer] number of the cols
+  # @!attribute [r] start
+  #   @return [Integer] start vertex coords
+  # @!attribute [r] finish
+  #   @return [Integer] finish vertex coords
+  class Pathfinder
+    attr_reader :lines
+    attr_reader :rows
+    attr_reader :cols
+    attr_reader :start
+    attr_reader :finish
+  
+    VERTEX_VALUES = {
+    	' ' => Graph::BLANK,
+    	'*' => Graph::INF,
+    	'A' => Graph::START,
+    	'B' => Graph::FINISH
+    }
+  
+    # Initializes Pathfinder, sets @lines, @rows and @cols
+    #
+    # @param filename [String] path to file with maze
+    def initialize(filename)
+      if filename
+        @lines = IO.readlines(filename).map(&:chomp)
+        @rows = lines.length
+        @cols = lines.first.length
+      end
+    end
+  
+    # Starts a search for the shortest path
+    def solution
+      graph_map = parse_graph_map.flatten
+      set_route(graph_map)
+      graph = Graph.new(rows, cols, graph_map)
+      graph.shortest_path(start, finish).map(&:reverse).reverse
+    end
+  
+    private
+  
+    # Sets start and finish vertex coords
+    #
+    # @param graph_map [Array] flatterned graph map
+    def set_route(graph_map)
+      start_element = graph_map.index(Graph::START)
+      finish_element = graph_map.index(Graph::FINISH)
+      graph_map[start_element] = Graph::BLANK
+      graph_map[finish_element] = Graph::BLANK
+      @start = [start_element / cols, start_element % cols]
+      @finish = [finish_element / cols, finish_element % cols]
+    end
+  
+    # Converts letter according to maze format
+    #
+    # @param letter [String] letter to convert
+    def convert_letter(letter)
+      VERTEX_VALUES[letter] || letter
+    end
+  
+    # Parses the maze map and converts it to the internal format
+    def parse_graph_map
+      lines.map do |line| 
+        line.split('').map do |letter| 
+        	convert_letter(letter)
+        end
+      end
+    end
+  end
+end

data/lib/mazemap/version.rb

@@ -0,0 +1,3 @@
+module Mazemap
+  VERSION = '0.0.2'
+end

data/mazemap.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mazemap/version'
+
+Gem::Specification.new do |spec|
+  spec.authors     = ["Evgenii Shevchenko"]
+
+  spec.name        = 'mazemap'
+  spec.version     = '0.0.1'
+  spec.date        = '2016-12-16'
+  spec.summary     = 'MazeMap Graph Pathfinder'
+  spec.description = 'Runs Wavefront algorithm to find the shortest path from A to B'
+  spec.homepage    = 'https://github.com/leafmind/mazemap'
+  
+  spec.email       = 'leafmind@gmail.com'
+
+  spec.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files  = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.version     = Mazemap::VERSION
+
+  spec.license     = 'MIT'
+
+  spec.add_dependency 'nmatrix'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 11.3"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "awesome_print"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: mazemap
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Evgenii Shevchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nmatrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Runs Wavefront algorithm to find the shortest path from A to B
+email: leafmind@gmail.com
+executables:
+- mazemap
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rpsec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mazemap
+- bin/setup
+- lib/mazemap.rb
+- lib/mazemap/graph.rb
+- lib/mazemap/pathfinder.rb
+- lib/mazemap/version.rb
+- mazemap.gemspec
+homepage: https://github.com/leafmind/mazemap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: MazeMap Graph Pathfinder
+test_files: []