maze_magic 0.2.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb317cd3c86320f1a7623933c05e7cd48cc8f48a
-  data.tar.gz: 85c9ca375dddded5129e4ac13dc3746bae3e7479
+  metadata.gz: f7447fa71e7555290286900742895d52354352e8
+  data.tar.gz: 66c642337e7bbcf27cfa02f7fa540f5249063fa2
 SHA512:
-  metadata.gz: f789ce926446fc33b2b46362e00b4133c5bedb36c870c8810786b5388c8bfdffe36cab0caf6b9f5e211fe6c7a17a38d60524fe1c9fe8cdf789988caba8dbed8c
-  data.tar.gz: 14e2800aaf2ae2c9a0d431bdfde5b845e30e06ee2f01a5cebf521966d99e93b88a6ec6e09f9e87506d8e7187f5cab0647718213c472b784ba2dbe349f5ec62a2
+  metadata.gz: 4afc27121862a26cd4c29cae4c798500e0fd21b7fff84ed439d2bf71340ebf2f2cdeafeb94bd3f292fcc3bb4272a8c6dc5e6e5dc9457fa7e7acdb72e83426e10
+  data.tar.gz: d617ea146e65f0b689563405205b60c9d04397e6e0844d6c5cc11c7a1837577784cd276096e5e80122a73db63daf76f5d7f2988fd372f5774f80756b007498a7

data/.travis.yml

@@ -13,3 +13,6 @@ rvm:
   - ruby-head
   - jruby-head
 before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: 04e5a8142d8a9c41028d505f4fe22d5fd371ea48c49372e7397903beddef0d6f

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in maze_magic.gemspec
 gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,5 +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)
+[![Test Coverage](https://codeclimate.com/github/equivalent/maze_magic/badges/coverage.svg)](https://codeclimate.com/github/equivalent/maze_magic/coverage)
 
 # MazeMagic
 
@@ -19,6 +20,9 @@ Ruby Maze generating gem.
 |_________|___|_________|_____________|_______|___|_____|_____|___|_________|_____|_________|___|_________|_____________|
 ```
 
+![](https://41.media.tumblr.com/59fd2a42d464f41af75887e2c2c7dcaf/tumblr_nvy4dupkKf1uicc6wo1_400.png)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -75,6 +79,37 @@ MazeMagic::Renderer::ConsoleRenderer.new(cells_grid: maze).call
 `MazeMagic::Generate` is just an Interface. For more complex usage check
 `lib/maze_magic/generate.rb`, ...or specs.
 
+#### Usage in web-app
+
+You can check https://github.com/equivalent/a-maze-ing for example Rails
+application, but the point is that you will represent the "Maze Wall Representation
+Objects" as walls/passages. (e.g. `<div class="horizontal-wall"></div>`, ...;
+or `<img src="/public/horizontal-wall.png">`)
+
+stupid example:
+
+```ruby
+@maze = generate_maze(height: 5, width: 5)
+```
+
+```erb
+<div id="maze">
+  <% @maze.each_with_index do |row, index| %>
+    <div class="maze-row maze-row-<%= index %>">
+      <% row.each do |maze_rep| %>
+        <% if maze_rep.is_a? MazeMagic::HorizontalWall  %>
+           <img src="/public/horizontal-wall.png">
+        <% elsif maze_rep.is_a? MazeMagic::Passage %>
+           <img src="/public/passage.png">
+           # ...
+        <% end %>
+      <% end %>
+    </div>
+    <div class=clear-fix></div>
+  <% end %>
+</div>
+```
+
 ## Maze generating Algorithm
 
 At this point there is just altered version of [Recursive Backtracking

data/lib/maze_magic.rb

@@ -5,16 +5,11 @@ 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}"
+  require "maze_magic/maze/#{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'
 require 'maze_magic/generate'

data/lib/maze_magic/generate.rb

@@ -11,9 +11,8 @@ module MazeMagic
 
     def generate_maze
       initialize_instructions_grid
-      apply_maze_algorithm_to_grid
       generate_maze_cells_from_instructions
-      return maze
+      maze
     end
 
     def algorithm
@@ -39,12 +38,6 @@ module MazeMagic
       @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:
@@ -64,10 +57,10 @@ module MazeMagic
     #       |___|_____|
     #
     def generate_maze_cells_from_instructions
-      @maze ||= MazeMagic::MazeGenerator::InstructionsGridToCellsGrid
+      @maze ||= algorithm
         .new(grid: instructions_grid)
-        .tap { |generator| generator.call }
-        .cells_grid
+        .tap { |generator| generator.generate }
+        .maze
     end
 
     def grid_klass

data/lib/maze_magic/maze/edge.rb

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

data/lib/maze_magic/maze/horizontal_wall.rb

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

data/lib/maze_magic/maze/passage.rb

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

data/lib/maze_magic/maze/vertical_wall.rb

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

data/lib/maze_magic/maze_generator/recursive_backtracking.rb

@@ -1,3 +1,6 @@
+%w(north south east west).each do |file|
+  require_relative "recursive_backtracking/#{file}"
+end
 module MazeMagic
   module MazeGenerator
     ## RecursiveBacktracking algorithm for generating Maze
@@ -9,23 +12,27 @@ module MazeMagic
     #  I've wraped the algorith with objects
     #
     class RecursiveBacktracking
+      extend Forwardable
       include Randomnes
 
-      attr_reader :grid
+      attr_reader :grid, :maze
+
+      def_delegators :grid, :width, :height
 
       def initialize(grid:)
         @grid = grid
       end
 
-      def call
+      def generate
         preseeder.call
-        algorithm(grid, grid.start_x, grid.start_y)
-        grid
+        carve_instructions_to_grid(grid, grid.start_x, grid.start_y)
+        generate_maze
+        maze
       end
 
       private
 
-      def algorithm(grid, current_x, current_y)
+      def carve_instructions_to_grid(grid, current_x, current_y)
         directions = [
           North.instance,
           South.instance,
@@ -40,10 +47,47 @@ module MazeMagic
           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)
+            carve_instructions_to_grid(grid, next_x, next_y)
           end
         end
       end
+
+      def generate_maze
+        @maze = []
+        @maze << [edge] + Array.new((width * 2 - 1), hw) + [edge]
+
+        height.times do |y|
+          row = []
+          row << vw
+
+          width.times do |x|
+            row << ((grid[y][x] & South.instance.to_i != 0) ? passage : hw)
+            if grid[y][x] & East.instance.to_i != 0
+              row << (((grid[y][x] | grid[y][x+1]) & South.instance.to_i != 0) ? passage : hw)
+            else
+              row << vw
+            end
+          end
+
+          @maze << row
+        end
+      end
+
+      def vw
+        MazeMagic::Maze::VerticalWall.instance
+      end
+
+      def hw
+        MazeMagic::Maze::HorizontalWall.instance
+      end
+
+      def passage
+        MazeMagic::Maze::Passage.instance
+      end
+
+      def edge
+        MazeMagic::Maze::Edge.instance
+      end
     end
   end
 end

data/lib/maze_magic/maze_generator/recursive_backtracking/east.rb

@@ -0,0 +1,25 @@
+module MazeMagic
+  module MazeGenerator
+    class RecursiveBacktracking
+      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
+end

data/lib/maze_magic/maze_generator/recursive_backtracking/north.rb

@@ -0,0 +1,25 @@
+module MazeMagic
+  module MazeGenerator
+    class RecursiveBacktracking
+      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
+end

data/lib/maze_magic/maze_generator/recursive_backtracking/south.rb

@@ -0,0 +1,25 @@
+module MazeMagic
+  module MazeGenerator
+    class RecursiveBacktracking
+      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
+end

data/lib/maze_magic/maze_generator/recursive_backtracking/west.rb

@@ -0,0 +1,25 @@
+module MazeMagic
+  module MazeGenerator
+    class RecursiveBacktracking
+      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
+end

data/lib/maze_magic/version.rb

@@ -1,3 +1,3 @@
 module MazeMagic
-  VERSION = "0.2.1.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maze_magic
 version: !ruby/object:Gem::Version
-  version: 0.2.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,22 +70,21 @@ files:
 - bin/console
 - 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/edge.rb
+- lib/maze_magic/maze/horizontal_wall.rb
+- lib/maze_magic/maze/passage.rb
+- lib/maze_magic/maze/vertical_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/maze_generator/recursive_backtracking/east.rb
+- lib/maze_magic/maze_generator/recursive_backtracking/north.rb
+- lib/maze_magic/maze_generator/recursive_backtracking/south.rb
+- lib/maze_magic/maze_generator/recursive_backtracking/west.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:

data/lib/maze_magic/edge.rb

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

data/lib/maze_magic/horizontal_wall.rb

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

data/lib/maze_magic/maze_generator/east.rb

@@ -1,23 +0,0 @@
-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

@@ -1,59 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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/south.rb

@@ -1,23 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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/passage.rb

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

data/lib/maze_magic/vertical_wall.rb

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