shattered_ruby 0.5.0.2

data/lib/rails_generator/scripts.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/options'
+
+module Rails
+  module Generator
+    module Scripts
+
+      # Generator scripts handle command-line invocation.  Each script
+      # responds to an invoke! class method which handles option parsing
+      # and generator invocation.
+      class Base
+        include Options
+        default_options :collision => :ask, :quiet => false
+
+        # Run the generator script.  Takes an array of unparsed arguments
+        # and a hash of parsed arguments, takes the generator as an option
+        # or first remaining argument, and invokes the requested command.
+        def run(args = [], runtime_options = {})
+          begin
+            parse!(args.dup, runtime_options)
+          rescue OptionParser::InvalidOption => e
+            # Don't cry, script. Generators want what you think is invalid.
+          end
+
+          # Generator name is the only required option.
+          unless options[:generator]
+            usage if args.empty?
+            options[:generator] ||= args.shift
+          end
+
+          # Look up generator instance and invoke command on it.
+          Rails::Generator::Base.instance(options[:generator], args, options).command(options[:command]).invoke!
+        rescue => e
+          puts e
+          puts "  #{e.backtrace.join("\n  ")}\n" if options[:backtrace]
+          raise SystemExit
+        end
+
+        protected
+          # Override with your own script usage banner.
+          def banner
+            "Usage: #{$0} generator [options] [args]"
+          end
+
+          def usage_message
+            usage = "\nInstalled Generators\n"
+            Rails::Generator::Base.sources.each do |source|
+              label = source.label.to_s.capitalize
+              names = source.names
+              usage << "  #{label}: #{names.join(', ')}\n" unless names.empty?
+            end
+
+            usage << <<end_blurb
+
+More are available at http://rubyonrails.org/show/Generators
+  1. Download, for example, login_generator.zip
+  2. Unzip to directory #{Dir.user_home}/.rails/generators/login
+     to use the generator with all your Rails apps
+end_blurb
+
+            if Object.const_defined?(:SHATTERED_ROOT)
+              usage << <<end_blurb
+     or to #{File.expand_path(SHATTERED_ROOT)}/generators/login
+     to use with this app only.
+end_blurb
+            end
+
+            usage << <<end_blurb
+  3. Run generate with no arguments for usage information
+       #{$0} login
+
+Generator gems are also available:
+  1. gem search -r generator
+  2. gem install login_generator
+  3. #{$0} login
+
+end_blurb
+            return usage
+          end
+      end # Base
+
+    end
+  end
+end

data/lib/rails_generator/simple_logger.rb

@@ -0,0 +1,46 @@
+module Rails
+  module Generator
+    class SimpleLogger # :nodoc:
+      attr_reader :out
+      attr_accessor :quiet
+
+      def initialize(out = $stdout)
+        @out = out
+        @quiet = false
+        @level = 0
+      end
+
+      def log(status, message, &block)
+        @out.print("%12s  %s%s\n" % [status, '  ' * @level, message]) unless quiet
+        indent(&block) if block_given?
+      end
+
+      def indent(&block)
+        @level += 1
+        if block_given?
+          begin
+            block.call
+          ensure
+            outdent
+          end
+        end
+      end
+
+      def outdent
+        @level -= 1
+        if block_given?
+          begin
+            block.call
+          ensure
+            indent
+          end
+        end
+      end
+
+      private
+        def method_missing(method, *args, &block)
+          log(method.to_s, args.first, &block)
+        end
+    end
+  end
+end

data/lib/rails_generator/spec.rb

@@ -0,0 +1,44 @@
+module Rails
+  module Generator
+    # A spec knows where a generator was found and how to instantiate it.
+    # Metadata include the generator's name, its base path, and the source
+    # which yielded it (PathSource, GemSource, etc.)
+    class Spec
+      attr_reader :name, :path, :source
+
+      def initialize(name, path, source)
+        @name, @path, @source = name, path, source
+      end
+
+      # Look up the generator class.  Require its class file, find the class
+      # in ObjectSpace, tag it with this spec, and return.
+      def klass
+        unless @klass
+          require class_file
+          @klass = lookup_class
+          @klass.spec = self
+        end
+        @klass
+      end
+
+      def class_file
+        "#{path}/#{name}_generator.rb"
+      end
+
+      def class_name
+        "#{name.camelize}Generator"
+      end
+
+      private
+        # Search for the first Class descending from Rails::Generator::Base
+        # whose name matches the requested class name.
+        def lookup_class
+          ObjectSpace.each_object(Class) do |obj|
+            return obj if obj.ancestors.include?(Rails::Generator::Base) and
+                          obj.name.split('::').last == class_name
+          end
+          raise NameError, "Missing #{class_name} class in #{class_file}"
+        end
+    end
+  end
+end

data/lib/rails_generator.rb

@@ -0,0 +1,43 @@
+#--
+# Copyright (c) 2004 Jeremy Kemper
+#
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.dirname(__FILE__) + "/../../shattered_support/lib")
+
+begin
+  require 'shattered_support'  
+rescue LoadError
+  require 'rubygems'
+  require_gem 'shattered_support'
+end
+
+require 'rails_generator/base'
+require 'rails_generator/lookup'
+require 'rails_generator/commands'
+
+Rails::Generator::Base.send(:include, Rails::Generator::Lookup)
+Rails::Generator::Base.send(:include, Rails::Generator::Commands)
+
+# Set up a default logger for convenience.
+require 'rails_generator/simple_logger'
+Rails::Generator::Base.logger = Rails::Generator::SimpleLogger.new(STDOUT)

data/lib/shatter.rb

@@ -0,0 +1,7 @@
+["shattered_support", "shattered_ogrerb", "shattered_pack"].each do |component|
+  lib_path = File.expand_path(File.dirname(__FILE__)+"/../../#{component}/lib")
+  $: << lib_path if File.directory? lib_path
+  require component
+end
+
+require File.dirname(__FILE__) + '/game_loader'

data/lib/tasks/documentation.rake

@@ -0,0 +1,46 @@
+namespace :doc do
+  desc "Generate documentation for the application"
+  Rake::RDocTask.new("app") { |rdoc|
+    rdoc.rdoc_dir = 'doc/app'
+    rdoc.title    = "Shattered Game Documentation"
+    rdoc.options << '--line-numbers' << '--inline-source'
+    rdoc.rdoc_files.include('doc/README_FOR_APP')
+    rdoc.rdoc_files.include('app/**/*.rb')
+  }
+  
+  plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }
+
+  desc "Generate documation for all installed plugins"
+  task :plugins => plugins.collect { |plugin| "doc:plugins:#{plugin}" }
+
+  desc "Remove plugin documentation"
+  task :clobber_plugins do 
+    rm_rf 'doc/plugins' rescue nil
+  end
+
+  namespace :plugins do
+    # Define doc tasks for each plugin
+    plugins.each do |plugin|
+      task(plugin => :environment) do
+        plugin_base   = "vendor/plugins/#{plugin}"
+        options       = []
+        files         = Rake::FileList.new
+        options << "-o doc/plugins/#{plugin}"
+        options << "--title '#{plugin.titlecase} Plugin Documentation'"
+        options << '--line-numbers' << '--inline-source'
+        options << '-T html'
+
+        files.include("#{plugin_base}/lib/**/*.rb")
+        if File.exists?("#{plugin_base}/README")
+          files.include("#{plugin_base}/README")    
+          options << "--main '#{plugin_base}/README'"
+        end
+        files.include("#{plugin_base}/CHANGELOG") if File.exists?("#{plugin_base}/CHANGELOG")
+
+        options << files.to_s
+
+        sh %(rdoc #{options * ' '})
+      end
+    end
+  end
+end

data/lib/tasks/framework.rake

@@ -0,0 +1,80 @@
+namespace :shattered do
+  namespace :freeze do
+    desc "Lock this application to the current gems (by unpacking them into vendor/Shattered)"
+    task :gems do
+      require 'rubygems'
+      Gem.manage_gems
+      
+      version = ENV['VERSION'] || Gem.cache.search('shattered').sort_by { |g| g.version }[-1].version
+      
+      gems = Gem.cache.search('shattered', "= #{version}")
+      
+      if gems.length == 0
+        puts "No shattered gem #{version} is installed.  Do 'gem list shattered' to see what you have available."
+        exit
+      end
+      
+      puts "Freezing to the gems for shattered #{gems[0].version}"
+      rm_rf   "vendor/shattered"
+      mkdir_p "vendor/shattered"
+
+      chdir("vendor/shattered") do
+        gems.reverse.each do |g|
+          puts g.name
+          Gem::GemRunner.new.run(["unpack", "-v", "#{g.version}", "#{g.name}"])
+          mv(Dir.glob("#{g.name}*").first, g.name)
+        end
+        mv(Dir.glob("shattered_ruby").first, "shatter")
+      end
+    end
+
+    desc "Lock to latest Shattered Edge or a specific revision with REVISION=X (ex: REVISION=4021) or a tag with TAG=Y (ex: TAG=rel_1-1-0)"
+    task :edge do
+      $verbose = false
+      `svn --version` rescue nil
+      unless !$?.nil? && $?.success?
+        $stderr.puts "ERROR: Must have subversion (svn) available in the PATH to lock this application to Edge Shattered"
+        exit 1
+      end
+            
+      rm_rf   "vendor/shattered"
+      mkdir_p "vendor/shattered"
+      
+      svn_root = "http://svn.shatteredruby.com/"
+
+      if ENV['TAG']
+        shattered_svn = "#{svn_root}/tags/#{ENV['TAG']}"
+        touch "vendor/shattered/TAG_#{ENV['TAG']}"
+      else
+        shattered_svn = "#{svn_root}/trunk"
+
+        if ENV['REVISION'].nil?
+          ENV['REVISION'] = /^r(\d+)/.match(%x{svn -qr HEAD log #{svn_root}})[1]
+          puts "REVISION not set. Using HEAD, which is revision #{ENV['REVISION']}."
+        end
+
+        touch "vendor/shattered/REVISION_#{ENV['REVISION']}"
+      end
+      
+      for framework in %w( shatter shattered_pack shattered_support shattered_ogrerb )
+        system "svn export #{shattered_svn}/trunk/#{framework} vendor/shattered/#{framework}" + (ENV['REVISION'] ? " -r #{ENV['REVISION']}" : "")
+      end
+    end
+  end
+
+  desc "Unlock this application from freeze of gems or edge and return to a fluid use of system gems"
+  task :unfreeze do
+    rm_rf "vendor/shattered"
+  end
+
+  desc "Update both configs, scripts and public/javascripts from shattered"
+  task :update => [ "update:scripts", "update:javascripts", "update:configs" ]
+
+  namespace :update do
+    desc "Update boot/config.rb from your current Shattered install"
+    task :configs do
+      require 'railties_path'  
+      FileUtils.cp(RAILTIES_PATH + '/environments/boot.rb', SHATTERED_ROOT + '/config/boot.rb')
+    end
+  end
+end

data/lib/tasks/log.rake

@@ -0,0 +1,9 @@
+namespace :log do
+  desc "Truncates all *.log files in log/ to zero bytes"
+  task :clear do
+    FileList["log/*.log"].each do |log_file|
+      f = File.open(log_file, "w")
+      f.close
+    end
+  end
+end

data/lib/tasks/misc.rake

@@ -0,0 +1,4 @@
+task :default => :test
+task :environment do
+  require(File.join(SHATTERED_ROOT, 'config', 'environment'))
+end

data/lib/tasks/pre_namespace_aliases.rake

@@ -0,0 +1,28 @@
+# clear
+task :clear_logs => "log:clear"
+
+# test
+task :recent          => "test:recent"
+task :test_units      => "test:units"
+task :test_functional => "test:functionals"
+task :test_plugins    => "test:plugins"
+
+
+# doc
+task :appdoc            => "doc:app"
+task :apidoc            => "doc:rails"
+task :plugindoc         => "doc:plugins"
+task :clobber_plugindoc => "doc:clobber_plugins"
+
+FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }.each do |plugin|
+  task :"#{plugin}_plugindoc" => "doc:plugins:#{plugin}"
+end
+
+
+# rails
+task :freeze_gems        => "rails:freeze:gems"
+task :freeze_edge        => "rails:freeze:edge"
+task :unfreeze_rails     => "rails:unfreeze"
+task :add_new_scripts    => "rails:update:scripts"
+task :update_javascripts => "rails:update:javascripts"
+

data/lib/tasks/shattered.rb

@@ -0,0 +1,6 @@
+# Load Rails rakefile extensions
+Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }
+
+# Load any custom rakefile extensions
+Dir["./lib/tasks/**/*.rake"].sort.each { |ext| load ext }
+Dir["./vendor/plugins/*/tasks/**/*.rake"].sort.each { |ext| load ext }

data/lib/tasks/statistics.rake

@@ -0,0 +1,17 @@
+STATS_DIRECTORIES = [
+  %w(Helpers            app/helpers), 
+  %w(Controllers        app/controllers), 
+  %w(APIs               app/apis),
+  %w(Components         components),
+  %w(Functional\ tests  test/functional),
+  %w(Models             app/models),
+  %w(Unit\ tests        test/unit),
+  %w(Libraries          lib/),
+  %w(Integration\ tests test/integration)
+].collect { |name, dir| [ name, "#{SHATTERED_ROOT}/#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  require 'code_statistics'
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end

data/lib/tasks/testing.rake

@@ -0,0 +1,102 @@
+TEST_CHANGES_SINCE = Time.now - 600
+
+# Look up tests for recently modified sources.
+def recent_tests(source_pattern, test_path, touched_since = 10.minutes.ago)
+  FileList[source_pattern].map do |path|
+    if File.mtime(path) > touched_since
+      test = "#{test_path}/#{File.basename(path, '.rb')}_test.rb"
+      test if File.exists?(test)
+    end
+  end.compact
+end
+
+
+# Recreated here from ActiveSupport because :uncommitted needs it before Rails is available
+module Kernel
+  def silence_stderr
+    old_stderr = STDERR.dup
+    STDERR.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+    STDERR.sync = true
+    yield
+  ensure
+    STDERR.reopen(old_stderr)
+  end
+end
+
+desc 'Test all units and functionals'
+task :test do
+  Rake::Task["test:units"].invoke       rescue got_error = true
+  Rake::Task["test:functionals"].invoke rescue got_error = true
+  
+  if File.exist?("test/integration")
+    Rake::Task["test:integration"].invoke rescue got_error = true
+  end
+
+  raise "Test failures" if got_error
+end
+
+namespace :test do
+  desc 'Test recent changes'
+  Rake::TestTask.new(:recent) do |t|
+    since = TEST_CHANGES_SINCE
+    touched = FileList['test/**/*_test.rb'].select { |path| File.mtime(path) > since } +
+      recent_tests('app/models/*.rb', 'test/unit', since) +
+      recent_tests('app/controllers/*.rb', 'test/functional', since)
+
+    t.libs << 'test'
+    t.verbose = true
+    t.test_files = touched.uniq
+  end
+  
+  desc 'Test changes since last checkin (only Subversion)'
+  Rake::TestTask.new(:uncommitted) do |t|
+    def t.file_list
+      changed_since_checkin = silence_stderr { `svn status` }.map { |path| path.chomp[7 .. -1] }
+
+      models      = changed_since_checkin.select { |path| path =~ /app\/models\/.*\.rb/ }
+      controllers = changed_since_checkin.select { |path| path =~ /app\/controllers\/.*\.rb/ }  
+
+      unit_tests       = models.map { |model| "test/unit/#{File.basename(model, '.rb')}_test.rb" }
+      functional_tests = controllers.map { |controller| "test/functional/#{File.basename(controller, '.rb')}_test.rb" }
+
+      unit_tests.uniq + functional_tests.uniq
+    end
+    
+    t.libs << 'test'
+    t.verbose = true
+  end
+
+  desc "Run the unit tests in test/unit"
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+
+  desc "Run the functional tests in test/functional"
+  Rake::TestTask.new(:functionals) do |t|
+    t.libs << "test"
+    t.pattern = 'test/functional/**/*_test.rb'
+    t.verbose = true
+  end
+
+  desc "Run the integration tests in test/integration"
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "test"
+    t.pattern = 'test/integration/**/*_test.rb'
+    t.verbose = true
+  end
+
+  desc "Run the plugin tests in vendor/plugins/**/test (or specify with PLUGIN=name)"
+  Rake::TestTask.new(:plugins => :environment) do |t|
+    t.libs << "test"
+
+    if ENV['PLUGIN']
+      t.pattern = "vendor/plugins/#{ENV['PLUGIN']}/test/**/*_test.rb"
+    else
+      t.pattern = 'vendor/plugins/**/test/**/*_test.rb'
+    end
+
+    t.verbose = true
+  end
+end

data/lib/templates/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2004 David Heinemeier Hansson
+
+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/lib/templates/README

@@ -0,0 +1,35 @@
+== Description of contents
+
+A large part of this is inspired (cp -R) by Rails.  The fact that a web framework and a game framework have so much in common amazes me.
+
+Each project is created with the following directory structure:
+
+log/
+	Ogre.log - For Ogre's errors
+	Shattered.log - For all of shattered's messages
+
+test/
+	Anything that matches /.*_test.rb/ will be executed when testing.
+
+app/
+	models/
+		All models here.
+	controllers/
+		All model controllers(AI, keyboard) here.
+	views/	
+		The views are here, each with a corresponding directory.
+		puppy_view.rb
+		puppy/
+				puppy.mesh
+				puppy.skeleton
+				puppy.material
+				puppy.png
+				puppy_normals.png
+		
+config/
+	Here you will define the ogre and other configuration
+
+script/
+	This contains the generators/runners/executable scripts
+doc/
+	The documentation in this directory will be generated by rails rdoc.

data/lib/templates/Rakefile

@@ -0,0 +1,11 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+# Or in plugins/*/tasks/**/*.rake
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/shattered'
+

data/lib/templates/configs/boot.rb

@@ -0,0 +1,35 @@
+# Don't change this file. Configuration is done in config/environment.rb
+
+unless defined?(SHATTERED_ROOT)
+  root_path = File.join(File.dirname(__FILE__), '..')
+
+  unless RUBY_PLATFORM =~ /mswin32/
+    require 'pathname'
+    root_path = Pathname.new(root_path).cleanpath(true).to_s
+  end
+
+  SHATTERED_ROOT = root_path
+end
+
+def load_shattered_edge(path)
+  shatter_path = "#{path}/shatter/lib"
+  $: << shatter_path if File.directory? shatter_path
+  require 'rubygems'
+  require 'shatter'
+end
+
+def load_plugins(path)
+  Dir.foreach(path) do |plugin|
+    next if plugin == ".." || plugin == "."
+    
+    plugin_file = "#{path}/#{plugin}/init" 
+    require plugin_file if File.exists? "#{plugin_file}.rb"
+  end
+end
+
+# Load the plugins, and Shattered Edge, if present
+load_shattered_edge("#{SHATTERED_ROOT}/vendor/shattered")
+
+# Load the plugins
+load_plugins("#{SHATTERED_ROOT}/vendor/plugins")
+

data/lib/templates/configs/ogre.cfg

@@ -0,0 +1,4 @@
+Render System	OpenGL Rendering Subsystem
+FSAA	2
+Full Screen	No
+Video Mode	800 x 600

data/lib/templates/configs/ogre_plugins.windows.cfg

@@ -0,0 +1,14 @@
+# Defines plugins to load
+
+# Define plugin folder
+PluginFolder=.
+
+# Define D3D rendering implementation plugin
+#Plugin=RenderSystem_GL
+#Plugin=RenderSystem_Direct3D7
+Plugin=RenderSystem_Direct3D9
+Plugin=Plugin_ParticleFX
+Plugin=Plugin_BSPSceneManager
+Plugin=Plugin_OctreeSceneManager
+#Plugin=Plugin_CgProgramManager
+

data/lib/templates/configs/runner.rb

@@ -0,0 +1,5 @@
+def start_game
+	require File.dirname(__FILE__) + "/../config/boot"
+	require File.dirname(__FILE__) + "/../config/environment"
+	Shatter::GameLoader.instance.run
+end

data/lib/templates/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake appdoc" to generate API documentation for your models and controllers.