amaze 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63c062699220d0b8d22106bb8af774b4774388cc
+  data.tar.gz: efcb6b4be887d1e3e5e594d01a32be10f5cbf419
+SHA512:
+  metadata.gz: 29d670232418e604d986e226ea304be3a97c4afc4139362048ccd9ab61e9fd8cf7a908d4ed5a7aa8e8887bd3a870e2e8fc3ca1d032f98eb805d35f2d164265eb
+  data.tar.gz: 6a221add8de5625e38ee5001ae59dec618367903db8a0a68be30bd733b1a00bdf6e51ade1cc22ea00ef79be62c75681fcbd12df64f37e45ab893b751bae70a38

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Patrick Marchi
+
+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,110 @@
+# Amaze
+
+Amaze is both a ruby library and a command line tool to generate mazes.
+
+I love mazes. The beauty of mazes have always fascinated me. Amaze is a personal project to create mazes with different tesselations, shapes and sizes. The wonderful book of Jamis Buck, [Mazes for Programmers: Code Your Own Twisty Little Passages](https://pragprog.com/book/jbmaze/mazes-for-programmers) was a great source of inspiration. To adapt the ideas, the code and add my own little twists was a lot of fun.
+
+Visit [Think Labyrinth: Maze Algorithms](http://www.astrolog.org/labyrnth/algrithm.htm) if you want to explore more on mazes, their classification, creation and solving algorithms.
+
+
+## Installation
+
+Amaze depends on [RMagick](https://github.com/rmagick/rmagick) to generate png images. RMagick is an interface between the Ruby programming language and the [ImageMagick](http://www.imagemagick.org) image processing library. You have to install imagemagick first before installing amaze.
+
+On **OS X** install imagemagick with brew
+
+    $ brew install imagemagick
+
+Then run
+
+    $ gem install amaze
+
+
+## Usage
+
+Execute `amaze --help` for a short description of all supported options.
+
+Generate a simple ASCII maze
+
+    $ amaze
+
+    +---+---+---+---+
+    |               |
+    +   +---+   +---+
+    |       |       |
+    +   +---+---+   +
+    |   |           |
+    +   +   +---+   +
+    |   |   |       |
+    +---+---+---+---+
+    Growing tree (last from list) algorithm: 0.00012327899457886815s
+    Dead ends: 5 of 16 (31%)
+    Random seed: 130944739226911434163498228124148718585
+
+Make it a little bigger
+
+    $ amaze -g 12
+
+How about a sigma grid
+
+    $ amaze --type sigma
+    
+     ___     ___
+    /   \___/   \___
+    \        ___    \
+    /   \___/    ___/
+    \   /    ___/   \
+    /   \   /   \   /
+    \   /   \       \
+    /   \___/   \   /
+    \___     ___/   \
+        \___/   \___/
+    Growing tree (last from list) algorithm: 0.00015847600298002362s
+    Dead ends: 3 of 16 (18%)
+    Random seed: 210159208462445383832077802753403683598
+
+Want to visualize the longest path through the maze (it will be nicely colored in your terminal)
+
+    $ exe/amaze --longest
+    
+    +---+---+---+---+
+    | ∙ | ∙-------∙ |
+    + | + | +---+ | +
+    | | | ∙---∙ | ∙ |
+    + | +---+ | +---+
+    | ∙---∙ | ∙---∙ |
+    +---+ | +---+ | +
+    |     ∙-------∙ |
+    +---+---+---+---+
+    Growing tree (last from list) algorithm: 0.00013193400809541345s
+    Dead ends: 3 of 16 (18%)
+    Path length: 14
+    Random seed: 21088416182148741326253564379123099432
+    
+How about watching the algorithm doing its work?
+
+    $ amaze --visualize
+
+You can choose between different algorithm (try Hunt and Kill next)
+
+    $ amaze --visualize --algorithm hk
+
+Finally you can render your maze as PNG
+
+    $ amaze --format=image
+    Growing tree (last from list) algorithm: 0.00013603299157693982s
+    Dead ends: 3 of 16 (18%)
+    Random seed: 72618483828743227022428199116847991100
+    Maze 'maze.png' saved.
+
+Amaze has a lot more options to play with. Have fun and create beautiful piece of [algorithmic art](https://en.wikipedia.org/wiki/Algorithmic_art).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pmarchi/amaze.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/amaze.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amaze/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amaze"
+  spec.version       = Amaze::VERSION
+  spec.authors       = ["Patrick Marchi"]
+  spec.email         = ["mail@patrickmarchi.ch"]
+
+  spec.summary       = %q{Maze generator}
+  spec.description   = %q{A maze generator inspired by the book of Jamis Buck, Mazes for Programmers: Code Your Own Twisty Little Passages.}
+  spec.homepage      = "https://github.com/pmarchi/amaze"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "chunky_png"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "gradient"
+  spec.add_dependency "rmagick"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+#require "bundler/setup"
+require "amaze"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'awesome_print'
+require "irb"
+IRB.start

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/exe/amaze

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'amaze'
+
+Amaze::Script.new.run ARGV

data/lib/amaze.rb

@@ -0,0 +1,17 @@
+require "amaze/version"
+
+module Amaze
+  autoload :Script, 'amaze/script'
+  autoload :Factory, 'amaze/factory'
+  autoload :Cell, 'amaze/cell'
+  autoload :Grid, 'amaze/grid'
+  autoload :SigmaCell, 'amaze/sigma_cell'
+  autoload :SigmaGrid, 'amaze/sigma_grid'
+  autoload :DeltaGrid, 'amaze/delta_grid'
+  autoload :Algorithm, 'amaze/algorithm'
+  autoload :Formatter, 'amaze/formatter'
+  autoload :Distances, 'amaze/distances'
+  autoload :Mask, 'amaze/mask'
+  autoload :MaskedGrid, 'amaze/masked_grid'
+  autoload :Shape, 'amaze/shape'
+end

data/lib/amaze/algorithm.rb

@@ -0,0 +1,44 @@
+
+require 'benchmark'
+
+class Amaze::Algorithm
+  
+  # Helper class to report the status of the algorithm
+  class Stat
+    def initialize opts
+      @current = opts[:current]
+      @pause = opts[:pause]
+      @info = opts[:info]
+    end
+
+    attr_reader :current, :info
+  
+    def pause?
+      @pause
+    end
+  end
+    
+  # The time the algorithm takes to generate the maze
+  attr_reader :duration
+  
+  def on grid
+    @duration = Benchmark.realtime do
+      work grid do |stat|
+        yield stat if block_given?
+      end
+    end
+    grid
+  end
+  
+  def speed
+    0.06
+  end
+    
+  autoload :AldousBorder, 'amaze/algorithm/aldous_border'
+  autoload :BinaryTree, 'amaze/algorithm/binary_tree'
+  autoload :Sidewinder, 'amaze/algorithm/sidewinder'
+  autoload :GrowingTree, 'amaze/algorithm/growing_tree'
+  autoload :Wilson, 'amaze/algorithm/wilson'
+  autoload :HuntAndKill, 'amaze/algorithm/hunt_and_kill'
+  autoload :RecursiveBacktracker, 'amaze/algorithm/recursive_backtracker'
+end

data/lib/amaze/algorithm/aldous_border.rb

@@ -0,0 +1,36 @@
+
+class Amaze::Algorithm::AldousBorder < Amaze::Algorithm
+  
+  def work grid
+    cell = grid.random_cell
+    unvisited = grid.size - 1
+
+    @iterations = 0 # visualize
+    pause = true    #
+
+    while unvisited > 0
+
+      yield Stat.new(                                           # visualize
+        current: [cell],                                        #
+        pause: pause,                                           #
+        info: "Iteration: #{@iterations += 1}") if block_given? #
+      pause = false                                             #
+
+      neighbor = cell.neighbors.sample
+      
+      if neighbor.links.empty?
+        pause = true    # visualize
+        cell.link neighbor
+        unvisited -= 1
+      end
+
+      cell = neighbor
+
+    end
+    grid
+  end
+  
+  def status
+    "Aldous-Border algorithm: #{@iterations} iterations in #{duration}s"
+  end
+end

data/lib/amaze/algorithm/binary_tree.rb

@@ -0,0 +1,20 @@
+
+class Amaze::Algorithm::BinaryTree < Amaze::Algorithm
+
+  def work grid
+    count = 0 # visualize
+    grid.each_cell do |cell|
+      links = [cell.north, cell.east].compact
+      cell.link links[rand(links.size)] unless links.empty?
+
+      yield Stat.new(                                # visualize
+        current: [cell],                             #
+        info: "Cell: #{count += 1}") if block_given? #
+    end
+    grid
+  end
+  
+  def status
+    "Binary tree algorithm: #{duration}s"
+  end
+end

data/lib/amaze/algorithm/growing_tree.rb

@@ -0,0 +1,52 @@
+
+class Amaze::Algorithm::GrowingTree < Amaze::Algorithm
+  
+  # The configuration of the algorithm
+  # In this instance the way the next cell gets picked
+  # from the list of active cells.
+  attr_reader :config
+  
+  def initialize
+    @description = "last from list"
+    @config = Proc.new {|active| active.last }
+  end
+  
+  def configure description, block
+    @description = description
+    @config = block
+  end
+  
+  def work grid
+    # true when active gets cells added
+    # false when active gets cells deleted
+    mode = true
+
+    active = [grid.random_cell]
+    
+    while active.any?
+      cell = config.call active
+      
+      neighbor = cell.neighbors.select {|neighbor| neighbor.links.empty? }.sample
+      
+      yield Stat.new(                                  # visualize
+        current: active,                               #
+        pause: mode ^ !!neighbor,                      #
+        info: "Active #{active.size}") if block_given? #
+      mode = !!neighbor                                #
+      
+      if neighbor
+        cell.link neighbor
+        active << neighbor
+      else
+        active.delete cell
+      end
+      
+    end
+    
+    grid
+  end
+  
+  def status
+    "Growing tree (#{@description}) algorithm: #{duration}s"
+  end
+end

data/lib/amaze/algorithm/hunt_and_kill.rb

@@ -0,0 +1,53 @@
+
+class Amaze::Algorithm::HuntAndKill < Amaze::Algorithm
+  
+  def work grid
+    
+    current = grid.random_cell
+    path = [] # visualize
+    
+    while current
+      unvisited_neighbors = current.neighbors.select {|c| c.links.empty? }
+
+      path << current                               # visualize
+      yield Stat.new(                               #
+        current: path,                              #
+        pause: unvisited_neighbors.empty?,          #
+        info: "Path: #{path.size}") if block_given? #
+
+      # kill
+      if unvisited_neighbors.any?
+        neighbor = unvisited_neighbors.sample
+        current.link neighbor
+        current = neighbor
+        
+      # hunt
+      else
+        current = nil
+
+        path = [] # visualize
+        hunt = 0  #
+
+        grid.each_cell do |cell|
+          visited_neighbors = cell.neighbors.select {|c| c.links.any? }
+
+          yield Stat.new(                                       # visualize
+            current: [cell],                                    #
+            pause: cell.links.empty? && visited_neighbors.any?, #
+            info: "Hunt: #{hunt += 1}") if block_given?         #
+
+          if cell.links.empty? && visited_neighbors.any?
+            current = cell
+            neighbor = visited_neighbors.sample
+            current.link neighbor
+            break
+          end
+        end
+      end
+    end
+  end
+  
+  def status
+    "Hunt and Kill algorithm: #{duration}s"
+  end
+end