caterpillar 0.9.0

data/lib/caterpillar/liferay.rb

@@ -0,0 +1,235 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  # Creates liferay-portlet XML and liferay-display XML.
+  # The latter optionally combines your production portlet display configuration.
+  class Liferay
+
+    # Liferay version
+    attr_accessor :version
+
+    # The location of Liferay's WEB-INF folder for XML analyzation
+    attr_accessor :WEB_INF
+
+    def initialize(version='5.1.1')
+      @version = version
+    end
+
+    def analyze(type)
+      raise 'Configure WEB-INF' unless self.WEB_INF
+      require 'hpricot'
+      return nil unless type==:native
+
+      portlets = []
+
+      f=File.open(self.WEB_INF+'/portlet-custom.xml','r')
+      portlet_xml = Hpricot.XML(f.read)
+      f.close
+
+      f=File.open(self.WEB_INF+'/liferay-display.xml','r')
+      display_xml = Hpricot.XML(f.read)
+      f.close
+
+      (portlet_xml/'portlet').each do |portlet|
+        _p = {
+          :name  => (portlet/'portlet-name').innerHTML,
+          :title => (portlet/'display-name').innerHTML
+        }
+
+        # horribly ineffective
+        display_xml.search("//category").each do |c|
+          _p.update(:category => c['name'] ) if (c/"//portlet[@id='#{_p[:name]}']").any?
+        end
+
+        portlets << _p
+      end
+      return portlets
+    end
+
+    # liferay-portlet XML
+    def portletapp_xml(portlets)
+      doctype = 'liferay-portlet-app'
+      xml = self.xml_header(doctype)
+      portlets.each do |p|
+        xml << self.portletapp_template(p)
+      end
+      xml << self.portlet_xml_footer(doctype)
+      return xml
+    end
+
+    # liferay-display XML
+    def display_xml(portlets)
+      xml = self.xml_header('display')
+
+      categories = []
+      Util.categorize(portlets).each_pair do |category,portlets|
+        categories << category
+        xml << self.display_template(category,portlets)
+      end
+
+      # include other native Liferay categories
+      if self.WEB_INF
+        require 'hpricot'
+
+        filename = self.WEB_INF+'/liferay-display.xml'
+        f=File.open(filename,'r')
+        doc = Hpricot.XML(f.read)
+        f.close
+        (doc/:category).each do |el|
+          unless categories.include?(el.attributes['name'])
+            xml << '  ' + el.to_original_html + "\n"
+          end
+        end
+      end
+
+      xml << self.portlet_xml_footer('display')
+      return xml
+    end
+
+    protected
+
+    # common XML header
+    def xml_header(doctype)
+      version = self.dtd_version(doctype)
+      xml =  '<?xml version="1.0" encoding="UTF-8"?>'
+      xml << "\n"
+      xml << '<!DOCTYPE %s PUBLIC' % doctype
+      case doctype
+      when 'liferay-portlet-app'
+        xml << '  "-//Liferay//DTD Portlet Application %s//EN"' % version
+        xml << '  "http://www.liferay.com/dtd/%s_%s.dtd">' % [
+        doctype, version.gsub('.','_') ]
+      when 'display'
+        xml << '  "-//Liferay//DTD Display %s//EN"' % version
+        xml << '  "http://www.liferay.com/dtd/liferay-%s_%s.dtd">' % [
+        doctype, version.gsub('.','_') ]
+      end
+      xml << "\n\n"
+      xml << '<%s>' % doctype
+      xml << "\n"
+      return xml
+    end
+
+    # common XML footer
+    def portlet_xml_footer(doctype)
+      '</%s>' % doctype
+    end
+
+    # TODO: DTD version detection based on self.version
+    def dtd_version(type)
+      case type
+      when 'liferay-portlet-app'
+        '5.1.0'
+      when 'display'
+        '5.1.0'
+      end
+    end
+
+    def portletapp_template(portlet)
+      xml =  "  <portlet>\n"
+      xml << "    <portlet-name>%s</portlet-name>\n" % portlet[:name]
+      xml << "    <icon>/%s/images/icon.png</icon>\n" % portlet[:servlet]
+      # can there be several portlet instances on the same page?
+      xml << "    <instanceable>true</instanceable>\n"
+      # include javascripts?
+      portlet[:javascripts].each do |js|
+        xml << "    <header-portal-javascript>"
+        xml << "/%s/javascripts/%s" % [portlet[:servlet],js]
+        xml << "</header-portal-javascript>\n"
+      end
+      xml << "  </portlet>\n\n"
+    end
+
+    def display_template(category,portlets)
+      xml = '  <category name="%s">' % category +"\n"
+
+      portlets.each do |p|
+        xml << '    <portlet id="%s" />' % p[:name]
+        xml << "\n"
+      end
+      xml << "  </category>\n\n"
+
+      return xml
+    end
+
+    public
+
+    # tables that are skipped when creating fixtures
+    def skip_fixture_tables
+      [
+        "country","cyrususer","cyrusvirtual",
+        "documentlibrary_fsentry","documentlibrary_binval","documentlibrary_node","documentlibrary_prop","documentlibrary_refs",
+        "expandocolumn",
+        "expandorow",
+        "expandotable",
+        "expandovalue",
+        "image",
+        "chat_entry",
+        "chat_status",
+        "journalcontentsearch",
+        "journalfeed",
+        "journalstructure",
+        "journaltemplate",
+        "listtype",
+        "mbban",
+        "mbmessageflag",
+        "mbstatsuser",
+        "membershiprequest",
+        "orglabor",
+        "passwordpolicyrel",
+        "passwordpolicy",
+        "passwordtracker",
+        "pluginsetting",
+        "pollschoice",
+        "pollsquestion",
+        "pollsvote",
+        "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",
+        "release_",
+        "scframeworkversion",
+        "scframeworkversi_scproductvers",
+        "schema_migrations",
+        "sclicenses_scproductentries",
+        "sclicense",
+        "scproductentry",
+        "scproductscreenshot",
+        "scproductversion",
+        "servicecomponent",
+        "sessions",
+        "shoppingcart",
+        "shoppingcategory",
+        "shoppingcoupon",
+        "shoppingitemfield",
+        "shoppingitemprice",
+        "shoppingitem",
+        "shoppingorderitem",
+        "shoppingorder",
+        "socialactivity",
+        "socialrelation",
+        "subscription",
+        "tasksproposal",
+        "tasksreview",
+        "webdavprops",
+        "website"
+      ]
+    end
+
+  end
+end

data/lib/caterpillar/liferay_portlet.rb

@@ -0,0 +1,8 @@
+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

data/lib/caterpillar/navigation.rb

@@ -0,0 +1,40 @@
+module Caterpillar
+  # Portlet navigation on Rails.
+  #
+  # Caterpillar installs a partial 'caterpillar/navigation' into your views,
+  # along with an image and a CSS file.
+  # You need to add a filter 'caterpillar' which you will only load in
+  # development environment - in production the portlet container will be the
+  # 'window manager'. This partial helps you to navigate between your portlets.
+  #
+  # This will go to your ApplicationController:
+  #   if RAILS_ENV=='development'
+  #     before_filter :caterpillar
+  #   end
+  #
+  #   def caterpillar # :nodoc:
+  #     @caterpillar_navigation = Caterpillar::Navigation.rails
+  #     @caterpillar_navigation_defaults = {
+  #       :uid => 13904,
+  #       :gid => 13912
+  #     }
+  #   end
+  #
+  # 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 -%>
+  #
+  class Navigation
+
+    # Method for formulating the portlets hash in Rails environment
+    def self.rails
+      config = Util.eval_configuration
+      config.routes = Util.parse_routes(config)
+      return Util.categorize(Parser.new(config).portlets)
+    end
+
+  end
+end

data/lib/caterpillar/parser.rb

@@ -0,0 +1,110 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  # Portlet configuration and route parser.
+  class Parser
+
+    def initialize(config)
+      @config = config
+      @routes = config.routes
+    end
+
+    # Updates the portlets hash from the routes and configuration options.
+    # Changes the path variables to a format supported by the Rails-portlet.
+    def portlets(routes=@routes)
+      raise 'No configuration' unless @config
+      raise 'No routes provided' unless routes
+      portlets = []
+
+      @config.instances.flatten.each do |portlet|
+
+        ### route to path
+        if portlet[:path]
+          # take user-given path & do not parse routes
+          path = portlet[:path]
+          #
+          # 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
+
+          portlet.update( :reqs => {} )
+          portlet.update( :vars => [] )
+
+        else
+          begin
+            _r = routes.select{
+              |route| route[:name]==portlet[:name].to_sym
+            }
+            path = _r.first[:path] # take only the first segments
+            raise if path.nil?
+          rescue
+            STDERR.puts ' !! no route for %s' % portlet[:name]
+            next
+          end
+
+          ### requirements - controller & action
+          portlet.update( :reqs => _r.first[:reqs] )
+
+          ### variables
+          portlet.update( :vars => _r.first[:vars] )
+
+          # delete the route from routes
+          _r.each do |r|
+            routes.delete(r)
+          end
+        end
+        # fix path variables to be replaced by rails-portlet at runtime
+        path.gsub!(/:uid/,'%UID%')
+        path.gsub!(/:gid/,'%GID%')
+        # TODO: notify user of unsupported variables
+        portlet.update( :path => path )
+
+        ### javascripts
+        # append portlet's javascripts to global javascripts
+        javascripts = (portlet[:javascripts].nil? ?
+          @config.javascripts : @config.javascripts + portlet[:javascripts].to_a)
+        portlet.update( :javascripts => javascripts.flatten )
+
+        portlets << portlet
+      end
+
+      # leftover named routes
+      if @config.include_all_named_routes==true
+        portlets << routes
+        portlets.flatten!
+      end
+
+      # sanity check
+      portlets.each do |portlet|
+        ### hostname
+        portlet.update( :host => @config.host ) unless portlet[:host]
+
+        ### servlet
+        portlet.update( :servlet => @config.servlet ) unless portlet[:servlet]
+
+        ### category
+        portlet.update( :category => @config.category ) unless portlet[:category]
+
+        ### title
+        _title = portlet[:title] || portlet[:name].to_s.gsub('_',' ').capitalize
+        # strip illegal characters
+        title = _title.gsub(/ä/,'a').gsub(/ö/,'o').gsub(/Ä/,'A').gsub(/Ö/,'O')
+        portlet.update( :title => title )
+
+        ### javascripts
+        portlet.update( :javascripts => @config.javascripts ) unless portlet[:javascripts]
+      end
+
+      return portlets
+    end
+
+  end
+end

data/lib/caterpillar/portlet.rb

@@ -0,0 +1,98 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  # Formulates generic JSR286 portlet XML
+  class Portlet
+    class << self
+
+    # Creates portlet XML
+    def xml(portlets)
+      xml = self.header
+      portlets.each do |p|
+        xml << self.template(p)
+      end
+      xml << self.footer
+      return xml
+    end
+
+    def debug(config,routes) # :nodoc:
+      routes.select{|r| !r[:name].empty?}.each do |route|
+        puts '%s: %s' % [route[:name], route[:path]]
+      end
+    end
+
+    # Rails-portlet Java class
+    def portlet_class
+      'com.celamanzi.liferay.portlets.rails286.Rails286Portlet'
+    end
+
+    # Rails-portlet Java class
+    def portlet_filter_class
+      'com.celamanzi.liferay.portlets.rails286.Rails286PortletRenderFilter'
+    end
+
+    protected
+
+    def header
+      xml =  '<?xml version="1.0" encoding="UTF-8"?>'
+      xml << "\n"
+      xml << '<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+             xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">'
+      xml << "\n\n"
+      return xml
+    end
+
+    def footer
+      '</portlet-app>' + "\n"
+    end
+
+    # portlet.xml template.
+    def template(portlet)
+      xml =  "  <!-- %s -->\n" % portlet[:title]
+      xml << "  <portlet>\n"
+      xml << "    <portlet-name>%s</portlet-name>\n" % portlet[:name]
+      xml << "    <portlet-class>%s</portlet-class>\n" % self.portlet_class
+      xml << "    <supports>\n"
+      xml << "      <mime-type>text/html</mime-type>\n"
+      xml << "      <portlet-mode>view</portlet-mode>\n"
+      ### edit mode
+      xml << "      <portlet-mode>edit</portlet-mode>\n" if portlet[:edit]==true
+      xml << "    </supports>\n"
+      xml << "    <portlet-info>\n"
+      xml << "      <title>%s</title>\n" % portlet[:title]
+      xml << "    </portlet-info>\n"
+      xml << "  </portlet>\n"
+      xml << ""
+      xml << "  <filter>\n"
+      xml << "    <filter-name>%s_filter</filter-name>\n" % portlet[:name]
+      xml << "    <filter-class>%s</filter-class>\n" % self.portlet_filter_class
+      xml << "    <lifecycle>RENDER_PHASE</lifecycle>\n"
+      xml << "    <init-param>\n"
+      xml << "      <name>host</name>\n"
+      xml << "      <value>%s</value>\n" % portlet[:host] || ""
+      xml << "    </init-param>\n"
+      xml << "    <init-param>\n"
+      xml << "      <name>servlet</name>\n"
+      xml << "      <value>%s</value>\n" % portlet[:servlet]
+      xml << "    </init-param>\n"
+      xml << "    <init-param>\n"
+      xml << "      <name>route</name>\n"
+      xml << "      <value>%s</value>\n" % portlet[:path].gsub(/&/,"&amp;")
+      xml << "    </init-param>\n"
+      xml << "  </filter>\n"
+      xml << ""
+      xml << "  <filter-mapping>\n"
+      xml << "    <filter-name>%s_filter</filter-name>\n" % portlet[:name]
+      xml << "    <portlet-name>%s</portlet-name>\n" % portlet[:name]
+      xml << "  </filter-mapping>\n"
+      xml << "\n"
+    end
+
+  end # static methods
+  end
+end