connect_four_2307 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ced57e94e7fa7afe035b7ff6f77d801e1e7b4fda261f369a15246aeeec41171
+  data.tar.gz: 5f666da86f8234ca8b06c4bcac87417d94569691056a1cabdfb4a78ccb8a769e
+SHA512:
+  metadata.gz: 457d46850a3415c7d6f4b30244f66b438aa0e97c2abf9175916d7549b3b5f93af4692055885ccd0c569d464a97b6bebb2e59f887c79fa8509b2d10cbd84a8c40
+  data.tar.gz: 13058fbb87fdf708583c8b793170fe2c8404099a5709c4615cad0f30e7e5d164aa522644ba80d9294e895b1d3b2211696effaad924c7e56179ac935ef774efc2

data/.rspec

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Tyler Blackmon
+
+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,78 @@
+# **CONNECT FOUR - PAIR PROJECT - TURING - MOD1**
+![funny image](https://i.kym-cdn.com/photos/images/original/001/335/681/bac.jpg)
+## **Overview:**
+
+This project explores creating a version of the classic game Connect Four as a CLI game within your computer terminal. A specific requirement of this project was to develop all code given only written instruction without code prompts from an interaction pattern. As a pair, our team was able to design architecture for this application and implement that design in our codebase to create a functioning and interactive game. The project explores the concept of abstraction in OOP through creation of complex, logic based methods that are applied to a gameflow found in the game controller class. 
+
+
+## **User interaction outcome:**
+The game in it's current state provides two game modes for the player: one player, and two player. In our one player mode, the player plays against a computer which places a random piece after a player's turn until winning conditions are met by either the computer or player. In two player mode, two human players can play on the same terminal placing one piece per turn until winning conditions are met by one player. 
+
+## **Tech Stack:**
+- Ruby
+- Gems: RSpec
+
+## **Additional Documentation:**
+[Google Doc Brainstom](https://docs.google.com/document/d/1P3wmFz5bldRx5s5Ox9hBn4K1FPc2cF2PQGabBorPTnc/edit#heading=h.h8krlvcjmayj)
+[Defining Relationship](https://docs.google.com/document/d/1QYJ4KUGjahCnPv96DBg9BflEC1-6jwJpzyDmNIjcJL8/edit)
+
+## **Skills Gained/Expanded:**
+- Codebase architecture and design
+- Pair programming - driver/navigator, general collaboration, and collective creativity in design
+- TDD - utilizing testing in RSpec to ensure incremenental functionality of all methods; unit and integrations
+- CLI testing - utilizing user interactive testing alongside TDD to verify application functionality
+
+## **Reflection Points:**
+1. This project did not provide an interaction pattern. How did you approach the design and problem solving process for this project?
+
+*We began by putting our general thoughts on a Google Doc. We them split up our Google Doc by iteration of the project and revisited the documentation to brainstom at the beginning of each iteration. During the brainstorming sessions, we applied pseudo coding techniques as well as writing potential method and class names. During the last iteration we utilized Replit to play around with code for the check_diagonal_win method. We approached the design aspect from the get-go based on the data structure of the board. We began with a hash of hashes, and quickly reverted to an array of arrays once we began the second iteration. During each step of brainstorming, we also tried to foresee any potential roadblocks, or design flaws in order to better understand the limitations of our ideas.*
+
+2. If you had one more day to work on this project, what would you work on?
+
+*We would most likely try to implement the HTTP requirements in order for two players to be able to play each other across the web. We would also like to make the user interface a bit friendlier by creating better spacing in the board, making it visually easier to play the game.*
+
+3. Describe the pairing techniques you used while working on this project.
+
+*We utilized some driver/navigator techniques as well as divide and conquer. For some of the more complex methods (checking win conditions), we attempted to separate and come up with our solutions in order to juxtapose. For some simpler methods such as the ones found in iteration 1 and 2, we simply divided the work, and created pull requests with detailed summaries that we reviewed and commented on before merging into the main branch.**
+
+4. Describe how feedback was shared over the course of this project.
+
+*We gave feedback in the form of assuring mutual understanding when implementing new methods and design. When one partner did not understand the exact logic or reasoning behind method design, we took the time to explain it to one another. During driver/navigator sessions, we gave direct but polite feedback when making a correction change to the code. We showed appreciation for each others contributions along the way, and acknowledged when one partner provided a solution that was better than another.*
+
+# GEM INSTALLATION
+
+# ConnectFour2307
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/connect_four_2307`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/connect_four_2307.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/connect_four.rb

@@ -0,0 +1,5 @@
+require './lib/game_controller'
+
+gc = GameController.new
+#could put in here an input that distinguishes between player1 and player 2\
+gc.start_game

data/connect_four_2307.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/connect_four_2307/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "connect_four_2307"
+  spec.version = ConnectFour2307::VERSION
+  spec.authors = ["Tyler Blackmon", "Antoine Aube"]
+  spec.email = ["tyler.blackmon8@gmail.com", "aaube3@gmail.com"]
+
+  spec.summary = "A simple gem to play Connect 4 from a CLI."
+  spec.homepage = "https://github.com/Antoine-Aube/connect_four"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Antoine-Aube/connect_four"
+  spec.metadata["changelog_uri"] = "https://github.com/Antoine-Aube/connect_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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  # spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables = ["connect_four_2307"]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/connect_four_2307

@@ -0,0 +1,3 @@
+require "connect_four_2307"
+
+ConnectFour2307.start

data/lib/connect_four_2307/board.rb

@@ -0,0 +1,38 @@
+require_relative 'cell'
+
+class Board
+  attr_reader :board_grid
+
+  def initialize
+    @board_grid = generate_board
+  end
+
+  def generate_board
+    board = [
+      [Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new],
+      [Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new],
+      [Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new],
+      [Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new],
+      [Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new],
+      [Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new, Cell.new]
+  ]
+  end
+
+  
+  def render_board
+    puts "ABCDEFG"
+    
+    @board_grid.each do |row|
+      row.each do |cell|
+        print cell.state
+      end
+      puts "\n"
+    end
+  end
+
+  def board_is_full? 
+    @board_grid[0].none? do |cell|
+      cell.state == "."
+    end
+  end
+end

data/lib/connect_four_2307/cell.rb

@@ -0,0 +1,11 @@
+class Cell 
+  attr_reader :state
+
+  def initialize
+    @state = "."
+  end
+
+  def set_state(player_piece)
+    @state = player_piece
+  end
+end

data/lib/connect_four_2307/computer.rb

@@ -0,0 +1,9 @@
+class Computer
+  attr_reader :piece
+  attr_accessor :winner
+  
+  def initialize
+    @piece = "O"
+    @winner = false
+  end
+end

data/lib/connect_four_2307/game_controller.rb

@@ -0,0 +1,112 @@
+require_relative 'board'
+require_relative 'turn'
+require_relative 'player'
+require_relative 'computer'
+
+class GameController
+  def start_game
+    puts "Welcome to Connect 4!!!"
+    puts "Enter P to start a game, or Q to quit."
+    user_input = gets.chomp.downcase
+    while user_input != "p" && user_input != "q"
+      "Please enter P to start a game, or Q to quit."
+      user_input = gets.chomp.downcase
+    end
+    if user_input == "q"
+      exit()
+    end
+    puts "Enter 1 for one player and 2 for two players"
+    user_input = gets.chomp.downcase
+    while user_input != "1" && user_input != "2"
+      puts "Invalid input! Please enter 1 for one player and 2 for two players"
+      user_input = gets.chomp.downcase
+    end
+    
+    if user_input == "1"
+      one_player_game
+    else
+      two_player_game
+    end
+  end
+
+  def one_player_game
+    board = Board.new
+    player_1 = Player.new("X")
+    computer = Computer.new
+    puts "Enter Player 1 name"
+    player_one_name = gets.chomp
+    player_1.get_player_name(player_one_name)
+    puts 
+    board.render_board
+    turn_counter = 1
+    while !board.board_is_full? && !player_1.winner && !computer.winner
+      if turn_counter % 2 == 0
+        turn = Turn.new(computer, board)
+        turn.get_move
+        turn.set_cell
+        turn.check_win_conditions
+      else
+        turn = Turn.new(player_1, board)
+        turn.get_move
+        turn.set_cell
+        turn.check_win_conditions
+      end
+      board.render_board
+      turn_counter += 1
+    end
+    if player_1.winner
+      puts "#{player_1.name} wins! \n"
+      start_game
+    elsif computer.winner
+      puts "Computer wins! \n"
+      start_game
+    elsif board.board_is_full?
+      puts "Draw! \n"
+      start_game
+    end
+  end
+
+
+  def two_player_game
+    board = Board.new
+    player_1 = Player.new("X")
+    player_2 = Player.new("O")
+    puts "Enter Player 1 name"
+    player_one_name = gets.chomp
+    player_1.get_player_name(player_one_name)
+    puts 
+    puts "Enter Player 2 name"
+    player_two_name = gets.chomp
+    player_2.get_player_name(player_two_name)
+    puts 
+    board.render_board
+    turn_counter = 1
+    while !board.board_is_full? && !player_1.winner && !player_2.winner
+      if turn_counter % 2 == 0
+        turn = Turn.new(player_2, board)
+        turn.get_move
+        turn.set_cell
+        turn.check_win_conditions
+        board.render_board
+        turn_counter += 1
+      else
+        turn = Turn.new(player_1, board)
+        turn.get_move
+        turn.set_cell
+        turn.check_win_conditions
+        board.render_board
+        turn_counter += 1
+      end
+    end
+    if player_1.winner
+      puts "#{player_1.name} wins!\n"
+      start_game
+    elsif player_2.winner
+      puts "#{player_2.name} wins!\n"
+      start_game
+    elsif board.board_is_full?
+      puts "Draw!"
+      start_game
+    end
+  end
+end 

data/lib/connect_four_2307/player.rb

@@ -0,0 +1,15 @@
+
+class Player 
+  attr_reader :piece, :name
+  attr_accessor :winner
+  
+  def initialize(piece)
+    @piece = piece
+    @winner = false
+    @name = nil
+  end
+
+  def get_player_name(name)
+    @name = name
+  end
+end

data/lib/connect_four_2307/turn.rb

@@ -0,0 +1,134 @@
+class Turn
+  attr_reader :player,
+              :board,
+              :columns
+
+  attr_accessor :move
+
+  def initialize(player, board)
+    @player = player
+    @board = board
+    @columns = ["a", "b", "c", "d", "e", "f", "g"]
+    @move = nil
+  end
+
+  def get_move
+    if @player.instance_of?(Player)
+      puts "#{@player.name}'s turn: place a piece in column A-G \n"
+      move = validate_player_move(gets.chomp.downcase)
+    else
+      move = get_computer_move
+    end
+    @move = move
+  end
+  
+  def validate_player_move(move)
+    while !@columns.include?(move) || column_is_full?(move)
+      puts "Oops, that's an invalid move or a full column. Please select column A-G!"
+      move = gets.chomp.downcase
+    end
+    move
+  end
+
+  def column_is_full?(move)
+    column_index = @columns.index(move)
+    @board.board_grid[0][column_index].state != "."
+  end
+  
+  def get_computer_move
+    computer_move = @columns.sample
+    while validate_cpu_move(computer_move) == "invalid"
+      computer_move = @columns.sample
+    end
+    computer_move
+  end
+
+  def validate_cpu_move(move)
+    if column_is_full?(move)
+      return "invalid"
+    else 
+      move
+    end
+  end
+  
+  def set_cell
+    index_array = find_lowest_cell_in_column
+    @board.board_grid[index_array[0]][index_array[1]].set_state(@player.piece)
+  end
+  
+  def find_lowest_cell_in_column
+    index_1 = nil
+    index_2 = nil
+    @board.board_grid.reverse.each do |row|
+      if row[(@columns.index(@move))].state == "."
+        index_1 = @board.board_grid.index(row)
+        index_2 = @columns.index(@move)
+        break
+      end
+    end
+    [index_1, index_2]
+  end
+
+  def check_win_conditions
+    check_horizontal_win
+    check_vertical_win
+    check_diagonal_win
+  end
+
+  def get_board_as_states
+    @board.board_grid.map do |row|
+      row.map do |cell|
+        cell.state
+      end
+    end
+  end
+  
+  def check_horizontal_win
+    winning_string = ""
+    4.times { winning_string += "#{@player.piece}" }
+    board_as_states = get_board_as_states
+    board_as_states.each do |row|
+      @player.winner = true if row.join.include?(winning_string)
+    end
+  end
+
+  def check_vertical_win
+    winning_string = ""
+    4.times { winning_string += "#{@player.piece}" }
+    board_as_states = get_board_as_states
+    column_as_array = board_as_states.map { |row| row[@columns.index(@move)] }
+    @player.winner = true if column_as_array.join.include?(winning_string)
+  end
+
+  #range is acting as way to create index positions to check index positions on our board
+  def diag_offset_columns(board, range)
+    range.map do |outer_int|
+      (outer_int..(board[0].size - 1)).collect {|inner_int| board[inner_int - outer_int][inner_int]}
+    end
+  end
+
+  def diag_offset_rows(board, range)
+    range.map do |outer_int|
+      (outer_int..(board.size - 1)).collect {|inner_int| board[inner_int][inner_int - outer_int]}
+    end
+  end
+
+  def check_diagonal_win
+    winning_string = ""
+    4.times { winning_string += "#{@player.piece}" }
+    board_states = get_board_as_states
+    board_rotated = board_states.transpose.reverse
+    diag_offset_columns(board_states, (1..3)).each do |array|
+      @player.winner = true if array.join.include?(winning_string)
+    end
+    diag_offset_rows(board_states, (0..2)).each do |array|
+      @player.winner = true if array.join.include?(winning_string)
+    end
+    diag_offset_columns(board_rotated, (0..2)).each do |array|
+      @player.winner = true if array.join.include?(winning_string)
+    end
+    diag_offset_rows(board_rotated, (1..3)).each do |array|
+      @player.winner = true if array.join.include?(winning_string)
+    end
+  end
+end

data/lib/connect_four_2307/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ConnectFour2307
+  VERSION = "0.1.0"
+end

data/lib/connect_four_2307.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "connect_four_2307/version"
+require_relative "connect_four_2307/game_controller"
+
+module ConnectFour2307
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.start
+    GameController.new.start_game
+  end
+end

data/sig/connect_four_2307.rbs

@@ -0,0 +1,4 @@
+module ConnectFour2307
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: connect_four_2307
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Blackmon
+- Antoine Aube
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- tyler.blackmon8@gmail.com
+- aaube3@gmail.com
+executables:
+- connect_four_2307
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- connect_four.rb
+- connect_four_2307.gemspec
+- exe/connect_four_2307
+- lib/.keep
+- lib/connect_four_2307.rb
+- lib/connect_four_2307/board.rb
+- lib/connect_four_2307/cell.rb
+- lib/connect_four_2307/computer.rb
+- lib/connect_four_2307/game_controller.rb
+- lib/connect_four_2307/player.rb
+- lib/connect_four_2307/turn.rb
+- lib/connect_four_2307/version.rb
+- sig/connect_four_2307.rbs
+homepage: https://github.com/Antoine-Aube/connect_four
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Antoine-Aube/connect_four
+  source_code_uri: https://github.com/Antoine-Aube/connect_four
+  changelog_uri: https://github.com/Antoine-Aube/connect_four
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A simple gem to play Connect 4 from a CLI.
+test_files: []