tumblr-game 1.2.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aca34894248585f3753dabcb2093700c4c4c196e
-  data.tar.gz: 35775065b2818c913cb33808b370298b108be22f
+  metadata.gz: ebdcf94506e353243360efc40b2dd2b2a5c09e23
+  data.tar.gz: a5e9b6029157b4f3e015ecc1fcab2f0580965204
 SHA512:
-  metadata.gz: 5a3bbf087f21767286b2996c8a09e50b7e45d2cf36ddbb9243181e3b96e0e799c5618d27abe457ea3ac11b5821e6e01be599b8a9589352dd2ae34e0ee1545cfb
-  data.tar.gz: 540c76c487355da51106505c54945ff372028374b2917340c56c82254c1ce658b8f5b502bd2589ccb6ce5cc5d36c1b741f4e4384be1091922ff21f0ce469769b
+  metadata.gz: 23bfca9d86a47a10da517f9e23a8c7a6996788571a42349a97d0dd1fa6f1f08fe7e4cd7e6872199ad30bd6f9d46be78aa9429667d8e23a7007b6b24df8c2ee53
+  data.tar.gz: 41c0cd929c08ebfd164a154c7a45316d173ee133167df6e9b1df3589f098494b217093a6d9882ea166259212e3a9e71b565b95413d145b15490dd02a15d958c7

data/lib/tumblr-game.rb

@@ -1,6 +1,11 @@
 require_relative 'tumblr-game/gosu.rb'
 require_relative 'tumblr-game/tumblr.rb'
 
+
+## GAME CLASS. This class takes care of getting user input from the user, passing it to the appropriate class for error checking, starting the game,
+# and ending the game. A Game object must be created. The user must then call the initialize function, pass it the parameters, and then call start.
+# Those three steps are all that is necessary to start the game. 
+
 class Game
 
   ## this function will accept the dimensions of the window to be created and initialize a Game object
@@ -35,7 +40,8 @@ class Game
     end
   end
   
-  ## this function will delete the files that have been made over the course of the game. this must be called after Game.start in the main program file
+  ## this function will delete the files that have been made over the course of the game. this function is automatically called by this class after the
+  # window is closed
   def delete
     File.delete( File.join(Dir.home, 'Desktop/image1.png'),
                  File.join(Dir.home, 'Desktop/image2.png'),

data/lib/tumblr-game/board.rb

@@ -1,5 +1,10 @@
 require_relative 'tile.rb'
 
+## BOARD CLASS. This class represents the "game board" that each tile is drawn on. The initialize function accepts 10 images that will be stored
+# in the board object's tile_array. This represents the entire game board. This class effectively acts as an interface to the game tiles. The draw board
+# function calls the draw functions for each of the tiles. This class contains various utility functions described below to interface appropriately with
+# the tiles.
+
 class Board
   
 	## initialize function of the board class: this will accept 10 parameters that are each a path to an image
@@ -21,39 +26,39 @@ class Board
     @matchedCount = 0
 	end
 	
-	# draw function of the board class: this will go through the tile array and draw each tile
+	## draw function of the board class: this will go through the tile array and draw each tile
 	def draw_board
 		for i in 0..9
 			@tile_Array[i].draw
 		end
 	end
 	
-	# this function will flip a given tile to the face indicated by the parameter bool. false = facedown, true = face up
+	## this function will flip a given tile to the face indicated by the parameter bool. false = facedown, true = face up
 	def flip_tile(ind, bool)
 		@tile_Array[ind].flip(bool)
 	end
 
-	# this function will get the id from the desired tile
+	## this function will get the id from the desired tile
 	def get_id(ind)
 		return @tile_Array[ind].return_id
 	end
 	
-	# this function will set a tile to its "matched" configuration
+	## this function will set a tile to its "matched" configuration
 	def matchTile(ind)
 		@tile_Array[ind].set_match
 	end
 	
-	# this function will get the matched status of a specific tile and return it
+	## this function will get the matched status of a specific tile and return it
 	def is_matched(ind)
 		return @tile_Array[ind].return_match
 	end
   
-  # this function will increment the match counter to reflect a user successfully matching tiles
+  ## this function will increment the match counter to reflect a user successfully matching tiles
   def inc_match
     @matchedCount += 1
   end
   
-  # this function will return the amount of matched tiles
+  ## this function will return the amount of matched tiles
   def return_count
     return @matchedCount
   end

data/lib/tumblr-game/gosu.rb

@@ -3,6 +3,10 @@ require_relative 'board.rb'
 require_relative 'tile.rb'
 require_relative 'timer.rb'
 
+## MY WINDOW CLASS. This class is the main workhorse class of the game. It maintains all of the objects and variables associated with the game, as well
+# as rendering the window and allowing the user to interface with the tiles through picking. Each function is described in a comment block above the
+# function declaration.
+
 class MyWindow < Gosu::Window
   
   ## constants that will represent the background color for the window when the user loses
@@ -51,7 +55,7 @@ class MyWindow < Gosu::Window
    ## initialize a Timer object that will keep track of the time remaining for the given game
    # also create a Gosu font object that will be passed to the Timer object
    font = Gosu::Font.new(self, Gosu::default_font_name, 20)
-   @timer = Timer.new(font, @width/2, @height/2)
+   @timer = Timer.new(font, @width/2, @height/2, 30)
    
    ## create a font for the end of the game, either win or lose
    @endFont = Gosu::Font.new(self, Gosu::default_font_name, 20)
@@ -134,11 +138,6 @@ class MyWindow < Gosu::Window
     
     ## update the Timer object
     @timer.update
-    
-    #if @timer.return_time == 0 then
-    #  check_win
-    #end
-    
   end
   
   ## draw function. this function will draw one of the three backgrounds for the game. if the game is in the LOSE state, if the time has run out and the
@@ -148,7 +147,6 @@ class MyWindow < Gosu::Window
   def draw
     if (!@win and @lose) or (@frameCounter == 0 and @game_board.return_count < 5 and @timer.return_time == 0)
       draw_lose
-      puts "here"
     elsif (@win and !@lose)
       draw_win
     elsif (!@win and !@lose)

data/lib/tumblr-game/tile.rb

@@ -1,5 +1,10 @@
 require 'gosu'
 
+## TILE CLASS. This class represents each of the pictures in the game window. Each tile is created with the initialize function that accepts a Gosu
+# image for the main picture (img), x- and y-coordinates, an image to display when the tile is face down (img2), and id string, and a completion image
+# that is displayed when the tile is matched (chkImg). The draw function renders the tile to the game window. This class contains various utility
+# functions for tiles.
+
 class Tile
 	
 	## initialize function of the Tile class: this will create a Tile object with all necessary parameters
@@ -18,7 +23,10 @@ class Tile
 		@chkImage = chkImg
 	end
 	
-	# draw function of the Tile class: this will draw the image at the Tile's specified location
+	## draw function of the Tile class: this will draw the image at the Tile's specified location.
+  # if the tile is not fliped and not matched, then its facedown image is drawn.
+  # if the tile is flipped and not matched, then its true image is drawn.
+  # if the tile is matched, then the completion image is drawn.
 	def draw
 		if !@flipped and !@matched then
 			@rev.draw(@xLocation, @yLocation, 0)
@@ -29,22 +37,22 @@ class Tile
 		end
 	end
 	
-	# flip function of the Tile class: this will make the Tile be drawn with its true image
+	## flip function of the Tile class: this will make the Tile be drawn with its true image
 	def flip( bool )
 		@flipped = bool
 	end
 	
-	# return_id function of the Tile class: this will return the given Tile's id to be used in comparisons
+	## return_id function of the Tile class: this will return the given Tile's id to be used in comparisons
 	def return_id
 		return @idStr
 	end
 	
-	# sets the matched attribute of a Tile object to true. this will result in the tile displaying a checkmark for completion
+	## sets the matched attribute of a Tile object to true. this will result in the tile displaying a checkmark for completion
 	def set_match
 		@matched = true
 	end
 	
-	# this function will return a tile's matched status
+	## this function will return a tile's matched status
 	def return_match
 		return @matched
 	end

data/lib/tumblr-game/timer.rb

@@ -1,5 +1,10 @@
 require 'gosu'
 
+## TIMER CLASS. This class handles the timing aspect of the game. The initialize function accepts parameters that pass in a font, the timer location,
+# and the amount of time the game will run for. The update function will increment the frame counter by 1 every frame until it gets to 60. It then resets
+# to zero. The draw function renders the Timer on the game screen at the location established in initialize. The return_time function returns the time
+# left in the game.
+
 class Timer
   
   ## initialize function of the timer class
@@ -8,10 +13,10 @@ class Timer
   # pX = the x coordinate of where the font will display
   # pY = the y coordinate of where the font will display
   # the timer object also maintains a frame count and a count of the total time
-  def initialize(fontParam, pX, pY)
+  def initialize(fontParam, pX, pY, time)
     @font = fontParam
     @frameCounter = 0
-    @totalTime = 30
+    @totalTime = time
     @posX = pX
     @posY = pY
   end

data/lib/tumblr-game/tumblr.rb

@@ -1,6 +1,10 @@
 require 'open-uri'
 require 'tumblr_client'
 
+## TUMBLR API OBJECT CLASS. This class handles all of the interfacing with the Tumblr api. The initialize function will open a connection with the
+# Tumblr API. The query function executes a query to get 5 images from Tumblr's API from the blog indicated in the url. The create images function makes 
+# the images that will be used in the game. They are stored on the user's desktop.
+
 class TumblrAPIObject
   
   ## creates a new Tumblr API Object that is able to pull information from Tumblr's servers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tumblr-game
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Joe Canero