towers_of_hanoi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd03a1e2611d2ec24b4a9c1a681ff410f02a8af9
+  data.tar.gz: b23013ba447c926284057f0234445bc98fbda96e
+SHA512:
+  metadata.gz: f71e154207fe2e63be2244a003f6c4a32f552160bc3db3d3bbd587d7443b634d409cad02f3b20dcdb7c7d4c2f605f6e5c4824c1f16b0eea51acd97b16cb4b38d
+  data.tar.gz: 1a4610cba42b481b86c6a85d5cdf27e85dcb7a79e15e0d6c4ae894c8b4648fbc715505e0900fe48876187e477f94742558e76a62fbd8b0d06b5cc45099328869

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andur Carr
+
+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,46 @@
+# Towers of Hanoi
+
+The Tower of Hanoi is a puzzle game created by Édouard Lucas in the 19th century. The goal is to move discs, which are of different sizes, from one of three pegs to another, by moving only one disc at a time and never placing a larger disc on top of a smaller one. This gem provides both an API for building this game and a CLI version of the game for demonstration.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'towers_of_hanoi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install towers_of_hanoi
+
+
+## Usage
+
+With Ruby installed, a command line demonstration of this game can be run with the following command in this project's directory:
+
+```
+$ bin/towers_of_hanoi
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lamarseillaise/towers_of_hanoi.
+
+
+## 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/bin/console

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

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "towers_of_hanoi"
+
+TowersOfHanoi::Controller.new.run

data/lib/towers_of_hanoi/board/base.rb

@@ -0,0 +1,11 @@
+require_relative "./brick"
+
+module TowersOfHanoi
+  class Board
+    class Base < Brick
+      def initialize(width: 3)
+        @width = width
+      end
+    end
+  end
+end

data/lib/towers_of_hanoi/board/brick.rb

@@ -0,0 +1,15 @@
+module TowersOfHanoi
+  class Board
+    class Brick
+      attr_reader :width
+
+      def initialize(width: 0)
+        @width = width
+      end
+
+      def <(brick)
+        width < brick.width
+      end
+    end
+  end
+end

data/lib/towers_of_hanoi/board/tower.rb

@@ -0,0 +1,38 @@
+module TowersOfHanoi
+  class Board
+    class Tower
+      def initialize(max_bricks: 3, bricks: 0)
+        @max_bricks = max_bricks
+        @bricks = Array.new(bricks).map.with_index do |el, idx|
+          TowersOfHanoi::Board::Brick.new(width: max_bricks - idx)
+        end
+      end
+
+      def height
+        @bricks.length
+      end
+
+      def top
+        brick(height) || TowersOfHanoi::Board::Base.new(width: @max_bricks + 1)
+      end
+
+      def full?
+        height == @max_bricks
+      end
+
+      def brick(position)
+        if (1..@max_bricks) === position
+          @bricks[position - 1] || TowersOfHanoi::Board::Brick.new
+        end
+      end
+
+      def add(new_brick)
+        @bricks.push(new_brick)
+      end
+
+      def remove
+        @bricks.pop
+      end
+    end
+  end
+end

data/lib/towers_of_hanoi/board.rb

@@ -0,0 +1,18 @@
+module TowersOfHanoi
+  class Board
+    attr_reader :bricks
+
+    def initialize(bricks: 3)
+      @bricks = bricks
+      @towers = [
+        TowersOfHanoi::Board::Tower.new(max_bricks: @bricks, bricks: @bricks),
+        TowersOfHanoi::Board::Tower.new(max_bricks: @bricks),
+        TowersOfHanoi::Board::Tower.new(max_bricks: @bricks)
+      ]
+    end
+
+    def tower(position)
+      @towers[position - 1] if (1..3) === position
+    end
+  end
+end

data/lib/towers_of_hanoi/controller.rb

@@ -0,0 +1,47 @@
+module TowersOfHanoi
+  class Controller
+    def initialize
+      @view = TowersOfHanoi::View.new
+    end
+
+    def run
+      puts @view.introduction
+      loop do
+        if tiles = select_number_of_tiles
+          game = TowersOfHanoi::Game.new(bricks: tiles)
+          puts @view.board_template(game.board)
+          play(game)
+          puts @view.victory_message(game)
+        else
+          puts @view.invalid_input_message
+        end
+      end
+    end
+
+    def select_number_of_tiles
+      number = get_input(@view.ask_for_number_of_tiles).to_i
+      (1..10) === number && number
+    end
+
+    def play(game)
+      until game.over? do
+        game.make_move(TowersOfHanoi::Move.new(
+          origin:      get_input(@view.ask_origin).to_i,
+          destination: get_input(@view.ask_destination).to_i
+        ))
+        puts @view.board_template(game.board)
+      end
+    end
+
+
+    private
+
+    def get_input(label = nil)
+      puts label if label
+      print '> '
+      input = gets.chomp
+      exit if input.start_with?('q') || input == "exit"
+      input
+    end
+  end
+end

data/lib/towers_of_hanoi/game.rb

@@ -0,0 +1,32 @@
+module TowersOfHanoi
+  class Game
+    attr_reader :moves, :board
+
+    def initialize(bricks: 3, moves: [])
+      @board = TowersOfHanoi::Board.new(bricks: bricks)
+      @moves = moves
+
+      @moves.each { |move| move.make(@board) }
+    end
+
+    def number_of_bricks
+      @board.bricks
+    end
+
+    def turns
+      @moves.length
+    end
+
+    def over?
+      @board.tower(3).full?
+    end
+
+    def make_move(move)
+      @moves << move if move.make(@board)
+    end
+
+    def minimum_turns
+      2**number_of_bricks - 1
+    end
+  end
+end

data/lib/towers_of_hanoi/move.rb

@@ -0,0 +1,24 @@
+module TowersOfHanoi
+  class Move
+    attr_reader :origin, :destination
+
+    def initialize(origin: nil, destination: nil)
+      @origin = origin
+      @destination = destination
+    end
+
+    def make(board)
+      if valid?(board)
+        board.tower(destination).add(board.tower(origin).remove)
+      end
+    end
+
+
+    private
+
+    def valid?(board)
+      (1..3) === origin && (1..3) === destination &&
+      board.tower(origin).top < board.tower(destination).top
+    end
+  end
+end

data/lib/towers_of_hanoi/version.rb

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

data/lib/towers_of_hanoi/view.rb

@@ -0,0 +1,90 @@
+module TowersOfHanoi
+  class View
+    BLANK  = ' '
+    SIDE   = '|'
+    TOP    = '-'
+    CORNER = '+'
+    TILE   = '='
+
+    def introduction
+      "Welcome to Towers of Hanoi!\n\n" +
+      "The object of this simple game is to move all of the tiles\n" +
+      "from the first tower (1) to the last tower (3).\n\n" +
+      "You must move only one tile at a time, from one tower to another,\n" +
+      "without placing a larger tile on top of a smaller tile.\n\n" +
+      "Enter 'q' to exit at any time.\n\n"
+    end
+
+    def ask_for_number_of_tiles
+      "How many tiles would you like in your tower?"
+    end
+
+    def too_many_tiles_message
+      "Playing with more than 10 tiles is not recommended due to requiring over 1000 moves to complete.\n\n"
+    end
+
+    def invalid_input_message
+      "Please enter a numeric value between 1 and 10.\n\n"
+    end
+
+    def ask_origin
+      "Move from:"
+    end
+
+    def ask_destination
+      "Move to:"
+    end
+
+    def victory_message(game)
+      "Completed in #{game.turns} moves! (minimum: #{game.minimum_turns})"
+    end
+
+    def board_template(board)
+      number_of_bricks = board.bricks
+
+      CORNER + horizontal_border(number_of_bricks) + CORNER + "\n" +
+
+      number_of_bricks.downto(1).map do |row|
+        SIDE + brick_row(row, board) + SIDE + "\n"
+      end.join +
+
+      SIDE + column_labels(number_of_bricks) + SIDE + "\n" +
+      CORNER + horizontal_border(number_of_bricks) + CORNER + "\n"
+    end
+
+
+    private
+
+    def horizontal_border(number_of_bricks)
+      TOP * (number_of_bricks * 6 - 1)
+    end
+
+    def column_labels(padding)
+      (1..3).map do |column|
+        BLANK * (padding - 1) +
+        column.to_s +
+        BLANK * (padding - 1)
+      end.join(BLANK)
+    end
+
+    def brick_row(row, board)
+      (1..3).to_a.map do |column|
+        brick(board.tower(column).brick(row).width, board.bricks)
+      end.join(BLANK)
+    end
+
+    def brick(width, number_of_bricks)
+      brick_buffer(width, number_of_bricks) +
+      (width > 0 ? TILE * (2 * width - 1) : BLANK) +
+      brick_buffer(width, number_of_bricks)
+    end
+
+    def brick_buffer(brick_width, number_of_bricks)
+      if brick_width > 0
+        BLANK * (number_of_bricks - brick_width)
+      else
+        BLANK * (number_of_bricks - 1)
+      end
+    end
+  end
+end

data/lib/towers_of_hanoi.rb

@@ -0,0 +1,9 @@
+require "towers_of_hanoi/version"
+require "towers_of_hanoi/controller"
+require "towers_of_hanoi/board"
+require "towers_of_hanoi/game"
+require "towers_of_hanoi/move"
+require "towers_of_hanoi/view"
+require "towers_of_hanoi/board/tower"
+require "towers_of_hanoi/board/brick"
+require "towers_of_hanoi/board/base"

data/towers_of_hanoi.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'towers_of_hanoi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "towers_of_hanoi"
+  spec.version       = TowersOfHanoi::VERSION
+  spec.authors       = ["Andur Carr"]
+  spec.email         = ["carr.andur@gmail.com"]
+
+  spec.summary       = %q{A 'Tower of Hanoi' game for the command line.}
+  spec.description   = %q{A 'Tower of Hanoi' game for the command line.}
+  spec.homepage      = "https://github.com/lamarseillaise/towers_of_hanoi"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: towers_of_hanoi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andur Carr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A 'Tower of Hanoi' game for the command line.
+email:
+- carr.andur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/towers_of_hanoi
+- lib/towers_of_hanoi.rb
+- lib/towers_of_hanoi/board.rb
+- lib/towers_of_hanoi/board/base.rb
+- lib/towers_of_hanoi/board/brick.rb
+- lib/towers_of_hanoi/board/tower.rb
+- lib/towers_of_hanoi/controller.rb
+- lib/towers_of_hanoi/game.rb
+- lib/towers_of_hanoi/move.rb
+- lib/towers_of_hanoi/version.rb
+- lib/towers_of_hanoi/view.rb
+- towers_of_hanoi.gemspec
+homepage: https://github.com/lamarseillaise/towers_of_hanoi
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: A 'Tower of Hanoi' game for the command line.
+test_files: []