command_four 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72057059e8d1017885ac9dc9a4e4afd0ccc49cdd207e3fd2472a7bb1087345e1
+  data.tar.gz: 1c604bf1c478bb1dfe578c7218cf8426eaa3ecb5f04ebfa0cdffa4480be38c7d
+SHA512:
+  metadata.gz: 9e2ae842c825a41ad570f04281cb49a9c2878f44e6058b11cc76d4f8f894d2387e117309be1ab1b89fabcb9d73e4ab27fd7f911e53704bd3d0210660c915ca5a
+  data.tar.gz: 424508b7559afd8415d9eccab9b1ae6dec4583bf05864b0d1f08c410bf2a392877a5bcc4c6a6d8b6842ffc8a33402a5eb0eef218260e54bd14eb166ff482fc84

data/.gitignore

@@ -0,0 +1,13 @@
+todo.txt
+.vscode
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "colorize", ">=0.8.1"
+gem "rspec", "~> 3.0"
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    command_four (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  colorize (>= 0.8.1)
+  command_four!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,22 @@
+  
+MIT License
+
+Copyright (c) 2020 Christopher Edwards
+
+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,39 @@
+# Command Four
+
+A command-line implementation of Connect Four written in Ruby
+
+## Gameplay
+
+From [Wikipedia](https://en.wikipedia.org/wiki/command_Four):
+
+>Connect Four is a two-player connection board game in which the players first choose a color and then take turns dropping one colored disc from the top into a seven-column, six-row vertically suspended grid. The pieces fall straight down, occupying the lowest available space within the column. The objective of the game is to be the first to form a horizontal, vertical, or diagonal line of four of one's own discs." 
+
+This command line app has players enter a column number between 1 and 7 to indicate into which column they wish to drop their disc:
+
+![A game in progress](game_in_progress.png)
+
+The game ends when one player gets four in a row, at which point the players get the option to play again. The losing player of one round will go first in the next round:
+
+![A completed game in which Yellow won](finished_game.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'command_four'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install command_four
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
+
+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).

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

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "command_four"
+CLI.new.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/command_four.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/command_four/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "command_four"
+  spec.version       = CommandFour::VERSION
+  spec.authors       = ["Christopher Edwards"]
+  spec.email         = ["cedwards036@gmail.com"]
+  
+  spec.summary       = %q{A command-line connect-four game for two players}
+  spec.homepage      = "https://github.com/cedwards036/command-four"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cedwards036/command-four"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["command_four"]
+  spec.require_paths = ["lib"]
+end

data/lib/command_four.rb

@@ -0,0 +1,4 @@
+require 'command_four/board'
+require 'command_four/board_renderer'
+require 'command_four/version'
+require 'command_four/cli'

data/lib/command_four/board.rb

@@ -0,0 +1,233 @@
+class Board
+  attr_reader :width, :height
+
+  def initialize(width = 7, height = 6, connect_n = 4)
+    @width = width
+    @height = height
+    @connect_n = connect_n
+    @state = GameState.new(false, [])
+    @board = Array.new(@width) {Array.new(@height, :empty)}
+    @completed_moves = 0
+    @max_moves = width * height
+  end
+
+  def drop_piece(column, color)
+    if game_over?()
+      raise PieceDropError.new("Game is already over")
+    elsif invalid_index?(column)
+      raise PieceDropError.new("Invalid column index: #{column}")
+    elsif full?(column)
+      raise PieceDropError.new("Column #{column} is already full")
+    else
+      first_empty_cell_index = @board[column].index {|cell| cell == :empty}
+      @board[column][first_empty_cell_index] = color
+      @completed_moves += 1
+      @state = ConnectNChecker.new(@board, @connect_n, column, first_empty_cell_index).check
+      if @completed_moves >= @max_moves && !game_over?()
+        @state = GameState.new(true, [])
+      end
+    end
+  end
+
+  def game_over?
+    @state.game_over?
+  end
+
+  def winning_cells
+    @state.winning_cells
+  end
+
+  def winning_color
+    if @state.winning_cells.length > 0
+      col_idx = @state.winning_cells[0][0]
+      row_idx = @state.winning_cells[0][1]
+      @board[col_idx][row_idx]
+    else
+      nil
+    end
+  end
+    
+  def self.from_a(arr, connect_n = 4)
+    board = Board.new(arr.length, arr[0].length, connect_n)
+    for i in 0...arr[0].length
+      for j in 0...arr.length
+        if arr[j][i] != :empty
+          board.drop_piece(j, arr[j][i])
+        end
+      end
+    end
+    board
+  end
+
+  def to_a
+    @board
+  end
+
+  class PieceDropError < StandardError
+  end
+
+  private
+
+  def invalid_index?(column)
+    column < 0 || column >= @width
+  end
+
+  def full?(column)
+    @board[column][-1] != :empty
+  end
+
+  class ConnectNChecker
+
+    def initialize(board, connect_n, col_idx, row_idx)
+      @col_idx = col_idx
+      @row_idx = row_idx
+      @cur_color = board[col_idx][row_idx]
+      @width = board.length
+      @height = board[0].length
+      @board = board
+      @connect_n = connect_n
+      @winning_cells = []
+    end
+
+    def check
+      if check_horizontal || check_vertical || check_left_diag || check_right_diag
+        GameState.new(true, @winning_cells)
+      else
+        GameState.new(false, [])
+      end
+    end
+
+    def check_horizontal
+      @winning_cells = []
+      total_count = get_right_count + get_left_count
+      total_count >= @connect_n
+    end
+
+    def check_vertical
+      @winning_cells = []
+      total_count = get_up_count + get_down_count
+      total_count >= @connect_n
+    end
+
+    def check_left_diag
+      @winning_cells = []
+      total_count = get_up_left_count + get_down_left_count
+      total_count >= @connect_n
+    end
+
+    def check_right_diag
+      @winning_cells = []
+      total_count = get_up_right_count + get_down_right_count
+      total_count >= @connect_n
+    end
+
+    def get_right_count
+      consecutive_count = 0
+      cur_col_idx = @col_idx
+      while cur_col_idx < @width && consecutive_count <= @connect_n && @board[cur_col_idx][@row_idx] == @cur_color
+        @winning_cells.push([cur_col_idx, @row_idx])
+        cur_col_idx += 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_left_count
+      consecutive_count = 0
+      cur_col_idx = @col_idx - 1
+      while cur_col_idx >= 0 && consecutive_count <= @connect_n && @board[cur_col_idx][@row_idx] == @cur_color
+        @winning_cells.push([cur_col_idx, @row_idx])
+        cur_col_idx -= 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_up_count
+      consecutive_count = 0
+      cur_row_idx = @row_idx
+      while cur_row_idx < @height && consecutive_count <= @connect_n && @board[@col_idx][cur_row_idx] == @cur_color
+        @winning_cells.push([@col_idx, cur_row_idx])
+        cur_row_idx += 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_down_count
+      consecutive_count = 0
+      cur_row_idx = @row_idx - 1
+      while cur_row_idx >= 0 && consecutive_count <= @connect_n && @board[@col_idx][cur_row_idx] == @cur_color
+        @winning_cells.push([@col_idx, cur_row_idx])
+        cur_row_idx -= 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_up_left_count
+      consecutive_count = 0
+      cur_row_idx = @row_idx
+      cur_col_idx = @col_idx
+      while cur_row_idx < @height && cur_col_idx >= 0 && consecutive_count <= @connect_n && @board[cur_col_idx][cur_row_idx] == @cur_color
+        @winning_cells.push([cur_col_idx, cur_row_idx])
+        cur_row_idx += 1
+        cur_col_idx -= 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_down_left_count
+      consecutive_count = 0
+      cur_row_idx = @row_idx - 1
+      cur_col_idx = @col_idx + 1
+      while cur_row_idx >= 0 && cur_col_idx < @width && consecutive_count <= @connect_n && @board[cur_col_idx][cur_row_idx] == @cur_color
+        @winning_cells.push([cur_col_idx, cur_row_idx])
+        cur_row_idx -= 1
+        cur_col_idx += 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_up_right_count
+      consecutive_count = 0
+      cur_row_idx = @row_idx
+      cur_col_idx = @col_idx
+      while cur_row_idx < @height && cur_col_idx < @width && consecutive_count <= @connect_n && @board[cur_col_idx][cur_row_idx] == @cur_color
+        @winning_cells.push([cur_col_idx, cur_row_idx])
+        cur_row_idx += 1
+        cur_col_idx += 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+
+    def get_down_right_count
+      consecutive_count = 0
+      cur_row_idx = @row_idx - 1
+      cur_col_idx = @col_idx - 1
+      while cur_row_idx >= 0 && cur_col_idx >= 0 && consecutive_count <= @connect_n && @board[cur_col_idx][cur_row_idx] == @cur_color
+        @winning_cells.push([cur_col_idx, cur_row_idx])
+        cur_row_idx -= 1
+        cur_col_idx -= 1
+        consecutive_count += 1
+      end
+      consecutive_count
+    end
+  end
+
+  class GameState
+    attr_reader :winning_cells
+    def initialize(game_is_over, winning_cells)
+      @game_is_over = game_is_over
+      @winning_cells = winning_cells
+    end
+  
+    def game_over?
+      @game_is_over
+    end
+  end
+
+end

data/lib/command_four/board_renderer.rb

@@ -0,0 +1,53 @@
+require 'colorize'
+
+class BoardRenderer
+  def initialize(board)
+    @board = board
+  end
+
+  def render_for_printing
+    row_divider = ("+" + ("----+" * @board.width)).blue 
+    col_divider = "|".blue
+    result = "" << (row_divider + "\n")
+    string_symbol_board = @board.to_a.map do |row|
+      row.map {|cell_color| TextCell.new(" ", "#{color_to_s(cell_color)}", "  ")}
+    end
+    if @board.game_over?
+      add_winning_cell_highlights(string_symbol_board)
+    end
+    string_board = string_symbol_board.transpose.reverse.map do |row|
+      col_divider + row.map(&:to_s).join(col_divider) + col_divider
+    end
+    result << string_board.join(+ "\n" + row_divider + "\n") << "\n" <<row_divider
+  end
+
+  private
+
+  def color_to_s(color)
+    large_filled_circle = "\u2B24".encode('utf-8')
+    case color
+    when :red
+      large_filled_circle.red
+    when :yellow
+      large_filled_circle.yellow
+    when :empty
+      " "
+    else
+      raise "Invalid color #{color}"
+    end
+  end
+
+  def add_winning_cell_highlights(string_symbol_board)
+    @board.winning_cells.each do |coord|
+      text_cell = string_symbol_board[coord[0]][coord[1]]
+      text_cell.left_bookmark = "["
+      text_cell.right_bookmark = " ]"
+    end
+  end
+
+  TextCell = Struct.new(:left_bookmark, :text, :right_bookmark) do
+    def to_s
+      "#{left_bookmark}#{text}#{right_bookmark}"
+    end
+  end
+end

data/lib/command_four/cli.rb

@@ -0,0 +1,101 @@
+require 'colorize'
+
+require 'command_four/board'
+require 'command_four/board_renderer'
+require 'command_four/version'
+
+class CLI
+  def start
+    game_is_in_session = true
+    colors = Colors.new
+    print_welcome_banner
+    while game_is_in_session
+      play_round(colors)
+      game_is_in_session = check_if_game_should_continue
+    end
+    puts "Thank you for playing!"
+  end
+
+  def print_welcome_banner
+    puts "========================="
+    puts " Welcome to Command Four"
+    puts "========================="
+  end
+
+  def play_round(colors)
+    board = Board.new
+    renderer = BoardRenderer.new(board)
+    until board.game_over?
+      puts renderer.render_for_printing
+      puts "#{color_to_s(colors.current_color)}'s turn"
+      play_turn(board, colors.current_color)
+      colors.switch_color
+    end
+    print_end_of_game_summary(board, renderer)
+  end
+
+  def play_turn(board, color)
+    turn_was_successful = false
+    until turn_was_successful  
+      print "Please enter a column number between 1 (far-left) and #{board.width} (far-right): " 
+      response = gets.chomp
+      if column_response_is_valid(response, board)
+        column = response.to_i - 1
+        begin
+          board.drop_piece(column, color)
+          turn_was_successful = true
+        rescue Board::PieceDropError
+          puts "Column #{response} is already full"
+        end
+      end
+    end
+  end
+
+  def column_response_is_valid(response, board)
+    /^[0-9]+$/ =~ response && response.to_i > 0 && response.to_i <= board.width
+  end
+
+  def check_if_game_should_continue
+    response = ""
+    until ["y", "n"].include? response
+        print "Would you like to play again (y / n)? "
+        response = gets.chomp.downcase
+    end
+    response == 'y'
+  end
+
+  def print_end_of_game_summary(board, renderer)
+    puts renderer.render_for_printing
+    if board.winning_color
+      puts "#{color_to_s(board.winning_color)} wins!"
+    else
+      puts "It's a draw!"
+    end
+  end
+
+  class Colors
+    def initialize
+      @colors = [:red, :yellow]
+      @cur_colors_index = 0
+    end
+
+    def current_color
+      @colors[@cur_colors_index]
+    end
+
+    def switch_color
+      @cur_colors_index = (@cur_colors_index + 1) % 2
+    end
+  end
+
+  def color_to_s(color)
+    case color
+    when :red
+      color.to_s.capitalize.red
+    when :yellow
+      color.to_s.capitalize.yellow
+    else
+      raise "Invalid color #{color}"
+    end
+  end
+end

data/lib/command_four/version.rb

@@ -0,0 +1,3 @@
+module CommandFour
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: command_four
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Edwards
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-21 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- cedwards036@gmail.com
+executables:
+- command_four
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/command_four
+- bin/setup
+- command_four.gemspec
+- finished_game.png
+- game_in_progress.png
+- lib/command_four.rb
+- lib/command_four/board.rb
+- lib/command_four/board_renderer.rb
+- lib/command_four/cli.rb
+- lib/command_four/version.rb
+homepage: https://github.com/cedwards036/command-four
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cedwards036/command-four
+  source_code_uri: https://github.com/cedwards036/command-four
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A command-line connect-four game for two players
+test_files: []