RSokoban 0.71 → 0.73

data/NEWS

@@ -0,0 +1,22 @@
+version 0.73  2011-??-??
+
+	* New: undo
+	
+	* New: default GUI with Tk library
+	
+	* Ruby requiered version down to 1.8.7
+	
+	* Curses and Portable user interface display a few more information
+
+
+version 0.72  2011-01-21
+
+  * New console output using curses
+  
+  * New command line options
+    --curses : Use curses as user interface. Default option.
+    --portable : Use a simplest user interface, should work on any platform.
+    --help-output : Display help on available user interfaces.
+
+  * Installing via RubyGem
+ 

data/README.rdoc

@@ -1,35 +1,31 @@
 = Welcome to RSokoban !
 
-RSokoban is a clone of the famous {Sokoban game}[http://en.wikipedia.org/wiki/Sokoban].
-I wrote this program just to improve my skills in Ruby. Currently, you can play only in a console
-window.
-
-      #####
-      #   #
-      #$  #
-    ###  $##
-    #  $ $ #
-  ### # ## #   ######
-  #   # ## #####  ..#
-  # $  $          ..#
-  ##### ### #@##  ..#
-      #     #########
-      #######
+RSokoban is a clone of the famous {Sokoban}[http://en.wikipedia.org/wiki/Sokoban] game.
+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
+* 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 and Game.
+Developpers can look at Level, Game and TkUI.
 
 
 == Dependancies
-Ruby >= 1.9
+Ruby >= 1.8.7
 
 == Installing RSokoban
-Installing via a gem is easy.
-Go to the RSokoban folder and build the gem :
+Installing via RubyGem is easy doing in one command:
+
+ gem install RSokoban
+
+Or you can install RSokoban from the source. To do this, go to the RSokoban folder and build the gem :
 
  gem build rsokoban.gemspec
 
@@ -41,6 +37,10 @@ Now start playing :
 
  rsokoban
 
+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/TODO

@@ -1,34 +1,41 @@
 
---- v0.71 ---
+doing gem and upload it
 
-(done)CursesConsole
-(done)--portable 
-(done)--curses (default)
-(done)--help-output
-(done)curses: level completed (yes/no) > y or n
-(done)gem
+--- next ---
+tk: view description of level set in 'load set' dialog
 
-wiki installing
+tk: add a scrollbar to the 'load set' dialog.
 
-wiki curses console
+tk: adjust window size to map size
 
-Picture must be a class
+tk: level preview
 
---- v0.90 ---
+redo
 
-undo
+--gnome
 
---- v1.0 ---
+skining (several size of tile, resizing ?)
 
---tk
+Console UI should provide a way to know names of sets
 
-skining
+save & reload
 
---- next ---
+multi player
+
+save score
+
+don't restrict map size
+
+solver (plugin ?)
 
 format fichier niveau xml (.slc)
+
 --windows ?
---gnome ?
+
 --kde ?
+
 --fxruby ?
-save, reload
+
+mouse support
+
+i18n

data/VERSION

@@ -0,0 +1 @@
+0.73

data/bin/rsokoban

@@ -1,10 +1,74 @@
 #!/usr/bin/env ruby
 
+# This file is part of RSokoban, a clone of the famous sokoban game.
+# Copyright 2011 Xavier Nayrac
+#
+# RSokoban is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+$RSOKOBAN_PATH = File.expand_path(File.dirname(__FILE__)) + '/..'
+
 $RSOKOBAN_DATA_PATH = File.expand_path(File.dirname(__FILE__) + '/../data')
+
 require 'rsokoban'
 
+tk_failed=<<EOS
+Sorry, failed to load tk or tkimg library.
+Please, be sure that libtcltk-ruby and libtk-img are correctly installed on
+your system.
+Now trying to start with curses library:
+  rsokoban --curses
+
+EOS
+
+curses_failed=<<EOS
+Sorry, failed to load curses library.
+Please, be sure that curses are correctly installed on your system.
+You can try the game with the portable UI.
+  rsokoban --portable
+
+EOS
+
+# If player don't specify an explicit user interface,
+# one will use tk.
 option = Option.new
 
+# I try to load the needed tk bindings. If it fails,
+# one can try with curses.
+if option[:ui] == :tk
+	begin
+		require 'tk'
+		require 'tkextlib/tkimg'
+	rescue LoadError => e
+		puts tk_failed
+		option.interface = :curses
+	end
+end
+
+# I try to load the needed curses binding. If it fails,
+# inform user and abandon.
+if option[:ui] == :curses
+	begin
+		require 'curses'
+	rescue LoadError => e
+		puts curses_failed
+		exit
+	end
+end
+
 game = RSokoban::Game.new option[:ui]
-game.run
+
+# It seems I have somme troubles to unify GUI and non-GUI.
+game.run if [:curses, :portable].include?(option[:ui])

data/lib/rsokoban/exception.rb

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

data/lib/rsokoban/game.rb

@@ -4,10 +4,10 @@ module RSokoban
 	class Game
 
 		# Construct a new game that you can later run.
-		# @param [:curses|:portable] ui_as_symbol the user interface for the game
+		# @param [:curses|:portable|:tk] ui_as_symbol the user interface for the game
 		def initialize ui_as_symbol
-			@levelLoader = LevelLoader.new "original.xsb"
-			@levelNumber = 1
+			@level_loader = LevelLoader.new "original.xsb"
+			@level_number = 1
 			case ui_as_symbol
 				when :curses
 					require "rsokoban/ui/curses_console"
@@ -15,36 +15,45 @@ module RSokoban
 				when :portable
 					require "rsokoban/ui/console"
 					@ui = UI::Console.new
+				when :tk
+					require "rsokoban/ui/tk_ui"
+					@ui = UI::TkUI.new
 			end
 		end
 		
 		# I am the game loop.
 		def run
-			action = start_level
+			player_action = start_level
 			loop do
-				if action.is_a?(Fixnum)
-					action = load_level action
+				if player_action.level_number?
+					player_action = load_level player_action.action
 					next
-				elsif action.instance_of?(String)
-					# Assuming we recieve a filename of level's set to load
-					action = load_a_new_set action
+				elsif player_action.set_name?
+					player_action = load_a_new_set player_action.action
 					next
-				elsif action == :quit
+				elsif player_action.quit?
 					break
-				elsif action == :next
-					action = next_level
+				elsif player_action.next?
+					player_action = next_level
 					next
-				elsif action == :retry
-					action = try_again
+				elsif player_action.retry?
+					player_action = try_again
 					next
-				elsif [:down, :up, :left, :right].include?(action)
-					result = @level.move(action)
+				elsif player_action.move?
+					result = @level.move(player_action.action)
+				elsif player_action.undo?
+					result = @level.undo
 				end
 				
+				move_index = result =~ /\d+/
 				if result.start_with?('WIN')
-					action = @ui.get_action('WIN', @level.picture, result)
+					player_action = @ui.get_action(:type=>:win, :map=>@level.map, :move=>result[move_index..-1])
 				else
-					action = @ui.get_action('DISPLAY', @level.picture, result)
+					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
 				end
 			end
 		end
@@ -54,7 +63,7 @@ module RSokoban
 		# Load and start the next level of the set
 		# @return [Object] the user's {action}[Console#get_action]
 		def next_level
-			@levelNumber += 1
+			@level_number += 1
 			start_level
 		end
 		
@@ -68,22 +77,25 @@ module RSokoban
 		# @param [String] setname the name of the set (with .xsb extension)
 		# @return [Object] the user's {action}[Console#get_action]
 		def load_a_new_set setname 
+			title = nil
+			error = nil
 			begin
-				@levelLoader = LevelLoader.new setname
-				@levelNumber = 1
-				@level = @levelLoader.level(@levelNumber)
-				message = "Level : #{@level.title}"
+				@level_loader = LevelLoader.new setname
+				@level_number = 1
+				@level = @level_loader.level(@level_number)
+				title = @level.title
 			rescue NoFileError
-				message = "Error, no such file : #{setname}"
+				error = "Error, no such file : #{setname}"
 			end
-			@ui.get_action('START', @level.picture, message)
+			@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)
 		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
-			@levelNumber = num
+			@level_number = num
 			start_level
 		end
 		
@@ -91,10 +103,11 @@ module RSokoban
 		# @return [Object] the user's {action}[Console#get_action]
 		def start_level
 			begin
-				@level = @levelLoader.level(@levelNumber)
-				@ui.get_action('START', @level.picture, "Level : #{@level.title}")
+				@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('END_OF_SET', ['####'], "No more levels in this set")
+				@ui.get_action(:type=>:end_of_set, :map=>Map.new)
 			end
 		end
 		

data/lib/rsokoban/level.rb

@@ -21,13 +21,14 @@ module RSokoban
 		# @param [RawLevel] rawLevel
 		def initialize rawLevel
 			@title = rawLevel.title
-			@floor = init_floor rawLevel.picture
-			@man = init_man rawLevel.picture
+			@floor = init_floor rawLevel.map
+			@man = init_man rawLevel.map
 			@crates = []
 			@storages = []
-			init_crates_and_storages rawLevel.picture
+			init_crates_and_storages rawLevel.map
 			@move = 0
-			@picture = nil
+			@map = nil
+			@move_recorder = MoveRecorder.new
 		end
 		
 		# Two Level objects are equals if their @title, @floor, @man, @crates and @storages are equals.
@@ -44,14 +45,14 @@ module RSokoban
 			self == obj
 		end
 		
-		# Get an instant picture of the game.
-		# @return [Array<String>] the picture, after X turns of game.
-		def picture
-			@picture = init_floor @floor
+		# Get an instant map of the game.
+		# @return [Map] the map, after X turns of game.
+		def map
+			@map = init_floor @floor
 			draw_crates
 			draw_storages
 			draw_man
-			@picture
+			@map
 		end
 		
 		# Move the man one box up.
@@ -90,15 +91,51 @@ module RSokoban
 			return 'ERROR wall behind crate' if wall_behind_crate?(direction)
 			return 'ERROR double crate' if double_crate?(direction)
 			@move += 1
+			
 			@man.send(direction)
 			if @crates.include?(Crate.new(@man.x, @man.y))
 				i = @crates.index(Crate.new(@man.x, @man.y))
 				@crates[i].send(direction)
+				@move_recorder.record direction, :push
+			else
+				@move_recorder.record direction
 			end
 			return "WIN move #{@move}" if win?
 			"OK move #{@move}"
 		end
 		
+		# Undo last move
+		def undo
+			begin
+				case @move_recorder.undo
+					when :up then @man.down
+					when :down then @man.up
+					when :left then @man.right
+					when :right then @man.left
+					when :UP
+						i = @crates.index(Crate.new(@man.x, @man.y-1))
+						@crates[i].down
+						@man.down
+					when :DOWN
+						i = @crates.index(Crate.new(@man.x, @man.y+1))
+						@crates[i].up
+						@man.up
+					when :LEFT
+						i = @crates.index(Crate.new(@man.x-1, @man.y))
+						@crates[i].right
+						@man.right
+					when :RIGHT
+						i = @crates.index(Crate.new(@man.x+1, @man.y))
+						@crates[i].left
+						@man.left
+				end
+				@move -= 1
+			rescue EmptyMoveQueueError
+				# Nothing to do
+			end
+			"OK move #{@move}"
+		end
+		
 		private
 		
 		# @return true if all crates are on a storage location
@@ -173,29 +210,29 @@ module RSokoban
 			box == CRATE or box == CRATE_ON_STORAGE
 		end
 		
-		# Draw the man for @picture output
+		# Draw the man for map output
 		def draw_man
 			box = what_is_on @man.x, @man.y
-			put_man_in_picture if box == FLOOR
-			put_man_on_storage_in_picture if box == STORAGE
+			put_man_in_map if box == FLOOR
+			put_man_on_storage_in_map if box == STORAGE
 		end
 		
-		def put_man_in_picture
-			@picture[@man.y][@man.x] = MAN
+		def put_man_in_map
+			@map[@man.y][@man.x] = MAN
 		end
 		
-		def put_man_on_storage_in_picture
-			@picture[@man.y][@man.x] = MAN_ON_STORAGE
+		def put_man_on_storage_in_map
+			@map[@man.y][@man.x] = MAN_ON_STORAGE
 		end
 		
-		# Draw the crates for @picture output
+		# Draw the crates for map output
 		def draw_crates
-			@crates.each {|crate| @picture[crate.y][crate.x] = what_is_on(crate.x, crate.y) }
+			@crates.each {|crate| @map[crate.y][crate.x] = what_is_on(crate.x, crate.y) }
 		end
 		
-		# Draw the storages location for @picture output
+		# Draw the storages location for map output
 		def draw_storages
-			@storages.each {|st| @picture[st.y][st.x] = what_is_on(st.x, st.y) }
+			@storages.each {|st| @map[st.y][st.x] = what_is_on(st.x, st.y) }
 		end
 
 		# Get the content of box x, y
@@ -220,21 +257,21 @@ module RSokoban
 		
 		# Removes all storages locations, all crates and the man, leaving only walls and floor.
 		#
-		# @param [Array<String>] picture 
-		# @return [Array<String>] picture with only walls and floor
-		def init_floor picture
+		# @param [Map] map 
+		# @return [Map] map with only walls and floor
+		def init_floor map
 			floor = []
-			picture.each {|x| floor.push x.tr("#{STORAGE}#{CRATE}#{MAN}#{CRATE_ON_STORAGE}", FLOOR) }
+			map.each {|x| floor.push x.tr("#{STORAGE}#{CRATE}#{MAN}#{CRATE_ON_STORAGE}", FLOOR) }
 			floor
 		end
 		
 		# Find the man's position, at the begining of the level.
 		#
-		# @param [Array<String>] picture
+		# @param [Map] map
 		# @return [Man] an initialised man
-		def init_man picture
+		def init_man map
 			x = y = 0
-			picture.each {|line| 
+			map.each {|line| 
 				if line.include?(MAN)
 					x = line.index(MAN)
 					break
@@ -246,10 +283,10 @@ module RSokoban
 		
 		# Find position of crates and storages, at the begining of the level.
 		#
-		# @param [Array<String>] picture
-		def init_crates_and_storages picture
+		# @param [Map] map
+		def init_crates_and_storages map
 			y = 0
-			picture.each do |line| 
+			map.each do |line| 
 				count = 0
 				line.each_char do |c| 
 					@crates.push Crate.new(count, y) if c == CRATE

data/lib/rsokoban/level_loader.rb

@@ -7,10 +7,10 @@ module RSokoban
 	class LevelLoader
 		attr_reader :level, :set
 	
-		# @filename [String] le nom du fichier où trouver les niveaux.
+		# @param [String] filename le nom du fichier où trouver les niveaux.
 		#   Ce fichier est cherché dans le dossier data/.
-		# @throws [RSokoban::NoFileError] si le fichier n'existe pas
-		# @see LevelSet for an overview of .xsb file format
+		# @raise [RSokoban::NoFileError] si le fichier n'existe pas
+		# @see LevelSet overview of .xsb file format
 		def initialize filename
 			filename = "#{$RSOKOBAN_DATA_PATH}/" + filename
 			raise NoFileError unless File.exist?(filename)
@@ -35,7 +35,7 @@ module RSokoban
 						line = file.readline.chomp
 					end
 					line = line.chomp.sub(/;/, '').sub(/\s*/, '')
-					@set.rawLevels.push RawLevel.new(line, raw)
+					@set.rawLevels.push RawLevel.new(line, raw) unless raw.empty?
 					
 					line = file.readline
 					while line[0, 1] == ';'

data/lib/rsokoban/level_set.rb

@@ -3,22 +3,28 @@ module RSokoban
 	# I am a set of sokoban levels.
 	# Level set are found in .xsb files.
 	#
-	# =xsb file format
+	# = xsb file format
 	# 
 	# Info lines begins with semi-colon (;)
-	# Map lines begins with a # (that's a wall !)
+	# Map lines begins with a # (that's a wall !) preceded by 0, 1 or more spaces.
 	# 
-	# 1: First info is title of the set
-	# 2: Blank line
-	# 3: List of info lines : description
-	# 4: Blank line
-	# 5: Level map
-	# 6: info title of this level
-	# 7: List of info lines : blabla about this level
+	# 1. First info is title of the set
+	# 2. Blank line
+	# 3. List of info lines : description
+	# 4. Blank line
+	# 5. Level map
+	# 6. info title of this level
+	# 7. List of info lines : blabla about this level
 	#
 	# From 4 to 7 again for each supplementary level
 	class LevelSet
-		attr_accessor :title, :description, :rawLevels
+	
+		# @param [String] title get/set the title of this level set.
+		attr_accessor :title
+		# @param [String] description get/set the description of this level set.
+		attr_accessor :description
+		# @param [Array<RawLevel>] rawLevels get/set the raw levels of this set
+		attr_accessor :rawLevels
 		
 		def initialize
 			@title = 'Unknown set title'
@@ -26,6 +32,10 @@ module RSokoban
 			@rawLevels = []
 		end
 		
+		def size
+			@rawLevels.size
+		end
+		
 	end
 	
 end

data/lib/rsokoban/map.rb

@@ -0,0 +1,51 @@
+module RSokoban
+
+	# I am the map of a level.
+	# @since 0.73
+	class Map
+		# @param [Array<String>]
+		attr_reader :rows
+	
+		# Construct a map from an array of strings.
+		# @example very simple maps
+		#   map1 = Map.new['###', '#@#', '###']
+		#
+		#   map2 = Map.new
+		#   map2.rows = ['###', '#@#', '###']
+		#
+		# @param [Array<String>]
+		def initialize rows = []
+			@rows= rows
+			@width = 0
+		end
+		
+		def rows=(rows)
+			@rows = rows
+			@width = 0
+			@rows.each {|row| @width = row.size if row.size > @width }
+		end
+		
+		def height
+			@rows.size
+		end
+		
+		def width
+			@width
+		end
+		
+		def [](num)
+			@rows[num]
+		end
+		
+		def each(&block)
+			@rows.each(&block)
+		end
+		
+		def ==(obj)
+			return false unless obj.kind_of?(Map)
+			@rows == obj.rows
+		end
+		
+	end
+
+end