slickr 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODRmY2E3NWEwZjg0YTc1Y2QwZDlkYTExZGNmMWZlMmQxMDEyMjJkNg==
+  data.tar.gz: !binary |-
+    ZjVmZWI5MTU5ZWNhOGRmZTNmM2NlYjNlNWE4MjViNjkyMDNiZTZhYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGRkMzg4NGE3MTE1OTkyNzk1MDkxMDk5MjViNTdiYzU5ODliMDUyYTZhMDk4
+    YTVmMWNkNTgxZjlhOWQ3NDAyYzIwYWJkMjJmYWI0ODlmMzM2ZmU4NmJiYTI5
+    YjZjYjQ5NWNjM2RmZWM4ZTZiMjY0ZjY1MTllNGFiZTI1MjRlNTI=
+  data.tar.gz: !binary |-
+    YzQ4MWI3YTE3YzZkZmJjMzMwOTY4NzFkMzUyMzk5Zjg4NmVkNDQ1MDRlNzg2
+    OTc2OWE4NWVjODg1MWZkOTJmMmE2MDg0NmFhMzRhMWYwZTkzZDdkNzM2MWNk
+    NWFmMGY0YzFiYmY5Y2ZhYjU4M2UxZmViY2YzMDY4OTIzZTUyODM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+-d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slickj.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matte Noble
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# slickr
+
+JRuby Slick2D project generators.
+
+## Overview
+
+The project Slickr sets up is an attempt to merge concepts from
+Entity-Component and just plain old OOP best practices. Ruby gives you 
+a lot of power to write great code and Slickr tries to set you up to do 
+that well.
+
+Keep things simple. Components should have no knowledge of the Entities
+that will implement them; Systems should not care about what type of
+Entity they're acting on. Basically, watch or read anything Sandi Metz
+says and follow it.
+
+## Project Structure
+
+    ├── Rakefile
+    ├── assets/
+    ├── java/
+    │   ├── jinput.jar
+    │   ├── lwjgl.jar
+    │   └── slick.jar
+    ├── lib
+    │   ├── components
+    │   ├── components.rb
+    │   ├── engine.rb
+    │   ├── entities
+    │   ├── entities.rb
+    │   ├── renderers
+    │   ├── renderers.rb
+    │   ├── systems
+    │   └── systems.rb
+    ├── libjinput-osx.jnilib
+    ├── liblwjgl.jnilib
+    └── openal.dylib
+
+### assets
+
+Images, sounds, videos, etc.
+
+### java
+
+Slick2D framework jars.
+
+### lib
+
+Your game code.
+
+### lib/components
+
+Behaviors that entities will include. These are modules that implement
+whatever behavior the entity should have. A common example will be a
+`Spatial` component that implements `x` and `y` position and movement.
+
+### lib/entities
+
+The actual objects that live your game's world. Entities will implement
+Components and Systems conduct Entities. These will be your Heros,
+Enemies, Bosses, etc.
+
+### lib/renderers
+
+Draws the current state of entities to the screen.
+
+### lib/systems
+
+Systems react to changes in the world and update entitites accordingly.
+View these as controllers of sorts. A good example of this is an `Input`
+system. It would react to keyboard events and tell the appropriate
+entities where to move.
+
+## Installation
+
+    $ gem install slickr
+
+## Usage
+
+    $ slickr new PROJECT_NAME
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/slickr

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "slickr"
+Slickr::CLI.start

data/files/Rakefile

@@ -0,0 +1,2 @@
+require "slickr/tasks"
+Slickr::Tasks.all

data/lib/slickr.rb

@@ -0,0 +1,7 @@
+require "fileutils"
+require "pathname"
+require "thor"
+require "active_support/all"
+require "slickr/version"
+require "slickr/cli"
+require "slickr/actions/create"

data/lib/slickr/actions/create.rb

@@ -0,0 +1,79 @@
+module Slickr
+  module Actions
+    class Create
+      def initialize(name)
+        @name = name
+      end
+
+      def start
+        empty_directory "java"
+        empty_directory "assets"
+        empty_directory "lib"
+        empty_directory "lib", "renderers"
+        empty_directory "lib", "components"
+        empty_directory "lib", "systems"
+        empty_directory "lib", "entities"
+
+        copy_file "jinput.jar", "java"
+        copy_file "lwjgl.jar",  "java"
+        copy_file "slick.jar",  "java"
+
+        copy_file "libjinput-osx.jnilib"
+        copy_file "liblwjgl.jnilib"
+        copy_file "openal.dylib"
+
+        copy_file "Rakefile"
+
+        template "engine.erb",     "engine.rb"
+        template "components.erb", "components.rb"
+        template "renderers.erb",  "renderers.rb"
+        template "systems.erb",    "systems.rb"
+        template "entities.erb",   "entities.rb"
+      end
+
+      def empty_directory(*path)
+        project_directory.join(*path).mkpath
+      end
+
+      def copy_file(filename, destination="")
+        FileUtils.cp(root.join("files", filename), project_directory.join(destination, filename))
+      end
+
+      def template(filename, destination)
+        file = lib_file(destination)
+        file.write(render(template_source(filename)))
+        file.close
+      end
+
+      protected
+
+      def lib_file(filename)
+        project_directory.join("lib", filename).open("w+")
+      end
+
+      def render(source)
+        ERB.new(source).result(binding)
+      end
+
+      def template_source(filename)
+        root.join("templates", filename).read
+      end
+
+      def module_name
+        name.gsub(" ", "_").camelize
+      end
+
+      def name
+        @name
+      end
+
+      def project_directory
+        @project_directory ||= Pathname.new(name)
+      end
+
+      def root
+        @root ||= Pathname.new(__FILE__).join("../../../../").expand_path
+      end
+    end
+  end
+end

data/lib/slickr/cli.rb

@@ -0,0 +1,9 @@
+module Slickr
+  class CLI < Thor
+    desc "new NAME", "Create a new jruby slick2d project"
+    method_options :name => :string
+    def new(name)
+      Actions::Create.new(name).start
+    end
+  end
+end

data/lib/slickr/tasks.rb

@@ -0,0 +1,12 @@
+module Slickr
+  class Tasks
+    extend Rake::DSL if defined? Rake::DSL
+
+    def self.all
+      desc "Play the game"
+      task :play do
+        sh "ruby -I./lib lib/engine.rb"
+      end
+    end
+  end
+end

data/lib/slickr/version.rb

@@ -0,0 +1,3 @@
+module Slickr
+  VERSION = "0.0.1"
+end

data/slickr.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slickr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slickr"
+  spec.version       = Slickr::VERSION
+  spec.authors       = ["Matte Noble"]
+  spec.email         = ["me@mattenoble.com"]
+  spec.description   = %q{Slick2D JRuby project generator}
+  spec.summary       = %q{Slick2D JRuby project generator}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "i18n"
+  spec.add_dependency "active_support"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakefs"
+end

data/spec/slickj/actions/create_spec.rb

@@ -0,0 +1,174 @@
+require "spec_helper"
+
+describe Slickr::Actions::Create do
+  let!(:action)  { described_class.new("A Game") }
+  let!(:rootdir) { Pathname.new(__FILE__).join("../../../../").expand_path }
+  let!(:gamedir) { Pathname.new("A Game") }
+
+  before do
+    # Need the actual template contents so we can compare the rendered output
+    engine     = rootdir.join("templates", "engine.erb").read
+    renderers  = rootdir.join("templates", "renderers.erb").read
+    components = rootdir.join("templates", "components.erb").read
+    systems    = rootdir.join("templates", "systems.erb").read
+
+    FakeFS.activate!
+
+    rootdir.mkpath
+    rootdir.join("files").mkpath
+
+    # The contents of these don't matter, so just make empty files
+    FileUtils.touch(rootdir.join("files", "Rakefile"))
+    FileUtils.touch(rootdir.join("files", "jinput.jar"))
+    FileUtils.touch(rootdir.join("files", "lwjgl.jar"))
+    FileUtils.touch(rootdir.join("files", "slick.jar"))
+    FileUtils.touch(rootdir.join("files", "libjinput-osx.jnilib"))
+    FileUtils.touch(rootdir.join("files", "liblwjgl.jnilib"))
+    FileUtils.touch(rootdir.join("files", "openal.dylib"))
+
+    # Write templates to FakeFS
+    rootdir.join("templates").mkpath
+    rootdir.join("templates", "engine.erb").open("w+") { |f| f << engine }
+    rootdir.join("templates", "components.erb").open("w+") { |f| f << components }
+    rootdir.join("templates", "renderers.erb").open("w+") { |f| f << renderers }
+    rootdir.join("templates", "systems.erb").open("w+") { |f| f << systems }
+
+    # Finally
+    action.start
+  end
+
+  after do
+    FakeFS.deactivate!
+  end
+
+  it "creates the project directory" do
+    gamedir.should be_directory
+  end
+
+  it "creates a java directory" do
+    gamedir.join("java").should be_directory
+  end
+
+  it "creates a lib directory" do
+    gamedir.join("lib").should be_directory
+  end
+
+  it "creates a lib/renderers directory" do
+    gamedir.join("lib", "renderers").should be_directory
+  end
+
+  it "creates a lib/components directory" do
+    gamedir.join("lib", "components").should be_directory
+  end
+
+  it "creates a lib/systems directory" do
+    gamedir.join("lib", "systems").should be_directory
+  end
+
+  it "creates a lib/entities directory" do
+    gamedir.join("lib", "entities").should be_directory
+  end
+
+  it "creates an assets directory" do
+    gamedir.join("assets").should be_directory
+  end
+
+  it "copies jinput.jar into the java directory" do
+    gamedir.join("java", "jinput.jar").should exist
+  end
+
+  it "copies lwjgl.jar into the java directory" do
+    gamedir.join("java", "lwjgl.jar").should exist
+  end
+
+  it "copies slick.jar into the java directory" do
+    gamedir.join("java", "slick.jar").should exist
+  end
+
+  it "copies libjinput-osx.jnilib into the project directory" do
+    gamedir.join("libjinput-osx.jnilib").should exist
+  end
+
+  it "copies liblwjgl.jnilib into the project directory" do
+    gamedir.join("liblwjgl.jnilib").should exist
+  end
+
+  it "copies openal.dylib into the project directory" do
+    gamedir.join("openal.dylib").should exist
+  end
+
+  it "creates the engine file skeleton" do
+    File.read(gamedir.join("lib", "engine.rb")).should == <<-CODE
+$LOAD_PATH << File.expand_path("../../java", __FILE__)
+require "java"
+require "lwjgl.jar"
+require "slick.jar"
+
+java_import org.newdawn.slick.AppGameContainer
+java_import org.newdawn.slick.BasicGame
+java_import org.newdawn.slick.Color
+java_import org.newdawn.slick.GameContainer
+java_import org.newdawn.slick.Graphics
+java_import org.newdawn.slick.Image
+java_import org.newdawn.slick.Input
+
+module AGame
+  class Engine < BasicGame
+    def init(container)
+    end
+
+    def update(container, delta)
+    end
+
+    def render(container, graphics)
+    end
+  end
+end
+
+game = AppGameContainer.new(AGame::Engine.new("A Game"))
+game.set_display_mode(800, 600, false)
+game.start
+
+    CODE
+  end
+
+  it "creates the components file" do
+    File.read(gamedir.join("lib", "components.rb")).should == <<-CODE
+module AGame
+  module Components
+  end
+end
+
+    CODE
+  end
+
+  it "creates the renderers file" do
+    File.read(gamedir.join("lib", "renderers.rb")).should == <<-CODE
+module AGame
+  module Renderers
+  end
+end
+
+    CODE
+  end
+
+  it "creates the systems file" do
+    File.read(gamedir.join("lib", "systems.rb")).should == <<-CODE
+module AGame
+  module Systems
+  end
+end
+
+    CODE
+  end
+
+  it "creates the systems file" do
+    File.read(gamedir.join("lib", "entities.rb")).should == <<-CODE
+module AGame
+  module Entities
+  end
+end
+
+    CODE
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$: << File.expand_path("../../lib", __FILE__)
+require "rspec"
+require "slickr"
+require "fakefs/safe"
+require "fakefs/spec_helpers"
+
+RSpec.configure do |c|
+  c.include FakeFS::SpecHelpers
+end

data/templates/components.erb

@@ -0,0 +1,5 @@
+module <%= module_name %>
+  module Components
+  end
+end
+

data/templates/engine.erb

@@ -0,0 +1,30 @@
+$LOAD_PATH << File.expand_path("../../java", __FILE__)
+require "java"
+require "lwjgl.jar"
+require "slick.jar"
+
+java_import org.newdawn.slick.AppGameContainer
+java_import org.newdawn.slick.BasicGame
+java_import org.newdawn.slick.Color
+java_import org.newdawn.slick.GameContainer
+java_import org.newdawn.slick.Graphics
+java_import org.newdawn.slick.Image
+java_import org.newdawn.slick.Input
+
+module <%= module_name %>
+  class Engine < BasicGame
+    def init(container)
+    end
+
+    def update(container, delta)
+    end
+
+    def render(container, graphics)
+    end
+  end
+end
+
+game = AppGameContainer.new(<%= module_name %>::Engine.new("<%= name %>"))
+game.set_display_mode(800, 600, false)
+game.start
+

data/templates/entities.erb

@@ -0,0 +1,5 @@
+module <%= module_name %>
+  module Entities
+  end
+end
+

data/templates/renderers.erb

@@ -0,0 +1,5 @@
+module <%= module_name %>
+  module Renderers
+  end
+end
+

data/templates/systems.erb

@@ -0,0 +1,5 @@
+module <%= module_name %>
+  module Systems
+  end
+end
+

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: slickr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matte Noble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Slick2D JRuby project generator
+email:
+- me@mattenoble.com
+executables:
+- slickr
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/slickr
+- files/Rakefile
+- files/jinput.jar
+- files/libjinput-osx.jnilib
+- files/liblwjgl.jnilib
+- files/lwjgl.jar
+- files/openal.dylib
+- files/slick.jar
+- lib/slickr.rb
+- lib/slickr/actions/create.rb
+- lib/slickr/cli.rb
+- lib/slickr/tasks.rb
+- lib/slickr/version.rb
+- slickr.gemspec
+- spec/slickj/actions/create_spec.rb
+- spec/spec_helper.rb
+- templates/components.erb
+- templates/engine.erb
+- templates/entities.erb
+- templates/renderers.erb
+- templates/systems.erb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Slick2D JRuby project generator
+test_files:
+- spec/slickj/actions/create_spec.rb
+- spec/spec_helper.rb