RSokoban 0.74 → 0.76

data/lib/rsokoban/ui.rb

@@ -1,5 +1,6 @@
 require "rsokoban/ui/base_ui"
 require "rsokoban/ui/player_action"
+require "rsokoban/ui/skin"
 
 module RSokoban
 	

data/lib/rsokoban.rb

@@ -1,12 +1,11 @@
 require "rsokoban/extensions"
 require "rsokoban/level"
-require "rsokoban/level_loader"
+require "rsokoban/set_loader"
 require "rsokoban/exception"
 require "rsokoban/position"
 require "rsokoban/man"
 require "rsokoban/crate"
 require "rsokoban/storage"
-require "rsokoban/game"
 require "rsokoban/option"
 require "rsokoban/level_set"
 require "rsokoban/raw_level"
@@ -14,6 +13,11 @@ require "rsokoban/ui"
 require "rsokoban/move_recorder"
 require "rsokoban/map"
 require "rsokoban/move_result"
+require "rsokoban/game"
+require "rsokoban/layered_map"
+require "rsokoban/record"
+require "rsokoban/install"
+require "rsokoban/config"
 
 # I am the main module of the game.
 module RSokoban	
@@ -26,5 +30,13 @@ module RSokoban
 	WALL = '#'
 	MAN_ON_STORAGE = '+'
 	CRATE_ON_STORAGE = '*'
+	OUTSIDE = 'o'
+	
+	# config files will go in this folder
+	CONFIG_FOLDER = File.expand_path "~/.rsokoban"
+	# primary config file
+	CONFIG_FILE = 'config'
 	
+	# Record files will go in this folder
+	RECORD_FOLDER = File.expand_path "~/.rsokoban/record"
 end

data/skins/AntiqueDesk/skin.conf

@@ -0,0 +1,3 @@
+author: Gerry Wiseman
+license: unknown
+size: 30

data/skins/BlueGranite/skin.conf

@@ -0,0 +1,3 @@
+author: MerlijnVV
+license: unknown
+size: 30

data/skins/HeavyMetal/skin.conf

@@ -0,0 +1,3 @@
+author: Gerry Wiseman
+license: unknown
+size: 35

data/test/record/original.yaml

@@ -0,0 +1,2 @@
+1: 200
+22: 321

data/test/tc_game.rb

@@ -1,28 +1,37 @@
 class TC_Game < Test::Unit::TestCase
-
+	include RSokoban
+	
+	class GameFake
+		include RSokoban::Game
+	end
+	
 	def setup
 		$RSOKOBAN_DATA_PATH = File.expand_path(File.dirname(__FILE__))
-		@game = RSokoban::Game.new :portable, 'original.xsb'
-		# Make Game@ui nil to not start the ui.
-		@game.instance_variable_set(:@ui, nil)
-		# Load the first level, without starting ui (see previous line)
-		@game.start_level
+		@level_set_name = 'original.xsb'
+		@game = GameFake.new('Fake UI', @level_set_name)
 	end
 	
-	def test_level_width
-		assert_equal 19, @game.level_width
+	def test_game_is_not_instanciable
+		assert_raise(NoMethodError) do
+			ins = Game.new
+		end
 	end
 	
-	def test_level_height
-		assert_equal 11, @game.level_height
+	def test_run_method_must_failed
+		assert_raise(NotImplementedError) do
+			@game.run
+		end
 	end
 	
-	def test_level_title
-		assert_equal '1', @game.level_title
+	def test_start_level_method_must_failed
+		assert_raise(NotImplementedError) do
+			@game.start_level
+		end
 	end
 	
-	def test_man_x
-		assert_equal 11, @game.man_x
-	end
+	# must create a fake config file to test this
+	#~ def test_level_number_is_initialized_to_1
+		#~ assert_equal 1, @game.level_number
+	#~ end
 	
 end

data/test/tc_game_factory.rb

@@ -0,0 +1,40 @@
+class TC_GameFactory < Test::Unit::TestCase
+	include RSokoban
+	
+	def setup
+		$RSOKOBAN_DATA_PATH = File.expand_path(File.dirname(__FILE__))
+		@level_set_name = 'original.xsb'
+	end
+	
+	def test_create_with_wrong_argument
+		assert_raise(ArgumentError) do
+			game = GameFactory.create String
+		end
+	end
+	
+	def test_method_new_is_not_allowed
+		assert_raise(NoMethodError) do
+			gf = GameFactory.new
+		end
+	end
+	
+	def test_create_a_game_with_portable_ui
+		game = GameFactory.create(GamePortable, 'Fake UI', @level_set_name)
+		assert_equal GamePortable, game.class
+	end
+	
+	def test_create_a_game_with_curses_ui
+		game = GameFactory.create(GameCurses, 'Fake UI', @level_set_name)
+		assert_equal GameCurses, game.class
+	end
+	
+	def test_create_a_game_with_tk_gui
+		# tk is normally requiered from the bin/rsokoban program.
+		require 'tk'
+		game = GameFactory.create(GameTk, 'Fake UI', @level_set_name)
+		assert_equal GameTk, game.class
+	end
+	
+	
+
+end

data/test/tc_game_gui.rb

@@ -0,0 +1,26 @@
+class TC_GameGUI < Test::Unit::TestCase
+	include RSokoban
+	
+	class GameFake
+		include RSokoban::GameGUI
+	end
+	
+	class UIFake
+	end
+	
+	def setup
+		$RSOKOBAN_DATA_PATH = File.expand_path(File.dirname(__FILE__))
+		@level_set_name = 'original.xsb'
+		@ui = UIFake.new
+		# initialize a game
+		@game = GameFake.new(@ui, @level_set_name)
+		@game.start_level
+	end
+	
+	def test_game_ui_is_not_instanciable
+		assert_raise(NoMethodError) do
+			ins = GameGUI.new
+		end
+	end
+	
+end

data/test/tc_game_ui.rb

@@ -0,0 +1,153 @@
+# @todo find something to test the run method
+class TC_GameUI < Test::Unit::TestCase
+	include RSokoban
+
+	class GameFake
+		include RSokoban::GameUI
+	end
+	
+	class UIFake
+		def get_action(hash)
+			RSokoban::UI::PlayerAction.new :quit
+		end
+	end
+	
+	def setup
+		$RSOKOBAN_DATA_PATH = File.expand_path(File.dirname(__FILE__))
+		@level_set_name = 'original.xsb'
+		@ui = UIFake.new
+		# initialize a game
+		@game = GameFake.new(@ui, @level_set_name)
+		@game.start_level
+	end
+	
+	def test_game_ui_is_not_instanciable
+		assert_raise(NoMethodError) do
+			ins = GameUI.new
+		end
+	end
+	
+	def test_start_level_must_return_an_action
+		game = GameFake.new(@ui, @level_set_name)
+		assert_equal UI::PlayerAction, game.start_level.class
+	end
+	
+	def test_run_method_must_respond_to_the_quit_command
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		assert_equal true, game.run
+	end
+	
+	### Test module Game trough module GameUI ####################################
+	
+	# must create a fake config file to test this
+	#~ def test_level_width
+		#~ assert_equal 19, @game.level_width
+	#~ end
+	
+	# must create a fake config file to test this
+	#~ def test_level_height
+		#~ assert_equal 11, @game.level_height
+	#~ end
+	
+	# must create a fake config file to test this
+	#~ def test_level_title
+		#~ assert_equal '1', @game.level_title
+	#~ end
+	
+	def test_map_as_array_must_return_an_array
+		assert_equal Array, @game.map_as_array.class
+	end
+	
+	# must create a fake config file to test this
+	#~ def test_man_x
+		#~ assert_equal 11, @game.man_x
+	#~ end
+	
+	# must create a fake config file to test this
+	#~ def test_man_y
+		#~ assert_equal 8, @game.man_y
+	#~ end
+	
+	def test_move_must_return_move_result
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		assert_equal MoveResult, game.move(:up).class
+	end
+	
+	def test_initial_move_number_must_be_zero
+		assert_equal 0, @game.move_number
+	end
+	
+	# must create a fake config file to test this
+	#~ def test_move_number
+		#~ game = GameFake.new(@ui, @level_set_name)
+		#~ game.start_level
+		#~ game.move(:up)
+		#~ assert_equal 1, game.move_number
+	#~ end
+	
+	def test_undo_must_return_move_result
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		assert_equal MoveResult, game.undo.class
+	end
+	
+	def test_redo_must_return_move_result
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		assert_equal MoveResult, game.undo.class
+	end
+	
+	def test_title_of_the_set
+		assert_equal 'Original & Extra', @game.set_title
+	end
+	
+	def test_size_of_the_set
+		assert_equal 90, @game.set_size
+	end
+	
+	# must create a fake config file to test this
+	#~ def test_next_level
+		#~ game = GameFake.new(@ui, @level_set_name)
+		#~ game.start_level
+		#~ game.next_level
+		#~ assert_equal 2, game.level_number
+	#~ end
+	
+	def test_load_level
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		game.load_level 3
+		assert_equal 3, game.level_number
+	end
+	
+	def test_restart_set
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		game.load_level 3
+		game.restart_set
+		assert_equal 1, game.level_number
+	end
+	
+	def test_load_a_set_that_doesnt_exist
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		game.load_a_new_set 'doesnt_exist.xsb'
+		# assert nothing has changed
+		
+		# must create a fake config file to test this
+		#~ assert_equal 1, game.level_number
+		
+		assert_equal 'Original & Extra', game.set_title
+	end
+	
+	def test_load_a_set_of_levels
+		game = GameFake.new(@ui, @level_set_name)
+		game.start_level
+		game.load_a_new_set 'test_file2.xsb'
+		assert_equal 1, game.level_number
+		assert_equal 'another test file', game.set_title
+	end
+	
+end

data/test/tc_install.rb

@@ -0,0 +1,12 @@
+class TC_Install< Test::Unit::TestCase
+	include RSokoban
+	
+	def test_create_folder
+		Install.create_folder 'temp/record'
+		assert File.exist? 'temp/record'
+		assert File.directory? 'temp/record'
+	ensure
+		FileUtils.remove_dir('temp') if File.exist?('temp')
+	end
+	
+end

data/test/tc_layered_map.rb

@@ -0,0 +1,105 @@
+class TC_LayeredMap < Test::Unit::TestCase
+	include RSokoban
+
+	MAP_1 = [ '####',
+	          '#..#',
+	          '#$$#',
+	          '#@ #',
+	          '####']
+						
+	MAP_2 = [ '####',
+	          '#*.#',
+	          '# $#',
+	          '#@ #',
+	          '####']
+	
+	FLOOR_1 = [ '####',
+	          '#  #',
+	          '#  #',
+	          '#  #',
+	          '####']
+	def setup
+		map = Map.new MAP_1
+		@lay_map = LayeredMap.new(map)
+	end
+	
+	def test_must_be_initialized_from_map_or_array_of_string
+		assert_raise(ArgumentError) do
+			@lay_map = LayeredMap.new('a string')
+		end
+	end
+	
+	def test_floor
+		assert_equal FLOOR_1, @lay_map.floor
+	end
+	
+	def test_man_position
+		man = @lay_map.man
+		assert_equal 1, man.x
+		assert_equal 3, man.y
+	end
+	
+	def test_storages_positions
+		store = Storage.new(1, 1)
+		assert_equal true, @lay_map.storages.include?(store)
+		
+		store = Storage.new(2, 1)
+		assert_equal true, @lay_map.storages.include?(store)
+	end
+	
+	def test_crates_position
+		crate = Crate.new(1, 2)
+		assert_equal true, @lay_map.crates.include?(crate)
+		
+		crate = Crate.new(2, 2)
+		assert_equal true, @lay_map.crates.include?(crate)
+	end
+	
+	def test_map_as_array
+		assert_equal MAP_1, @lay_map.map_as_array
+	end
+	
+	def test_expected_wall
+		assert_equal WALL, @lay_map.what_is_on(0, 0)
+	end
+	
+	def test_expected_floor
+		assert_equal FLOOR, @lay_map.what_is_on(2, 3)
+	end
+	
+	def test_expected_crate
+		assert_equal CRATE, @lay_map.what_is_on(1, 2)
+	end
+	
+	def test_expected_storage
+		assert_equal STORAGE, @lay_map.what_is_on(1, 1)
+	end
+	
+	def test_expected_crate_on_storage
+		lay_map = LayeredMap.new(Map.new(MAP_2))
+		assert_equal CRATE_ON_STORAGE, lay_map.what_is_on(1, 1)
+	end
+	
+	### BUGS #################################################
+	
+	MAP_BUG_9 = [
+	'####',
+	'#$+#',
+	'#  #',
+	'####']
+	
+	# Some levels crashes (like microban.xsb #101) because they contain man on storage in its map.
+	def test_bug_9_man_on_storage
+		map = Map.new MAP_BUG_9
+		lay_map = LayeredMap.new(map)
+		
+		man = lay_map.man
+		assert_equal 2, man.x
+		assert_equal 1, man.y
+		
+		assert_equal STORAGE, lay_map.what_is_on(2, 1)
+		
+		assert_equal CRATE, lay_map.what_is_on(1, 1)
+	end
+	
+end