gosu-keyboard 0.1.7

data/.gitignore

@@ -0,0 +1,4 @@
+/pkg
+.rvmrc
+.DS_Store
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,165 @@
+# Gosu-Keyboard
+
+A DSL for easily handling keyboard events within a `Gosu::Window`.
+
+## Install
+
+### Bundler
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'gosu'
+gem 'gosu-keyboard', require: 'gosu/keyboard'
+```
+
+### RubyGems
+
+Install with:
+
+```sh
+$ gem install gosu-keyboard
+```
+
+and `require` with:
+
+```ruby
+require 'gosu/keyboard'
+```
+
+## Usage
+
+### Sample usage within a `Gosu::Window`
+
+`my_game/lib/keyboard_helpers.rb`
+
+```ruby
+module MyGame
+  module KeyboardHelpers
+    def left
+      super || a
+    end
+    
+    def right
+      super || d
+    end
+    
+    def direction
+      left || right
+    end
+    
+    def walk
+      direction && !shift && !control
+    end
+    
+    def run
+      direction && shift && !control
+    end
+    
+    def crouch
+      alt
+    end
+  end
+end
+
+Gosu::Keyboard.register(MyGame::KeyboardHelpers)
+```
+
+`my_game/lib/player.rb`
+
+```ruby
+module MyGame
+  class Player
+    attr_accessor :state, :direction
+    
+    def initialize
+      @state, @direction = :standing, :right
+    end
+  end
+end
+```
+
+`my_game/lib/game_window.rb`
+
+```ruby
+module MyGame
+  class GameWindow < Gosu::Window
+    
+    def initialize
+      super(Gosu::screen_width, Gosu::screen_height, false)
+        
+      self.caption = "Gosu::Keyboard Test"
+        
+      @font = Gosu::Font.new(self, Gosu::default_font_name, 40)
+      
+      @player = Player.new
+    end
+      
+    def update
+      @player.state = :standing
+      
+      Gosu::Keyboard.handle_keys(self) do
+        down?(escape) { close }
+        down?(left)   { @player.direction = :left }
+        down?(right)  { @player.direction = :right }
+        down?(walk)   { @player.state = :walking }
+        down?(run)    { @player.state = :running }
+        down?(crouch) { @player.state = :crouching }
+      end
+    end
+      
+    def draw
+      @font.draw "Player State: #{@player.state}", 0, 0, 0, 1, 1, Gosu::Color::BLUE
+      @font.draw "Player Direction: #{@player.direction}", 0, 30, 0, 1, 1, Gosu::Color::BLUE
+      @font.draw "Left, A - Change direction of player to 'left' and state to 'walk'", 0, 90, 0, 1, 1, Gosu::Color::RED
+      @font.draw "Right, B - Change direction of player to 'right' and state to 'walk'", 0, 120, 0, 1, 1, Gosu::Color::RED
+      @font.draw "Shift - Change state of player to 'running'", 0, 150, 0, 1, 1, Gosu::Color::RED
+      @font.draw "Alt - Change state of player to 'crouching'", 0, 180, 0, 1, 1, Gosu::Color::RED
+    end
+    
+    # Always show the system mouse cursor, for aesthetic 
+    # reasons. Has nothing to do with example.
+    def needs_cursor?
+      true
+    end
+    
+  end
+end
+```
+
+`my_game/lib/my_game`
+
+```ruby
+require 'pathname'
+
+require 'bundler/setup'
+Bundler.require(:default)
+
+require 'gosu'
+require 'gosu/keyboard'
+
+__LIB__ ||= Pathname.new(__FILE__).join('..', '..', 'lib').expand_path
+$:.unshift(__LIB__.to_s) unless $:.include?(__LIB__.to_s)
+
+require 'my_game/keyboard_helpers'
+require 'my_game/player'
+require 'my_game/game_window'
+```
+
+`my_game/bin/my_game`
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+__LIB__ = Pathname.new(__FILE__).join('..', '..', 'lib').expand_path
+
+$:.unshift(__LIB__.to_s) unless $:.include?(__LIB__.to_s)
+
+require 'my_game'
+
+window = MyGame::GameWindow.new
+window.show
+```
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake/version_task'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+require 'pathname'
+
+spec = Gem::Specification.new do |s|
+  s.name         = 'gosu-keyboard'
+  s.version      = Pathname.new(__FILE__).dirname.join('VERSION').read.strip
+  s.author       = 'Ryan Scott Lewis'
+  s.email        = 'ryan@rynet.us'
+  s.homepage     = "http://github.com/c00lryguy/#{s.name}"
+  s.summary      = "A nice DSL for handling a Gosu::Window's keyboard events"
+  s.description  = "A DSL for easily defining keyboard events for a Gosu::Window"
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.lines.to_a.collect { |s| s.strip }
+  s.executables  = `git ls-files -- bin/*`.lines.to_a.collect { |s| File.basename(s.strip) }
+  
+  s.add_dependency 'version', '~> 1.0.0'
+  s.add_dependency 'active_support', '~> 3'
+  s.add_dependency 'gosu', '~> 0.7.45'
+  s.add_development_dependency 'rake', '~> 0.9'
+  # s.add_development_dependency 'guard-rspec', '~> 2.1.1'
+  # s.add_development_dependency 'fuubar', '~> 1.1'
+  # s.add_development_dependency 'at', '~> 0.1.2'
+end
+
+Rake::VersionTask.new do |t|
+  t.with_git_tag = true
+  t.with_gemspec = spec
+end
+
+RSpec::Core::RakeTask.new
+
+Gem::PackageTask.new(spec) do |t|
+  t.need_zip = false
+  t.need_tar = false
+end
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.7

data/examples/simple.rb

@@ -0,0 +1,93 @@
+require 'pathname'
+
+__LIB__ ||= Pathname.new(__FILE__).join('..', '..', 'lib').expand_path
+$:.unshift(__LIB__.to_s) unless $:.include?(__LIB__.to_s)
+
+require 'gosu'
+require 'gosu/keyboard'
+
+module Simple
+  module KeyboardHelpers
+    def left
+      super || a
+    end
+    
+    def right
+      super || d
+    end
+    
+    def direction
+      left || right
+    end
+    
+    def walk
+      direction && !shift && !control
+    end
+    
+    def run
+      direction && shift && !control
+    end
+    
+    def crouch
+      alt
+    end
+  end
+end
+
+Gosu::Keyboard.register(Simple::KeyboardHelpers)
+
+module Simple
+  class Player
+    attr_accessor :state, :direction
+    
+    def initialize
+      @state, @direction = :standing, :right
+    end
+  end
+end
+
+module Simple
+  class GameWindow < Gosu::Window
+    
+    def initialize
+      super(Gosu::screen_width, Gosu::screen_height, false)
+        
+      self.caption = "Gosu::Keyboard Test"
+        
+      @font = Gosu::Font.new(self, Gosu::default_font_name, 40)
+      
+      @player = Player.new
+    end
+      
+    def update
+      @player.state = :standing
+      
+      Gosu::Keyboard.handle_keys(self) do
+        down?(escape) { close }
+        down?(left)   { @player.direction = :left }
+        down?(right)  { @player.direction = :right }
+        down?(walk)   { @player.state = :walking }
+        down?(run)    { @player.state = :running }
+        down?(crouch) { @player.state = :crouching }
+      end
+    end
+      
+    def draw
+      @font.draw "Player State: #{@player.state}", 0, 0, 0, 1, 1, Gosu::Color::BLUE
+      @font.draw "Player Direction: #{@player.direction}", 0, 30, 0, 1, 1, Gosu::Color::BLUE
+      @font.draw "Left, A - Change direction of player to 'left' and state to 'walk'", 0, 90, 0, 1, 1, Gosu::Color::RED
+      @font.draw "Right, B - Change direction of player to 'right' and state to 'walk'", 0, 120, 0, 1, 1, Gosu::Color::RED
+      @font.draw "Shift - Change state of player to 'running'", 0, 150, 0, 1, 1, Gosu::Color::RED
+      @font.draw "Alt - Change state of player to 'crouching'", 0, 180, 0, 1, 1, Gosu::Color::RED
+    end
+    
+    # Always show the system mouse cursor, for aesthetic reasons..
+    def needs_cursor?
+      true
+    end
+    
+  end
+end
+
+window = Simple::GameWindow.new
+window.show

data/gosu-keyboard.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "gosu-keyboard"
+  s.version = "0.1.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Scott Lewis"]
+  s.date = "2012-11-13"
+  s.description = "A DSL for easily defining keyboard events for a Gosu::Window"
+  s.email = "ryan@rynet.us"
+  s.files = [".gitignore", "Gemfile", "README.md", "Rakefile", "VERSION", "examples/simple.rb", "gosu-keyboard.gemspec", "lib/gosu/keyboard.rb", "lib/gosu/keyboard/dsl.rb", "lib/gosu/keyboard/dsl/helpers.rb"]
+  s.homepage = "http://github.com/c00lryguy/gosu-keyboard"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A nice DSL for handling a Gosu::Window's keyboard events"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<version>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<active_support>, ["~> 3"])
+      s.add_runtime_dependency(%q<gosu>, ["~> 0.7.45"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9"])
+    else
+      s.add_dependency(%q<version>, ["~> 1.0.0"])
+      s.add_dependency(%q<active_support>, ["~> 3"])
+      s.add_dependency(%q<gosu>, ["~> 0.7.45"])
+      s.add_dependency(%q<rake>, ["~> 0.9"])
+    end
+  else
+    s.add_dependency(%q<version>, ["~> 1.0.0"])
+    s.add_dependency(%q<active_support>, ["~> 3"])
+    s.add_dependency(%q<gosu>, ["~> 0.7.45"])
+    s.add_dependency(%q<rake>, ["~> 0.9"])
+  end
+end

data/lib/gosu/keyboard.rb

@@ -0,0 +1,55 @@
+require 'forwardable'
+require 'pathname'
+
+require 'bundler/setup'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/hash_with_indifferent_access'
+require 'gosu'
+
+__LIB__ = Pathname.new(__FILE__).join('..', '..').expand_path
+$:.unshift(__LIB__.to_s) unless $:.include?(__LIB__.to_s)
+
+require 'gosu/keyboard/dsl'
+require 'gosu/keyboard/dsl/helpers'
+
+module Gosu
+  module Keyboard
+    
+    class << self
+      
+      def keys
+        @keys ||= Gosu.constants.collect(&:to_s).grep(/^Kb/).each_with_object({}) do |constant_name, memo|
+          constant = Gosu.const_get(constant_name)
+          key_name = constant_name.gsub(/^Kb/, '').underscore.gsub(/numpad(\d)/, 'numpad_\1')
+          
+          key_name = case key_name
+            when '0' then :zero
+            when '1' then :one
+            when '2' then :two
+            when '3' then :three
+            when '4' then :four
+            when '5' then :five
+            when '6' then :six
+            when '7' then :seven
+            when '8' then :eight
+            when '9' then :nine
+            else
+              key_name.to_sym
+          end
+          
+          memo[key_name] = constant
+        end
+      end
+      
+      def handle_keys(window, &blk)
+        DSL.new(window, &blk)
+      end
+      
+      def register(mod)
+        DSL.send(:include, mod)
+      end
+      
+    end
+    
+  end
+end

data/lib/gosu/keyboard/dsl.rb

@@ -0,0 +1,25 @@
+module Gosu
+  module Keyboard
+    class NoKeyError < NoMethodError; end
+    
+    class DSL
+      
+      def initialize(window, &blk)
+        @window = window
+        
+        instance_eval(&blk)
+      end
+      
+      def method_missing(key_name, &blk)
+        raise NoKeyError unless Keyboard.keys.has_key?(key_name)
+        
+        @window.button_down?( Keyboard.keys[key_name] )
+      end
+      
+      def down?(condition, &blk)
+        @window.instance_eval(&blk) if condition
+      end
+      
+    end
+  end
+end

data/lib/gosu/keyboard/dsl/helpers.rb

@@ -0,0 +1,25 @@
+module Gosu
+  module Keyboard
+    class DSL
+      
+      module Helpers
+        
+        def shift
+          left_shift || right_shift
+        end
+        
+        def alt
+          left_alt || right_alt
+        end
+        
+        def control
+          left_control || right_control
+        end
+        
+      end
+      
+      include Helpers
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: gosu-keyboard
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: gosu
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.45
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.45
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A DSL for easily defining keyboard events for a Gosu::Window
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- examples/simple.rb
+- gosu-keyboard.gemspec
+- lib/gosu/keyboard.rb
+- lib/gosu/keyboard/dsl.rb
+- lib/gosu/keyboard/dsl/helpers.rb
+homepage: http://github.com/c00lryguy/gosu-keyboard
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3963561981835123036
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A nice DSL for handling a Gosu::Window's keyboard events
+test_files: []