caterpillar 0.9.8 → 0.9.15

data/ChangeLog

@@ -1,44 +1,67 @@
+= 0.9.15
+	- use rails-portlet 0.6.0 in Liferay 5.1.1
+	- moved all migrations to lportal, now executes lportal migrations
+	- db:rollback and db:migrate required!!
+	- detect the version of Liferay from Lportal::Schema
+	- option to set JRUBY_HOME in the config file
+	- collect data whether portlet is instanceable
+	- exit on error when installing the JAR
+	- notify if the config file does not exist
+	- use Liferay as the default container
+	- load helpers only in Rails environment
+	- Web::Portlet.find_caterpillar_portlet
+	- moved some portlet methods to lportal
+
+
+= 0.9.11
+	- fixed a gem loading bug with Ruby 1.8.5
+	- load helpers only in Rails environment
+	- small random fixes
+
+
 = 0.9.8
-  - fix problem with subcategories in liferay-display.xml
-  - model Rails portlets as Web::Portlets
+	- fix problem with subcategories in liferay-display.xml
+	- model Rails portlets as Web::Portlets
 
 
 = 0.9.7
-  - display version in navigation view
-  - comply link_to_exit_portlet with link_to api
+	- display version in navigation view
+	- comply link_to_exit_portlet with link_to api
 
 
 = 0.9.6
-  - added some tables and a notice to sequence migrations
-  - no longer installs css and javascript files, everything is cramped inline into the view
-  - upgrade lportal dependency to version 1.0.9
+	- added some tables and a notice to sequence migrations
+	- no longer installs css and javascript files, everything is cramped inline into the view
+	- upgrade lportal dependency to version 1.0.9
 
 
 = 0.9.5
-  - portlet xml definition to Liferay 5.2.0 standards
-  - liferay xml files are tagged by selection based on the configured version
-  - portlet jar installation based on Liferay version
-  - Upgrade to rails-portlet 0.6.1 for Liferay 5.2.x
-  - Fixed the sequences migration
-  - include ActionView helpers, raise an error if given exit_portlet url is nil
-  - fixed a small bug with inline JS parsing
+	- portlet xml definition to Liferay 5.2.0 standards
+	- liferay xml files are tagged by selection based on the configured version
+	- portlet jar installation based on Liferay version
+	- Upgrade to rails-portlet 0.6.1 for Liferay 5.2.x
+	- Fixed the sequences migration
+	- include ActionView helpers, raise an error if given exit_portlet url is nil
+	- fixed a small bug with inline JS parsing
 
 
 = 0.9.4
-  - Web::PortletNames migrations + model
-  - random small fixes
+	- Web::PortletNames migrations + model
+	- random small fixes
 
 
 = 0.9.2
-  - fixed a problem with navigation; enhanced css
-  - deployment task
+	- fixed a problem with navigation; enhanced css
+	- deployment task
 
 
 = 0.9.1
 Released at 2008-12-18
-  - task to install the Rails-portlet
+	- task to install the Rails-portlet
 
 
 = 0.9.0
 Released at 2008-12-17
-  - the initial release
+	- the initial release
+
+

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

@@ -1,5 +1,8 @@
 Caterpillar::Config.new do |portlet|
 
+  # JRUBY_HOME can be set here, unless the environment variable can be used.
+  # portlet.class::JRUBY_HOME = '/usr/local/jruby'
+
   # The portlet container.
   # By default only portlet.xml is created.
   # Currently only Liferay is supported. You may optionally define the version.
@@ -43,19 +46,19 @@ Caterpillar::Config.new do |portlet|
   #  - :name        -- named route
   #  - :category    -- portlet category (Liferay only)
   #  - :title       -- the title in portlet container's category (Liferay only)
-  #  - :javascripts -- portlet-specific javascripts that are not in the HTML head section (Liferay only)
-  #  - :host
-  #  - :servlet
+  #  - :javascripts -- portlet-specific javascripts that are included at
+  #                    the head of master HTML, such as body onload functions (Liferay only)
+  #  - :host        -- hostname:port of the deployment server
+  #  - :servlet     -- by default, the name of the Rails app (= name of the WAR package)
   #  - :path        -- unless you're using named routes, you can define the path here
 
-  # example:
-  #   portlet.instances << {
-  #     :name     => 'rails286_test',
-  #     :title    => 'Rails-portlet testing application',
-  #     :category => 'Testing',
-  #     :servlet  => 'RailsTestBench',
-  #     :path     => '/'
-  #   }
+  # Rails-portlet testing application:
+  portlet.instances << {
+    :name     => 'test',
+    :title    => 'Rails-portlet testing application',
+    :category => 'Caterpillar',
+    :path     => '/RailsTestBench'
+  }
 
   # this will include all named routes without further configuration
   portlet.include_all_named_routes = true

data/lib/caterpillar.rb

@@ -1,17 +1,17 @@
 #--
-# (c) Copyright 2008 Mikael Lammentausta
+# (c) Copyright 2008,2009 Mikael Lammentausta
 # See the file LICENSES.txt included with the distribution for
 # software license details.
 #++
 
 module Caterpillar
-  VERSION='0.9.8'
+  VERSION='0.9.15'
 end
 
 this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 this_dir = File.dirname(File.expand_path(this_file))
 
-CATERPILLAR_LIBS=this_dir
+CATERPILLAR_LIBS=this_dir unless defined?(CATERPILLAR_LIBS)
 
 require 'find'
 
@@ -20,6 +20,11 @@ Find.find(this_dir) do |file|
   if FileTest.directory?(file)
     if File.basename(file) == 'deprecated'
       Find.prune # Don't look any further into this directory.
+
+    # load helpers only in Rails environment
+    elsif (!defined?(RAILS_ENV) and (File.basename(file) == 'helpers'))
+      Find.prune
+
     else
       next
     end

data/lib/caterpillar/config.rb

@@ -7,7 +7,8 @@
 module Caterpillar
   # Portlet configuration. The config file 'config/portlets.rb' should be installed in your Rails application. See the comments in the configuration file for more specific information about each option.
   class Config
-    FILE = "config/portlets.rb"
+    FILE = File.join('config','portlets.rb')
+    JRUBY_HOME = nil # override in the config file if necessary
 
     # Are all named routes used, or only the ones specifically defined in the config FILE?
     attr_accessor :include_all_named_routes
@@ -30,6 +31,8 @@ module Caterpillar
 
     attr_accessor :warbler_conf
 
+    attr_accessor :logger
+
     # Sets sane defaults that are overridden in the config file.
     def initialize
       @rails_root  = File.expand_path(defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)
@@ -39,15 +42,17 @@ module Caterpillar
       @javascripts = []
       @include_all_named_routes = true
       @warbler_conf = File.join(@rails_root,'config','warble.rb')
+      STDERR.puts 'Warbler configuration file could not be found' unless File.exists?(@warbler_conf)
+      #@logger  = (defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new)
 
       yield self if block_given?
     end
 
     # The container class is used for parsing XML files.
     #
-    # Possible values: Liferay
+    # Possible values: Liferay (default)
     def container
-      self._container
+      self._container || Caterpillar::Liferay.new
     end
 
     # Accepts the configuration option, and instantates the container class.

data/lib/caterpillar/helpers/liferay.rb

@@ -1,15 +1,31 @@
+require 'rubygems'
+require 'action_controller'
+
 module Caterpillar
 module Helpers
+  # This module contains Rails helpers that provide methods to deal with various aspects
+  # of portlet functionality in Liferay.
+  #
+  # Currently this consists of things that were constructed whenever needed during development,
+  # and concidered general enough to be included here.
+  #
+  # link_to_liferay is deprecated, and is clearly a wrong way to solve the problem in question.
+  # A better way has been constructed, but it is not perfect due to its dependency on a specific portlet.
   module Liferay
     include ActionView::Helpers::UrlHelper
     include ActionView::Helpers::TagHelper
 
-    # Formulates a link to Liferay.
+    # Link that the rails-portlet will leave unparsed.
+    def link_to_exit_portlet(name, options = {}, html_options = {})
+      link_to(name, url_to_exit_portlet(options), html_options)
+    end
+
+    # Formulates a link to Liferay. DEPRECATED.
+    #
     # Parameters:
     #  - obj is an instance of a model from the lportal library.
     #  - options
     def link_to_liferay(obj,options={})
-      options.update(:use_large_igpreview => false) unless options[:use_large_igpreview]
 
       # Rails-portlet cannot pass the actual redirect parameter.
       # Workaround with JavaScript.
@@ -17,68 +33,33 @@ module Helpers
 
       title = 'n/a' # link title
       begin
-        STDERR.puts 'This method is DEPRECATED - use obj.path instead'
         logger.debug "Formulating Liferay link for #{obj}"
         case obj.liferay_class
 
         ### group
         when 'com.liferay.portal.model.Group'
-#           title = (obj.name.empty? ? obj.owner.fullname : obj.name)
-#           urls = LiferayUrl.new(obj,nil,nil).static_url
-#           logger.debug urls
-#           if options[:private]
-#             label = _('yksityiset sivut')
-#             urls[:private] ?
-#               link_to_exit_portlet( label, urls[:private] ) :
-#               link_to_function(
-#                 label, "alert('%s')" % _('Yhteisöllä ei ole yksityisiä sivuja'))
-#           else
-#             label = _('julkiset sivut')
-#             urls[:public] ?
-#               link_to_exit_portlet( label, urls[:public] ) :
-#               link_to_function(
-#                 label, "alert('%s')" % _('Yhteisöllä ei ole julkisia sivuja'))
-#           end
-
-
-# siirretty malliin
-#         when 'com.liferay.portal.model.Layout'
-#           url = LiferayUrl.new(obj).static_url
-#           return url_to_exit_portlet(url)
+          STDERR.puts 'Called DEPRECATED method - use %s.path instead' % obj
+
+
+        when 'com.liferay.portal.model.Layout'
+          STDERR.puts 'Called DEPRECATED method - use %s.path instead' % obj
 
 
         ### user
         when 'com.liferay.portal.model.User'
-#           urls = LiferayUrl.new(obj,nil,nil).static_url
-#           #logger.debug urls
-#           if options[:private]
-#             label = options[:label]
-#             label ||= _('yksityiset sivut')
-#             urls[:private] ?
-#               link_to_exit_portlet( label, urls[:private] ) :
-#               link_to_function(
-#                 label, "alert('%s')" % _('Tunnuksella ei ole yksityisiä sivuja'))
-#           else
-#             label = options[:label] || _('julkiset sivut')
-#             urls[:public] ?
-#               link_to_exit_portlet( label, urls[:public] ) :
-#               link_to_function(
-#                 label, "alert('%s')" % _('Tunnuksella ei ole julkisia sivuja'))
-#           end
+          STDERR.puts 'Called DEPRECATED method - use %s.path instead' % obj
 
 
         ### blog
         when 'com.liferay.portlet.blogs.model.BlogsEntry'
-#           title = _('Linkki blogimerkintään "%s"') % obj.title
-#           url = LiferayUrl.new(obj,@user,redirect).instance_url
-#           link_to_exit_portlet( title, url )
-
+          STDERR.puts 'FIXME: %s.path' % obj
 
         ### document library file
         #
         # tämä toimii hiukan eri logiikalla kuin toiset, koska
         # sama malli joutuu mallintamaan myös tyyppinsä tiedostopäätteestä
         when 'com.liferay.portlet.documentlibrary.model.DLFileEntry'
+          STDERR.puts 'Called DEPRECATED method - use %s.path instead' % obj
           redirect_link=request.env["PATH_INFO"] # ei toimi portletissa
 
           label = 'Tiedostotyyppiä %s ei vielä tueta' % obj.type[:name]
@@ -105,7 +86,9 @@ module Helpers
 
         ### galleriakuva
         when 'com.liferay.portlet.imagegallery.model.IGImage'
+          STDERR.puts 'FIXME: %s.path' % obj
           base_url = "#{$LIFERAY_SERVER}/image/image_gallery"
+          options.update(:use_large_igpreview => false) unless options[:use_large_igpreview]
           img_id = (options[:use_large_igpreview] == true ? obj.large.id : obj.small.id)
 
           img = link_to_exit_portlet(
@@ -117,48 +100,47 @@ module Helpers
 
 
         when 'com.liferay.portlet.journal.model.JournalArticle'
+          STDERR.puts 'FIXME: %s.path' % obj
           url = LiferayUrl.new(obj,@user,redirect).instance_url
           link_to_exit_portlet( _('Lue koko artikkeli "%s"') % obj.asset.title, url )
 
         when 'com.liferay.portlet.messageboards.model.MBCategory'
-#           url = LiferayUrl.new(obj,@user,redirect).static_url
-#           link_to_exit_portlet( obj.name, url )
+          STDERR.puts 'Called DEPRECATED method - use %s.path instead' % obj
 
 
         when 'com.liferay.portlet.messageboards.model.MBMessage'
+          STDERR.puts 'FIXME: %s.path' % obj
           url = LiferayUrl.new(obj,@user,redirect).instance_url
           link_to_exit_portlet( _('Lue viesti "%s"') % obj.asset.title, url )
 
   #       when 'com.liferay.portlet.messageboards.model.MBThread'
 
-        when 'com.liferay.portlet.wiki.model.WikiNode'
-          logger.debug "WikiNode"
-  #         url = LiferayUrl.new(obj,@user,redirect).instance_url
-  #         link_to_exit_portlet( _('Lue sivu "%s"') % obj.asset.title, url )
-
         when 'com.liferay.portlet.wiki.model.WikiPage'
-          logger.debug "WikiPage"
+          STDERR.puts 'FIXME: %s.path' % obj
           url = LiferayUrl.new(obj,@user,redirect).instance_url
           link_to_exit_portlet( _('Lue sivu "%s"') % obj.asset.title, url )
 
         else
-          logger.debug obj.liferay_class
-          raise _('Tämän tyyppistä linkkiä ei vielä hallita')
+          STDERR.puts 'Called DEPRECATED method, but no method can handle %s' % obj
+          raise _('This type of link cannot be handled.')
 
         end
 
       rescue Exception => err
         logger.error '*** ERROR ***: %s' % err.message
-        link_to_function( _('Kohteeseen ei voi linkittää.'), "alert('#{err.message}')" )
+        link_to_function( _('Cannot link to resource.'), "alert('#{err.message}')" )
       end
     end
 
 
+    # Appends parameters "exit_portlet=true" into the url.
+    # Url might be either Hash or String.
     def url_to_exit_portlet(url)
-      directive = { :exit_portlet => 'true' }
+      parameters = { :exit_portlet => 'true' }
 
+      # append parameters to the url
       if url.is_a? Hash
-        url.update directive
+        url.update parameters
 
       elsif url.is_a? String
         if url[/\?[\w]*\=/]     # url has parameters
@@ -166,18 +148,12 @@ module Helpers
         else                    # no parameters
           delimiter = '?'
         end
-        url += "#{delimiter}#{directive.keys.first}=#{directive.values.first}"
+        url += "#{delimiter}#{parameters.keys.first}=#{parameters.values.first}"
 
       end
       return url
     end
 
-
-    # formulates a link that the rails286-portlet will leave unparsed.
-    def link_to_exit_portlet(name, options = {}, html_options = {})
-      link_to(name, url_to_exit_portlet(options), html_options)
-    end
-
   end
 end
 end

data/lib/caterpillar/liferay.rb

@@ -15,8 +15,17 @@ module Caterpillar
     # the installation directory
     attr_accessor :root
 
-    def initialize(version='5.1.1')
+    # Liferay version is given as a String, eg. '5.2.2'.
+    # Unless given, the latest buildnumber value in the release_ table is used to decipher the version.
+    def initialize(version=nil)
+      
       @version = version
+      @root    = '/usr/local/liferay'
+    end
+
+    # The name of the portal. Used in STDOUT messages.
+    def name
+      'Liferay'
     end
 
     # The location of Liferay's WEB-INF folder for XML analyzation.
@@ -51,9 +60,15 @@ module Caterpillar
           :title => (portlet/'display-name').innerHTML
         }
 
-        # search the name
+        # search portlet metadata
         portlet_xml.search("//portlet-name").each do |p|
-          _p.update(:name => (p/"../struts-path").text) if p.innerHTML==_p[:id]
+          if p.innerHTML==_p[:id]
+            _p.update(:name => (p/"../struts-path").text)
+
+            # is the portlet instanceable?
+            # it seems that if undefined, the default is "false"
+            _p.update(:instanceable => (p/"../instanceable").text=='true')
+          end
         end
 
         # search the category - horribly ineffective.

data/lib/caterpillar/parser.rb

@@ -8,6 +8,8 @@ module Caterpillar
   # Portlet configuration and route parser.
   class Parser
 
+#     include ActionController::Assertions::RoutingAssertions
+
     def initialize(config)
       @config = config
       @routes = config.routes
@@ -30,10 +32,16 @@ module Caterpillar
           # parse the requirements - controller & action
           # ( this is too difficult -- no navigation for user-given paths )
           #
-          # builder = ActionController::Routing::RouteBuilder.new
-          # req_path = builder.segments_for_route_path(path)
-          # r = ActionController::Routing::Routes.recognize_path(req_path, { :method => :get })
-          # puts r.inspect
+#           begin
+#             #recognized_request_for(path)
+#             #builder = ActionController::Routing::RouteBuilder.new
+#             #r = ActionController::Routing::Routes.recognize_path(path, { :method => :get })
+#             #puts r.inspect
+#             #req_path = builder.segments_for_route_path(r)
+#             #STDERR.puts req_path.inspect
+#           rescue
+#             STDERR.puts $!.message
+#           end
 
           portlet.update( :reqs => {} )
           portlet.update( :vars => [] )
@@ -54,7 +62,13 @@ module Caterpillar
           portlet.update( :reqs => _r.first[:reqs] )
 
           ### variables
-          portlet.update( :vars => _r.first[:vars] )
+          # take just the ones that are required in the path!
+          vars = []
+          _r.first[:vars].each do |var|
+            # variables that are not defined in reqs are required to be inserted by the rails-portlet
+            vars << var unless _r.first[:reqs][var]
+          end
+          portlet.update( :vars => vars )
 
           # delete the route from routes
           _r.each do |r|
@@ -81,13 +95,13 @@ module Caterpillar
       # sanity check
       portlets.each do |portlet|
         ### hostname
-        portlet.update( :host => @config.host ) unless portlet[:host]
+        portlet[:host] ||= @config.host
 
         ### servlet
-        portlet.update( :servlet => @config.servlet ) unless portlet[:servlet]
+        portlet[:servlet] ||= @config.servlet
 
         ### category
-        portlet.update( :category => @config.category ) unless portlet[:category]
+        portlet[:category] ||= @config.category
 
         ### title
         _title = portlet[:title] || portlet[:name].to_s.gsub('_',' ').capitalize
@@ -95,8 +109,8 @@ module Caterpillar
         title = _title.gsub(/ä/,'a').gsub(/ö/,'o').gsub(/Ä/,'A').gsub(/Ö/,'O')
         portlet.update( :title => title )
 
-        ### javascripts
-        portlet.update( :javascripts => @config.javascripts ) unless portlet[:javascripts]
+        ### unless defined, use default javascripts
+        portlet[:javascripts] ||= @config.javascripts
 
         # fix path variables to be replaced by rails-portlet at runtime
         path = portlet[:path]