Neil Hendren

cards.txt

@@ -0,0 +1,7 @@
+What is 10 + 15?,25,math
+What is the author of this repository's first name?,Neil,common_knowledge
+What is the integral of (x dx) evaluated from 0 to 2?,2,math
+Who is the president of the United States as of January 2024?,Joe Biden,common_knowledge
+Is pineapple pizza delicious or not (yes or no)?,yes,common_knowledge
+Does water have higher density than ethanol?,yes,physics
+What is the SI unit for charge?,coulomb,physics

flashcard_runner.rb

@@ -0,0 +1,3 @@
+require './lib/game'
+
+Game.new.start

lib/card.rb

@@ -0,0 +1,14 @@
+# A card containing a question, answer, and cateogory
+#
+# Syntax:
+#
+# card = Card.new("question", "answer", :category)
+class Card
+  attr_reader :question, :answer, :category
+
+  def initialize(question, answer, category)
+    @question = question
+    @answer = answer
+    @category = category
+  end
+end

lib/card_generator.rb

@@ -0,0 +1,33 @@
+require './lib/card'
+
+# Generates an array of cards from a .txt file
+#
+# Syntax:
+#
+# card_generator = CardGenerator.new(".../file_path.txt")
+class CardGenerator
+  attr_reader :cards, :file_text
+
+  def initialize(file_path)
+    @cards = []
+    @file_text = ''
+    @file_path = file_path
+  end
+
+  def parse_file
+    file = File.open(@file_path)
+    @file_text += file.read
+  end
+
+  def push_cards
+    text_array = @file_text.split("\n")
+    text_array.each do |card_text|
+      params_array = card_text.split(',')
+      question = params_array[0]
+      answer = params_array[1]
+      category = params_array[2].to_sym
+      card = Card.new(question, answer, category)
+      @cards.push(card)
+    end
+  end
+end

lib/deck.rb

@@ -0,0 +1,29 @@
+require './lib/card'
+require './lib/deck'
+
+# Generates a deck of cards from an array of Card instances. The main
+# difference between this class and an array of Cards is the
+# .cards_in_category method.
+#
+# Syntax:
+#
+# deck = Deck.new([card1, card2, card3...])
+class Deck
+  attr_reader :cards
+
+  def initialize(cards)
+    @cards = cards
+  end
+
+  def count
+    @cards.length
+  end
+
+  def cards_in_category(category)
+    num_of_cards = 0
+    @cards.each do |card|
+      num_of_cards += 1 if card.category == category
+    end
+    num_of_cards
+  end
+end

lib/game.rb

@@ -0,0 +1,72 @@
+require './lib/card'
+require './lib/deck'
+require './lib/round'
+require './lib/turn'
+require './lib/card_generator'
+
+# This class is the wrapper for the entire flash card CLI.
+# It handles the text input and output happening in the terminal.
+#
+# Syntax:
+#
+# Game.new.start
+#
+# Terminal command to start the game:
+#
+# ruby ...path_to/flashcard_runner.rb
+class Game
+  def initialize
+    card_generator = CardGenerator.new('cards.txt')
+    card_generator.parse_file
+    card_generator.push_cards
+    @cards = card_generator.cards
+    @deck = Deck.new(@cards)
+    @round = Round.new(@deck)
+  end
+
+  def start
+    puts "\nWelcome! You're playing with #{@deck.count} cards.\n--------------------------------------\n"
+    quiz_loop
+  end
+
+  def provide_question
+    puts "This is card number #{@round.turn_number + 1} out of #{@deck.count}"
+    puts "Question: #{@round.current_card.question}"
+  end
+
+  def provide_feedback(turn)
+    puts turn.feedback
+    sleep(1)
+    puts "--------------------------------------\n"
+  end
+
+  def take_input
+    provide_question
+    guess = gets.chomp
+    turn = @round.take_turn(guess)
+    provide_feedback(turn)
+  end
+
+  def quiz_loop
+    take_input while @round.turn_number < @deck.count
+    show_results
+  end
+
+  def categories_array
+    list_of_categories = []
+    @deck.cards.each do |card|
+      list_of_categories.push(card.category) unless list_of_categories.include?(card.category)
+    end
+    list_of_categories
+  end
+
+  def show_results
+    puts "\n****** Game over! ******\n"
+    puts "\nYou had #{@round.number_correct} correct guesses out of #{@deck.count} for a total score of #{(100.0 * @round.number_correct / @deck.count).round}%."
+    list_of_categories = categories_array
+    list_of_categories.each do |category|
+      puts "#{category} - #{@round.percent_correct_by_category(category)}% correct"
+    end
+    puts ''
+  end
+end

lib/round.rb

@@ -0,0 +1,60 @@
+require './lib/card'
+require './lib/turn'
+require './lib/deck'
+
+# A class that provides functionality for the flash cards game.
+# It is instantiated from a Deck instance, and has methods to
+# compare guesses with answers, count the number of correct answers
+# by cateogory, and display the current card.
+#
+# Syntax:
+#
+# round = Round.new(deck)
+class Round
+  attr_reader :deck, :turns, :turn_number, :number_correct
+
+  def initialize(deck)
+    @deck = deck
+    @turns = []
+    @turn_number = 0
+    @number_correct = 0
+  end
+
+  def current_card
+    @deck.cards[@turn_number]
+  end
+
+  def take_turn(guess)
+    turn = Turn.new(guess, current_card)
+    turns.push(turn)
+    @turn_number += 1
+    @number_correct += 1 if guess == turn.card.answer
+    turn
+  end
+
+  def correct?
+    @turns.last.guess == current_card.answer
+  end
+
+  def number_correct_by_category(category)
+    count_correct = 0
+    @turns.each do |turn|
+      count_correct += 1 if turn.card.category == category && turn.guess == turn.card.answer
+    end
+    count_correct
+  end
+
+  def total_in_category(category)
+    count_category = 0
+    @turns.each do |turn|
+      count_category += 1 if turn.card.category == category
+    end
+    count_category
+  end
+
+  def percent_correct_by_category(category)
+    number_correct_in_category = number_correct_by_category(category)
+    number_total_in_category = total_in_category(category)
+    ((number_correct_in_category.to_f / number_total_in_category) * 100).round(1)
+  end
+end

lib/turn.rb

@@ -0,0 +1,28 @@
+# This is a class providing functionality for each individual
+# turn in a Round. It has methods to check whether the answer
+# for that turn is correct, and provides feedback based on
+# whether or not the answer for that turn is correct.
+#
+# Syntax:
+#
+# turn = Turn.new("guess", card)
+class Turn
+  attr_reader :card, :guess
+
+  def initialize(guess, card)
+    @guess = guess
+    @card = card
+  end
+
+  def correct?
+    @guess == @card.answer
+  end
+
+  def feedback
+    if @guess.downcase == @card.answer.downcase
+      'Correct!'
+    else
+      "Incorrect. The correct answer is #{@card.answer}"
+    end
+  end
+end

spec/card_generator_spec.rb

@@ -0,0 +1,31 @@
+# typed: ignore
+
+require './lib/card'
+require './lib/turn'
+require './lib/deck'
+require './lib/round'
+require './lib/card_generator'
+
+RSpec.describe CardGenerator do
+  before(:each) do
+    @card_generator = CardGenerator.new('cards.txt')
+  end
+
+  it 'exists' do
+    expect(@card_generator).to be_an_instance_of(CardGenerator)
+  end
+
+  it 'parses text file' do
+    @card_generator.parse_file
+    expect(@card_generator.file_text).to(satisfy { |file_text| !file_text.empty? })
+  end
+
+  it 'creates an array of cards of class Card' do
+    @card_generator.parse_file
+    @card_generator.push_cards
+    expect(@card_generator.cards).to(satisfy { |cards| !cards.empty? })
+    @card_generator.cards.each do |card|
+      expect(card).to be_an_instance_of(Card)
+    end
+  end
+end

spec/card_spec.rb

@@ -1,27 +1,25 @@
+# typed: ignore
+
 require './lib/card'
 
 RSpec.describe Card do
-  it 'exists' do
-    card = Card.new("What is the capital of Alaska?", "Juneau", :Geography)
+  before(:each) do
+    @card = Card.new('What is the capital of Alaska?', 'Juneau', :Geography)
+  end
 
-    expect(card).to be_instance_of(Card)
+  it 'exists' do
+    expect(@card).to be_instance_of(Card)
   end
 
   it 'has a question' do
-    card = Card.new("What is the capital of Alaska?", "Juneau", :Geography)
-
-    expect(card.question).to eq("What is the capital of Alaska?")
+    expect(@card.question).to eq('What is the capital of Alaska?')
   end
 
   it 'has an answer' do
-    card = Card.new("What is the capital of Alaska?", "Juneau", :Geography)
-
-    expect(card.answer).to eq("Juneau")
+    expect(@card.answer).to eq('Juneau')
   end
 
   it 'has a category' do
-    card = Card.new("What is the capital of Alaska?", "Juneau", :Geography)
-
-    expect(card.category).to eq(:Geography)
+    expect(@card.category).to eq(:Geography)
   end
 end

spec/deck_spec.rb

@@ -0,0 +1,36 @@
+# typed: ignore
+
+require './lib/card'
+require './lib/turn'
+require './lib/deck'
+
+RSpec.describe Deck do
+  before(:each) do
+    @cards = [
+      Card.new('Question 1', 'Answer 1', :category1),
+      Card.new('Question 2', 'Answer 2', :category1),
+      Card.new('Question 3', 'Answer 3', :category2)
+    ]
+    @deck = Deck.new(@cards)
+  end
+
+  it 'exists' do
+    expect(@deck).to be_an_instance_of(Deck)
+  end
+
+  it 'cards property is an array' do
+    expect(@deck.cards).to be_an_instance_of(Array)
+  end
+
+  it 'cards array items are correct cards' do
+    expect(@deck.cards).to eq(@cards)
+  end
+
+  it 'counts number of cards in deck' do
+    expect(@deck.count).to eq(3)
+  end
+
+  it 'counts number of cards in category' do
+    expect(@deck.cards_in_category(:category1)).to eq(2)
+  end
+end