caterpillar 0.9.6 → 0.9.8

data/ChangeLog

@@ -1,3 +1,13 @@
+= 0.9.8
+  - 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
+
+
 = 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

data/README

@@ -1,21 +1,37 @@
 Caterpillar helps you with building Rails applications to be used in Java
 JSR286 portlets. This is possible with the help of Rails-portlet[http://rails-portlet.rubyforge.org].
 
-Rails portlets have been used on Liferay and the helpers offer specialized methods to support better Liferay integration.
-
-This package offers these functionalities:
+Writing Rails portlets for Liferay is great fun!
+Caterpillar tasks offer specialized methods for better Liferay integration:
 
+++xml++ and ++xml:deploy++
  - processes the portlet XML configuration in accordance with the named routes
 See Caterpillar::Config
 
+++jar:install++
+ - installs the Rails-portlet JAR into Liferay's classpath
+
+++deploy++
+ - warbles the application, updates the XML configuration and copies these to Liferay
+
+++pluginize++
  - provides a navigation view in development (you will have to enable it manually)
 See Caterpillar::Navigation
 
+++db:migrate++
  - offers a set of migrations to help with Liferay integration
 
- - provides a Rake task 'fixtures', which imports live data
-   from the production database for testing
+ - patches Web::Portlet in the lportal[http://lportal.rubyforge.org] library, so manipulating
+   portlets is easier. This requires running the migrations.
+
+++fixtures++
+ - imports live data from the production database for testing
+
+
+See the rdoc documentation and caterpillar --describe for the full feature list.
 
 
+Caterpillar is open source! Patches and comments are welcome.
+Join the bugs mailing list (http://rubyforge.org/mailman/listinfo/rails-portlet-bugs) to request help.
 
-See the rdoc documentation and caterpillar --describe for the feature list.
+Caterpillar is written by Mikael Lammentausta for Cel'Amanzi Ltd.

data/lib/caterpillar.rb

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

data/lib/caterpillar/helpers/liferay.rb

@@ -174,9 +174,8 @@ module Helpers
 
 
     # formulates a link that the rails286-portlet will leave unparsed.
-    def link_to_exit_portlet(label, url)
-      raise 'No url given' if url.nil?
-      link_to label, url_to_exit_portlet(url)
+    def link_to_exit_portlet(name, options = {}, html_options = {})
+      link_to(name, url_to_exit_portlet(options), html_options)
     end
 
   end

data/lib/caterpillar/liferay.rb

@@ -26,7 +26,8 @@ module Caterpillar
       File.join(self.root,'webapps','ROOT','WEB-INF')
     end
 
-    def analyze(type)
+    # Reads Liferay portlet descriptor XML files and parses them with Hpricot.
+    def analyze(type=:native)
       require 'hpricot'
       return nil unless type==:native
 
@@ -55,9 +56,28 @@ module Caterpillar
           _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[:id]}']").any?
+        # search the category - horribly ineffective.
+        # the categories is an Array where each raising index is a new subcategory
+        display_xml.search("display/category").each do |c|
+          if (c/"//portlet[@id='#{_p[:id]}']").any?
+            # the portlet is in this category
+            categories = [c['name']]
+
+            # child categories
+            c.search("category").each do |child|
+              categories << child['name']
+            end
+
+            if categories.size > 1
+              _p.update(:categories => categories)
+            else
+              _p.update(:category => categories.first)
+            end
+            # debug
+            #puts _p.inspect
+            #portlets << _p
+
+          end
         end
 
         portlets << _p
@@ -81,12 +101,13 @@ module Caterpillar
       xml = self.xml_header('display')
 
       categories = []
+      # process Rails portlets
       Util.categorize(portlets).each_pair do |category,portlets|
         categories << category
         xml << self.display_template(category,portlets)
       end
 
-      # include other native Liferay categories
+      # include other native Liferay portlets and categories
       if self.WEB_INF
         require 'hpricot'
 
@@ -94,7 +115,7 @@ module Caterpillar
         f=File.open(filename,'r')
         doc = Hpricot.XML(f.read)
         f.close
-        (doc/:category).each do |el|
+        (doc/"display/category").each do |el|
           unless categories.include?(el.attributes['name'])
             xml << '  ' + el.to_original_html + "\n"
           end

data/lib/caterpillar/navigation.rb

@@ -22,8 +22,6 @@ module Caterpillar
   #
   # This will go the body of your layout:
   #   <% if @caterpillar_navigation -%>
-  #     <%= stylesheet_link_tag 'caterpillar/caterpillar' %>
-  #     <%= javascript_include_tag 'caterpillar/caterpillar' %>
   #     <%= render :partial => "caterpillar/navigation" %>
   #   <% end -%>
   #

data/lib/caterpillar/task.rb

@@ -43,7 +43,7 @@ module Caterpillar
       @config = Util.eval_configuration(config)
       yield self if block_given?
       @xml_files = []
-      STDOUT.puts 'Caterpillar v.%s (c) Copyright 2008 Mikael Lammentausta' % VERSION
+      STDOUT.puts 'Caterpillar v.%s (c) Copyright 2008,2009 Mikael Lammentausta' % VERSION
       #STDOUT.puts 'Caterpillar v.%s' % Caterpillar::VERSION
       STDOUT.puts 'Provided under the terms of the MIT license.'
       STDOUT.puts
@@ -481,17 +481,28 @@ module Caterpillar
     protected
 
     def print_portlets(hash)
-      Util.categorize(hash).each_pair do |category,portlets|
-        puts category
+      # organize
+      _sorted = Util.categorize(hash)
+
+      # calculate the longest title
+      longest_title = 0
+      _sorted.each_pair do |category,portlets|
+        x = portlets.sort_by{|p| p[:title].size}.last[:title]
+        longest_title = x.size if x.size > longest_title
+      end
+
+      _sorted.each_pair do |category,portlets|
+        STDOUT.puts category
         portlets.each do |portlet|
           # spaces
           spaces = ''
-          0.upto(50-portlet[:title].size+1) do
+          0.upto((longest_title + 5)-portlet[:title].size) do
             spaces << ' '
           end
 
-          field = :path
-          puts "\t"+ portlet[:title] +spaces+ portlet[field].inspect
+          #field = :path
+          #fields = [:name, :id]
+          STDOUT.puts "\t" + portlet[:title] +spaces+ portlet[:id].inspect + "\t" + portlet[:name].inspect
         end
       end
     end

data/lib/caterpillar/util.rb

@@ -1,5 +1,5 @@
 #--
-# (c) Copyright 2008 Mikael Lammentausta
+# (c) Copyright 2008,2009 Mikael Lammentausta
 # See the file LICENSES.txt included with the distribution for
 # software license details.
 #++
@@ -56,26 +56,35 @@ module Caterpillar
     #  {'Category 1' => [portlets], 'Category 2' => [portlets]}
     def categorize(portlets)
       ret = {}
-# STDERR.puts portlets.first.inspect
 
-      # organize into categories
-      categories = portlets.collect{|p| p[:category]}.uniq.each do |category|
-        # select the portlets in this category
-        _portlets = portlets.select{|p| p[:category]==category}
-        ret.update(category => _portlets)
-      end
+      # organize into main categories
+      categories = portlets.collect{|p| p[:category]}
+      categories << portlets.collect{|p| p[:categories].first if p[:categories]}
+      categories.flatten!.uniq!
 
-# puts ret.inspect
+      categories.each do |category|
+        next if category.nil? # skip nil categories
 
+        # does this category have subcategories?
+        # skip them. TODO: parse internal categories
+        if (portlets.map{|p| (
+          !p[:categories].nil? && \
+          p[:categories].first==category)} & [true] ).any?
+          STDERR.puts '%s has subcategories, skipping' % category.inspect
+          next
+        end
+
+        # select the portlets in this category
+        _portlets = portlets.select do |p|
+          p[:category]==category or (!p[:categories].nil? and p[:categories].include?(category))
+        end
 
-#       {'Zcore' => [], 'Foo' => []}
+        ret.update(category => _portlets)
+      end
 
       return ret
     end
 
-
-
-
     end # static
   end
 end

data/lib/web/portlet.rb

@@ -2,9 +2,35 @@ require 'active_record'
 
 module Web
   class Portlet < ActiveRecord::Base
+
+    @@caterpillar_portlets = nil
+
+    def self.caterpillar_portlets
+      return @@caterpillar_portlets if @@caterpillar_portlets
+
+      config = Caterpillar::Util.eval_configuration
+      config.routes = Caterpillar::Util.parse_routes(config)
+
+      # transform objects
+      portlets = []
+      Caterpillar::Parser.new(config).portlets.each do |p|
+        portlets << self.new(
+          :portletid => p[:name].to_s
+        )
+      end
+
+      @@caterpillar_portlets = portlets
+    end
+
+    def self.find_caterpillar_portlet(name)
+      self.caterpillar_portlets.select{
+        |p| p.name=='%s' % name }.first # find_by_name
+    end
+
     def title
       p = Web::PortletName.find_by_portletid(self.portletid)
       p ? p.title : nil
     end
+
   end
 end

data/views/caterpillar/_navigation.html.erb

@@ -22,12 +22,14 @@
   .caterpillar_navigation {
   background: url('/images/caterpillar.gif') no-repeat;
   padding: 10px 0 0 50px;
-  margin-left: 10px;
-  min-height: 50px;
+  min-height: 55px;
+  overflow: auto;
+  
   filter:alpha(opacity=81);-moz-opacity:.81;opacity:.81;
   /* css3 tags, works on Firefox and Safari */
   -moz-border-radius: 15px;
   -webkit-border-radius: 15px;
+  border-bottom: 1px dotted green;
   }
 
   .caterpillar_navigation ul {
@@ -67,6 +69,14 @@
   -moz-border-radius: 8px;
   -webkit-border-radius: 8px;
   }
+
+  #cp_version {
+  font-style: italic;
+  font-size: 9px;
+  position: absolute;
+  left: 10px;
+  top: 55px;
+  }
 </style>
 
 <div class="caterpillar_navigation">
@@ -115,4 +125,7 @@
       </ul>
     </div>
   <% end -%>
+  <div id="cp_version">
+    Caterpillar v<%= Caterpillar::VERSION -%>
+  </div>
 </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: caterpillar
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.8
 platform: ruby
 authors: 
 - Mikael Lammentausta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-15 00:00:00 +02:00
+date: 2009-02-24 00:00:00 +02:00
 default_executable: caterpillar
 dependencies: 
 - !ruby/object:Gem::Dependency