RSokoban 0.73 → 0.74

data/NEWS

@@ -1,4 +1,19 @@
-version 0.73  2011-??-??
+version 0.74  2011-01-31
+
+	* New: redo feature (only available with Tk GUI)
+	
+  * Tk GUI
+    + add a 'next level' feature
+    + undo shortcut change to Ctrl+Z
+    + view description of a level set in the 'load set' dialog box
+    + minor improvements in dialog boxes
+  
+  * Fix
+  	+ bug#1
+  	+ bug#2
+    
+
+version 0.73  2011-01-27
 
 	* New: undo
 	

data/README.rdoc

@@ -4,32 +4,35 @@ RSokoban is a clone of the famous {Sokoban}[http://en.wikipedia.org/wiki/Sokoban
 I wrote this program just to improve my skills in Ruby.
 
 *Features*
-* User interface comes in 3 flavors (tk, curses, straight text mode)
-* Installing via RubyGem
-* Undo
+* Graphical user interface with Tk
+* Two console user interfaces (curses and straight text mode)
+* 200+ levels
+* Undo/redo
 * Use xsb file format to load sets of levels
 
 Enjoy the game.
 
+
 == Documentation
+
 Players can look at {the wiki}[https://github.com/lkdjiin/RSokoban/wiki].
 
 Developpers can look at Level, Game and TkUI.
 
 
 == Dependancies
+
 Ruby >= 1.8.7
 
-== Installing RSokoban
-Installing via RubyGem is easy doing in one command:
 
- gem install RSokoban
+== Installing RSokoban
 
-Or you can install RSokoban from the source. To do this, go to the RSokoban folder and build the gem :
+*First method*
+To install RSokoban from the source, go to the RSokoban folder and build the gem:
 
  gem build rsokoban.gemspec
 
-Then install it :
+Then install it (maybe you have to be root):
 
  gem install RSokoban-x-xx.gem
  
@@ -37,11 +40,25 @@ Now start playing :
 
  rsokoban
 
+If you prefer using rake to build and install:
+
+ rake build
+ rake install
+
+*Second method*
+Or install via RubyGem in one command (you need ruby 1.9 or higher).
+Note that I don't certify you will get the latest release:
+
+ gem install RSokoban
+
+*Third method*
 Or you can play without installing it. Go to the RSokoban/bin folder and type:
 
  ./rsokoban
 
+
 == Questions and/or Comments
+
 Feel free to email {Xavier Nayrac}[mailto:xavier.nayrac@gmail.com]
 with any questions.
 

data/Rakefile

@@ -0,0 +1,51 @@
+desc 'Unit tests'
+task :default => :unit
+
+# Running RSokoban with the different (G)UIs
+
+desc 'Run RSokoban with Tk GUI'
+task :tk do
+  exec "./bin/rsokoban --tk"
+end
+
+desc 'Run RSokoban with curses UI'
+task :curses do
+  exec "./bin/rsokoban --curses"
+end
+# Aliases to rake curses
+task :curse => :curses
+task :curs => :curses
+task :cur => :curses
+
+desc 'Run RSokoban in straight text mode'
+task :portable do
+  exec "./bin/rsokoban --portable"
+end
+
+# Build & Install RSokoban
+
+desc 'Build the gem'
+task :build do
+  exec "gem build rsokoban.gemspec"
+end
+
+desc 'Install the gem (maybe you have to be root)'
+task :install do
+	require 'rake'
+	f = FileList['RSokoban*gem'].to_a
+	exec "gem install #{f.first}"
+end
+
+# Testing RSokoban
+
+desc 'Unit tests'
+task :unit do 
+	Dir.chdir 'test'
+	exec "./test.rb"
+end
+
+# Documentation
+desc 'Generate yard documentation'
+task :doc do 
+	exec 'yardoc --title "RSokoban Documentation" - NEWS COPYING VERSION'
+end

data/TODO

@@ -1,41 +1,19 @@
-
-doing gem and upload it
-
---- next ---
-tk: view description of level set in 'load set' dialog
-
-tk: add a scrollbar to the 'load set' dialog.
-
-tk: adjust window size to map size
-
-tk: level preview
-
-redo
-
---gnome
-
-skining (several size of tile, resizing ?)
-
-Console UI should provide a way to know names of sets
-
-save & reload
-
-multi player
-
-save score
-
-don't restrict map size
-
-solver (plugin ?)
-
-format fichier niveau xml (.slc)
-
---windows ?
-
---kde ?
-
---fxruby ?
-
-mouse support
-
-i18n
+* tk: use one image for rendering, not an array (if possible ?)
+* don't restrict map size
+* gnome GUI (gtk only to be windows compatible ?)
+* give a try to rubygame ?
+* skining
+  + load skin
+  + several size of tiles or resizing ?)
+* Console UI should provide a way to know names of sets
+* save a game
+* reload a saved game
+* multi player support
+* save score
+* scoring moves and pushes
+* level preview
+* solver (plugin ?)
+* format fichier niveau xml (.slc)
+* other GUI(s) ?
+* mouse support
+* i18n

data/VERSION

@@ -1 +1 @@
-0.73
+0.74

data/bin/rsokoban

@@ -69,6 +69,4 @@ if option[:ui] == :curses
 end
 
 game = RSokoban::Game.new option[:ui]
-
-# It seems I have somme troubles to unify GUI and non-GUI.
-game.run if [:curses, :portable].include?(option[:ui])
+game.run

data/lib/rsokoban.rb

@@ -1,3 +1,4 @@
+require "rsokoban/extensions"
 require "rsokoban/level"
 require "rsokoban/level_loader"
 require "rsokoban/exception"
@@ -12,6 +13,7 @@ require "rsokoban/raw_level"
 require "rsokoban/ui"
 require "rsokoban/move_recorder"
 require "rsokoban/map"
+require "rsokoban/move_result"
 
 # I am the main module of the game.
 module RSokoban	

data/lib/rsokoban/exception.rb

@@ -8,4 +8,8 @@ module RSokoban
 	# Used by {MoveRecorder}. Raise me if one try to undo when there is no move left.
 	class EmptyMoveQueueError < StandardError
 	end
+	
+	# Used by {MoveRecorder}. Raise me if one try to redo when there is nothing to redo.
+	class EmptyRedoError < StandardError
+	end
 end

data/lib/rsokoban/extensions.rb

@@ -0,0 +1,26 @@
+
+class String
+	# In xsb files, an information line start with a semi-colon.
+	# I remove it, remove leading and trailing spaces and inject a newline to the end.
+	# @example
+	#   > a = "; hello world !   \n"
+	#   > a.get_xsb_info_line
+	#   => "hello world !\n"
+	# @since 0.74
+	# @see #get_xsb_info_line_chomp
+	def get_xsb_info_line
+		self.get_xsb_info_line_chomp + "\n"
+	end
+	
+	# In xsb files, an information line start with a semi-colon.
+	# I remove it and also remove leading and trailing spaces.
+	# @example
+	#   > a = "; hello world !   \n"
+	#   > a.get_xsb_info_line_chomp
+	#   => "hello world !"
+	# @since 0.74
+	# @see #get_xsb_info_line
+	def get_xsb_info_line_chomp
+		self.sub(/;/, '').strip
+	end
+end

data/lib/rsokoban/game.rb

@@ -1,12 +1,17 @@
 module RSokoban
 
-	# I am mostly the game loop.
+	# I manage the game.
 	class Game
+		# @return [Fixnum]
+		# @since 0.74
+		attr_reader :level_number
 
 		# Construct a new game that you can later run.
 		# @param [:curses|:portable|:tk] ui_as_symbol the user interface for the game
-		def initialize ui_as_symbol
-			@level_loader = LevelLoader.new "original.xsb"
+		# @param [String] setname only used during testing
+		def initialize ui_as_symbol, setname = 'microban.xsb'
+			@ui_as_symbol = ui_as_symbol
+			@level_loader = LevelLoader.new setname
 			@level_number = 1
 			case ui_as_symbol
 				when :curses
@@ -17,12 +22,28 @@ module RSokoban
 					@ui = UI::Console.new
 				when :tk
 					require "rsokoban/ui/tk_ui"
-					@ui = UI::TkUI.new
+					require "rsokoban/ui/tk_box"
+					require "rsokoban/ui/tk_dialogs"
+					@gui = UI::TkUI.new self
 			end
 		end
 		
-		# I am the game loop.
+		# Start the game loop.
+		#
+		# For GUI game (like Tk), the tool kit provide its own event-loop. In that case, I simply
+		# call this event-loop via the run() method (for example see {RSokoban::UI::TkUI#run}.
+		#
+		# For UI game (like Curses) which are text based, Game provide the loop.
 		def run
+			if [:curses, :portable].include?(@ui_as_symbol)
+				ui_mainloop
+			else
+				@gui.run
+			end
+		end
+		
+		# I am the game loop for UIs.
+		def ui_mainloop
 			player_action = start_level
 			loop do
 				if player_action.level_number?
@@ -45,40 +66,151 @@ module RSokoban
 					result = @level.undo
 				end
 				
-				move_index = result =~ /\d+/
-				if result.start_with?('WIN')
-					player_action = @ui.get_action(:type=>:win, :map=>@level.map, :move=>result[move_index..-1])
+				if result[:status] == :win
+					player_action = @ui.get_action(:type=>:win, :map=>@level.map, :move=>result[:move_number])
+				elsif result[:status] == :ok
+					player_action = @ui.get_action(:type=>:display, :map=>@level.map, :move=>result[:move_number])
 				else
-					if move_index
-						player_action = @ui.get_action(:type=>:display, :map=>@level.map, :move=>result[move_index..-1])
-					else
-						player_action = @ui.get_action(:type=>:display, :map=>@level.map, :error=>result)
-					end
+					player_action = @ui.get_action(:type=>:display, :map=>@level.map, :error=>result[:message])
 				end
 			end
+			true
 		end
 		
-		private
+		# @return [Fixnum]
+		# @since 0.74
+		# @see Level#width
+		def level_width
+			@level.width
+		end
+		
+		# @return [Fixnum]
+		# @since 0.74
+		# @see Level#height
+		def level_height
+			@level.height
+		end
+		
+		# @return [String]
+		# @since 0.74
+		# @see Level#title
+		def level_title
+			@level.title
+		end
+		
+		# Get current map of the game
+		# @return [Map]
+		# @since 0.74
+		def map
+			@level.map
+		end
+		
+		# Get x coordinate of the man
+		# @return [Fixnum]
+		# @since 0.74
+		def man_x
+			@level.man.x
+		end
+		
+		# Get y coordinate of the man
+		# @return [Fixnum]
+		# @since 0.74
+		def man_y
+			@level.man.y
+		end
+		
+		# Get result of the move
+		# @param [:up|:down|:right|:left] direction
+		# @return [Object]
+		# @since 0.74
+		def move direction
+			@level.move direction
+		end
+		
+		# Get current move number
+		# @return [Fixnum]
+		# @since 0.74
+		def move_number
+			@level.move_number
+		end
+		
+		# Get result of undo last move
+		# @return [MoveResult]
+		# @since 0.74
+		def undo
+			@level.undo
+		end
+		
+		# Get result of redo last undone move
+		# @return [MoveResult]
+		# @since 0.74
+		def redo
+			@level.redo
+		end
+		
+		# Get title of the current set
+		# @return [String]
+		# @since 0.74
+		def set_title
+			@level_loader.title
+		end
+		
+		# Get numbers of level from the current set
+		# @return [Fixnum]
+		# @since 0.74
+		def set_size
+			@level_loader.size
+		end
+		
+		# Start a level, according to some instance members.
+		# @return [PlayerAction|nil] the user's action for console window
+		#    interface, or nil for GUI.
+		def start_level
+			begin
+				@level = @level_loader.level(@level_number)
+				if @ui
+					@ui.get_action(:type=>:start, :map=>@level.map, :title=>@level.title, :set=>@level_loader.title,
+										:number=>@level_number, :total=>@level_loader.size)
+				end
+			rescue LevelNumberTooHighError
+				if @ui
+					@ui.get_action(:type=>:end_of_set, :map=>Map.new)
+				else
+					raise LevelNumberTooHighError
+				end
+			end
+		end
 	
 		# Load and start the next level of the set
-		# @return [Object] the user's {action}[Console#get_action]
+		# @return [PlayerAction|nil] the user's action for console window
+		#    interface, or nil for GUI.
 		def next_level
 			@level_number += 1
 			start_level
 		end
 		
-		# Restart the current level
-		# @return [Object] the user's {action}[Console#get_action]
-		def try_again
+		# Load a level from the current set.
+		# @param [Fixnum] num the number of the set (base 1)
+		# @return [PlayerAction|nil] the user's action for console window
+		#    interface, or nil for GUI.
+		def load_level num
+			@level_number = num
+			start_level
+		end
+		
+		# Restart from level 1.
+		# @return [PlayerAction|nil] the user's action for console window
+		#    interface, or nil for GUI.
+		def restart_set
+			@level_number = 1
 			start_level
 		end
 		
 		# Load a new set of levels and start its first level.
 		# @param [String] setname the name of the set (with .xsb extension)
-		# @return [Object] the user's {action}[Console#get_action]
+		# @return [PlayerAction|nil] the user's action for console window
+		#    interface, or nil for GUI.
 		def load_a_new_set setname 
-			title = nil
-			error = nil
 			begin
 				@level_loader = LevelLoader.new setname
 				@level_number = 1
@@ -87,32 +219,20 @@ module RSokoban
 			rescue NoFileError
 				error = "Error, no such file : #{setname}"
 			end
-			@ui.get_action(:type=>:start, :map=>@level.map, :title=>title, :error=>error, :set=>@level_loader.set.title,
-			:number=>@level_number, :total=>@level_loader.set.size)
+			if @ui
+				@ui.get_action(:type=>:start, :map=>@level.map, :title=>title, :error=>error, :set=>@level_loader.title,
+						:number=>@level_number, :total=>@level_loader.size)
+			end
 		end
 		
-		# Load a level from the current set.
-		# @param [Fixnum] num the number of the set (base 1)
-		# @return [Object] the user's {action}[Console#get_action]
-		def load_level num
-			@level_number = num
-			start_level
-		end
+		private
 		
-		# Start a level, according to some instance members.
+		# Restart the current level
 		# @return [Object] the user's {action}[Console#get_action]
-		def start_level
-			begin
-				@level = @level_loader.level(@level_number)
-				@ui.get_action(:type=>:start, :map=>@level.map, :title=>@level.title, :set=>@level_loader.set.title,
-				:number=>@level_number, :total=>@level_loader.set.size)
-			rescue LevelNumberTooHighError
-				@ui.get_action(:type=>:end_of_set, :map=>Map.new)
-			end
+		def try_again
+			start_level
 		end
 		
 	end
 	
-	
-
 end