caterpillar 0.9.2 → 0.9.4

data/ChangeLog

@@ -1,3 +1,8 @@
+= 0.9.4
+  - Web::PortletNames migrations + model
+  - random small fixes
+
+
 = 0.9.2
   - fixed a problem with navigation; enhanced css
   - deployment task
@@ -10,4 +15,4 @@ Released at 2008-12-18
 
 = 0.9.0
 Released at 2008-12-17
-  - the initial release
+  - the initial release

data/db/migrate/20081205000001_portlet_names.rb

@@ -0,0 +1,17 @@
+class PortletNames < ActiveRecord::Migration
+  def self.up
+    # dealing with tables that have no id is a pain with ActiveRecord,
+    # and using the 'id' column for portletid does not work either,
+    # ActiveRecord does not let that column to be set manually.
+    create_table :portlet_names do |t|
+      t.column :portletid, :string, :null => false
+      t.column :name,      :string, :null => false
+      t.column :title,     :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :portlet_names
+    #ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS portlet_names")
+  end
+end

data/db/migrate/20081205000002_lportal_sequences.rb

@@ -4,6 +4,8 @@ class LportalSequences < ActiveRecord::Migration
   @@tables = [
     Account,
     Address,
+    Announcement::Delivery,
+    Announcement::Entry,
     Asset,
     Contact,
     Group,

data/lib/caterpillar.rb

@@ -5,7 +5,7 @@
 #++
 
 module Caterpillar
-  VERSION='0.9.2'
+  VERSION='0.9.4'
 end
 
 this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__

data/lib/caterpillar/helpers/liferay.rb

@@ -0,0 +1,183 @@
+module Caterpillar
+module Helpers
+  module Liferay
+#     include ActionView::Helpers::UrlHelper
+#     include ActionView::Helpers::TagHelper
+
+    # Formulates a link to Liferay.
+    # 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.
+      redirect = 'javascript: history.go(-1)'
+
+      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)
+
+
+        ### 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
+
+
+        ### 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 )
+
+
+        ### 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'
+          redirect_link=request.env["PATH_INFO"] # ei toimi portletissa
+
+          label = 'Tiedostotyyppiä %s ei vielä tueta' % obj.type[:name]
+            #_('Lataa tiedosto "%s"') % obj.asset.title
+          case obj.type[:uuid]
+            when :video
+              label = _('Linkki videoon "%s"') % obj.asset.title
+              link_to_exit_portlet( label, url_for(
+                { :controller => :video,
+                  :action => :asset,
+                  :id => obj.asset.id,
+                  :uid => @user.id,
+                  :redirect => redirect_link
+                }))
+
+            when :pdf
+              label = _('Linkki dokumenttiin "%s"') % obj.asset.title
+              redirect = ''
+              url = LiferayUrl.new(obj,nil,redirect).static_url
+              link_to_exit_portlet( label, url )
+
+          end
+
+
+        ### galleriakuva
+        when 'com.liferay.portlet.imagegallery.model.IGImage'
+          base_url = "#{$LIFERAY_SERVER}/image/image_gallery"
+          img_id = (options[:use_large_igpreview] == true ? obj.large.id : obj.small.id)
+
+          img = link_to_exit_portlet(
+            image_tag( "#{base_url}?img_id=#{img_id}", :alt => obj.description, :class => 'asset_image' ),
+            "#{base_url}?img_id=#{obj.large.id}"
+          )
+          logger.debug img
+          return img
+
+
+        when 'com.liferay.portlet.journal.model.JournalArticle'
+          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 )
+
+
+        when 'com.liferay.portlet.messageboards.model.MBMessage'
+          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"
+          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')
+
+        end
+
+      rescue Exception => err
+        logger.error '*** ERROR ***: %s' % err.message
+        link_to_function( _('Kohteeseen ei voi linkittää.'), "alert('#{err.message}')" )
+      end
+    end
+
+
+    def url_to_exit_portlet(url)
+      directive = { :exit_portlet => 'true' }
+
+      if url.is_a? Hash
+        url.update directive
+
+      elsif url.is_a? String
+        if url[/\?[\w]*\=/]     # url has parameters
+          delimiter = '&'
+        else                    # no parameters
+          delimiter = '?'
+        end
+        url += "#{delimiter}#{directive.keys.first}=#{directive.values.first}"
+
+      end
+      return url
+    end
+
+
+    # formulates a link that the rails286-portlet will leave unparsed.
+    def link_to_exit_portlet(label, url)
+      link_to label, url_to_exit_portlet(url)
+    end
+
+  end
+end
+end

data/lib/caterpillar/liferay.rb

@@ -33,6 +33,10 @@ module Caterpillar
       portlets = []
 
       f=File.open(self.WEB_INF+'/portlet-custom.xml','r')
+      custom_xml = Hpricot.XML(f.read)
+      f.close
+
+      f=File.open(self.WEB_INF+'/liferay-portlet.xml','r')
       portlet_xml = Hpricot.XML(f.read)
       f.close
 
@@ -40,15 +44,20 @@ module Caterpillar
       display_xml = Hpricot.XML(f.read)
       f.close
 
-      (portlet_xml/'portlet').each do |portlet|
+      (custom_xml/'portlet').each do |portlet|
         _p = {
-          :name  => (portlet/'portlet-name').innerHTML,
+          :id    => (portlet/'portlet-name').innerHTML,
           :title => (portlet/'display-name').innerHTML
         }
 
-        # horribly ineffective
+        # search the name
+        portlet_xml.search("//portlet-name").each do |p|
+          _p.update(:name => (p/"../struts-path").text) if p.innerHTML==_p[:id]
+        end
+
+        # search the category - horribly ineffective
         display_xml.search("//category").each do |c|
-          _p.update(:category => c['name'] ) if (c/"//portlet[@id='#{_p[:name]}']").any?
+          _p.update(:category => c['name'] ) if (c/"//portlet[@id='#{_p[:id]}']").any?
         end
 
         portlets << _p
@@ -167,7 +176,7 @@ module Caterpillar
     # tables that are skipped when creating fixtures
     def skip_fixture_tables
       [
-        "country","cyrususer","cyrusvirtual",
+        "cyrususer","cyrusvirtual",
         "documentlibrary_fsentry","documentlibrary_binval","documentlibrary_node","documentlibrary_prop","documentlibrary_refs",
         "expandocolumn",
         "expandorow",
@@ -177,10 +186,6 @@ module Caterpillar
         "chat_entry",
         "chat_status",
         "journalcontentsearch",
-        "journalfeed",
-        "journalstructure",
-        "journaltemplate",
-        "listtype",
         "mbban",
         "mbmessageflag",
         "mbstatsuser",
@@ -190,9 +195,6 @@ module Caterpillar
         "passwordpolicy",
         "passwordtracker",
         "pluginsetting",
-        "pollschoice",
-        "pollsquestion",
-        "pollsvote",
         "quartz_blob_triggers",
         "quartz_calendars",
         "quartz_cron_triggers",
@@ -238,4 +240,4 @@ module Caterpillar
     end
 
   end
-end
+end

data/lib/caterpillar/task.rb

@@ -238,13 +238,15 @@ module Caterpillar
           ActiveRecord::Migrator.migrate(
             File.expand_path(
               File.dirname(__FILE__) + "/../../db/migrate"))
-  #         Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+          STDOUT.puts 'Now, run rake db:schema:dump'
+          #Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
 
           @portlets = config.container.analyze(:native)
           @portlets.each do |portlet|
-            LiferayPortlet.create(
-              :name => portlet[:name],
-              :title => portlet[:title]
+            Web::PortletName.create(
+              :portletid => portlet[:id],
+              :name      => portlet[:name],
+              :title     => portlet[:title]
             )
           end
         end
@@ -261,7 +263,8 @@ module Caterpillar
           ActiveRecord::Migrator.migrate(
             File.expand_path(
               File.dirname(__FILE__) + "/../../db/migrate"), version)
-  #         Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+          STDOUT.puts 'Now, run rake db:schema:dump'
+          #Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
         end
       end
     end
@@ -274,16 +277,17 @@ module Caterpillar
           raise 'Only Liferay is supported' unless @config.container.kind_of? Liferay
           require 'find'
 
+          #version = '0.5.2'
+          version = '0.6.0'
+
           portlet_jar = nil
           old_jar = nil
-          version = nil
           source = File.join(CATERPILLAR_LIBS,'java')
           target = File.join(@config.container.WEB_INF,'lib')
 
           Find.find(source) do |file|
-            if File.basename(file) =~ /rails-portlet/
+            if File.basename(file) =~ /rails-portlet-#{version}/
               portlet_jar = file
-              version = file[/(\d.\d.\d).jar/,1]
             end
           end
 
@@ -361,10 +365,20 @@ module Caterpillar
     end
 
 
-
+    # Using JRuby to build the WAR file is necessary, as MRI Ruby can build broken files, even with the same set of rubygems.
+    # Especially gettext seems to be a problem.
     def define_warble_task
       desc 'Create a WAR package with Warbler'
       task :warble do
+        unless ENV['JRUBY_HOME']
+          info 'Environment variable JRUBY_HOME is not set, exiting'
+          exit 1
+        end
+        jruby = File.join(ENV['JRUBY_HOME'],'bin','jruby')
+        unless File.exists?(jruby)
+          info 'JRuby executable was not found in %s, exiting' % jruby
+          exit 1
+        end
         unless system('which warble')
           info 'Warbler was not found in PATH, exiting'
           exit 1
@@ -373,14 +387,9 @@ module Caterpillar
           info 'Warbler configuration file %s was not found, exiting' % @config.warbler_conf
           exit 1
         end
-        info 'building WAR package'
-
-        system('ruby -S warble war')
+        info 'building WAR package using JRuby (%s)' % jruby
+        system(jruby+' -S warble war')
 
-        unless File.exists?(@config.servlet+'.war')
-          info 'cannot find the WAR file, exiting'
-          exit 1
-        end
       end
     end
 

data/lib/web/portlet.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+
+module Web
+  class Portlet < ActiveRecord::Base
+    def title
+      p = Web::PortletName.find_by_portletid(self.portletid)
+      p ? p.title : nil
+    end
+  end
+end

data/lib/web/portlet_name.rb

@@ -2,7 +2,7 @@ require 'active_record'
 
 module Web # :nodoc:
   # This model does not appear in the lportal database. This is created by a migration and contains the portlet id => name mappings.
-  class PortletName < ActiveRecord::Base # :nodoc:
-    set_table_name       :web_portlet_names
+  class PortletName < ActiveRecord::Base
+    set_table_name       :portlet_names
   end
 end

data/lib/web/portlet_preferences.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+
+module Web
+  class PortletPreferences < ActiveRecord::Base
+    def title
+      p = Web::PortletName.find_by_portletid(self.name)
+      p ? p.title : nil
+    end
+  end
+end

data/test/liferay_helpers_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+require File.dirname(File.expand_path(__FILE__))+'/test_helper'
+
+class LiferayHelpersTest < Caterpillar::TestCase # :nodoc:
+  def test_link_to_liferay
+    user = User.first
+
+    flunk
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: caterpillar
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors: 
 - Mikael Lammentausta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-19 00:00:00 +02:00
+date: 2009-01-23 00:00:00 +02:00
 default_executable: caterpillar
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,11 +47,16 @@ files:
 - install.rb
 - init.rb
 - lib/java
+- lib/java/rails-portlet-0.6.0.jar
 - lib/java/rails-portlet-0.5.2.jar
+- lib/java/commons-httpclient-3.1.jar
+- lib/java/htmlparser-1.6.jar
+- lib/java/commons-codec-1.3.jar
 - lib/caterpillar
 - lib/caterpillar/config.rb
+- lib/caterpillar/helpers
+- lib/caterpillar/helpers/liferay.rb
 - lib/caterpillar/navigation.rb
-- lib/caterpillar/liferay_portlet.rb
 - lib/caterpillar/usage.rb
 - lib/caterpillar/liferay.rb
 - lib/caterpillar/portlet.rb
@@ -61,6 +66,8 @@ files:
 - lib/caterpillar.rb
 - lib/web
 - lib/web/portlet_name.rb
+- lib/web/portlet_preferences.rb
+- lib/web/portlet.rb
 - generators/caterpillar
 - generators/caterpillar/templates
 - generators/caterpillar/templates/stylesheets
@@ -77,7 +84,7 @@ files:
 - generators/caterpillar/caterpillar_generator.rb
 - generators/caterpillar/USAGE
 - db/migrate
-- db/migrate/20081205000001_lportal_portlets.rb
+- db/migrate/20081205000001_portlet_names.rb
 - db/migrate/20081205000002_lportal_sequences.rb
 - views/caterpillar
 - views/caterpillar/_navigation.html.erb
@@ -91,7 +98,6 @@ rdoc_options:
 - README
 - --line-numbers
 - --inline-source
-- -U
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -115,4 +121,5 @@ specification_version: 2
 summary: Caterpillar helps building Rails applications for JSR286 portlets.
 test_files: 
 - test/portlets_test.rb
+- test/liferay_helpers_test.rb
 - test/xml_test.rb

data/db/migrate/20081205000001_lportal_portlets.rb

@@ -1,12 +0,0 @@
-class LportalPortlets < ActiveRecord::Migration
-  def self.up
-    create_table :lportal_portlets do |t|
-      t.column :name,  :string
-      t.column :title, :string
-    end
-  end
-
-  def self.down
-    drop_table :lportal_portlets
-  end
-end

data/lib/caterpillar/liferay_portlet.rb

@@ -1,8 +0,0 @@
-require 'active_record'
-
-module Caterpillar
-  # This model does not appear in the lportal database. This is created by a migration and contains the portlet id => name mappings.
-  class LiferayPortlet < ActiveRecord::Base
-    set_table_name :lportal_portlets
-  end
-end