Class: TypingStatistics

Inherits:
Object
  • Object
show all
Defined in:
lib/typing_statistics.rb

Instance Method Summary collapse

Instance Method Details

#average_accuracy(total_symbol_count, total_error_count) ⇒ Object

Average accuracy method to assist with setting the key values



44
45
46
 
# File 'lib/typing_statistics.rb', line 44

def average_accuracy(total_symbol_count, total_error_count)
  ((total_symbol_count / (total_symbol_count + total_error_count).to_f) * 100).round(1)
end

#average_wpm(total_wpm, total_symbol_count) ⇒ Object

Average Words Per Minute method to assist with setting the key values



49
50
51
 
# File 'lib/typing_statistics.rb', line 49

def average_wpm(total_wpm, total_symbol_count)
  (total_wpm / total_symbol_count).round(1)
end

#display_statistics ⇒ Object

Display the statistics in a terminal table, for the users to read.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/typing_statistics.rb', line 95

def display_statistics
  # Read the current JSON file to get the averaged_statistics hash
  read_statistics
  # Make a terminal table and add in values from averaged_statistics hash
  @rows = []
  counter = 0
  @averaged_statistics.each do |key, val|
    # Set the color of the accuracy to red if the users accuracy is less than 60
    val[2] = val[2].to_s.colorize(:red) if val[2].positive? && val[2] < 60
    # Set the color of the WPM if the user WPM is under 50
    val[4] = val[4].to_s.colorize(:yellow) if val[4] < 40 && val[4] != 0

    # Add each symbol and associated data to the terminal-table row
    @rows << [key, val[4], val[2], val[0], make_pie_chart(val[0], val[1])]
    counter += 1
    # Print a seperator for each symbol apart from the last
    @rows << :separator if counter < @averaged_statistics.size
  end
  table = Terminal::Table.new title: 'Your Typing Statistics', headings: ['Symbol', 'Average WPM', 'Average Accuracy %', 'Symbol Count', 'Hit/Miss'], rows: @rows
  table.align_column(0, :center)
  table.align_column(1, :center)
  table.align_column(2, :center)
  table.align_column(3, :center)
  puts table
end

#file_path ⇒ Object

Used for getting the absolute file path, wherever the user is. For when the user runs program from anywhere.



62
63
64
65
66
67
 
# File 'lib/typing_statistics.rb', line 62

def file_path
  path = File.dirname(__FILE__).split('/')
  path.pop
  json_file = "#{path.join('/')}/public/key_scores.json"
  json_file
end

#make_pie_chart(total_hit, total_miss) ⇒ Object

Make a pie chart for the hit and miss count



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/typing_statistics.rb', line 81

def make_pie_chart(total_hit, total_miss)
  data = [
    { value: total_hit, color: :bright_green, fill: '•' },
    { value: total_miss, color: :bright_red, fill: '•' }
  ]
  # Create the pie chart
  pie_chart = TTY::Pie.new(data: data, radius: 2)
  pie_chart.render
  # It will throw a type error for nil values, in that case return a string
rescue TypeError
  'no data yet'
end

#read_statistics ⇒ Object

Read and parse the averaged_statistics hash from the JSON file



70
71
72
73
 
# File 'lib/typing_statistics.rb', line 70

def read_statistics
  file = File.read(file_path)
  @averaged_statistics = JSON.parse(file)
end

#sort_averaged_statistics(averaged_statistics) ⇒ Object

Sort the users average scores by adding the average speed and accuracy, this is the indication of a good key



54
55
56
57
58
59
 
# File 'lib/typing_statistics.rb', line 54

def sort_averaged_statistics(averaged_statistics)
  # This converts the hash into a sorted array
  sorted_array = averaged_statistics.sort_by { |_key, val| -(val[2] + val[4]) }
  # Convert the array back to a hash for processing
  @averaged_statistics = sorted_array.to_h
end

#statistics(scores) ⇒ Object

The method for taking in the score of the game that the user just played It then inputs the score into the average statistics for the user include StatisticsHelper



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/typing_statistics.rb', line 11

def statistics(scores)
  # If there is already a hash in the JSON File, then read it or else create a new blank hash (Will only be first time user runs game)
  begin
    read_statistics
  rescue JSON::ParserError
    # Create an instanced empty hash so the score can be appended to it, as it will be nil otherwise and throw an error
    @averaged_statistics = StatisticsHelper.add_symbols_to_hash if @averaged_statistics.nil?
  end

  # Take the scores hash of the last completed typing game and append them to the averaged_statistics hash
  scores.each do |key, val|
    # Storing the amount of times each symbol has been displayed to the averaged hash
    @averaged_statistics[key][0] = total_count(@averaged_statistics[key][0], val[0])
    # Storing the total amount of errors the user has made
    @averaged_statistics[key][1] = total_count(@averaged_statistics[key][1], val[1])
    # Storing the average accuracy for the user
    @averaged_statistics[key][2] = average_accuracy(@averaged_statistics[key][0], @averaged_statistics[key][1])
    # Storing the total wpm
    @averaged_statistics[key][3] = total_count(@averaged_statistics[key][3], val[2])
    # Storing the average WPM to the averaged hash
    @averaged_statistics[key][4] = average_wpm(@averaged_statistics[key][3], @averaged_statistics[key][0])
  end
  # Write the statistics at the end of each game into the JSON file
  sort_averaged_statistics(@averaged_statistics)
end

#total_count(total, addition) ⇒ Object

Total counter method to assist with setting the key values



38
39
40
41
 
# File 'lib/typing_statistics.rb', line 38

def total_count(total, addition)
  total += addition
  total
end

#wipe_file ⇒ Object

The method for wiping the JSON file if the user wants to.



122
123
124
125
 
# File 'lib/typing_statistics.rb', line 122

def wipe_file
  File.truncate(file_path, 0)
  @averaged_statistics = StatisticsHelper.add_symbols_to_hash
end

#write_statistics ⇒ Object

Write the averaged_statistics hash to the JSON file



76
77
78
 
# File 'lib/typing_statistics.rb', line 76

def write_statistics
  File.write(file_path, JSON.pretty_generate(@averaged_statistics))
end