KeeperChallenge 0.0.3 → 0.0.4

data/KeeperChallenge.gemspec

@@ -4,7 +4,7 @@ require "keeperchallenge/version"
 
 Gem::Specification.new do |s|
   s.name            = "KeeperChallenge"
-  s.version         = '0.0.3'
+  s.version         = '0.0.4'
   s.authors         = ["Benjamin Combe"]
   s.email           = ["benjamin.combe@gmail.com"]
   s.homepage        = "https://github.com/kamiben/KeeperChallenge"

data/lib/KeeperChallenge.rb

@@ -1,9 +1,3 @@
-#require './keeperchallenge/player'
-#require './keeperchallenge/score'
-#require './keeperchallenge/activity'
-#require './keeperchallenge/database'
-#TODO
-#import activity and players from text file ?
 require File.dirname(__FILE__) +'/keeperchallenge/player'
 require File.dirname(__FILE__) +'/keeperchallenge/score'
 require File.dirname(__FILE__) +'/keeperchallenge/activity'
@@ -11,14 +5,15 @@ require File.dirname(__FILE__) +'/keeperchallenge/database'
 
 # will handle user input - will to quit the program, input from the console
 class UserInput
-  attr_accessor :exit
+  attr_accessor :exit, :input
   def initialize
     exit = false
+    self.input  = $stdin
   end
   
   def get_input
     print '> '
-    result = gets.chomp()
+    result = input.gets.chomp()
     return result
   end
   
@@ -51,27 +46,30 @@ class Display
     end
   end
 
+  #will return an index to use in the [@players]
   def select_player(players)
     puts "Please select your player"
     i=1
     if !players.empty?
-      players.each do |player|
-        puts "#{i}. #{player.name}"
+      players.each do |key,player|
+        puts "#{player.name}"
       end
       choice = @input.get_input
-      return choice.to_i-1
+      return choice
     else
       puts "There are no players in the database"
       return nil
     end
   end
   
+  # Will return the new player name
   def add_player
     puts "Enter the new player name :"
     name = @input.get_input
     return name
   end
   
+  # will return the components of a new activity
   def add_activity(activities_type)
     
     puts "Enter activity type"
@@ -91,13 +89,23 @@ class Display
     return type, time, cal, km
   end
   
+  # Will print the scores
   def display_scores(players)
     puts "Scores :"
-    players.each do |player|
+    players.each do |key,player|
       puts "#{player.name} : #{player.score}"
     end
   end
   
+  def confirm_delete
+    puts "Are you sure you want to erase all data? (type YES)"
+    return @input.get_input
+  end
+
+  def abort
+    puts "Abort"
+  end
+  
 end
 
 
@@ -107,9 +115,9 @@ class Main
   def initialize
     # load players
     # load activities
-    @players = []
+    @players = {}
     @activities_type = ["velo", "course" , "marche",  "natation"]
-   #setup_test_users
+    #setup_test_users
 
   end
   def launch
@@ -130,15 +138,19 @@ class Main
         when :add_player then 
           name = screen.add_player
           new_player = Player.new(name)
-          @players.push(new_player)
-          #add player
+          @players.update(name => new_player)
         when :launch_scoreboard then 
           score = Score.new(@players)
           score.compute(@activities_type)
           screen.display_scores(@players)
         when :clean_database then
-          db.clear
-          @players.clear
+          response = screen.confirm_delete
+          if response == "YES"    
+            db.clear
+            @players.clear
+          else 
+            screen.abort
+          end
           
       end
       db.save(@players)
@@ -146,14 +158,14 @@ class Main
   end
   
   def setup_test_users
-    @players.push(Player.new("Ben"))
-    @players.push(Player.new("Claire"))
+    @players.update({"Ben" => Player.new("Ben")})
+    @players.update({"Claire" => Player.new("Claire")})
     
-    @players[0].add_activity("velo", 15, 15, 15)
-    @players[0].add_activity("course", 10, 10, 10)
-    @players[0].add_activity("course", 20, 20, 20)
-    @players[1].add_activity("velo", 12, 12, 12)
-    @players[1].add_activity("natation", 30, 20, 10)
+    @players["Ben"].add_activity("velo", 15, 15, 15)
+    @players["Ben"].add_activity("course", 10, 10, 10)
+    @players["Claire"].add_activity("course", 20, 20, 20)
+    @players["Claire"].add_activity("velo", 12, 12, 12)
+    @players["Claire"].add_activity("natation", 30, 20, 10)
   end
 
   

data/lib/keeperchallenge/database.rb

@@ -1,9 +1,10 @@
 class FileDatabase
-  
+  attr_reader :folder_path
   # will create the db folder if not present on system
   def initialize
     #if db folder does not exist, create it
     @folder_path = File.dirname(__FILE__) + "/db/"
+    puts @folder_path
     unless File.directory?(@folder_path)
       Dir.mkdir(@folder_path)
     end
@@ -12,20 +13,20 @@ class FileDatabase
   
   #will load all files from db directory and load them as player and activities
   def load(players)
-    index = 0
+
     # read all files in database
     
     Dir.foreach(@folder_path) do |file|
       if !(file =='.' || file == '..')
         # create an object per file (=player)
-        players.push(Player.new(file))
+        players.update({file => Player.new(file)})
         # populate with activities
         content = File.open("#{@folder_path}#{file}")
         content.each_line do |line|
           activity = line.split(' ')
-          players[index].add_activity(activity[0], activity[1], activity[2], activity[3])
+          players[file].add_activity(activity[0], activity[1], activity[2], activity[3])
         end
-        index += 1
+
         content.close
       end
     end
@@ -34,7 +35,7 @@ class FileDatabase
   #will save player to static files in db directory
   def save(players)
     # create a file per player
-    players.each do |player|
+    players.each do |key,player|
       file_name = "#{@folder_path}#{player.name}"
       player_file = File.open(file_name,'w')
       # in this file : one activity per line, each attribute separated by a space 

data/lib/keeperchallenge/player.rb

@@ -2,18 +2,21 @@ class Player
   attr_reader :name
   attr_accessor :activities, :score
   
+  #only need a name to initialize a player
   def initialize(name)
     @name = name
     @activities = []
     @score = 0
   end
   
+  # to add an activity, need all the parameters of an activity
   def add_activity(type, time, cal, km)
     new_activity = Activity.new(type, time, cal, km)
     @activities.push(new_activity)
   end
   
-  def list_by_type(type)
+  # will return all activities taken for a type of activity in an array
+  def activities_taken(type)
     activity_by_type = []
     @activities.each do |activity|
       if activity.type == type
@@ -23,6 +26,7 @@ class Player
     return activity_by_type
   end
   
+  # Will count all sports the player practised.
   def count_activity_type
     total_activities_type = 0
     previous_activity = ''

data/lib/keeperchallenge/score.rb

@@ -14,12 +14,12 @@ class Score
       total_time = {}
       total_cal = {}
       total_km = {}
-      @players.each do |player|
+      @players.each do |key,player|
         total_time[player.name] =0
         total_cal[player.name] =0
         total_km[player.name] =0   
         
-        player.list_by_type(activity).each do |player_activity|
+        player.activities_taken(activity).each do |player_activity|
           total_time[player.name]  += player_activity.time.to_i
           total_cal[player.name]  += player_activity.cal.to_i
           total_km[player.name]  += player_activity.km.to_i
@@ -27,7 +27,7 @@ class Score
       end
       
       #d�termine le meilleur de chaque discipline
-      @players.each do |player|
+      @players.each do |key,player|
         if player.name == find_best_score(total_time)
           puts "Best total time in #{activity} for #{player.name}, adding 3 points"
           player.score += 3
@@ -46,13 +46,14 @@ class Score
     end
     
     #Incr�mentation du compteur pour le nombre d'activit�s diff�rentes effectu�es
-    @players.each do |player|
+    @players.each do |key,player|
       puts "Adding numbers of activity for #{player.name} = #{player.count_activity_type}"
       player.score += player.count_activity_type
     end
     
   end
   
+  # returns the player name of the best total from the given hash. 
   def find_best_score(total_per_player)
     best_score = 0
     winner = ''
@@ -66,9 +67,9 @@ class Score
     return winner
   end
   
-  
+  # Reset all scores to prevent abuse from the save file
   def reset_player_scores()
-    @players.each do |player|
+    @players.each do |key,player|
       player.score = 0
     end
   end

data/readme.md

@@ -5,4 +5,12 @@ It will allow :
 - adding an activity for a player
 - compute the score for each player in the system
 - save and load from disk
-- erase all data
+- erase all data
+
+To install :
+  gem install KeeperChallenge
+  
+To use : 
+  KeeperChallenge
+  
+The application is console based for now.

data/test/test_keeperchallenge.rb

@@ -1,17 +1,161 @@
 require 'test/unit'
+require 'stringio'
+require_relative '../lib/keeperchallenge'
 
 class MyUnitTest < Test::Unit::TestCase
 
-  def setup
-    puts "setup"
+  def test_user_input
+    # STDIN should be returned by get_input
+    user_input = UserInput.new()
+    text_input = StringIO.new("velo\n")
+    user_input.input = text_input
+    assert_equal(user_input.get_input,"velo")
+ 
   end
   
-  def teardown
-    puts "teardown"
+  def test_display
+    # test select_player
+    user_input = UserInput.new()
+    user_input.input = StringIO.new("Ben\n")
+    display = Display.new(user_input)
+    player1 = Player.new("Ben")
+    player2 = Player.new("Claire")
+    players = {"Ben" =>player1,"Claire" =>player2}
+    
+    assert_equal(display.select_player(players),"Ben")
+    
+    # test add player 
+    user_input.input = StringIO.new("Cyril")
+    assert_equal(display.add_player(),"Cyril")
+    
+    
   end
 
-  def test_basic
-    puts "I ran"
+  def test_main
+    game = Main.new()
+    game.setup_test_users
+    # quite hard to test a console based program that loops through the main. 
+    # this test is on hold as not vital to the aim to the app
   end 
   
+  def test_activity
+    #Only accessors here ! Nothing to test
+  end
+  
+  def test_add_activity
+    player = Player.new("Ben")
+    
+    # test new activity
+    player.add_activity("Velo", 1, 1, 1)
+ 
+    assert_equal(player.activities[0].type,"Velo")
+    assert_equal(player.activities[0].km,1)
+    assert_equal(player.activities[0].cal,1)
+    assert_equal(player.activities[0].time,1)
+    
+  end 
+  
+  def test_list_by_type
+    player = Player.new("Ben")
+    player.add_activity("Velo", 1, 1, 1)
+
+    assert_equal(player.activities_taken("Velo"),[player.activities[0]])
+    
+  end
+  
+  def test_count_activities_type
+    player = Player.new("Ben")
+    player.add_activity("Velo", 1, 1, 1)
+    
+    assert_equal(player.count_activity_type,1)
+    
+  end
+
+  def test_score
+    setup_test_users
+    @activities_type = ["velo", "course" , "marche",  "natation"]
+    score = Score.new(@players)
+    
+    score.compute(@activities_type)
+    assert_equal(@players["Ben"].score,11)
+    assert_equal(@players["Claire"].score,21)
+    
+    @players.clear
+  end
+  
+  def test_find_best_score
+
+    score = Score.new(@players)
+    total_time = {}
+    total_time['Ben'] = 10
+    total_time['Claire'] = 5
+    assert_equal(score.find_best_score(total_time),'Ben')
+
+  end
+  
+  def reset_player_score
+    player = Player.new("Ben")
+    player.score = 10
+    players=[player]
+    assert_equal(player.score,10)
+    score = Score.new(players)
+    score.reset_player_score
+    assert_equal(player.score,0)
+    
+  end
+  
+  
+  def setup_test_users
+    @players ={}
+    @players.update({"Ben" => Player.new("Ben")})
+    @players.update({"Claire" => Player.new("Claire")})
+    
+    @players["Ben"].add_activity("velo", 15, 15, 15)
+    @players["Ben"].add_activity("course", 10, 10, 10)
+    @players["Claire"].add_activity("course", 20, 20, 20)
+    @players["Claire"].add_activity("velo", 12, 12, 12)
+    @players["Claire"].add_activity("natation", 30, 20, 10)
+  end
+  
+  
+  def test_load
+      players = {}
+      @folder_path = "../lib/keeperchallenge/db/"
+      puts @folder_path
+      player_file = File.open("#{@folder_path}Ben",'w')
+      activity_string = "Velo 1 1 1\n"
+      player_file.write(activity_string)
+      player_file.close
+      
+      db = FileDatabase.new
+      
+      db.load(players)
+      
+      assert_equal(players["Ben"].name,"Ben")
+      assert_equal(players["Ben"].activities[0].type,"Velo")
+      
+      db.clear
+      
+  end
+  
+  
+  def test_save
+    setup_test_users
+    db = FileDatabase.new     
+    db.save(@players)    
+    index = 0
+    Dir.foreach(db.folder_path) do |file|
+      if !(file =='.' || file == '..')
+        if index == 0
+          assert_equal(file,'Ben')
+        elsif index ==1 
+          assert_equal(file,'Claire')
+        end
+      end
+      index += 1
+    end
+    
+    db.clear
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: KeeperChallenge
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies: []
 description: KeeperChallenge is a console based application that will allow the user
   to add participants, add activities and then determine the winner of the contest.
@@ -21,6 +21,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - KeeperChallenge-0.0.2.gem
+- KeeperChallenge-0.0.3.gem
 - KeeperChallenge.gemspec
 - bin/keeperchallenge
 - lib/KeeperChallenge.rb