maze_magic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25a41050524d8cfe7ae0abf1795f87015d6b4c86
+  data.tar.gz: 6bfb0374d773201bb5b8f46f9e8c85733ad0202c
+SHA512:
+  metadata.gz: bc3c0b157789ef61eb2dbaa5b0f9e3dde9f6333b2aa2461ad3b62057e26de77b5f1ba946eb9c613e8640c7dba9579104f473b3d58e7af840e21a05592e2176a3
+  data.tar.gz: e50657baaea38e8c4780357b120be77926dc7eb60adfe8a4300c2b1479f2ac467e56eea42ffc97c174457a692d008ba57ff2888610b8c8a8da60fe8cdc9dd9fa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tomas Valent
+
+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,78 @@
+# MazeMagic
+
+Ruby Maze generating gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maze_magic', github: 'equivalent/maze_magic'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+# init grid
+grid = MazeMagic::Grid.new(height: 5, width: 5)
+
+
+#  _________ 
+# |_|_|_|_|_|
+# |_|_|_|_|_|
+# |_|_|_|_|_|
+# |_|_|_|_|_|
+# |_|_|_|_|_|
+
+# apply maze algorithm instructions to grid
+MazeMagic::MazeGenerator::RecursiveBacktracking
+  .new(grid: grid)
+  .call
+
+# translate maze instructions to Cells:
+#
+#   MazeMagic::Edge.instance              # ' '
+#   MazeMagic::HorizontalWall.instance    #  _
+#   MazeMagic::VerticalWall.instance      #  |
+#   MazeMagic::Passage.instance           # ' '
+#
+cells_grid = MazeMagic::MazeGenerator::InstructionsGridToCellsGrid
+  .new(grid: grid)
+  .tap { |generator| generator.call }
+  .cells_grid
+
+# optional - render the cells viea console
+MazeMagic::Renderer::ConsoleRenderer.new(cells_grid: cells_grid).call
+
+#  _________ 
+# |_  |  _  |
+# |  _| |  _|
+# | |_  | | |
+# | |  _| | |
+# |___|_____|
+
+```
+
+## Maze generating Algorithm
+
+At this point there is just altered version of [Recursive Backtracking
+algorithm](http://weblog.jamisbuck.org/2010/12/27/maze-generation-recursive-backtracking),
+but the the gem can be extended by any algorithm.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## TODO
+
+* add support for more Algorithms (e.g. http://www.jamisbuck.org/mazes/)

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "maze_magic"
+
+# 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 "irb"
+IRB.start

data/bin/setup

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

data/lib/maze_magic/edge.rb

@@ -0,0 +1,9 @@
+module MazeMagic
+  class Edge
+    include Singleton
+
+    def to_console_print
+      ' '
+    end
+  end
+end

data/lib/maze_magic/grid.rb

@@ -0,0 +1,22 @@
+module MazeMagic
+  class Grid
+    extend Forwardable
+
+    attr_reader :height, :width, :start_x, :start_y
+
+    def_delegators :grid_map, :size, :each, :length, :[], :to_s, :to_a
+
+    def initialize(width:, height:, start_x: 0, start_y: 0)
+      @width  = width
+      @height = height
+      @start_x = start_x
+      @start_y = start_y
+    end
+
+    private
+
+    def grid_map
+      @grid_map ||= Array.new(height) { Array.new(width, 0) }
+    end
+  end
+end

data/lib/maze_magic/horizontal_wall.rb

@@ -0,0 +1,9 @@
+module MazeMagic
+  class HorizontalWall
+    include Singleton
+
+    def to_console_print
+      '_'
+    end
+  end
+end

data/lib/maze_magic/maze_generator/east.rb

@@ -0,0 +1,23 @@
+module MazeMagic
+  module MazeGenerator
+    class East
+      include Singleton
+
+      def direction_x
+        1
+      end
+
+      def  direction_y
+        0
+      end
+
+      def oposite
+        West.instance
+      end
+
+      def to_i
+        4
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator/instructions_grid_to_cells_grid.rb

@@ -0,0 +1,59 @@
+module MazeMagic
+  module MazeGenerator
+    class InstructionsGridToCellsGrid
+      attr_reader :instructions_grid, :cells_grid
+
+      def initialize(grid:)
+        @instructions_grid = grid
+      end
+
+      def call
+        @cells_grid = []
+        cells_grid << [edge] + Array.new((width * 2 - 1), hw) + [edge]
+
+        height.times do |y|
+          row = []
+          row << vw
+
+          width.times do |x|
+            row << ((instructions_grid[y][x] & South.instance.to_i != 0) ? passage : hw)
+            if instructions_grid[y][x] & East.instance.to_i != 0
+              row << (((instructions_grid[y][x] | instructions_grid[y][x+1]) & South.instance.to_i != 0) ? passage : hw)
+            else
+              row << vw
+            end
+          end
+
+          cells_grid << row
+        end
+        cells_grid
+      end
+
+      private
+
+      def width
+        instructions_grid.width
+      end
+
+      def height
+        instructions_grid.height
+      end
+
+      def vw
+        MazeMagic::VerticalWall.instance
+      end
+
+      def hw
+        MazeMagic::HorizontalWall.instance
+      end
+
+      def passage
+        MazeMagic::Passage.instance
+      end
+
+      def edge
+        MazeMagic::Edge.instance
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator/north.rb

@@ -0,0 +1,23 @@
+module MazeMagic
+  module MazeGenerator
+    class North
+      include Singleton
+
+      def direction_x
+        0
+      end
+
+      def  direction_y
+        -1
+      end
+
+      def oposite
+        South.instance
+      end
+
+      def to_i
+        1
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator/randomnes.rb

@@ -0,0 +1,17 @@
+module MazeMagic
+  module MazeGenerator
+    module Randomnes
+      def self.included(base)
+        base.send(:attr_writer, :preseeder, :randomizer)
+      end
+
+      def preseeder
+        @preseeder ||= MazeMagic::MazeGenerator.default_preseeder
+      end
+
+      def randomizer
+        @randomizer ||= MazeMagic::MazeGenerator.default_randomizer
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator/recursive_backtracking.rb

@@ -0,0 +1,49 @@
+module MazeMagic
+  module MazeGenerator
+    ## RecursiveBacktracking algorithm for generating Maze
+    #
+    #  original author Jamis Buck
+    #
+    #  http://weblog.jamisbuck.org/2010/12/27/maze-generation-recursive-backtracking
+    #
+    #  I've wraped the algorith with objects
+    #
+    class RecursiveBacktracking
+      include Randomnes
+
+      attr_reader :grid
+
+      def initialize(grid: grid)
+        @grid = grid
+      end
+
+      def call
+        preseeder.call
+        algorithm(grid, grid.start_x, grid.start_y)
+        grid
+      end
+
+      private
+
+      def algorithm(grid, current_x, current_y)
+        directions = [
+          North.instance,
+          South.instance,
+          East.instance,
+          West.instance
+        ]
+          .sort_by{randomizer.call}
+
+        directions.each do |direction|
+          next_x, next_y = current_x + direction.direction_x, current_y + direction.direction_y
+
+          if next_y.between?(0, grid.length-1) && next_x.between?(0, grid[next_y].length-1) && grid[next_y][next_x] == 0
+            grid[current_y][current_x] |= direction.to_i
+            grid[next_y][next_x] |= direction.oposite.to_i
+            algorithm(grid, next_x, next_y)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator/south.rb

@@ -0,0 +1,23 @@
+module MazeMagic
+  module MazeGenerator
+    class South
+      include Singleton
+
+      def direction_x
+        0
+      end
+
+      def  direction_y
+        1
+      end
+
+      def oposite
+        North.instance
+      end
+
+      def to_i
+        2
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator/west.rb

@@ -0,0 +1,23 @@
+module MazeMagic
+  module MazeGenerator
+    class West
+      include Singleton
+
+      def direction_x
+        -1
+      end
+
+      def  direction_y
+        0
+      end
+
+      def oposite
+        East.instance
+      end
+
+      def to_i
+        8
+      end
+    end
+  end
+end

data/lib/maze_magic/maze_generator.rb

@@ -0,0 +1,11 @@
+module MazeMagic
+  module MazeGenerator
+    def self.default_preseeder
+      ->{ srand(MazeMagic::MazeGenerator.default_randomizer.call(0xFFFF_FFFF).to_i) }
+    end
+
+    def self.default_randomizer
+      ->(*args){ rand(*args) }
+    end
+  end
+end

data/lib/maze_magic/passage.rb

@@ -0,0 +1,9 @@
+module MazeMagic
+  class Passage
+    include Singleton
+
+    def to_console_print
+      ' '
+    end
+  end
+end

data/lib/maze_magic/renderer/console_renderer.rb

@@ -0,0 +1,25 @@
+module MazeMagic
+  module Renderer
+    class ConsoleRenderer
+      attr_reader :cells_grid
+      attr_writer :printer
+
+      def initialize(cells_grid:)
+        @cells_grid = cells_grid
+      end
+
+      def call
+        cells_grid.each do |row|
+          row.each do |cell|
+            printer.call(cell.to_console_print)
+          end
+          printer.call("\n")
+        end
+      end
+
+      def printer
+        @printer ||= ->(*args){print(*args)}
+      end
+    end
+  end
+end

data/lib/maze_magic/version.rb

@@ -0,0 +1,3 @@
+module MazeMagic
+  VERSION = "0.1.0"
+end

data/lib/maze_magic/vertical_wall.rb

@@ -0,0 +1,9 @@
+module MazeMagic
+  class VerticalWall
+    include Singleton
+
+    def to_console_print
+      '|'
+    end
+  end
+end

data/lib/maze_magic.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+require 'singleton'
+require 'maze_magic/version'
+require 'maze_magic/grid'
+require 'maze_magic/maze_generator'
+require 'maze_magic/maze_generator/randomnes'
+
+%w(north south east west).each do |file|
+  require "maze_magic/maze_generator/#{file}"
+end
+
+%w(horizontal_wall vertical_wall passage edge).each do |file|
+  require "maze_magic/#{file}"
+end
+
+require 'maze_magic/maze_generator/recursive_backtracking'
+require 'maze_magic/maze_generator/instructions_grid_to_cells_grid'
+
+require 'maze_magic/renderer/console_renderer'
+
+module MazeMagic
+end

data/maze_magic.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maze_magic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "maze_magic"
+  spec.version       = MazeMagic::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+
+  spec.summary       = %q{Maze generating gem}
+  spec.description   = %q{Ruby gem for generating Maze in form of nested Arrays}
+  spec.homepage      = 'https://github.com/equivalent/maze_magic'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: maze_magic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Ruby gem for generating Maze in form of nested Arrays
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/maze_magic.rb
+- lib/maze_magic/edge.rb
+- lib/maze_magic/grid.rb
+- lib/maze_magic/horizontal_wall.rb
+- lib/maze_magic/maze_generator.rb
+- lib/maze_magic/maze_generator/east.rb
+- lib/maze_magic/maze_generator/instructions_grid_to_cells_grid.rb
+- lib/maze_magic/maze_generator/north.rb
+- lib/maze_magic/maze_generator/randomnes.rb
+- lib/maze_magic/maze_generator/recursive_backtracking.rb
+- lib/maze_magic/maze_generator/south.rb
+- lib/maze_magic/maze_generator/west.rb
+- lib/maze_magic/passage.rb
+- lib/maze_magic/renderer/console_renderer.rb
+- lib/maze_magic/version.rb
+- lib/maze_magic/vertical_wall.rb
+- maze_magic.gemspec
+homepage: https://github.com/equivalent/maze_magic
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Maze generating gem
+test_files: []