caterpillar 1.0.1 → 1.0.5

data/ChangeLog

@@ -1,3 +1,17 @@
+= 1.0.5
+	- comply XML with Liferay 5.2.3 - output more XML with default values
+	- cleanup program output
+	- generator cleanup
+	- added portlet test for flash messages
+
+= 1.0.4
+	- bugfix release
+
+= 1.0.2
+	- support for installing on JBoss/Tomcat
+	- refined the Liferay variable detection test
+	- cleanup
+
 = 1.0.1
 	- added test for liferay session variables
 	- fixed XML validation error on 5.2.3 (all portlets are now uninstanceable)
@@ -84,3 +98,4 @@ Released at 2008-12-17
 	- the initial release
 
 
+

data/README

@@ -9,21 +9,20 @@ that integrates into any Rails project when you 'pluginize' Caterpillar.
 == Quickstart ==
 Start up a new Rails project:
 
-  $ rails shiny_app
-  $ cd shiny_app
+  $ rails example
+  $ cd example
   $ caterpillar pluginize
 
-Activate the test bench portlet by inserting 'map.caterpillar' in RAILS_ROOT/config/routes.rb before any other routes.
-
-If you are using Liferay, +require 'lportal'+ in the Rails startup:
+Caterpillar contains Rails portlet test bench, which can be activated by inserting 
++map.caterpillar+ in RAILS_ROOT/config/routes.rb before any other routes.
 
+If you are connecting to the Liferay database, add +require 'lportal'+ in the Rails startup:
   $ echo "require 'lportal'" > config/initializers/lportal.rb
+And set up the database connection.
 
-Finally, set up the database connection. Then you should run +caterpillar portlets+ to check if your installation is working. The output should be something like this:
+Now you should run +caterpillar portlets+ to check if your installation is working.
+The output should include these lines:
 
-  Caterpillar: version 0.9.9999
-  Using Liferay schema build 5101, version 5.1.1
-  Caterpillar configured for Liferay version 5.1.1 at /usr/local/liferay/
   * Portlet configuration ***********************
   Caterpillar
     Rails-portlet test bench      "portlet_test_bench"  []
@@ -31,6 +30,10 @@ Finally, set up the database connection. Then you should run +caterpillar portle
 Then you can start up the server (./script/server) and navigate to http://localhost:3000/caterpillar/test_bench
 
 
+== Quick production deployment using JRuby ==
+See the documentation in the example app (SVN checkout).
+
+
 == Useful tasks ==
 Here are the most useful tasks; see the rdoc documentation and caterpillar --describe for the full feature list.
 

data/generators/caterpillar/caterpillar_generator.rb

@@ -1,18 +1,31 @@
 # This generator installs the required files into the main Rails application.
 # This generator should always be run after upgrading the plugin.
 class CaterpillarGenerator < Rails::Generator::Base
-  def manifest
+  def msg(txt)
+    _txt = " *\n"
+    txt.split("\n").each do |line|
+      _txt << " * %s\n" % line
+    end
+    _txt << " *\n"
+    STDOUT.puts _txt
+    STDOUT.flush
+  end
 
+  def after_generate
+    msg(
+      "If you want to use the portlet test bench,\n" + \
+      "put the following line in your config/routes.rb before other routes.\n" + \
+      "  map.caterpillar"
+    )
+  end
+
+  def manifest
     require 'find'
     file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
     this_dir = File.dirname(File.expand_path(file))
     tmpl = File.join(this_dir,'templates')
 
-    STDOUT.puts ' * Installing configuration file with images, stylesheets and javascripts.'
-    STDOUT.puts ' * If you want to use the portlet test bench,'
-    STDOUT.puts ' * put the following line in your config/routes.rb before other routes.'
-    STDOUT.puts ' *   map.caterpillar'
-    STDOUT.puts ' *'
+    msg 'Installing configuration file with images, stylesheets and javascripts.'
 
     record do |m|
 

data/generators/caterpillar/templates/config/portlets.rb

@@ -17,7 +17,18 @@ Caterpillar::Config.new do |portlet|
   #
   # No changes are made to any of the files in this directory while making XML,
   # only the deploy and install tasks make any changes.
-  portlet.container.root = '/usr/local/liferay/'
+  # portlet.container.root = '/usr/local/liferay/'
+
+  # The server that the container is running on.
+  # Possible values:
+  #  - 'Tomcat' (default)
+  #  - 'JBoss/Tomcat'
+  # portlet.container.server = 'JBoss/Tomcat'
+
+  # The server dir is only meaningful with JBoss.
+  # This is the name of the directory in server/.
+  # By default the first entry in the directory is chosen.
+  # portlet.container.server_dir = 'default'
 
   # The hostname and port.
   # By default the values are taken from the request.

data/init.rb

@@ -1,4 +1,11 @@
-# Rails plugin initialization.
+#--
+# (c) Copyright 2008,2009 Mikael Lammentausta
+#
+# See the file MIT-LICENSE included with the distribution for
+# software license details.
+#++
+
+### Initialize the Rails plugin.
 
 file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 this_dir = File.dirname(File.expand_path(file))
@@ -6,30 +13,32 @@ this_dir = File.dirname(File.expand_path(file))
 # load the main file
 require File.join(this_dir, 'lib', 'caterpillar')
 
-STDERR.puts 'Caterpillar: version %s' % Caterpillar::VERSION
+#STDERR.puts 'Caterpillar: version %s' % Caterpillar::VERSION
 
 # Add Caterpillar portlet navigation to views paths
 ActionController::Base.append_view_path File.join(this_dir, 'views')
 
-### Portlet test bench
-  # Adding directories to the load path makes them appear just like files in the the main app directory.
-  ActiveSupport::Dependencies.load_paths << File.join(this_dir, 'portlet_test_bench', 'controllers')
-  ActiveSupport::Dependencies.load_paths << File.join(this_dir, 'portlet_test_bench', 'helpers')
+### Initialize the portlet test bench
+
+# Adding directories to the load path makes them appear just like files in the the main app directory.
+%w{ controllers helpers }.each do |path|
+  ActiveSupport::Dependencies.load_paths << File.join(this_dir, 'portlet_test_bench', path)
+end
 
-  # Removing a directory from the load once paths allow changes
-  # to be picked up as soon as you save the file – without having to restart the web server.
-  ActiveSupport::Dependencies.load_once_paths.delete(File.join(this_dir, 'portlet_test_bench'))
+# Removing a directory from the load once paths allow changes
+# to be picked up as soon as you save the file – without having to restart the web server.
+ActiveSupport::Dependencies.load_once_paths.delete(File.join(this_dir, 'portlet_test_bench'))
 
-  # Add views
-  ActionController::Base.append_view_path File.join(this_dir, 'portlet_test_bench','views')
+# Add views
+ActionController::Base.append_view_path File.join(this_dir, 'portlet_test_bench','views')
 
-  # Define routes
-  # NOTE: the routes need to be activated by 'map.caterpillar' in RAILS_ROOT/config/routes.rb
-  require File.join(this_dir, 'portlet_test_bench', 'routing')
-  ActionController::Routing::RouteSet::Mapper.send :include, Caterpillar::Routing::MapperExtensions
+# Define routes
+# NOTE: the routes need to be activated by 'map.caterpillar' in RAILS_ROOT/config/routes.rb
+require File.join(this_dir, 'portlet_test_bench', 'routing')
+ActionController::Routing::RouteSet::Mapper.send :include, Caterpillar::Routing::MapperExtensions
 
-  # hack; the application controller needs to be loaded explicitly,
-  # but NOT for standard Caterpillar tasks (breaks the tasks)
-  unless $0[/caterpillar|generate/]
-    require File.join(this_dir, 'portlet_test_bench','controllers','caterpillar','application')
-  end
+# hack; the application controller needs to be loaded explicitly,
+# but NOT for standard Caterpillar tasks (breaks the tasks)
+unless $0[/caterpillar|generate/]
+  require File.join(this_dir, 'portlet_test_bench','controllers','caterpillar','application')
+end

data/lib/caterpillar.rb

@@ -1,11 +1,12 @@
 #--
 # (c) Copyright 2008,2009 Mikael Lammentausta
-# See the file LICENSES.txt included with the distribution for
+#
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 
 module Caterpillar
-  VERSION='1.0.1'
+  VERSION='1.0.5'
 end
 
 this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
@@ -19,38 +20,7 @@ require 'find'
 require 'rake'
 require 'rake/tasklib'
 
-# NOTE: During normal startup (not while building the gem),
-# ActiveRecord should be loaded at this point, before loading any of the models.
-# However, this may conflict later when Rails' rake task activates the boot process.
-# The correct versions should be loaded at this point.
-# Otherwise only one version of Rails & co. rubygems should exist on the system.
-
-if $0[/gem$/]
-  rails_gem_version = nil
-else
-  # Attempt to guess proper Rails version by reading Rails' config file
-  f=File.open(
-    File.join(
-      File.expand_path(RAILS_ROOT),
-      'config',
-      'environment.rb'
-    )
-  )
-  config = f.read
-  rails_gem_version = config[/RAILS_GEM_VERSION.*(\d\.\d\.\d)/,1]
-  f.close
-end
-
-# Load the proper versions of Rails etc.
-# Not tested on all setups.
-require 'rubygems'
-['activesupport',
-'actionpack',
-'activerecord'].each { |rg|
-  gem(rg, '= '+rails_gem_version) if rails_gem_version
-  require rg
-}
-require 'action_controller'
+require File.join(this_dir,'load_rails')
 
 # include all ruby files
 Find.find(this_dir) do |file|

data/lib/caterpillar/config.rb

@@ -50,7 +50,7 @@ module Caterpillar
 
       @warbler_conf = File.join(@rails_root,'config','warble.rb')
       unless File.exists?(@warbler_conf)
-        STDERR.puts 'Warbler configuration file could not be found'
+        #STDERR.puts 'Warbler configuration file could not be found'
       end
 
       #@logger  = (defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new)
@@ -60,7 +60,7 @@ module Caterpillar
 
     # The container class is used for parsing XML files.
     #
-    # Possible values: Liferay (default)
+    # Possible values: Caterpillar::Liferay (default using Tomcat)
     def container
       self._container || Caterpillar::Liferay.new
     end
@@ -72,4 +72,4 @@ module Caterpillar
 
 
   end
-end
+end

data/lib/caterpillar/liferay.rb

@@ -5,7 +5,8 @@
 # software license details.
 #++
 
-module Caterpillar
+module Caterpillar # :nodoc:
+
   # Creates liferay-portlet XML and liferay-display XML.
   # The latter optionally combines your production portlet display configuration.
   #
@@ -43,11 +44,20 @@ module Caterpillar
     # the installation directory
     attr_accessor :root
 
+    # server type:
+    #  - 'Tomcat'
+    #  - 'JBoss/Tomcat'
+    attr_accessor :server
+
+    # the name of the JBoss server directory
+    attr_accessor :server_dir
+
     # Liferay version is given as a String, eg. '5.2.2'.
     # Defaults to +Lportal::Schema.version+.
     def initialize(version=nil)
       @version = version
       @root    = '/usr/local/liferay'
+      @server  = 'Tomcat'
     end
 
     # The name of the portal. Used in STDOUT messages.
@@ -55,11 +65,55 @@ module Caterpillar
       'Liferay'
     end
 
+    def deploy_dir
+      raise 'Configure container root folder' unless self.root
+      case @server
+
+      when 'Tomcat'
+        root_dir = 'ROOT'
+        File.join(self.root,'webapps')
+
+      when 'JBoss/Tomcat'
+        # detect server name if not configured
+        @server_dir ||= Dir.new(
+            File.join(self.root,'server')).entries.first
+        path = File.join(self.root,'server',@server_dir,'deploy')
+
+        unless File.exists?(path)
+          raise 'Portal deployment directory does not exist: %s' % path
+        end
+
+        return path
+      end
+    end
+
     # The location of Liferay's WEB-INF folder for XML analyzation.
     # This is relative to installation directory (self.root)
     def WEB_INF
       raise 'Configure container root folder' unless self.root
-      File.join(self.root,'webapps','ROOT','WEB-INF')
+      case @server
+
+      when 'Tomcat'
+        root_dir = 'ROOT'
+        File.join(self.deploy_dir,root_dir,'WEB-INF')
+
+      when 'JBoss/Tomcat'
+        # detect lportal dir (ROOT.war or lportal.war)
+        root_dir =
+          if File.exists?(File.join(self.deploy_dir,'ROOT.war'))
+            'ROOT.war'
+          elsif File.exists?(File.join(self.deploy_dir,'lportal.war'))
+            'lportal.war'
+          end
+        unless root_dir
+          STDERR.puts 'There seems to be a problem detecting the proper install paths.'
+          STDERR.puts 'Please file a bug on Caterpillar.'
+          raise 'Portal root directory not found at %s' % self.deploy_dir
+        end
+
+        File.join(self.deploy_dir,root_dir,'WEB-INF')
+
+      end
     end
 
     # Reads Liferay portlet descriptor XML files and parses them with Hpricot.
@@ -117,7 +171,6 @@ module Caterpillar
             end
             # debug
             #puts _p.inspect
-            #portlets << _p
 
           end
         end
@@ -222,20 +275,40 @@ module Caterpillar
       end
     end
 
-    # the actual portlet definition
+    # liferay-portlet-ext definition
+    #
+    # http://www.liferay.com/web/guest/community/wiki/-/wiki/Main/Liferay-portlet.xml
+    #
+    # The content of element type "portlet" must match "(portlet-name,icon?,virtual-path?,struts-path?,configuration-path?,configuration-action-class?,indexer-class?,open-search-class?,scheduler-class?,portlet-url-class?,friendly-url-mapper-class?,url-encoder-class?,portlet-data-handler-class?,portlet-layout-listener-class?,poller-processor-class?,pop-message-listener-class?,social-activity-interpreter-class?,social-request-interpreter-class?,webdav-storage-token?,webdav-storage-class?,control-panel-entry-category?,control-panel-entry-weight?,control-panel-entry-class?,preferences-company-wide?,preferences-unique-per-layout?,preferences-owned-by-group?,use-default-template?,show-portlet-access-denied?,show-portlet-inactive?,action-url-redirect?,restore-current-view?,maximize-edit?,maximize-help?,pop-up-print?,layout-cacheable?,instanceable?,scopeable?,user-principal-strategy?,private-request-attributes?,private-session-attributes?,render-weight?,ajaxable?,header-portal-css*,header-portlet-css*,header-portal-javascript*,header-portlet-javascript*,footer-portal-css*,footer-portlet-css*,footer-portal-javascript*,footer-portlet-javascript*,css-class-wrapper?,facebook-integration?,add-default-resource?,system?,active?,include?)".
     def portletapp_template(portlet)
       xml =  "  <portlet>\n"
       xml << "    <portlet-name>%s</portlet-name>\n" % portlet[:name]
+      # portlet icon is favicon - FIXME: use proper host
       xml << "    <icon>/%s/favicon.ico</icon>\n" % portlet[:servlet]
-      # can there be several portlet instances on the same page?
-      xml << "    <instanceable>false</instanceable>\n"
-      # define the control panel category for 5.2 and newer -
+
+      # define the control panel category for Liferay 5.2 and newer -
+      #
       # Note that when the control panel settings are defined,
       # the portlet cannot be instanceable.
       unless @version[/5.1/]
         xml << "    <control-panel-entry-category>#{portlet[:category]}</control-panel-entry-category>\n"
-        xml << "    <control-panel-entry-weight>1.0</control-panel-entry-weight>\n"
+        xml << "    <control-panel-entry-weight>420.0</control-panel-entry-weight>\n"
+        #xml << "    <control-panel-entry-class></control-panel-entry-class>\n"
       end
+
+      # Set the use-default-template value to true if the portlet uses the default template to decorate and wrap content. Setting this to false allows the developer to own and maintain the portlet's entire outputted content. The default value is true.
+      #
+      # The most common use of this is if you want the portlet to look different from the other portlets or if you want the portlet to not have borders around the outputted content.
+      #
+      # RD: This is a nice option except that if you set it, then you loose all border functionality including drag, drop, min,max,edit,conf,close These should be controlled by a separate property.
+      xml << "    <use-default-template>true</use-default-template>\n"
+
+      # can there be several portlet instances on the same page?
+      xml << "    <instanceable>false</instanceable>\n"
+
+      # The default value of ajaxable is true. If set to false, then this portlet can never be displayed via Ajax.
+      xml << "    <ajaxable>true</ajaxable>\n"
+
       # include javascripts?
       js_tag = (@version[/5.1/] ? 'header' : 'footer') + '-portal-javascript'
       portlet[:javascripts].each do |js|
@@ -243,6 +316,13 @@ module Caterpillar
         xml << "/#{portlet[:servlet]}/javascripts/#{js}"
         xml << "</#{js_tag}>\n"
       end
+
+      # If the add-default-resource value is set to true, the default portlet resources and permissions are added to the page. The user can then view the portlet.
+      xml << "    <add-default-resource>true</add-default-resource>\n"
+      xml << "    <system>false</system>\n"
+      xml << "    <active>true</active>\n"
+      xml << "    <include>true</include>\n"
+
       xml << "  </portlet>\n\n"
     end
 
@@ -281,63 +361,68 @@ module Caterpillar
 
     # tables that are skipped when creating fixtures
     def skip_fixture_tables
-      [
-        "cyrususer","cyrusvirtual",
-        "documentlibrary_fsentry","documentlibrary_binval","documentlibrary_node","documentlibrary_prop","documentlibrary_refs",
-        "expandocolumn",
-        "expandorow",
-        "expandotable",
-        "expandovalue",
-        "image",
-        "chat_entry",
-        "chat_status",
-        "journalcontentsearch",
-        "mbban",
-        "membershiprequest",
-        "orglabor",
-        "passwordpolicyrel",
-        "passwordpolicy",
-        "passwordtracker",
-        "pluginsetting",
-        "quartz_blob_triggers",
-        "quartz_calendars",
-        "quartz_cron_triggers",
-        "quartz_fired_triggers",
-        "quartz_job_details",
-        "quartz_job_listeners",
-        "quartz_locks",
-        "quartz_paused_trigger_grps",
-        "quartz_scheduler_state",
-        "quartz_simple_triggers",
-        "quartz_trigger_listeners",
-        "quartz_triggers",
-        "ratingsentry",
-        "ratingsstats",
-        "region",
-        "scframeworkversion",
-        "scframeworkversi_scproductvers",
-        "schema_migrations",
-        "sclicenses_scproductentries",
-        "sclicense",
-        "scproductentry",
-        "scproductscreenshot",
-        "scproductversion",
-        "servicecomponent",
-        "sessions",
-        "shoppingcart",
-        "shoppingcategory",
-        "shoppingcoupon",
-        "shoppingitemfield",
-        "shoppingitemprice",
-        "shoppingitem",
-        "shoppingorderitem",
-        "shoppingorder",
-        "subscription",
-        "tasksproposal",
-        "tasksreview",
-        "webdavprops",
-        "website"
-      ]
+      %w{
+        cyrususer
+        cyrusvirtual
+        documentlibrary_fsentry
+        documentlibrary_binval
+        documentlibrary_node
+        documentlibrary_prop
+        documentlibrary_refs
+        expandocolumn
+        expandorow
+        expandotable
+        expandovalue
+        image
+        chat_entry
+        chat_status
+        journalcontentsearch
+        mbban
+        membershiprequest
+        orglabor
+        passwordpolicyrel
+        passwordpolicy
+        passwordtracker
+        pluginsetting
+        quartz_blob_triggers
+        quartz_calendars
+        quartz_cron_triggers
+        quartz_fired_triggers
+        quartz_job_details
+        quartz_job_listeners
+        quartz_locks
+        quartz_paused_trigger_grps
+        quartz_scheduler_state
+        quartz_simple_triggers
+        quartz_trigger_listeners
+        quartz_triggers
+        ratingsentry
+        ratingsstats
+        region
+        scframeworkversion
+        scframeworkversi_scproductvers
+        schema_migrations
+        sclicenses_scproductentries
+        sclicense
+        scproductentry
+        scproductscreenshot
+        scproductversion
+        servicecomponent
+        sessions
+        shoppingcart
+        shoppingcategory
+        shoppingcoupon
+        shoppingitemfield
+        shoppingitemprice
+        shoppingitem
+        shoppingorderitem
+        shoppingorder
+        subscription
+        tasksproposal
+        tasksreview
+        webdavprops
+        website
+      }
     end
 
   end

data/lib/caterpillar/task.rb

@@ -172,6 +172,11 @@ module Caterpillar
       task :environment do
         require(File.join(@config.rails_root, 'config', 'environment'))
         if @config.container.is_a?(Caterpillar::Liferay)
+          if @config.container.version.nil? and !defined?(Lportal)
+            STDERR.puts 'Liferay version is undefined, and lportal gem is not present.'
+            STDERR.puts 'Please define portlet.container.version in %s.' % @config.class::FILE
+            raise 'Insufficient configuration'
+          end
           @config.container.version ||= Lportal::Schema.version
           portal_info
         end
@@ -337,19 +342,14 @@ module Caterpillar
         task :install => :environment do
           source = File.join(CATERPILLAR_LIBS,'java')
 
-          unless @config.container.kind_of? Liferay
-            info 'Installation of the JAR is only supported on Liferay. Patches are welcome.'
-            info 'Copy the JAR from this directory into the CLASSPATH of the portlet container.'
-            info source
-            exit 1
-          end
-
+          # detect (Liferay) container version
           container_v = @config.container.version
-
           unless container_v
             info 'Unable to detect the version of the portlet container. Installing the latest version.'
           end
 
+          # detect the version of the JAR to install
+          portlet_jar = nil
           version = (
             if container_v and container_v[/^5.1/]
               '0.6.0' #'0.5.2' # FIXME: branch properly
@@ -357,8 +357,21 @@ module Caterpillar
               '0.6.1'
             end
           )
+          require 'find'
+          Find.find(source) do |file|
+            if File.basename(file) == "rails-portlet-#{version}.jar"
+              portlet_jar = file
+            end
+          end
+
+          # check if requirements match
+          unless deployment_requirements_met?
+            info 'Installation of the JAR is only supported on Liferay on Tomcat. Patches are welcome.'
+            info 'Copy this JAR into the CLASSPATH of the portlet container.'
+            info portlet_jar
+            exit 1
+          end
 
-          portlet_jar = nil
           old_jar = nil
           target = File.join(@config.container.WEB_INF,'lib')
 
@@ -368,13 +381,6 @@ module Caterpillar
             exit 1
           end
 
-          require 'find'
-          Find.find(source) do |file|
-            if File.basename(file) =~ /^rails-portlet-#{version}.jar$/
-              portlet_jar = file
-            end
-          end
-
           # check for previous installs..
           Find.find(target) do |file|
             if File.basename(file) =~ /rails-portlet/
@@ -391,7 +397,8 @@ module Caterpillar
           end
 
           exit 1 unless system('cp %s %s' % [portlet_jar,target])
-          info 'installed Rails-portlet version %s (%s)' % [version, File.join(target,portlet_jar)]
+          info 'installed Rails-portlet version %s (%s)' % [
+            version, File.join(target,File.basename(portlet_jar))]
           if old_jar
             exit 1 unless system('rm -f %s' % old_jar)
             info '..removed the old version %s' % old_jar
@@ -406,7 +413,7 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Uninstalls Rails-portlet JAR from the portlet container'
         task :uninstall do
-          raise 'Only Liferay is supported' unless @config.container.kind_of? Liferay
+          raise 'Only Liferay is supported' unless deployment_requirements_met?
           target = File.join(@config.container.WEB_INF,'lib')
 
           # check that target exists
@@ -436,7 +443,7 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Checks the installed Rails-portlet version'
         task :version do
-          raise 'Only Liferay is supported' unless @config.container.kind_of? Liferay
+          raise 'Only Liferay is supported' unless deployment_requirements_met?
           require 'find'
           target = File.join(@config.container.WEB_INF,'lib')
 
@@ -483,8 +490,8 @@ module Caterpillar
           info 'Warbler configuration file %s was not found, exiting' % @config.warbler_conf
           exit 1
         end
-        info 'Building WAR using Warbler %s on JRuby %i (%s)' % [
-          Warbler::VERSION, JRUBY_VERSION, jruby]
+        info 'Building WAR using Warbler %s on JRuby at %s' % [
+          Warbler::VERSION, jruby]
         info ''
         exit 1 unless system(jruby+' -S warble war')
         info 'Warbler finished successfully'
@@ -493,8 +500,12 @@ module Caterpillar
 
     def define_deploy_task
       desc 'Deploy XML files and the application WAR to the portlet container'
+      tasks = []
+
+      # only update the DB if the lportal gem is loaded
+      tasks << 'db:update' if defined?(Lportal)
 
-      tasks = ['db:update', :xml, :warble, 'deploy:xml', 'deploy:war']
+      [:xml, :warble, 'deploy:xml', 'deploy:war'].each { |task| tasks << task }
       task :deploy => tasks
     end
 
@@ -503,7 +514,13 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Deploys the XML files'
         task :xml do
-          raise 'Only deployment to Liferay on Tomcat is supported' unless @config.container.kind_of? Liferay
+          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.'
+            @xml_files.each { |f| info f }
+            exit 1
+          end
+
           target = @config.container.WEB_INF
           info 'deploying XML files to %s' % target
 
@@ -519,19 +536,28 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Deploys the WAR file'
         task :war do
-          raise 'Only deployment to Liferay on Tomcat is supported' unless @config.container.kind_of? Liferay
           file = @config.servlet+'.war'
           unless File.exists?(file)
             info 'cannot find the WAR file %s, exiting' % file
             exit 1
           end
 
-          target = File.join(@config.container.root,'webapps')
+          # check if requirements match
+          unless deployment_requirements_met?
+            info 'Deployment is only supported on Liferay on Tomcat. Patches are welcome.'
+            info 'Copy this WAR file into the portlet container\'s deployment directory.'
+            info file
+            exit 1
+          end
 
-          info '..removing previous installs..'
-          exit 1 unless system('rm -rf %s' % File.join(target,@config.servlet+'*'))
+          target = @config.container.deploy_dir
 
-          info 'deploying the WAR package to %s' % target
+          if File.exists?(File.join(target,File.basename(file)))
+            info '..removing previous installs..'
+            exit 1 unless system('rm -rf %s' % File.join(target,@config.servlet+'*'))
+          end
+
+          info 'deploying the WAR package to %s' % File.join(target,file)
           exit 1 unless system('cp %s %s' % [file,target])
 
         end
@@ -550,6 +576,13 @@ module Caterpillar
 
     protected
 
+    def deployment_requirements_met?
+      @config.container.kind_of? Liferay and (
+        @config.container.server == 'Tomcat' or
+        @config.container.server == 'JBoss/Tomcat'
+      )
+    end
+
     def print_portlets(hash)
       # organize
       _sorted = Util.categorize(hash)

data/lib/load_rails.rb

@@ -0,0 +1,29 @@
+# NOTE: During normal startup (not while building the gem),
+# ActiveRecord should be loaded at this point, before loading any of the models.
+# However, this may conflict later when Rails' rake task activates the boot process.
+# The correct versions should be loaded at this point.
+config_file = File.join(
+  File.expand_path(RAILS_ROOT),
+  'config',
+  'environment.rb'
+)
+if $0[/gem$/] or !File.exist?(config_file)
+  rails_gem_version = nil
+else
+  # Attempt to guess proper Rails version by reading 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]
+end
+
+# Load the proper versions of Rails etc.
+require 'rubygems'
+# gem build fails when activesupport is loaded here
+%w{ actionpack activerecord }.each do |rg|
+# %w{ activesupport actionpack activerecord }.each do |rg|
+  gem(rg, '= '+rails_gem_version) if rails_gem_version
+  require rg
+end
+require 'action_controller'

data/portlet_test_bench/README

@@ -0,0 +1,23 @@
+= Portlet test bench
+
+This application is for testing the portlet features live.
+Caterpillar includes this portlet into a vanilla Rails application:
+
+  rails new_app
+  cd new_app
+  caterpillar pluginize
+
+Edit the config/routes as instructed by the previous command.
+
+The command
+  caterpillar portlets
+
+Should output
+
+ * Portlet configuration ***********************
+Caterpillar
+	Rails-portlet test bench      "portlet_test_bench"	[]
+
+
+Now launch the Webrick server and navigate to http://localhost:3000/caterpillar/test_bench
+

data/portlet_test_bench/controllers/caterpillar/application.rb

@@ -6,6 +6,11 @@ class Caterpillar::ApplicationController < ActionController::Base
 
   before_filter :is_test_selected
 
+  # Rails-portlet does not have session cookie support.
+  # But flash messages require this.
+  #session :disabled => true
+
+  # If controller is not ApplicationController, test is selected.
   def is_test_selected
     @test_is_selected = self.class.to_s[/Application/].nil?
   end

data/portlet_test_bench/controllers/caterpillar/session_controller.rb

@@ -1,57 +1,59 @@
 class Caterpillar::SessionController < Caterpillar::ApplicationController
 
-  def initialize
-
-  end
-
-  def index
-    render :inline => VERSION
-  end
-
-
-  # inspect the session variables
-  def raw
-    render :inline => session.inspect
+  # flash message.
+  def flash_msg
+    flash[:info] = "Flash works."
+    redirect_to :action => :flash_display
   end
 
-
-  # inspect the session cookie
-  def cookie
-
-    s = "<html><body><pre>"
-
-    cookies.each do |cookie|
-#       s += "name: " + cookie[0]
-      s += cookie.inspect
-      s += "<br />"
-#       s += "id: " + cookie[1].to_s
+#   def index
+#     render :inline => VERSION
+#   end
+# 
+# 
+#   # inspect the session variables
+#   def raw
+#     render :inline => session.inspect
+#   end
+# 
+# 
+#   # inspect the session cookie
+#   def cookie
+# 
+#     s = "<html><body><pre>"
+# 
+#     cookies.each do |cookie|
+# #       s += "name: " + cookie[0]
+#       s += cookie.inspect
 #       s += "<br />"
-# cookie.methods.each { |m| s += m.to_s + "<br />" }
-
-    end
-
-    s += "</pre></body></html>"
-    render :inline => s
-  end
-
-  def _id
-    render :inline => session.session_id.inspect
-  end
-
-
-  # inspect the request variables
-  def req
-    s = "<html><body>"
-
-    request.env.each_pair do |key,value|
-      s += key
-      s += " => "
-      s += value unless value.nil?
-      s += "<br />"
-    end
-
-    s += "</body></html>"
-    render :inline => s
-  end
+# #       s += "id: " + cookie[1].to_s
+# #       s += "<br />"
+# # cookie.methods.each { |m| s += m.to_s + "<br />" }
+# 
+#     end
+# 
+#     s += "</pre></body></html>"
+#     render :inline => s
+#   end
+# 
+#   def _id
+#     render :inline => session.session_id.inspect
+#   end
+# 
+# 
+#   # inspect the request variables
+#   def req
+#     s = "<html><body>"
+# 
+#     request.env.each_pair do |key,value|
+#       s += key
+#       s += " => "
+#       s += value unless value.nil?
+#       s += "<br />"
+#     end
+# 
+#     s += "</body></html>"
+#     render :inline => s
+#   end
 
 end

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

@@ -67,12 +67,14 @@ These are isolated test cases of the Rails-portlet. These cases cover the most c
         :controller => 'Caterpillar::Resource', :action => :exit_portlet  -%><br />
 
   <%= link_to 'Liferay session variables',
-        :controller => 'Caterpillar::Liferay', :action => :session_variables -%><br />
-
-
-  <%#= link_to 'Login',
-        :controller => 'Caterpillar::Login', :action => :index  -%><br />
-
+        url_for(
+          :controller => 'Caterpillar::Liferay',
+          :action => :session_variables
+        )+'/uid/%UID%/gid/%GID%'
+  -%><br />
+
+  <%= link_to 'Flash message',
+        :controller => 'Caterpillar::Session', :action => :flash_msg -%><br />
 
 
 </body>

data/portlet_test_bench/views/caterpillar/liferay/session_variables.html.erb

@@ -9,26 +9,30 @@ When the Rails-portlet receives a request where the URL contains keywords %UID%
 </p>
 
 <p>
-  <%= link_to 'UID', url_for(:action => :session_variables)+'/uid/%UID%' -%><br/>
+  <%#= link_to 'UID', url_for(:action => :session_variables)+'/uid/%UID%' -%><br/>
   <%#= link_to 'UID debug', url_for(:action => :session_variables)+'/uid/10000' -%><br/>
   <% if @uid -%>
-    <span style="font-size: 14px;">
+    <span style="font-size: 18px;">
       Received UID: <%= @uid %>
     </span>
+  <% else -%>
+    No UID found!
   <% end -%>
 </p>
 
 <p>
-  <%= link_to 'GID', url_for(:action => :session_variables)+'/gid/%GID%' -%><br/>
+  <%#= link_to 'GID', url_for(:action => :session_variables)+'/gid/%GID%' -%><br/>
   <%#= link_to 'GID debug', url_for(:action => :session_variables)+'/gid/20000' -%><br/>
   <% if @gid -%>
-    <span style="font-size: 14px;">
+    <span style="font-size: 18px;">
       Received GID: <%= @gid %>
     </span>
+  <% else -%>
+    No GID found!
   <% end -%>
 </p>
 
 <p style="font-size: 18px;">
-  <%= link_to 'Reset', :action => :session_variables -%>
+  <%#= link_to 'Reset', :action => :session_variables -%>
 </p>
 

data/portlet_test_bench/views/caterpillar/session/flash_display.html.erb

@@ -0,0 +1,19 @@
+<h1>Flash message:</h1>
+
+<% if flash[:info] -%>
+  <p style="border: 2px solid black; background: #ccff99; padding: 5px; color: green;">
+    <%= flash[:info] %>
+  </p>
+
+  <%= link_to 'GET',
+        :controller => 'Caterpillar::Session', :action => :flash_msg -%><br />
+
+  <% form_tag( :controller => 'Caterpillar::Session', :action => :flash_msg ) do -%>
+    <div><%= submit_tag 'POST' %></div>
+  <% end -%>
+
+
+<% else -%>
+  There is something wrong with flash.
+
+<% end -%>

data/test/generator_test.rb

@@ -0,0 +1,11 @@
+# require 'test_helper'
+require File.dirname(File.expand_path(__FILE__))+'/test_helper'
+
+class GeneratorTest < Caterpillar::TestCase # :nodoc:
+
+  def test_generate
+    
+  end
+
+end
+#sudo gem -y uninstall caterpillar ; gem build caterpillar.gemspec && sudo gem install --no-ri --no-rdoc caterpillar-1.0.4.gem && cd /tmp/ && rm -rf foobar && rails foobar && cd foobar && caterpillar pluginize ; cd ~/dev/rails-portlet/trunk/caterpillar 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: caterpillar
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.5
 platform: ruby
 authors: 
 - Mikael Lammentausta
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 +03:00
+date: 2009-10-05 00:00:00 +03:00
 default_executable: caterpillar
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: lportal
+  name: hpricot
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.18
+        version: 0.6.164
     version: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -46,12 +46,9 @@ files:
 - Rakefile
 - install.rb
 - init.rb
-- lib/java
 - lib/java/rails-portlet-0.6.0.jar
 - lib/java/rails-portlet-0.6.1.jar
-- lib/caterpillar
 - lib/caterpillar/config.rb
-- lib/caterpillar/helpers
 - lib/caterpillar/helpers/liferay.rb
 - lib/caterpillar/navigation.rb
 - lib/caterpillar/usage.rb
@@ -61,38 +58,22 @@ files:
 - lib/caterpillar/util.rb
 - lib/caterpillar/task.rb
 - lib/caterpillar.rb
-- lib/web
+- lib/load_rails.rb
 - lib/web/portlet.rb
-- generators/caterpillar
-- generators/caterpillar/templates
-- generators/caterpillar/templates/stylesheets
-- generators/caterpillar/templates/stylesheets/portlet_test_bench
 - generators/caterpillar/templates/stylesheets/portlet_test_bench/main.css
-- generators/caterpillar/templates/config
 - generators/caterpillar/templates/config/portlets.rb
-- generators/caterpillar/templates/images
-- generators/caterpillar/templates/images/caterpillar
 - generators/caterpillar/templates/images/caterpillar/caterpillar.gif
-- generators/caterpillar/templates/images/portlet_test_bench
 - generators/caterpillar/templates/images/portlet_test_bench/Leafy_Sea_Dragon_1.jpg
 - generators/caterpillar/templates/images/portlet_test_bench/rails.png
 - generators/caterpillar/templates/images/portlet_test_bench/ruby.gif
 - generators/caterpillar/templates/images/portlet_test_bench/java.png
 - generators/caterpillar/templates/images/portlet_test_bench/debug.jpg
-- generators/caterpillar/templates/javascripts
-- generators/caterpillar/templates/javascripts/portlet_test_bench
 - generators/caterpillar/templates/javascripts/portlet_test_bench/main.js
 - generators/caterpillar/caterpillar_generator.rb
 - generators/caterpillar/USAGE
-- db/migrate
-- views/caterpillar
 - views/caterpillar/_navigation.html.erb
 - portlet_test_bench/routing.rb
-- portlet_test_bench/helpers
-- portlet_test_bench/helpers/caterpillar
 - portlet_test_bench/helpers/caterpillar/application_helper.rb
-- portlet_test_bench/controllers
-- portlet_test_bench/controllers/caterpillar
 - portlet_test_bench/controllers/caterpillar/application.rb
 - portlet_test_bench/controllers/caterpillar/resource_controller.rb
 - portlet_test_bench/controllers/caterpillar/session_controller.rb
@@ -102,31 +83,22 @@ files:
 - portlet_test_bench/controllers/caterpillar/user_controller.rb
 - portlet_test_bench/controllers/caterpillar/css_controller.rb
 - portlet_test_bench/controllers/caterpillar/liferay_controller.rb
-- portlet_test_bench/views
-- portlet_test_bench/views/caterpillar
-- portlet_test_bench/views/caterpillar/application
+- portlet_test_bench/README
 - portlet_test_bench/views/caterpillar/application/_back_to_menu.html.erb
 - portlet_test_bench/views/caterpillar/application/index.html.erb
-- portlet_test_bench/views/caterpillar/http_methods
 - portlet_test_bench/views/caterpillar/http_methods/parameter.html.erb
 - portlet_test_bench/views/caterpillar/http_methods/back.html.erb
 - portlet_test_bench/views/caterpillar/http_methods/post_and_redirect.html.erb
 - portlet_test_bench/views/caterpillar/http_methods/post.html.erb
 - portlet_test_bench/views/caterpillar/http_methods/redirect.html.erb
-- portlet_test_bench/views/caterpillar/css
 - portlet_test_bench/views/caterpillar/css/background.html.erb
 - portlet_test_bench/views/caterpillar/css/simple.html.erb
-- portlet_test_bench/views/caterpillar/user
 - portlet_test_bench/views/caterpillar/user/home.html.erb
-- portlet_test_bench/views/caterpillar/session
-- portlet_test_bench/views/caterpillar/resource
+- portlet_test_bench/views/caterpillar/session/flash_display.html.erb
 - portlet_test_bench/views/caterpillar/resource/exit_portlet.html.erb
 - portlet_test_bench/views/caterpillar/resource/images.html.erb
-- portlet_test_bench/views/caterpillar/login
 - portlet_test_bench/views/caterpillar/login/index.html.erb
-- portlet_test_bench/views/caterpillar/liferay
 - portlet_test_bench/views/caterpillar/liferay/session_variables.html.erb
-- portlet_test_bench/views/caterpillar/js
 - portlet_test_bench/views/caterpillar/js/jquery.html.erb
 - portlet_test_bench/views/caterpillar/js/link_to_post.html.erb
 - portlet_test_bench/views/caterpillar/js/prototype.html.erb
@@ -134,13 +106,14 @@ files:
 - portlet_test_bench/views/caterpillar/js/simple.html.erb
 - portlet_test_bench/views/caterpillar/js/dragndrop.html.erb
 - portlet_test_bench/views/caterpillar/js/_scriptaculous_jquery.html.erb
-- portlet_test_bench/views/layouts
 - portlet_test_bench/views/layouts/basic.html.erb
 - README
 - MIT-LICENSE
 - ChangeLog
 has_rdoc: true
 homepage: http://rails-portlet.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -164,11 +137,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rails-portlet
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Caterpillar helps building Rails applications for JSR286 portlets.
 test_files: 
+- test/generator_test.rb
 - test/portlets_test.rb
 - test/liferay_helpers_test.rb
 - test/xml_test.rb