FlashCardinator

filereader.rb

class FileReader
  def initialize(file)
    @file = file
  end

  def read_file
    @dictionary = {}
    File.open(@file, "r").each do |line|
      line.gsub!(/\\/, "")
      split_line = line.chomp.split("\t")
      key, value = split_line[0], split_line[1]
      @dictionary.store(key, value)
    end
    @dictionary
  end
end

filereader_spec.rb

require 'simplecov'
SimpleCov.start

require "./filereader"

describe FileReader do
  context "#initialize" do
    it "should be initialized with a file" do
      expect {FileReader.new}.to raise_error
    end
  end

  context "#read_file" do
    before do
      @reader = FileReader.new('flashcards_data.txt')
    end

    it "should read a file and create an collection of terms and definitions" do
      read_file = @reader.read_file
      read_file.keys.should include "yield"
    end
  end
end

flashcard.rb

class FlashCard
  attr_reader :term, :definition
  def initialize(term='', definition = '')
    @term = term
    @definition = definition
  end
end

flashcard_deck.rb

class FlashCardDeck
  #attr_reader :cards
  def initialize
    @cards = []
  end

  def empty?
    @cards.empty?
  end

  def add_card(card)
    raise 'Duplicate card' if @cards.include?(card) or card == nil
    @cards << card
  end

  def shuffle!
    @cards.shuffle!
  end

  def size
    @cards.size
  end

end

flashcard_deck_spec.rb

require 'simplecov'
SimpleCov.start

require "./flashcard_deck"
require "./flashcard"

describe FlashCardDeck do
  before do
    @deck = FlashCardDeck.new
  end

  context "#initialize" do
    it "is empty" do
      @deck.should be_empty
    end
  end

  context "#add_card" do
    before do
      @card = FlashCard.new
    end

    it "does not add duplicate cards to the deck" do
      @deck.add_card(@card)
      expect{@deck.add_card(@card)}.to raise_error
    end

    it "adds a card to the deck" do
      expect{@deck.add_card(@card)}.to change(@deck, :size).by 1
    end
  end

  context "#shuffle!" do
    it "shuffles the cards in the deck" do
      @deck.should_not eq(@deck.shuffle!)
    end
  end
end

flashcard_spec.rb

require 'simplecov'
SimpleCov.start

require "./flashcard"

describe FlashCard do
  context "#initialize" do
    before do
      @flashcard = FlashCard.new
    end

    it "is initialized with a term" do
      @flashcard.term.should_not be_nil
    end

    it "is initialized with a definition" do
      @flashcard.definition.should_not be_nil
    end

    it "is initialized with a term that is passed as a parameter" do
      flashcard2 = FlashCard.new("hello")
      flashcard2.term.should eq "hello"
    end

    it "is initialized with a definition that is passed as a parameter" do
      flashcard2 = FlashCard.new("hello", "greeting")
      flashcard2.definition.should eq("greeting")
    end
  end
end

flashcards_data.txt

alias	To create a second name for the variable or method.
and	A command that appends two or more objects together.
BEGIN	Designates code that must be run unconditionally at the beginning of the program before any other.
begin	Delimits a "begin" block of code, which can allow the use of while and until in modifier position with multi-line statements.
break	Gives an unconditional termination to a code block, and is usually placed with an argument.
case	starts a case statement; this block of code will output a result and end when it's terms are fulfilled, which are defined with when or else.
class	Opens a class definition block, which can later be reopened and added to with variables and even functions.
def	Used to define a function.
defined?	A boolean logic function that asks whether or not a targeted expression refers to anything recognizable in Ruby; i.e. literal object, local variable that has been initialized, method name visible from the current scope, etc.
do	Paired with end, this can delimit a code block, much like curly braces; however, curly braces retain higher precedence.
else	Gives an "otherwise" within a function, if-statement, or for-loop, i.e. if cats = cute, puts "Yay!" else puts "Oh, a cat."
elsif	Much like else, but has a higher precedence, and is usually paired with terms.
END	Designates, via code block, code to be executed just prior to program termination.
end	Marks the end of a while, until, begin, if, def, class, or other keyword-based, block-based construct.
ensure	Marks the final, optional clause of a begin/end block, generally in cases where the block also contains a rescue clause. The code in this term's clause is guaranteed to be executed, whether control flows to a rescue block or not.
false	denotes a special object, the sole instance of FalseClass. false and nil are the only objects that evaluate to Boolean falsehood in Ruby (informally, that cause an if condition to fail.)
for	A loop constructor; used in for-loops.
if	Ruby's basic conditional statement constructor.
in	Used with for, helps define a for-loop.
module	Opens a library, or module, within a Ruby Stream.
next	Bumps an iterator, or a while or until block, to the next iteration, unconditionally and without executing whatever may remain of the block.
nil	A special "non-object"; it is, in fact, an object (the sole instance of NilClass), but connotes absence and indeterminacy. nil and false are the only two objects in Ruby that have Boolean falsehood (informally, that cause an if condition to fail).
not	Boolean negation. i.e. not true # false, not 10 # false, not false # true.
or	Boolean or. Differs from || in that or has lower precedence.
redo	Causes unconditional re-execution of a code block, with the same parameter bindings as the current execution.
rescue	Designates an exception-handling clause that can occur either inside a begin<code>/<code>end block, inside a method definition (which implies begin), or in modifier position (at the end of a statement).
retry	Inside a rescue clause, causes Ruby to return to the top of the enclosing code (the begin keyword, or top of method or block) and try executing the code again.
return	Inside a method definition, executes the ensure clause, if present, and then returns control to the context of the method call. Takes an optional argument (defaulting to nil), which serves as the return value of the method. Multiple values in argument position will be returned in an array.
self	The "current object" and the default receiver of messages (method calls) for which no explicit receiver is specified. Which object plays the role of self depends on the context.
super	Called from a method, searches along the method lookup path (the classes and modules available to the current object) for the next method of the same name as the one being executed. Such method, if present, may be defined in the superclass of the object's class, but may also be defined in the superclass's superclass or any class on the upward path, as well as any module mixed in to any of those classes.
then	Optional component of conditional statements (if, unless, when). Never mandatory, but allows for one-line conditionals without semi-colons.
true	The sole instance of the special class TrueClass. true encapsulates Boolean truth; however, <emph>all</emph> objects in Ruby are true in the Boolean sense (informally, they cause an if test to succeed), with the exceptions of false and nil.
undef	Undefines a given method, for the class or module in which it's called. If the method is defined higher up in the lookup path (such as by a superclass), it can still be called by instances classes higher up.
unless	The negative equivalent of if. i.e. unless y.score > 10 puts "Sorry; you needed 10 points to win." end.
until	The inverse of while: executes code until a given condition is true, i.e., while it is not true. The semantics are the same as those of while.
when	Same as case.
while	Takes a condition argument, and executes the code that follows (up to a matching end delimiter) while the condition is true.
yield	Called from inside a method body, yields control to the code block (if any) supplied as part of the method call. If no code block has been supplied, calling yield raises an exception.

interface.rb

require './main'

class Interface
  def go
    game_deck = Main.new('flashcards_data.txt').add_cards
    game_deck = Hash[game_deck.to_a.shuffle!]


    game_deck.each do |term, definition|
      guess_counter = 1
      puts definition
      puts "Guess:"
      answer = gets.chomp
      break if answer == "quit"
      while true
        #answer = gets.chomp
        if answer == term
          puts "Your answer is correct!"
          puts ""
          break
        elsif guess_counter < 3
          puts "Incorrect, guess again:"
          answer = gets.chomp
          guess_counter += 1
        else
          puts "The correct answer was: #{term}"
          puts ""
          break
        end
      end
    end
  end
end

interface = Interface.new
interface.go

main.rb

require "./flashcard_deck"
require './flashcard'
require "./filereader"

class Main
  attr_reader :deck, :file
  def initialize(file)
    @deck = FlashCardDeck.new
    @file = file
  end

  def card(term, definition)
    FlashCard.new(term, definition)
  end

  def flashcard_data
    FileReader.new(file).read_file
  end
  
  def add_cards
    flashcard_data.each do |term, definition|
      @deck.add_card(card(term, definition))
    end
  end
end

main_spec.rb

require 'simplecov'
SimpleCov.start

require "./main"
require './flashcard_deck'

describe Main do
  let(:main) {Main.new("flashcards_data.txt")}
  let(:deck) {FlashCardDeck.new}

  context "#initialize" do
    it "creates a new deck" do
      main.deck.should_not be_nil
    end
  end

  context "#flashcard" do
    it "makes a flashcard" do
      main.card('blah', 'asdf').should_not be_nil
    end
  end

  context "#flashcard_data" do
    it "pulls in the data that will be used to make the cards" do
      main.flashcard_data["alias"].should eq "To create a second name for the variable or method."
    end
  end

  context "#add_cards" do
    it "adds cards to the deck" do
      main.add_cards
      main.deck.empty?.should eq false
    end
  end
end