willb-mazegen 0.0.0

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,17 @@
+= mazegen
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Will Benton. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "willb-mazegen"
+    gem.summary = %Q{Simple PDF maze generator}
+    gem.description = %Q{Simple PDF maze generator, based on spanning trees.  Can generate one or many mazes of different complexities.}
+    gem.email = "willbenton@gmail.com"
+    gem.homepage = "http://github.com/willb/mazegen"
+    gem.authors = ["Will Benton"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "prawn", ">= 0.7.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mazegen #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/mazegen

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+# mazegen.rb is a simple program that generates simple mazes by finding a
+# spanning tree of the cells in the maze.  (Perhaps someday it will be have
+# more interesting functionality.)  The mazes mazegen generates are PDF files
+# that are designed to mostly fill a letter-sized sheet of paper.  To run
+# mazegen, you'll need the prawn library for PDF generation.
+
+# mazegen.rb is licensed under the Apache Software License, version 2.0 
+# and copyright (c) 2010 William Benton (http://willbenton.com)
+
+require 'rubygems'
+require 'set'
+require 'prawn'
+
+require 'willb-mazegen/cellgraph'
+require 'willb-mazegen/maze'
+require 'willb-mazegen/mazerenderer'
+
+DEFAULT_WIDTH = 67
+DEFAULT_HEIGHT = 90
+PAGE_WIDTH = 536
+PAGE_HEIGHT = 720
+
+width = DEFAULT_WIDTH
+height = DEFAULT_HEIGHT
+cellsize = PAGE_WIDTH / DEFAULT_WIDTH
+
+page_count = 1
+
+op = OptionParser.new do |opts|
+  opts.banner = "Usage:  mazegen [options] outfile.pdf"
+  
+  opts.on("-w", "--width COLS", "width of maze in cells (defaults to 67)") do |w| 
+    width = w.to_i
+    cellsize = PAGE_WIDTH / width
+    height = PAGE_HEIGHT / cellsize
+  end
+  
+  opts.on("-p", "--pagecount NUM", "number of mazes to put in the output document") do |p| 
+    page_count = p.to_i
+  end
+  
+end
+
+begin
+  op.parse!
+rescue OptionParser::InvalidOption
+  puts op
+  exit
+end
+
+if ARGV.size < 1
+  puts "You must specify an output file"
+  puts op
+  exit
+end
+
+m = Maze.new(width, height)
+
+Prawn::Document.generate(ARGV[0]) do
+  while page_count > 0
+    page_count -= 1
+    
+    m.gen
+    
+    MazeRenderer.new(m,cellsize).render_lines.each do |lstart,lend|
+      stroke {line lstart, lend}
+    end
+    
+    start_new_page if page_count > 0
+  end
+end

data/lib/willb-mazegen/cellgraph.rb

@@ -0,0 +1,81 @@
+# cellgraph.rb is licensed under the Apache Software License, version 2.0 
+# and copyright (c) 2010 William Benton (http://willbenton.com)
+
+# An undirected, unweighted graph of cells on a square grid; edges 
+# indicate spaces, non-edges (between neighbors) indicate walls
+class CellGraph
+  def initialize(x,y)
+    @x = x
+    @y = y
+    @node_coords = init_coords
+    @node_edges = init_edges
+    @node_neighbors = init_neighbors
+  end
+  
+  attr_reader :x, :y
+  
+  def add_edges(edges)
+    edges.each do |source,dest|
+      @node_edges[source] << dest
+      # recall that this is an undirected graph
+      @node_edges[dest] << source
+    end
+  end
+
+  alias add_edge add_edges
+
+  def edges_from(node)
+    @node_edges[node].map {|dest| [node, dest]}
+  end
+
+  def edges
+    @node_edges.map do |source, dests|
+      dests.map {|dest| [source, dest]}
+    end.flatten(1)
+  end
+  
+  def neighbors(node)
+    @node_neighbors[node]
+  end
+  
+  def coords_for_cell(node)
+    @node_coords[node]
+  end
+  
+  def cell_for_coords(x,y)
+    @x * y + x
+  end
+  
+  def in_graph(px,py)
+    px >= 0 && py >= 0 && py < @y && px < @x
+  end
+  
+  def reset_edges
+    @node_edges = init_edges
+  end
+  
+  private
+  def init_coords
+    Hash[*nodenums.zip(nodenums.map {|num| [num % @x, num / @x]}).flatten(1)]
+  end
+
+  def init_edges
+    Hash.new do |hash,key|
+      hash[key] = Set.new
+    end
+  end
+
+  def init_neighbors
+    Hash[*nodenums.zip(nodenums.map {|num| gen_neighbors(num)}).flatten(1)]
+  end
+
+  def nodenums
+    (0...(@x * @y)).to_a
+  end
+
+  def gen_neighbors(node)
+    coords = @node_coords[node]
+    candidates = [[-1,0],[1,0],[0,-1],[0,1]].map {|dx,dy| [coords[0] + dx, coords[1] + dy]}
+    candidates.select {|px,py| in_graph(px,py)}.map {|px,py| cell_for_coords(px,py)}
+  end
+end

data/lib/willb-mazegen/maze.rb

@@ -0,0 +1,59 @@
+# maze.rb is licensed under the Apache Software License, version 2.0 
+# and copyright (c) 2010 William Benton (http://willbenton.com)
+
+class Maze
+  def initialize(x,y)
+    @cg = CellGraph.new(x,y)
+  end
+  
+  attr_reader :cg
+  
+  def size 
+    [@cg.x,@cg.y]
+  end
+  
+  def gen
+    reset
+    while @walls.size > 0
+      source,dest = @walls.delete_at(rand(@walls.size))
+      unless @maze_cells.include? dest
+        @maze_cells << dest
+        @cg.add_edge(source=>dest)
+        @walls = @walls + walls_for(dest)
+      end
+    end
+  end
+  
+  def walls_for(cell)
+    @cg.neighbors(cell).map {|nbc| [cell,nbc]} - @cg.edges_from(cell)
+  end
+  
+  def closed_sides(cell)
+    cx,cy = @cg.coords_for_cell(cell)
+    positions = {:left=>[-1,0], :right=>[+1,0], :top=>[0,-1], :bottom=>[0,+1]}
+    result = positions.inject([]) do |acc, pair| 
+      dir = pair[0]
+      dx,dy = pair[1]
+      candidate_coords = [cx+dx,cy+dy]
+      acc << dir if !(cg.in_graph(*candidate_coords)) || (!cg.edges_from(cell).map {|s,d| d}.include? @cg.cell_for_coords(*candidate_coords))
+      acc
+    end
+    
+    result -= [:top] if cell == @startcell
+    result -= [:bottom] if cell == @endcell
+    
+    result
+  end
+  
+  private
+  def reset
+    @cg.reset_edges
+    
+    @maze_cells = (Set.new << 0)
+    @walls = walls_for(0)
+    
+    @startcell = 0
+    @endcell = (@cg.x * @cg.y) - 1
+  end
+end
+

data/lib/willb-mazegen/mazerenderer.rb

@@ -0,0 +1,39 @@
+# mazerenderer.rb is licensed under the Apache Software License, version 2.0 
+# and copyright (c) 2010 William Benton (http://willbenton.com)
+
+class MazeRenderer
+  def initialize(m, cellsize)
+    @maze = m
+    @cellsize = cellsize
+  end
+  
+  def render_lines
+    acc = []
+    cols,rows = @maze.size
+    (0...rows).each do |y|
+      (0...cols).each do |x|
+        corners = gen_corners(x,y)
+        @maze.closed_sides(y*cols+x).each do |wall|
+          case wall
+            when :top then 
+              acc << [corners[:ul], corners[:ur]]
+            when :bottom then 
+              acc << [corners[:bl], corners[:br]]
+            when :left then 
+              acc << [corners[:ul], corners[:bl]]
+            when :right then
+              acc << [corners[:ur], corners[:br]]
+          end
+        end
+      end
+    end
+    
+    acc
+  end
+  
+  private
+  def gen_corners(x,y)
+    pairs = {:ul=>[x,y],:ur=>[x+1,y],:bl=>[x,y+1],:br=>[x+1,y+1]}.map {|key,val| [key,val.map{|p| p * @cellsize}]}
+    Hash[*pairs.flatten(1)]
+  end
+end

data/spec/mazegen_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Mazegen" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mazegen'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: willb-mazegen
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Will Benton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-06 00:00:00 -06:00
+default_executable: mazegen
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+    version: 
+description: Simple PDF maze generator, based on spanning trees.  Can generate one or many mazes of different complexities.
+email: willbenton@gmail.com
+executables: 
+- mazegen
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/mazegen
+- lib/willb-mazegen/cellgraph.rb
+- lib/willb-mazegen/maze.rb
+- lib/willb-mazegen/mazerenderer.rb
+- spec/mazegen_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/willb/mazegen
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple PDF maze generator
+test_files: 
+- spec/mazegen_spec.rb
+- spec/spec_helper.rb