flonkerton 0.0.1

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'protest'
+require 'rr'
+require File.dirname(__FILE__) + '/../lib/flonkerton'
+
+class Protest::TestCase
+  include RR::Adapters::TestUnit
+end
+
+Protest.report_with(:documentation)

data/test/unit_tests.rb

@@ -0,0 +1,386 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+Protest.describe('Flonkerton') do
+  it 'has a CONFIG hash.' do
+    config = { :width => 800,
+               :height => 600,
+               :caption => "Flonkerton Example",
+               :fullscreen => false,
+               :font_size => 20,
+               :initial_screen => "WelcomeScreen",
+               :media_path => "media",
+               :songs_ext => "*.ogg",
+               :images_ext => "*.png",
+               :samples_ext => "*.wav",
+               :tiles_ext => "*.png",
+               :fonts_ext => "*.ttf",
+               :image => { :x => 0,
+                           :y => 0,
+                           :z => 0,
+                           :factor_x => 1,
+                           :factor_y => 1,
+                           :color => 0xffffffff,
+                           :mode => :default,
+                           :order => [:x, :y, :z, :factor_x, :factor_y, :color, :mode] },
+               :font => { :text => "",
+                          :x => 0,
+                          :y => 0,
+                          :z => 0,
+                          :factor_x => 1,
+                          :factor_y => 1,
+                          :color => 0xffffffff,
+                          :mode => :default,
+                          :order => [:text, :x, :y, :z, :factor_x, :factor_y, :color, :mode] } }
+
+    assert_equal config, Flonkerton::CONFIG
+  end
+end
+
+Protest.describe('A Game Window') do
+  setup do
+    @window = Flonkerton::Window.new
+  end
+
+  it 'has a current screen. (default: WelcomeScreen)' do
+    assert_kind_of Flonkerton::WelcomeScreen, @window.screen
+  end
+
+  it 'has a next screen. (default: nil)' do
+    assert_nil @window.next_screen
+  end
+
+  it 'updates the current screen.' do
+    mock(@window.screen).update
+    @window.update
+  end
+
+  it 'draws the current screen.' do
+    mock(@window.screen).draw
+    @window.draw
+  end
+
+  it 'passes button_down events to the current screen.' do
+    mock(@window.screen).button_down(Gosu::KbA)
+    @window.button_down(Gosu::KbA)
+  end
+
+  it 'passes button_up events to the current screen.' do
+    mock(@window.screen).button_up(Gosu::KbA)
+    @window.button_up(Gosu::KbA)
+  end
+
+  context('when working with several screens') do
+    module Example
+      class LogoScreen < Flonkerton::Screen
+        def update
+          go_to(GameScreen)
+        end
+      end
+      class GameScreen < Flonkerton::Screen
+        def update
+          go_to(CreditsScreen)
+        end
+      end
+      class CreditsScreen < Flonkerton::Screen; end
+    end
+
+    it 'can switch between them.' do
+      @window = Flonkerton::Window.new(Example::LogoScreen)
+      assert_kind_of Example::LogoScreen, @window.screen
+      @window.update
+      assert_kind_of Example::GameScreen, @window.screen
+      @window.update
+      assert_kind_of Example::CreditsScreen, @window.screen
+    end
+  end
+
+  it 'has a params hash.' do
+    assert_equal Hash.new, @window.params
+  end
+end
+
+Protest.describe('A Screen') do
+  setup do
+    @game = Flonkerton::Window.new
+    @screen = Flonkerton::Screen.new(@game)
+  end
+
+  # Gosu::Window methods
+  #
+  it 'has a width.' do
+    assert_equal 800, @screen.width
+  end
+
+  it 'has a height.' do
+    assert_equal 600, @screen.height
+  end
+
+  it 'has mouse coordinates.' do
+    assert_kind_of Numeric, @screen.mouse_x
+    assert_kind_of Numeric, @screen.mouse_y
+  end
+
+  it 'closes itself when Escape is pressed.' do
+    mock(@screen).close
+    @screen.button_down(Gosu::KbEscape)
+  end
+
+  it 'knows if a button is down.' do
+    stub(@game).button_down?(Gosu::KbA) { true }
+    stub(@game).button_down?(Gosu::KbZ) { false }
+    assert @screen.button_down?(Gosu::KbA)
+    assert !@screen.button_down?(Gosu::KbZ)
+  end
+
+  # Empty methods to override.
+  #
+  it 'can setup before game loop.' do
+    assert_respond_to @screen, :setup
+  end
+
+  it 'check button_up events while in game loop.' do
+    assert_respond_to @screen, :button_up
+  end
+
+  it 'updates game logic while in game loop.' do
+    assert_respond_to @screen, :update
+  end
+
+  it 'draws while in game loop.' do
+    assert_respond_to @screen, :draw
+  end
+
+  it 'can switch to another screen.' do
+    module Example
+      class LogoScreen < Flonkerton::Screen
+        def update
+          go_to(GameScreen)
+        end
+      end
+      class GameScreen < Flonkerton::Screen
+        def update
+          close
+        end
+      end
+    end
+
+    @game = Flonkerton::Window.new(Example::LogoScreen)
+    mock(@game).next_screen=(Example::GameScreen)
+    @game.update
+  end
+
+  it 'shares a params hash with other screens.' do
+    module Example
+      class LogoScreen < Flonkerton::Screen
+        def setup
+          params[:foo] = 200
+        end
+        def update
+          go_to(GameScreen)
+        end
+      end
+      class GameScreen < Flonkerton::Screen
+        def setup
+          params[:bar] = 'abc' + params[:foo].to_s
+        end
+        def update
+          close
+        end
+      end
+    end
+
+    @game = Flonkerton::Window.new(Example::LogoScreen)
+    @game.update
+    assert_equal 200, @game.params[:foo]
+    assert_equal 'abc200', @game.params[:bar]
+  end
+
+  it 'can close itself.' do
+    mock(@game).close
+    @screen.close
+  end
+
+  it 'can clip an image.' do
+    mock(@game).clip_to(10, 20, 200, 300)
+    @screen.clip_to(10, 20, 200, 300)
+  end
+
+  it 'calls setup method after initialization.' do
+    module Example
+      class LogoScreen < Flonkerton::Screen
+        attr_reader :value
+        def setup
+          @value = 100
+        end
+      end
+    end
+    assert_equal 100, Example::LogoScreen.new(@game).value
+  end
+end
+
+Protest.describe('A WelcomeScreen') do
+  setup do
+    @game = Flonkerton::Window.new
+    @welcome_screen = Flonkerton::WelcomeScreen.new(@game)
+  end
+
+  it 'shows a brief explanation about Flonkerton.' do
+    mock(Flonkerton::Fonts[:default]).draw(:text => 'Welcome')
+    @welcome_screen.draw
+  end
+end
+
+Protest.describe('A Sample') do
+  setup do
+    @game = Flonkerton::Window.new
+    @sample = Flonkerton::Sample.new(@game, 'media/select.wav')
+  end
+
+  it 'is a Gosu::Sample.' do
+    assert_kind_of Gosu::Sample, @sample
+  end
+end
+
+Protest.describe('A Song') do
+  setup do
+    @game = Flonkerton::Window.new
+    @song = Flonkerton::Song.new(@game, 'media/catch_me_song.ogg')
+  end
+
+  it 'is a Gosu::Song.' do
+    assert_kind_of Gosu::Song, @song
+  end
+
+  it 'has a loop method.' do
+    mock(@song).play(true)
+    @song.loop
+  end
+end
+
+Protest.describe('A Font') do
+  setup do
+    @game = Flonkerton::Window.new
+    @font = Flonkerton::Font.new(@game, 'media/ArcadeClassic.ttf')
+  end
+
+  it 'is a Gosu::Font.' do
+    assert_kind_of Gosu::Font, @font
+  end
+
+  it 'has a draw method that takes an options hash.' do
+    assert_nothing_raised do
+      @font.draw :text => 'test', :color => Gosu::Color::RED
+    end
+  end
+end
+
+Protest.describe('An Image') do
+  setup do
+    @game = Flonkerton::Window.new
+    @image = Flonkerton::Image.new(@game, 'media/gosu_logo.png')
+  end
+
+  it 'is a Gosu::Image.' do
+    assert_kind_of Gosu::Image, @image
+  end
+
+  it 'has a draw method that takes an options hash.' do
+    assert_nothing_raised do
+      @image.draw :x => 20, :mode => :additive
+    end
+  end
+end
+
+Protest.describe('Resource') do
+  it 'returns the content hash' do
+    assert_equal Hash.new, Flonkerton::Resource.all
+  end
+end
+
+Protest.describe('Resource - Fonts') do
+  it 'has a :default font.' do
+    assert_kind_of Flonkerton::Font, Flonkerton::Fonts[:default]
+  end
+
+  it 'loads all fonts in CONFIG[:media_path].' do
+    path = File.join(Flonkerton::CONFIG[:media_path], Flonkerton::CONFIG[:fonts_ext])
+    files = Dir[path]
+    assert files.any?
+    fonts = [Flonkerton::Fonts[:default]]
+    files.each do |file|
+      fonts << Flonkerton::Fonts[File.label(file)]
+    end
+    assert_equal fonts.uniq.map {|x| x.class }, Array.new(files.size + 1, Flonkerton::Font)
+  end
+end
+
+Protest.describe('Resource - Images') do
+  it 'loads all images in CONFIG[:media_path].' do
+    path = File.join(Flonkerton::CONFIG[:media_path], Flonkerton::CONFIG[:images_ext])
+    files = Dir[path]
+    assert files.any?
+    images = []
+    files.each do |file|
+      images << Flonkerton::Images[File.label(file)]
+    end
+    assert_equal images.uniq.map {|x| x.class }, Array.new(files.size, Flonkerton::Image)
+  end
+end
+
+Protest.describe('Resource - Songs') do
+  it 'loads all songs in CONFIG[:media_path].' do
+    path = File.join(Flonkerton::CONFIG[:media_path], Flonkerton::CONFIG[:songs_ext])
+    files = Dir[path]
+    assert files.any?
+    songs = []
+    files.each do |file|
+      songs << Flonkerton::Songs[File.label(file)]
+    end
+    assert_equal songs.uniq.map {|x| x.class }, Array.new(files.size, Flonkerton::Song)
+  end
+end
+
+Protest.describe('Resource - Samples') do
+  it 'loads all samples in CONFIG[:media_path].' do
+    path = File.join(Flonkerton::CONFIG[:media_path], Flonkerton::CONFIG[:samples_ext])
+    files = Dir[path]
+    assert files.any?
+    samples = []
+    files.each do |file|
+      samples << Flonkerton::Samples[File.label(file)]
+    end
+    assert_equal samples.uniq.map {|x| x.class }, Array.new(files.size, Flonkerton::Sample)
+  end
+end
+
+Protest.describe('Resource - Tiles') do
+  it 'loads all images in CONFIG[:media_path] that looks like a tileset. (eg. woods_64x64.png)' do
+    path = File.join(Flonkerton::CONFIG[:media_path], Flonkerton::CONFIG[:tiles_ext])
+    files = Dir[path]
+    assert files.any?
+    tiles = []
+    files.each do |file|
+      if File.basename(file) =~ /(\w+)_(\d+)x(\d+)/
+        tiles << Flonkerton::Tiles[$1.intern]
+      end
+    end
+    assert_equal tiles.uniq.map {|x| x.class }, Array.new(tiles.size, Array)
+
+    # returns Gosu::Image
+    image = tiles.first.first
+    assert_kind_of Gosu::Image, image
+
+    # ..but draw takes a hash, same as Flonkerton::Image
+    assert_nothing_raised do
+      image.draw :x => 20, :mode => :additive
+    end
+  end
+end
+
+Protest.describe('File') do
+  context('.label') do
+    it 'returns a symbol for an specific file' do
+      assert_equal :gosu_logo, File.label('media/gosu_logo.png')
+    end
+  end
+end

data/watchmen.rb

@@ -0,0 +1,7 @@
+default_action { system("ruby test/unit_tests.rb") }
+#default_action { system("ruby test/integration_test.rb") }
+
+watch( 'lib/flonkerton.rb' )
+watch( 'test/unit_tests.rb' )
+watch( 'test/integration_test.rb' )
+watch( 'config/defaults.yml' )

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: flonkerton
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ariel H. Pillet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gosu
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 0
+        - 7
+        - 19
+        version: 0.7.19
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: protest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 0
+        - 10
+        - 11
+        version: 0.10.11
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id004
+description: A simple framework that aims to improve your Gosu experience.
+email: 
+- apillet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- TODO
+- README.md
+- media/CREDITS
+- Rakefile
+- watchmen.rb
+- config/defaults.yml
+- examples/clip.rb
+- examples/config/defaults.yml
+- examples/extras/actor.rb
+- examples/extras/fill.rb
+- examples/extras/input_handler.rb
+- examples/extras/mouse_border.rb
+- examples/extras/random_color.rb
+- examples/extras/scrollable.rb
+- examples/font.rb
+- examples/input.rb
+- examples/screen.rb
+- examples/scroll.rb
+- examples/sound.rb
+- examples/tiles.rb
+- games/gosu_demo/config/defaults.yml
+- games/gosu_demo/media/beep.wav
+- games/gosu_demo/media/Space.png
+- games/gosu_demo/media/star_25x25.png
+- games/gosu_demo/media/starfighter.png
+- games/gosu_demo/original.rb
+- games/gosu_demo/play.rb
+- lib/flonkerton.rb
+- flonkerton.gemspec
+- media/ArcadeClassic.ttf
+- media/background.png
+- media/catch_me_song.ogg
+- media/cursor.png
+- media/gosu_logo.png
+- media/select.wav
+- media/tiles_32x32.png
+- test/integration_test.rb
+- test/test_helper.rb
+- test/unit_tests.rb
+has_rdoc: true
+homepage: http://github.com/apillet/flonkerton
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: flonkerton
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Gosu toys for the bored rubyist.
+test_files: []
+