shattered 0.4.0.1 → 0.5.0.1

data/lib/rails_generator/manifest.rb

@@ -1,4 +1,4 @@
-module Rails #:nodoc:all
+module Rails
   module Generator
 
     # Manifest captures the actions a generator performs.  Instantiate

data/lib/rails_generator/options.rb

@@ -1,10 +1,9 @@
 require 'optparse'
 
-module Rails #:nodoc:all
+module Rails
   module Generator
     module Options
-      def self.append_features(base)
-        super
+      def self.included(base)
         base.extend(ClassMethods)
         class << base
           if respond_to?(:inherited)
@@ -96,8 +95,8 @@ module Rails #:nodoc:all
 
         # Raise a usage error.  Override usage_message to provide a blurb
         # after the option parser summary.
-        def usage
-          raise UsageError, "#{@option_parser}\n#{usage_message}"
+        def usage(message = usage_message)
+          raise UsageError, "#{@option_parser}\n#{message}"
         end
 
         def usage_message
@@ -118,16 +117,25 @@ module Rails #:nodoc:all
 
         # Adds general options like -h and --quiet.  Usually don't override.
         def add_general_options!(opt)
+          opt.separator ''
+          opt.separator 'Rails Info:'
+          opt.on('-v', '--version', 'Show the Rails version number and quit.')
+          opt.on('-h', '--help', 'Show this help message and quit.') { |v| options[:help] = v }
+
           opt.separator ''
           opt.separator 'General Options:'
 
-          opt.on('-p', '--pretend', 'Run but do not make any changes.') { |options[:pretend]| }
+          opt.on('-p', '--pretend', 'Run but do not make any changes.') { |v| options[:pretend] = v }
           opt.on('-f', '--force', 'Overwrite files that already exist.') { options[:collision] = :force }
           opt.on('-s', '--skip', 'Skip files that already exist.') { options[:collision] = :skip }
-          opt.on('-q', '--quiet', 'Suppress normal output.') { |options[:quiet]| }
-          opt.on('-t', '--backtrace', 'Debugging: show backtrace on errors.') { |options[:backtrace]| }
-          opt.on('-h', '--help', 'Show this help message.') { |options[:help]| }
-          opt.on('-c', '--svn', 'Modify files with subversion. (Note: svn must be in path)') { options[:svn] = Hash[*`svn status`.collect { |e| e.chop.split.reverse unless e.chop.split.size != 2 }.flatten] }
+          opt.on('-q', '--quiet', 'Suppress normal output.') { |v| options[:quiet] = v }
+          opt.on('-t', '--backtrace', 'Debugging: show backtrace on errors.') { |v| options[:backtrace] = v }
+          opt.on('-c', '--svn', 'Modify files with subversion. (Note: svn must be in path)') do
+            options[:svn] = `svn status`.inject({}) do |opt, e|
+              opt[e.chomp[7..-1]] = true
+              opt
+            end
+          end
         end
 
     end

data/lib/rails_generator/scripts.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/options'
 
-module Rails #:nodoc:all
+module Rails
   module Generator
     module Scripts
 
@@ -38,7 +38,7 @@ module Rails #:nodoc:all
         protected
           # Override with your own script usage banner.
           def banner
-            "Usage: #{$0} [options] generator [args]"
+            "Usage: #{$0} generator [options] [args]"
           end
 
           def usage_message
@@ -69,8 +69,8 @@ end_blurb
        #{$0} login
 
 Generator gems are also available:
-  1. gem list generator -s http://gems.rubyonrails.org
-  2. gem install login_generator -s http://gems.rubyonrails.org
+  1. gem search -r generator
+  2. gem install login_generator
   3. #{$0} login
 
 end_blurb

data/lib/rails_generator/simple_logger.rb

@@ -1,6 +1,6 @@
-module Rails #:nodoc:all
+module Rails
   module Generator
-    class SimpleLogger
+    class SimpleLogger # :nodoc:
       attr_reader :out
       attr_accessor :quiet
 

data/lib/rails_generator/spec.rb

@@ -1,4 +1,4 @@
-module Rails #:nodoc:all
+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

data/lib/shatter.rb

@@ -1,4 +1,4 @@
-["shattered_support", "shattered_ogre", "shattered_pack"].each do |component|
+["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

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,84 @@
+namespace :shattered do
+  namespace :freeze do
+    desc "Lock this application to the current gems (by unpacking them into vendor/rails)"
+    task :gems do
+      deps = %w(shatter shattered_pack shattered_ogre)
+      require 'rubygems'
+      Gem.manage_gems
+
+      shattered = (version = ENV['VERSION']) ?
+        Gem.cache.search('shattered', "= #{version}").first :
+        Gem.cache.search('shattered').sort_by { |g| g.version }.last
+
+      version ||= shattered.version
+
+      unless shattered
+        puts "No rails gem #{version} is installed.  Do 'gem list rails' to see what you have available."
+        exit
+      end
+
+      puts "Freezing to the gems for Rails #{rails.version}"
+      rm_rf   "vendor/shattered"
+      mkdir_p "vendor/shattered"
+
+      chdir("vendor/shattered") do
+        shattered.dependencies.select { |g| deps.include? g.name }.each do |g|
+          Gem::GemRunner.new.run(["unpack", "-v", "#{g.version_requirements}", "#{g.name}"])
+          mv(Dir.glob("#{g.name}*").first, g.name)
+        end
+
+        Gem::GemRunner.new.run(["unpack", "-v", "=#{version}", "rails"])
+        FileUtils.mv(Dir.glob("rails*").first, "railties")
+      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 Rails"
+        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( railties actionpack activerecord actionmailer activesupport actionwebservice )
+        system "svn export #{shattered_svn}/#{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 rails 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/Rakefile

@@ -1,15 +1,11 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/switchtower.rake, and they will automatically be available to 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'
 
-desc "Run the unit tests in test/unit"
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.pattern = 'test/unit/**/*_test.rb'
-  t.verbose = true
-end
+require 'tasks/shattered'
+

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
+