caterpillar 0.9.16 → 1.0.0

data/lib/caterpillar/config.rb

@@ -35,14 +35,24 @@ module Caterpillar
 
     # Sets sane defaults that are overridden in the config file.
     def initialize
-      @rails_root  = File.expand_path(defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)
+      # RAILS_ROOT is at least defined in Caterpillar initialization
+      @rails_root  = File.expand_path(RAILS_ROOT)
       @servlet = File.basename(@rails_root)
       @category = @servlet
       @instances = []
       @javascripts = []
       @include_all_named_routes = true
+
+      rails_conf = File.join(@rails_root,'config','environment.rb')
+      unless File.exists?(rails_conf)
+        STDERR.puts 'Rails configuration file could not be found'
+      end
+
       @warbler_conf = File.join(@rails_root,'config','warble.rb')
-      STDERR.puts 'Warbler configuration file could not be found' unless File.exists?(@warbler_conf)
+      unless File.exists?(@warbler_conf)
+        STDERR.puts 'Warbler configuration file could not be found'
+      end
+
       #@logger  = (defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new)
 
       yield self if block_given?

data/lib/caterpillar/liferay.rb

@@ -7,6 +7,33 @@
 module Caterpillar
   # Creates liferay-portlet XML and liferay-display XML.
   # The latter optionally combines your production portlet display configuration.
+  #
+  # See http://www.liferay.com/web/guest/community/wiki/-/wiki/Main/Liferay-portlet.xml
+  #
+  # Supported portlet.xml tags:
+  # (*) stands for non-configurable
+  #
+  #     <portlet-name>
+  #     <icon> (*)
+  #     <instanceable> (*; always true)
+  #
+  # 5.1.x -specific:
+  #     <header-portal-javascript>
+  #
+  # 5.2.0 -specific:
+  #     <footer-portal-javascript>
+  #     <control-panel-entry-category>
+  #     <control-panel-entry-weight> (*; always 99.0)
+  #
+  # TODO:
+  #     <footer-portlet-javascript>
+  #     <header-portlet-css>
+  #     <use-default-template>
+  #     <private-request-attributes>
+  #     <private-session-attributes>
+  #     <render-weight>
+  #     <restore-current-view>
+  #
   class Liferay
 
     # Liferay version
@@ -16,9 +43,8 @@ module Caterpillar
     attr_accessor :root
 
     # 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.
+    # Defaults to +Lportal::Schema.version+.
     def initialize(version=nil)
-      
       @version = version
       @root    = '/usr/local/liferay'
     end
@@ -103,12 +129,12 @@ module Caterpillar
     # liferay-portlet XML
     def portletapp_xml(portlets)
       doctype = 'liferay-portlet-app'
-      xml = self.xml_header(doctype)
+      xml = xml_header(doctype)
       portlets.each do |p|
-        xml << self.portletapp_template(p)
+        xml << portletapp_template(p)
       end
-      xml << self.portlet_xml_footer(doctype)
-      return xml
+      xml << roles
+      xml << portlet_xml_footer(doctype)
     end
 
     # liferay-display XML
@@ -181,41 +207,71 @@ module Caterpillar
           '5.1.0'
         elsif @version[/5.2/]
           '5.2.0'
+        else
+          @version
         end
       when 'display'
         if @version[/5.1/]
           '5.1.0'
         elsif @version[/5.2/]
           '5.2.0'
+        else
+          @version
         end
       end
     end
 
+    # the actual portlet definition
     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]
+      xml << "    <icon>/%s/favicon.ico</icon>\n" % portlet[:servlet]
       # can there be several portlet instances on the same page?
       xml << "    <instanceable>true</instanceable>\n"
+      # define the control panel category for 5.2 and newer
+      unless @version[/5.1/]
+        xml << "    <control-panel-entry-category>#{portlet[:category]}</control-panel-entry-category>\n"
+        xml << "    <control-panel-entry-weight>99.0</control-panel-entry-weight>\n"
+      end
       # include javascripts?
+      js_tag = (@version[/5.1/] ? 'header' : 'footer') + '-portal-javascript'
       portlet[:javascripts].each do |js|
-        xml << "    <header-portal-javascript>"
-        xml << "/%s/javascripts/%s" % [portlet[:servlet],js]
-        xml << "</header-portal-javascript>\n"
+        xml << "    <#{js_tag}>"
+        xml << "/#{portlet[:servlet]}/javascripts/#{js}"
+        xml << "</#{js_tag}>\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"
+        xml << '    <portlet id="%s" />' % p[:name] + "\n"
       end
       xml << "  </category>\n\n"
+    end
 
-      return xml
+    private
+
+    # XML role-mapper.
+    # Has to be duplicated in -ext.xml
+    def roles
+      xml =  "  <role-mapper>\n"
+      xml << "    <role-name>administrator</role-name>\n"
+      xml << "    <role-link>Administrator</role-link>\n"
+      xml << "  </role-mapper>\n"
+      xml << "  <role-mapper>\n"
+      xml << "    <role-name>guest</role-name>\n"
+      xml << "    <role-link>Guest</role-link>\n"
+      xml << "  </role-mapper>\n"
+      xml << "  <role-mapper>\n"
+      xml << "    <role-name>power-user</role-name>\n"
+      xml << "    <role-link>Power User</role-link>\n"
+      xml << "  </role-mapper>\n"
+      xml << "  <role-mapper>\n"
+      xml << "    <role-name>user</role-name>\n"
+      xml << "    <role-link>User</role-link>\n"
+      xml << "  </role-mapper>\n"
     end
 
     public

data/lib/caterpillar/portlet.rb

@@ -55,6 +55,10 @@ module Caterpillar
 
     # portlet.xml template.
     def template(portlet)
+      # add roles
+      # TODO: move into portlet hash
+      # administrator, power-user, user
+      roles = %w{ administrator }
       xml =  "  <!-- %s -->\n" % portlet[:title]
 
       xml << "  <portlet>\n"
@@ -74,6 +78,11 @@ module Caterpillar
       xml << "    <portlet-info>\n"
       xml << "      <title>%s</title>\n" % portlet[:title]
       xml << "    </portlet-info>\n"
+      roles.each do |role|
+        xml << "    <security-role-ref>\n"
+        xml << "      <role-name>#{role}</role-name>\n"
+        xml << "    </security-role-ref>\n"
+      end
       xml << "  </portlet>\n\n"
 
       ### portlet filters

data/lib/caterpillar/task.rb

@@ -7,15 +7,6 @@
 # software license details.
 #++
 
-require 'rake'
-require 'rake/tasklib'
-
-# these are required for Caterpillar to work on Ruby 1.8.5.
-# you shouldn't have more than one Rails installed at a time, or you should
-# use the latest with Caterpillar.
-require 'actionpack'
-require 'action_controller'
-
 # --
 # Rake task.  Allows defining multiple configurations inside the same
 # Rakefile by using different task names.
@@ -127,7 +118,7 @@ module Caterpillar
       end
 
       # print produced portlets
-      tasks << :portlets
+      #tasks << :portlets
 
       task :xml => tasks
     end
@@ -136,7 +127,7 @@ module Caterpillar
     def define_portlets_task
       desc 'Prints portlet configuration'
       task :portlets => :parse do
-        portal_info
+        #portal_info
         info 'Portlet configuration ***********************'
         print_portlets(@portlets)
       end
@@ -208,7 +199,7 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Create JSR286 portlet XML'
         task :portlet do
-          portal_info
+          #portal_info
 
           exit 1 unless system('touch %s' % file)
           f=File.open(file,'w')

data/lib/web/portlet.rb

@@ -1,10 +1,3 @@
-unless defined?(RAILS_ENV)
-  # this should load an appropriate version, there are problems when using an older Rails
-  # than the latest stable.
-  require 'rubygems'
-  require 'active_record'
-end
-
 module Web # :nodoc:
   # Adds Caterpillar portlets to available portlets.
   class Portlet < ActiveRecord::Base

data/portlet_test_bench/controllers/caterpillar/application.rb

@@ -0,0 +1,13 @@
+class Caterpillar::ApplicationController < ActionController::Base
+
+  layout 'basic'
+
+  helper 'Caterpillar::Application'
+
+  before_filter :is_test_selected
+
+  def is_test_selected
+    @test_is_selected = self.class.to_s[/Application/].nil?
+  end
+
+end

data/portlet_test_bench/controllers/caterpillar/css_controller.rb

@@ -0,0 +1,9 @@
+class Caterpillar::CssController < Caterpillar::ApplicationController
+  def simple
+    render :layout => false
+  end
+
+  def background
+    render :layout => false
+  end
+end

data/portlet_test_bench/controllers/caterpillar/http_methods_controller.rb

@@ -0,0 +1,35 @@
+class Caterpillar::HttpMethodsController < Caterpillar::ApplicationController
+
+  def post
+    @msg      = params[:msg] if request.post?
+    @checkbox = params[:checkbox]
+    render :action => :post
+  end
+
+  def post_and_redirect
+    @msg      = '"%s" passed from POST to GET' % params[:msg_get] if request.get? and params[:msg_get]
+    if request.post?
+      redirect_to :action => :post_and_redirect, :msg_get => params[:msg]
+    end
+  end
+
+  def parameter
+    @params = params
+    @params.delete :action
+    @params.delete :controller
+  end
+
+  def redirect_back
+    redirect_to :back
+  end
+
+  def redirect_action
+    flash[:info] = 'This message was set in the action before redirect'
+    redirect_to :action => :redirect, :x => true
+  end
+
+#   def redirect_target
+#     render :action => :redirect
+#   end
+
+end

data/portlet_test_bench/controllers/caterpillar/js_controller.rb

@@ -0,0 +1,74 @@
+class Caterpillar::JsController < Caterpillar::ApplicationController
+
+  def simple
+    @javascripts = false
+    render :layout => false
+  end
+
+  # the :defaults JavaScripts in javascript_include_tag
+  def defaults
+    @javascripts = false # do not include any javascripts
+    id = params[:id]
+    if id then
+      render :template => "js/#{id}"
+    else
+      render :template => 'js/defaults'
+    end
+  end
+
+  def prototype
+    @javascripts = ['prototype']
+  end
+
+  def scriptaculous
+    @javascripts = ['prototype','effects','controls']
+  end
+
+  def jquery
+    @javascripts = ['jquery','jquery-ui','jrails']
+  end
+
+  def dragndrop
+    #@javascript = ['prototype','scriptaculous']
+#     @javascripts = ['prototype','effects','dragdrop','controls']
+#     @javascripts = ['jquery','jquery-ui','jrails']
+    @javascripts = :defaults
+  end
+
+  def link_to_post
+    @msg = params[:msg] || 'method was GET'
+  end
+
+  def link_to_post_action
+    msgs = ['successful','ok','it works','dandy']
+    redirect_to :action => :link_to_post, :msg => msgs[rand(msgs.size)]
+  end
+
+  #######
+
+  def highlight_test
+    render :update do |page|
+      page[:highlight_test].visual_effect(:highlight)
+    end
+  end
+
+  def appear_test
+    render :update do |page|
+      page.visual_effect 'toggle_appear', "appear_test"
+    end
+  end
+
+  def toggle_blind_test
+    render :update do |page|
+      page.visual_effect 'toggle_blind', "toggle_blind_test"
+    end
+  end
+
+  def receive_drop
+    render :update do |page|
+      page[:drop_status].appear
+      page[:drop_status].replace_html('Received: %s' % params[:id])
+    end
+  end
+
+end

data/portlet_test_bench/controllers/caterpillar/login_controller.rb

@@ -0,0 +1,41 @@
+class Caterpillar::LoginController < Caterpillar::ApplicationController
+
+  before_filter :authorize, :except => [ :login, :index, :logout ]
+
+#   def initialize
+#   end
+
+  def index
+    @user = session[:username]
+    render :action => :index
+  end
+
+  def login
+    if request.post?
+      user = User.authenticate(params[:username],params[:password])
+      if user
+        session[:username] = user[:username]
+#         STDERR.puts user.inspect
+        flash[:notice] = "Logged in"
+        redirect_to :action => :index
+      else
+        flash[:notice] = "Invalid credentials"
+        render :action => :index
+      end
+    else
+      render :action => :index
+    end
+  end
+
+  def logout
+    session[:username] = nil
+    flash[:notice] = "Logged out"
+    redirect_to :action => :index
+  end
+
+
+  def authorize
+    redirect_to :action => :index
+  end
+
+end

data/portlet_test_bench/controllers/caterpillar/resource_controller.rb

@@ -0,0 +1,23 @@
+class Caterpillar::ResourceController < Caterpillar::ApplicationController
+
+  def images
+    @images = [
+      { :description => "Rails logo", :file => 'portlet_test_bench/rails.png' }
+#       { :description => "Image from a subdirectory", :file => 'lolcat/lolcat-monorail.jpg' }
+    ]
+  end
+
+  # Inline text
+  def inline
+    render :inline => "Inline text"
+  end
+
+  # link to outside the portlet
+  def exit_portlet
+    @links = ['http://www.rubyonrails.org', 'http://www.google.fi/search?q=jsr286', {:action => :exit_portlet}]
+    if params.include? :exit_portlet
+      render :inline => 'portlet should now be exited'
+    end
+  end
+
+end