caterpillar 1.2.5 → 1.3.1

data/lib/caterpillar/task.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-
-
 #--
 # (c) Copyright 2008,2009,2010 Mikael Lammentausta
 #
@@ -39,17 +37,22 @@ module Caterpillar
       #STDOUT.puts 'Caterpillar v.%s (c) Copyright 2008,2009 Mikael Lammentausta' % VERSION
       #STDOUT.puts 'Provided under the terms of the MIT license.'
       #STDOUT.puts
+
       @name   = name
       @config = Util.eval_configuration(config)
       @logger = @config.logger
-      unless @config.rails_root
-        Usage.show()
-        exit 1
+      @xml_files = []
+
+      if name == 'rails'
+        @required_gems = %w(rails caterpillar jruby-jars warbler)
+      else
+        unless @config.rails_root
+          Usage.show()
+          exit 1
+        end
       end
 
       yield self if block_given?
-      @xml_files = []
-
       send tasks
     end
 
@@ -78,6 +81,7 @@ module Caterpillar
       define_deploy_task
       define_deploy_xml_task
       define_deploy_war_task
+      define_rails_task
     end
 
     def define_usage_task
@@ -103,9 +107,7 @@ module Caterpillar
           puts "I can't find a place to build my nest"
           puts "(directory 'vendor/plugins' is missing)"
         else
-          Dir.chdir("vendor/plugins") do
-            ruby "-S", "gem", "unpack", "caterpillar"
-          end
+          ruby "-S", "gem", "unpack", "caterpillar", "--target", "vendor/plugins"
           ruby "./script/generate caterpillar"
         end
       end
@@ -124,10 +126,7 @@ module Caterpillar
         tasks << "#{@name}:liferaydisplay"
       end
 
-      # print produced portlets
-      #tasks << :portlets
-
-      task :xml => tasks
+      task :makexml => tasks
     end
 
     # Prints the list of portlets.
@@ -217,7 +216,7 @@ module Caterpillar
           f=File.open(file,'w')
           f.write Portlet.xml(@portlets)
           f.close
-          info '-> %s' % file
+          #info '-> %s' % file
         end
       end
     end
@@ -234,7 +233,7 @@ module Caterpillar
           f=File.open(file,'w')
           f.write config.container.portletapp_xml(@portlets)
           f.close
-          info '-> %s' % file
+          #info '-> %s' % file
         end
       end
     end
@@ -254,7 +253,7 @@ module Caterpillar
           f=File.open(file,'w')
           f.write config.container.display_xml(@portlets)
           f.close
-          info '-> %s' % file
+          #info '-> %s' % file
         end
       end
     end
@@ -338,7 +337,7 @@ module Caterpillar
             if container_v and container_v[/^5.1/]
               '0.6.0' # FIXME: branch properly
             else
-              '0.9.2'
+              '0.10.0'
             end
           )
           require 'find'
@@ -368,7 +367,7 @@ module Caterpillar
           # check for previous installs..
           Find.find(target) do |file|
             if File.basename(file) =~ /rails-portlet/
-              old_version = file[/(\d.\d.\d).jar/,1]
+              old_version = file[/(\d.\d*.\d).jar/,1]
               # check if there's an update available
               if version.gsub(/\./,'').to_i > old_version.gsub(/\./,'').to_i
                 info 'Rails-portlet version %s is found, but an update is available' % old_version
@@ -410,10 +409,9 @@ module Caterpillar
           require 'find'
           Find.find(target) do |file|
             if File.basename(file) =~ /rails-portlet/
-              version = file[/(\d.\d.\d).jar/,1]
-              info 'Uninstalling Rails-portlet version %s from %s' % [version, target]
-              exit 1 unless system('rm -f %s' % file)
-              exit 0
+              version = file[/(\d.\d*.\d).jar/,1]
+              info 'Uninstalling Rails-portlet JAR version %s from %s' % [version, target]
+              exit File.delete(file)
             end
           end
 
@@ -426,7 +424,7 @@ module Caterpillar
     def define_jar_version_task
       @name = :jar
       with_namespace_and_config do |name, config|
-        desc 'Checks the installed Rails-portlet version'
+        desc 'Checks the installed Rails-portlet JAR version'
         task :version do
           raise 'Only Liferay is supported' unless deployment_requirements_met?
           require 'find'
@@ -434,13 +432,13 @@ module Caterpillar
 
           Find.find(target) do |file|
             if File.basename(file) =~ /rails-portlet/
-              version = file[/(\d.\d.\d).jar/,1]
-              info 'Rails-portlet version %s found in %s' % [version, target]
+              version = file[/(\d.\d*.\d).jar/,1]
+              info 'Rails-portlet version %s found: %s' % [version, file]
               exit 0
             end
           end
 
-          info 'Rails-portlet was not found in %s' % target
+          info 'Rails-portlet JAR was not found in %s' % target
           exit 1
         end
       end
@@ -490,15 +488,15 @@ module Caterpillar
       # only update the DB if the lportal gem is loaded
       tasks << 'db:update' if defined?(Lportal)
 
-      [:xml, :warble, 'deploy:xml', 'deploy:war'].each { |task| tasks << task }
+      ['deploy:xml', 'warble', 'deploy:war'].each { |task| tasks << task }
       task :deploy => tasks
     end
 
     def define_deploy_xml_task
       @name = :deploy
       with_namespace_and_config do |name, config|
-        desc 'Deploys the XML files'
-        task :xml do
+        desc 'Builds and deploys the XML files'
+        task :xml => 'makexml' do
           unless deployment_requirements_met?
             info 'Deployment is only supported on Liferay on Tomcat. Patches are welcome.'
             info 'Copy these XML files into the portlet container\'s WEB-INF.'
@@ -507,15 +505,16 @@ module Caterpillar
           end
 
           target = @config.container.WEB_INF
-          info 'deploying XML files to %s' % target
+          info 'deploying XML files'
 
           @xml_files.each do |file|
-            exit 1 unless system('cp %s %s' % [file,target])
-            info ' %s' % [file]
+            FileUtils.cp(file,target)
+            info "-> " + File.join(target, File.basename(file))
           end
         end
       end
     end
+
     def define_deploy_war_task
       @name = :deploy
       with_namespace_and_config do |name, config|
@@ -554,9 +553,6 @@ module Caterpillar
       end
     end
 
-
-
-
     def with_namespace_and_config
       name, config = @name, @config
       namespace name do
@@ -564,6 +560,34 @@ module Caterpillar
       end
     end
 
+    def define_rails_task
+      task :rails do
+        exit 1 unless conferring_step 'Checking for required gems...' do 
+          check_required_gems
+        end
+        exit 1 unless conferring_step 'Checking for JRuby binary...' do
+          check_jruby
+        end
+        exit 1 unless conferring_step 'Checking for required gems in JRuby...' do
+          check_jruby_required_gems
+        end
+        exit 1 unless conferring_step 'Creating Rails project...' do
+          create_rails_project
+        end
+        exit 1 unless conferring_step 'Updating config/environment.rb...' do
+          update_environment(ARGV[1] + '/config/environment.rb')
+        end
+        exit 1 unless conferring_step 'Activating caterpillar...' do
+          # Rake::Task['pluginize'].execute         
+          Dir.chdir("#{ARGV[1]}/vendor/plugins"){system 'ruby -S gem unpack caterpillar >/dev/null'}
+          Dir.chdir("#{ARGV[1]}"){system 'script/generate caterpillar >/dev/null'}
+        end
+        exit 1 unless conferring_step 'Configuring warbler...' do
+          Dir.chdir("#{ARGV[1]}"){system 'ruby -S warble config >/dev/null 2>&1'}
+        end
+      end
+    end
+
     protected
 
     def deployment_requirements_met?
@@ -614,7 +638,76 @@ module Caterpillar
       @logger ? @logger.info(msg) : STDOUT.puts(msg)
     end
 
+    private
 
+    def check_required_gems
+      gems = @required_gems
+      available_gems = []
+
+      gems.each {|gem| available_gems << gem if Gem::available? gem}
+      gems_not_found = (gems - available_gems)
+
+      if gems_not_found.empty?
+        return true
+      else
+        return "These required gems were not found: #{gems_not_found.join(' ')}\n" +
+          "Please install them with: ruby -S gem install #{gems_not_found.join(' ')}"
+      end
+    end
+
+    def check_jruby
+      has_jruby = system 'jruby --copyright >/dev/null 2>&1'
+      
+      if has_jruby
+        return true
+      else
+        return "jruby binary was not found in your path\n" +
+          "Please visit: http://jruby.org/"
+      end
+    end
 
+    def check_jruby_required_gems
+      jruby_gems = `jruby -S gem list`
+      available_gems = []
+      
+      @required_gems.each {|gem| available_gems << gem if jruby_gems.match(gem)}
+      gems_not_found = (@required_gems - available_gems)
+
+      if gems_not_found.empty?
+        return true
+      else
+        return "These required gems were not found: #{gems_not_found.join(' ')}\n" +
+          "Please install them with: jruby -S gem install #{gems_not_found.join(' ')}"
+      end
+    end
+
+    def create_rails_project
+      return 'specify rails project name' if ARGV[1].nil?
+      return "#{ARGV[1]} folder name already exists" if FileTest.exists? ARGV[1]
+      return system "ruby -S rails #{ARGV[1]} >/dev/null"
+    end
+
+    def update_environment(file_path)
+      file = File.read(file_path).
+        sub(/([ ]*#[ ]*config\.gem)/,
+            "  config.gem 'caterpillar', :version => '#{Caterpillar::VERSION}'\n" + '\1')
+      File.open(file_path, 'w') {|f| f << file}
+    end
+
+    def conferring_step(message)
+      STDOUT.print message
+      STDOUT.flush
+      
+      result = yield
+      if result.class == String or result.class == NilClass
+        STDOUT.puts "\e[31mFAILED\e[0m"
+        puts result unless result.nil?
+        return false
+      else
+        STDOUT.puts "\e[32mOK\e[0m"
+        return true
+      end
+    end
+      
   end
 end

data/lib/rails_gem_chooser.rb

@@ -8,65 +8,71 @@
 
 require 'rubygems'
 
-# Rails gem chooser
+# Rails gem chooser.
 #
-# Requires the proper Rails version by the +RAILS_ROOT/config/environment.rb+ file.
+# Selects RAILS_GEM_VERSION from ENV, or from RAILS_ROOT/config/environment.rb.
+# Returns nil otherwise.
 class RailsGemChooser
   class << self
 
   def version(config_file=nil)
-	unless config_file
-	  config_file = File.join(
-	  File.expand_path(RAILS_ROOT),
-        'config',
-        'environment.rb'
-        )
+    # detect from ENV
+    if ENV['RAILS_GEM_VERSION']
+      return ENV['RAILS_GEM_VERSION']
+    elsif not config_file
+      # load Rails config file
+      if RAILS_ROOT
+          config_file = File.join(
+          File.expand_path(RAILS_ROOT),
+            'config',
+            'environment.rb'
+            )
+      else
+        STDERR.puts 'Could not detect Rails version'
+        return nil
+      end
 	end
     # don't attempt to load Rails if building a Rubygem..!
     if $0[/gem$/] or !File.exist?(config_file)
-      rails_gem_version = nil
+      return nil
     else
-      # Attempt to guess proper Rails version by reading Rails' config file
+      # read from Rails config file
       f=File.open(config_file)
       config = f.read
-      rails_gem_version = config[/RAILS_GEM_VERSION.*(\d\.\d\.\d)/,1]
       f.close
-      #STDOUT.puts 'Detected Rails version %s from the config file %s' % [rails_gem_version,config_file]
+      rails_gem_version = config[/^RAILS_GEM_VERSION.*(\d\.\d\.\d)/,1]
+      STDOUT.puts 'Detected Rails version %s from the config file %s' % [rails_gem_version,config_file]
+      return rails_gem_version
     end
-    return rails_gem_version
   end
 
   # Load a specific GEM
   def __load_gem(name,version)
+    #p 'require gem %s v%s' % [name,version]
     version ? gem(name, '= '+version) : gem(name)
     require name
   end
 
   # Either define +rails_gem_version+ or +config_file+
-  # Without any parameters, the config_file is detected from RAILS_ROOT.
   def __load(rails_gem_version=nil,config_file=nil)
     raise 'oops' if config_file and rails_gem_version
 
-    rails_gem_version ||= version(config_file)
+    rails_gem_version ||= version(config_file) # also detects ENV['RAILS_GEM_VERSION']
 
     #STDOUT.puts 'Loading Rails version %s' % rails_gem_version
-    #DEPRECATION WARNING: require "activesupport" is deprecated and will be removed in Rails 3. Use require "active_support" instead.. 
-    #DEPRECATION WARNING: require "actionpack" is deprecated and will be removed in Rails 3. Use require "action_pack" instead..
-    #DEPRECATION WARNING: require "activerecord" is deprecated and will be removed in Rails 3. Use require "active_record" instead..
-    #if rails_gem_version[/^2/]
-      rails_gems = %w{ activesupport actionpack activerecord }
-    #else
-      # .. except that this does not work..
-    #  rails_gems = %w{ active_support action_pack active_record }
-    #end
 
-    # gem build fails when activesupport is loaded here
-    # - except with Rails 2.3.5 where this needs to be added.
-    if $0[/gem$/]
-    #    rails_gems -= ['activesupport']
-    end
-    rails_gems.each do |rg|
-      __load_gem(rg,rails_gem_version)
+    # XXX: silly hack because gem loading seems to have a problem..
+    # >> gem('active_support', '=2.3.5')
+    # Gem::LoadError: Could not find RubyGem active_support (= 2.3.5)
+    # >> require 'activesupport'
+    # DEPRECATION WARNING: require "activesupport" is deprecated and will be removed in Rails 3. Use require "active_support" instead..
+    require 'active_support' 
+    rails_gems = %w{ actionpack activerecord }
+
+    ActiveSupport::Deprecation.silence do
+      rails_gems.each do |rg|
+        __load_gem(rg,rails_gem_version)
+      end
     end
     require 'action_controller'
 

data/portlet_test_bench/controllers/caterpillar/junit_controller.rb

@@ -98,6 +98,14 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
     render :text => ""
   end
   
+  def download_image
+    send_file(File.expand_path('vendor/plugins/caterpillar/portlet_test_bench/resources/jake_sully.jpg'), :filename => "jake_sully.jpg")
+  end
+  
+  def preferences
+    render :text => "Preferences view"
+  end
+  
   # Sets a session value so the single SESSION_KEY cookie is set.
   # The output XML prints the session ID and the JUnit test compares this
   # to the value from another request, and with the same cookie they should match.
@@ -109,6 +117,7 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
   def redirect
     redirect_to :action => :redirect_target
   end
+  
   def redirect_target
     render :text => request.request_uri
   end
@@ -119,6 +128,7 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
     cookies[:the_time]   = Time.now.to_s
     redirect_to :action => "show_cookies"
   end
+  
   def show_cookies
     logger.debug 'Cookies: %s' % cookies.inspect
     render :text => cookies.to_xml

data/portlet_test_bench/views/caterpillar/application/index.html.erb

@@ -10,7 +10,7 @@ background: white;
   font-size: 11px;
   line-height: 15px;
 }
-#mainTitle {
+#testBenchContainer h1 {
   border-bottom: 1px solid #B9B9B9;
   color: #990000;
   font-size: 18px;
@@ -18,7 +18,7 @@ background: white;
   margin-bottom: 20px;
   padding: 0 0 0 15px;
 }
-h1 {
+#testBenchContainer h2 {
   border: 1px solid #B9B9B9;
   color: #990000;
   font-size: 14px;
@@ -33,14 +33,13 @@ h1 {
 
 <div id="testBenchContainer">
 
-<div id="mainTitle">
-Rails-portlet test bench
-</div>
+<h1>Rails-portlet test bench</h1>
+
 <p style="font-size: 14px;">
 These are isolated test cases of the Rails-portlet, for manual testing in the browser. The <%= link_to_exit_portlet 'source code', 'http://rails-portlet.rubyforge.org/svn/trunk/caterpillar/portlet_test_bench/' -%> can be used as a reference for using the same features in other Rails apps.
 </p>
 
-<h1>HTTP</h1>
+<h2>HTTP</h2>
 <div class="testContainer">
 
   <%= link_to 'URL parameter passing',
@@ -61,7 +60,7 @@ These are isolated test cases of the Rails-portlet, for manual testing in the br
 </div>
 
 
-<h1>JavaScripts</h1>
+<h2>JavaScripts</h2>
 <div class="testContainer">
 
   <%= link_to 'Simple JavaScript',
@@ -85,7 +84,7 @@ These are isolated test cases of the Rails-portlet, for manual testing in the br
 </div>
 
 
-<h1>CSS</h1>
+<h2>CSS</h2>
 <div class="testContainer">
 
   <%= link_to 'Simple CSS',
@@ -97,7 +96,7 @@ These are isolated test cases of the Rails-portlet, for manual testing in the br
 </div>
 
 
-<h1>Misc</h1>
+<h2>Misc</h2>
 <div class="testContainer">
 
   <%= link_to 'Image resources',
@@ -122,7 +121,7 @@ These are isolated test cases of the Rails-portlet, for manual testing in the br
 </div>
 
 
-<h1>JUnit</h1>
+<h2>JUnit</h2>
 
 The JUnit tests are used for automatic testing and they output XML.