maze_magic 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a41050524d8cfe7ae0abf1795f87015d6b4c86
-  data.tar.gz: 6bfb0374d773201bb5b8f46f9e8c85733ad0202c
+  metadata.gz: 3f47e632779d7b0a33dcbbb1958199fe31c5c8cb
+  data.tar.gz: 1517bd675b2c944fbec6718d7dcc6133ed739086
 SHA512:
-  metadata.gz: bc3c0b157789ef61eb2dbaa5b0f9e3dde9f6333b2aa2461ad3b62057e26de77b5f1ba946eb9c613e8640c7dba9579104f473b3d58e7af840e21a05592e2176a3
-  data.tar.gz: e50657baaea38e8c4780357b120be77926dc7eb60adfe8a4300c2b1479f2ac467e56eea42ffc97c174457a692d008ba57ff2888610b8c8a8da60fe8cdc9dd9fa
+  metadata.gz: 9206be13fe795c4ea19219c7a7bce3d700ed6ad67f2a6d17f2f834109f8ad1e728cd71ae8bf297b0d7168454b756b4759ca3ea34076ebba9727c91ccdf1e1f77
+  data.tar.gz: 9a6d018e43dd27b1582f12fde3b531513a31e3fbc9f02dbd23fbc9e9943d318c9b3e69eb89769da97c626f8dea3aafc6efbaf9385b5b3ca838b29b03b228492f

data/.travis.yml

@@ -1,4 +1,15 @@
 language: ruby
 rvm:
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
   - 2.2.3
+  - ruby-head
+  - jruby-head
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.org/equivalent/maze_magic.svg)](https://travis-ci.org/equivalent/maze_magic)
+[![Code Climate](https://codeclimate.com/github/equivalent/maze_magic/badges/gpa.svg)](https://codeclimate.com/github/equivalent/maze_magic)
+
 # MazeMagic
 
 Ruby Maze generating gem.
@@ -7,7 +10,7 @@ Ruby Maze generating gem.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'maze_magic', github: 'equivalent/maze_magic'
+gem 'maze_magic'
 ```
 
 And then execute:
@@ -16,37 +19,33 @@ And then execute:
 
 ## Usage
 
+#### Simple use:
+
 ```ruby
-# init grid
-grid = MazeMagic::Grid.new(height: 5, width: 5)
 
+def generate_maze
+  MazeMagic::Generate
+    .new(height: 5, width: 5)
+    .tap { |g| g.generate_maze }
+    .maze
+end
 
-#  _________ 
-# |_|_|_|_|_|
-# |_|_|_|_|_|
-# |_|_|_|_|_|
-# |_|_|_|_|_|
-# |_|_|_|_|_|
-
-# apply maze algorithm instructions to grid
-MazeMagic::MazeGenerator::RecursiveBacktracking
-  .new(grid: grid)
-  .call
-
-# translate maze instructions to Cells:
+# maze is a 2 dimensional array of these singleton objects:
+#
+#       MazeMagic::Edge.instance              # ' '
+#       MazeMagic::HorizontalWall.instance    #  _
+#       MazeMagic::VerticalWall.instance      #  |
+#       MazeMagic::Passage.instance           # ' '
 #
-#   MazeMagic::Edge.instance              # ' '
-#   MazeMagic::HorizontalWall.instance    #  _
-#   MazeMagic::VerticalWall.instance      #  |
-#   MazeMagic::Passage.instance           # ' '
+# so something like:
 #
-cells_grid = MazeMagic::MazeGenerator::InstructionsGridToCellsGrid
-  .new(grid: grid)
-  .tap { |generator| generator.call }
-  .cells_grid
+#    [[Edge, HW, HW, HW, HW, Edge],[VW, P, P,VW,P,P,P, HW],...]
+#
+maze = generate_maze 
+
 
-# optional - render the cells viea console
-MazeMagic::Renderer::ConsoleRenderer.new(cells_grid: cells_grid).call
+# optional: render in console
+MazeMagic::Renderer::ConsoleRenderer.new(cells_grid: maze).call
 
 #  _________ 
 # |_  |  _  |
@@ -57,6 +56,11 @@ MazeMagic::Renderer::ConsoleRenderer.new(cells_grid: cells_grid).call
 
 ```
 
+#### More Complex use:
+
+`MazeMagic::Generate` is just an Interface. For more complex usage check
+`lib/maze_magic/generate.rb`, ...or specs.
+
 ## Maze generating Algorithm
 
 At this point there is just altered version of [Recursive Backtracking

data/lib/maze_magic/generate.rb

@@ -0,0 +1,77 @@
+module MazeMagic
+  class Generate
+    attr_reader :height, :width, :maze, :options
+    attr_writer :algorithm
+
+    def initialize(height:, width:, **options)
+      @height = height
+      @width  = width
+      @options = options
+    end
+
+    def generate_maze
+      initialize_instructions_grid
+      apply_maze_algorithm_to_grid
+      generate_maze_cells_from_instructions
+      return maze
+    end
+
+    def algorithm
+      @algorithm ||= MazeMagic::MazeGenerator::RecursiveBacktracking
+    end
+
+    private
+
+    attr_reader :instructions_grid
+
+    ## Initialize instructions grid
+    #
+    #        _________
+    #       |_|_|_|_|_|
+    #       |_|_|_|_|_|
+    #       |_|_|_|_|_|
+    #       |_|_|_|_|_|
+    #       |_|_|_|_|_|
+    #
+    def initialize_instructions_grid
+      grid_options = options.select { |k,v| %i(start_x start_y).include?(k) }
+      args = { height: height, width: width }.merge(grid_options)
+      @instructions_grid = grid_klass.new(args)
+    end
+
+    def apply_maze_algorithm_to_grid
+      MazeMagic::MazeGenerator::RecursiveBacktracking
+        .new(grid: instructions_grid)
+        .call
+    end
+
+    ## Generate Maze Cell objects from instructions:
+    #
+    #  2 dimensional array of these singleton objects:
+    #
+    #       MazeMagic::Edge.instance              # ' '
+    #       MazeMagic::HorizontalWall.instance    #  _
+    #       MazeMagic::VerticalWall.instance      #  |
+    #       MazeMagic::Passage.instance           # ' '
+    #
+    #  Objects inside can be translated to maze walls:
+    #
+    #        _________
+    #       |_  |  _  |
+    #       |  _| |  _|
+    #       | |_  | | |
+    #       | |  _| | |
+    #       |___|_____|
+    #
+    def generate_maze_cells_from_instructions
+      @maze ||= MazeMagic::MazeGenerator::InstructionsGridToCellsGrid
+        .new(grid: instructions_grid)
+        .tap { |generator| generator.call }
+        .cells_grid
+    end
+
+    def grid_klass
+      MazeMagic::Grid
+    end
+  end
+end

data/lib/maze_magic/version.rb

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

data/lib/maze_magic.rb

@@ -17,6 +17,7 @@ require 'maze_magic/maze_generator/recursive_backtracking'
 require 'maze_magic/maze_generator/instructions_grid_to_cells_grid'
 
 require 'maze_magic/renderer/console_renderer'
+require 'maze_magic/generate'
 
 module MazeMagic
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maze_magic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - bin/setup
 - lib/maze_magic.rb
 - lib/maze_magic/edge.rb
+- lib/maze_magic/generate.rb
 - lib/maze_magic/grid.rb
 - lib/maze_magic/horizontal_wall.rb
 - lib/maze_magic/maze_generator.rb