rmaze 1.0.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de1761ea1c434699b107bfd7ac8f67066ccbb72
-  data.tar.gz: 5a00adebfa0161e2bc9da4c708d35080f687e385
+  metadata.gz: 85febacd983d96080346ecd776ce57a069bf3298
+  data.tar.gz: 3fc99125e1fe8afd4c5e01d945b1f0548e9e39e3
 SHA512:
-  metadata.gz: ee50ce8778253e1915c1c4591ebb4e2ed6c08a68ef834cfd77116b88d68a18533c7f29ebe57a7f59b2b3b6434d98593d49fa3f6d1bc188723d71f35dfa9786cf
-  data.tar.gz: f225f4e02d3955852991b646319cbb9dcee0e713df7f55c544bd293a8325b0366805fa055799396c0fc18a7b87c88ffd217db3189fe0f7296ed1943b18f1f186
+  metadata.gz: 873a51c14c421519625a731e828a571ad8cbf0f375f09ced7d5e7cd31bc34d811788d16d886abad3319b6de1cf6ad21b6dd95232d67ee6efd3fc3eaf27a4609f
+  data.tar.gz: 291daa9e8d1f598c013de04306988d83a3f10e280dec2b92ecfb7c40be682ea45193611b14f2ae486afff75d46d0ae2104e7f87b14b8725b7a71446f09f4c195

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem 'OptionParser', '~> 0.5.1'
 gem 'rubytree', '~> 0.9.4'
+gem 'rake', '~> 10.1.0'
 
 group :test do
 	gem 'rspec', '~> 3.1.0'

data/Gemfile.lock

@@ -6,6 +6,7 @@ GEM
     docile (1.1.5)
     json (1.8.1)
     multi_json (1.10.1)
+    rake (10.1.0)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
@@ -33,6 +34,10 @@ PLATFORMS
 
 DEPENDENCIES
   OptionParser (~> 0.5.1)
+  rake (~> 10.1.0)
   rspec (~> 3.1.0)
   rubytree (~> 0.9.4)
   simplecov
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,4 +1,64 @@
-Maze
-====
+# RMaze
+Ruby library and tool for 2D maze generation
 
-Ruby library for maze generation
+[![Build Status](http://travis-ci.org/pedrohml/rmaze.svg?branch=master)](http://travis-ci.org/pedrohml/rmaze)
+[![Security](http://hakiri.io/github/pedrohml/rmaze/master.svg)](https://hakiri.io/github/pedrohml/rmaze/master)
+
+#### Description
+This simple library/tool generates 2D mazes with customizable dimensions.
+
+#### Tool usage
+The **rmaze** is in initial version and its simple to use
+
+```
+Usage: rmaze.rb [options]
+
+Basic options:
+    -w, --width width                Specify the maze width (default: 10)
+	-h, --height height              Specify the maze height (default: 10)
+
+Algorithms:
+	-b, --backtrace                  Choose backtrace algorithm (default)
+```
+
+#### Tool usage examples
+
+Default usage (*width=10, height=10*)
+```
+> rmaze
+
+# # # # # # # # # # # # # # # # # # # # #
+#           #                           #
+# # #   #   # # # # # # #   # # # # # # #
+#       #           #       #           #
+#   # # # # # # #   #   # # #   # # #   #
+#   #       #           #       #       #
+#   #   #   #   # # # # #   # # #   #   #
+#       #   #   #       #   #       #   #
+#   # # #   # # #   #   #   #   # # #   #
+#   #   #           #       #       #   #
+#   #   # # # # # # # # # # # # #   #   #
+#       #                           #   #
+#   # # #   # # # # # # # # # # # # #   #
+#   #       #           #           #   #
+#   #   #   #   # # #   #   # # #   # # #
+#   #   #   #   #   #   #   #   #       #
+#   #   #   #   #   #   #   #   # # # # #
+#   #   #   #       #       #           #
+#   #   # # # # #   # # # # #   # # #   #
+#   #                           #       #
+# # # # # # # # # # # # # # # # # # # # #
+```
+
+Generate mazes with customized dimensions (*width=5, height=2*)
+```
+> rmaze -w 5 -h 2
+
+# # # # # # # # # # #
+#                   #
+#   # # #   # # # # #
+#       #           #
+# # # # # # # # # # #
+```
+
+Enjoy !

data/Rakefile

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+begin
+	RSpec::Core::RakeTask.new(:spec)
+
+	desc 'Rake test'
+	task default: :test
+rescue LoadError
+	fail
+end
+
+desc 'Pre-commit hook (test)'
+task pre_commit: :test
+
+desc 'Run spec tests'
+task test: :spec

data/{maze_gen.rb → bin/rmaze}

@@ -9,7 +9,7 @@ options = {
 	:algorithm => :backtrace
 }
 OptionParser.new do |opts|
-	opts.banner = "Usage: maze_gen.rb [options]"
+	opts.banner = "Usage: rmaze [options]"
 
 	opts.separator ""
 	opts.separator "Basic options:"
@@ -37,4 +37,4 @@ else
 end
 
 maze.generate
-maze.debug
+maze.print

data/lib/game/game.rb

@@ -0,0 +1,37 @@
+require 'solver/tree_solver'
+
+class Game
+	def initialize(maze)
+		@maze = maze
+	end
+
+	def select_goal_cell(dificulty)
+		dificulty = dificulty.to_sym
+		solver = TreeSolver.new(@maze)
+		start_x, start_y = 0, 0
+		paths = solver.paths(start_x, start_y)
+		leafs = {}
+		paths.each_leaf do |leaf|
+			leafs[leaf.node_depth] = leaf
+		end
+		depths = leafs.keys.sort
+		case dificulty
+		when :easy
+			selected_depth = depths[(depths.size*0.25).ceil]
+		when :medium
+			selected_depth = depths[(depths.size*0.5).ceil]
+		when :hard
+			selected_depth = depths.last
+		else
+			selected_depth = depths[rand((depths.size/2.0).ceil) + (depths.size/2.0).ceil]
+		end
+		leafs[selected_depth].content
+	end
+
+	def generate_goal(dificulty)
+		selected_cell = select_goal_cell(dificulty)
+		i, j = @maze.xy_to_ij(selected_cell.x, selected_cell.y)
+		@maze.matrix[i][j] = 2
+		@maze
+	end
+end

data/lib/maze/maze.rb

@@ -2,8 +2,6 @@ require 'maze/maze_cell'
 
 class Maze
 	protected
-	attr_reader :matrix
-
 	def initialize_matrix
 		@matrix = []
 		(0...@height_full).each do
@@ -30,7 +28,7 @@ class Maze
 	end
 
 	public
-	attr_reader :mirrored, :width, :height, :width_full, :height_full
+	attr_reader :mirrored, :width, :height, :width_full, :height_full, :matrix
 
 	def initialize(width, height)
 		@mirrored = false
@@ -40,7 +38,7 @@ class Maze
 		@hash = "#{@width}#{@height}".to_i # optimized pre-computed hash
 	end
 
-	def debug
+	def print
 		@matrix.each do |row|
 			puts row.join(' ').gsub(/0/, ' ').gsub(/1/, '#').gsub(/2/, 'X')
 		end

data/lib/maze/maze_cell.rb

@@ -8,7 +8,7 @@ class MazeCell
 		@hash = "#{@maze.hash}#{@x}#{@y}".to_i
 	end
 
-	def debug
+	def print
 		i, j = @maze.xy_to_ij(@x, @y)
 		puts "  #{@maze.value(i - 1, j)}  "
 		puts "#{@maze.value(i, j - 1)} #{@maze.value(i, j)} #{@maze.value(i, j + 1)}"
@@ -67,6 +67,11 @@ class MazeCell
 		neighbours << down unless has_wall_down?
 		neighbours
 	end
+	
+	def value
+		i, j = xy_to_ij(@x, @y)
+		@maze.value(i, j)
+	end
 
 	def hash
 		@hash

data/lib/solver/tree_solver.rb

@@ -0,0 +1,34 @@
+require 'tree'
+
+class TreeSolver
+	attr_reader :maze
+
+	def initialize(maze)
+		@maze = maze
+	end
+
+	def paths(start_x, start_y)
+		current_cell = @maze.cell(start_x, start_y)
+		root_node = current_node = Tree::TreeNode.new("#{current_cell.x},#{current_cell.y}", current_cell)
+		visited_cells = [current_cell]
+		stack_node = []
+		stack_cell = []
+		while visited_cells.size != @maze.width * @maze.height
+			neighbours = current_cell.connected_neighbours
+			unvisited_neighbours = neighbours - visited_cells
+			if unvisited_neighbours.size == 0
+				current_cell = stack_cell.pop
+				current_node = stack_node.pop
+			elsif unvisited_neighbours.size >= 1
+				current_cell = unvisited_neighbours.shift
+				stack_cell += unvisited_neighbours
+				stack_node += [current_node]*unvisited_neighbours.size
+			end
+			visited_cells << current_cell
+			new_node = Tree::TreeNode.new("#{current_cell.x},#{current_cell.y}", current_cell)
+			current_node << new_node 
+			current_node = new_node
+		end
+		root_node
+	end
+end

data/rmaze.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name        = 'rmaze'
-	s.version     = '1.0.0'
+	s.version     = '1.5.0'
 	s.date        = '2014-10-01'
 	s.licenses    = ["MIT"]
 	s.platform    = Gem::Platform::RUBY
@@ -10,6 +10,9 @@ Gem::Specification.new do |s|
 	s.email       = 'pedrohml@gmail.com'
 	s.files         = `git ls-files`.split("\n")
 	s.test_files    = `git ls-files -- spec/*`.split("\n")
+	s.executables << 'rmaze'
 	s.homepage    = 'https://github.com/pedrohml/rmaze'
 	s.require_paths = ["lib"]
+	s.add_runtime_dependency 'rubytree', '~> 0.9'
+	s.add_runtime_dependency 'OptionParser', '~> 0.5.1'
 end

data/spec/game/game_spec.rb

@@ -0,0 +1,33 @@
+describe Game do
+	before do
+		@maze = MazeBTrace.new(8, 8)
+		@maze.generate
+		@game = Game.new(@maze)
+	end
+
+	it '#select_goal_cell' do
+		selected_cell = @game.select_goal_cell(:hard)
+		expect([selected_cell.x, selected_cell.y]).not_to eq([0, 0])
+		expect(selected_cell.connected_neighbours.size).to eq(1)
+	end
+
+	it '#generate_goal :easy' do
+		maze = @game.generate_goal(:easy)
+		expect(maze.matrix.flatten).to include(2)
+	end
+
+	it '#generate_goal :easy' do
+		maze = @game.generate_goal(:medium)
+		expect(maze.matrix.flatten).to include(2)
+	end
+
+	it '#generate_goal :easy' do
+		maze = @game.generate_goal(:hard)
+		expect(maze.matrix.flatten).to include(2)
+	end
+
+	it '#generate_goal :easy' do
+		maze = @game.generate_goal(:random)
+		expect(maze.matrix.flatten).to include(2)
+	end
+end

data/spec/maze/maze_cell_spec.rb

@@ -82,10 +82,10 @@ describe MazeCell do
 		expect(maze_cell != nil).to be_truthy
 	end
 
-	it '#debug' do
+	it '#print' do
 		allow($stdout).to receive(:puts).exactly(3).times
 		maze_cell = @maze.cell(0, 0)
-		maze_cell.debug
+		maze_cell.print
 	end
 
 	it '#inspect' do

data/spec/maze/maze_spec.rb

@@ -40,8 +40,8 @@ describe Maze do
 		expect(@maze.inspect).to eq("#<Maze: @width=#{@width}, @height=#{@height}>")
 	end
 
-	it '#debug' do
+	it '#print' do
 		allow($stdout).to receive(:puts).exactly(@maze.height_full).times
-		@maze.debug
+		@maze.print
 	end
 end

data/spec/solver/tree_solver_spec.rb

@@ -0,0 +1,13 @@
+describe TreeSolver do
+	before do
+		@maze = MazeBTrace.new(4, 4)
+		@maze.generate
+		@tree_solver = TreeSolver.new(@maze)
+	end
+
+	it '#paths' do
+		paths = @tree_solver.paths(0, 0)
+		expect(paths.name).to eq('0,0')
+		expect(paths.size).to eq(16)
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rmaze
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Pedro Lira
@@ -9,13 +9,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-10-01 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: OptionParser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 description: Ruby library for maze generation
 email: pedrohml@gmail.com
-executables: []
+executables:
+- rmaze
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gemtest"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -23,15 +53,20 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
+- Rakefile
+- bin/rmaze
+- lib/game/game.rb
 - lib/maze/maze.rb
 - lib/maze/maze_btrace.rb
 - lib/maze/maze_cell.rb
 - lib/rmaze.rb
-- maze_gen.rb
+- lib/solver/tree_solver.rb
 - rmaze.gemspec
+- spec/game/game_spec.rb
 - spec/maze/maze_btrace_spec.rb
 - spec/maze/maze_cell_spec.rb
 - spec/maze/maze_spec.rb
+- spec/solver/tree_solver_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pedrohml/rmaze
 licenses:
@@ -53,12 +88,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: RMaze
 test_files:
+- spec/game/game_spec.rb
 - spec/maze/maze_btrace_spec.rb
 - spec/maze/maze_cell_spec.rb
 - spec/maze/maze_spec.rb
+- spec/solver/tree_solver_spec.rb
 - spec/spec_helper.rb