caterpillar 1.3.1 → 1.4.0

data/ChangeLog

@@ -1,3 +1,25 @@
+= 1.4.0
+	- create Liferay XML with REXML
+	- Caterpillar works outside of RAILS_ROOT
+	- accept Ruby config file as the first parameter, for generating the XML (undocumented feature)
+	- write XML files to working directory
+	- create and deploy XML files with the task deploy:xml
+	- rename xml task to makexml
+	- update pluginize task (rename versioned caterpillar directory, accept FORCE env variable)
+	- introduced rspec and rcov tests
+	- set default Liferay version to 5.2.3
+	- small change to route parsing
+	- fix some deprecation warnings
+	- updated JBoss configuration handling
+	- fix the preferences route generation (by tulios)
+	- numerous small updates to portlet test bench
+
+= 1.3.2
+	- Adding public render parameters, to control liferay portlets
+	- Fixing a bug in edit_mode that caused the "rails-portlet" received 404 to access the method preferences
+	- New preferences_route option for portlet, allowing the route configuration
+	- Some small fixes and improvements
+	
 = 1.3.1
 	- rename xml task to makexml, and call it with deploy:xml
 	- many small fixes to various tasks
@@ -7,7 +29,8 @@
 = 1.3.0
 	- New helpers to generate resource urls (download) and get_liferay_preferences, to get the preferences
 	- edit_mode and instanceable working on portlet configuration
-	- Modifications on portlet-ext.xml (new filter and RESOURCE_PHASE)
+	- Modifications on portlet-ext.xml (new filter and RESOURCE_PHASE) 
+	- The new task rails (caterpillar rails project_name)
 
 = 1.2.5
 	- Ruby 1.9 compatibility fix

data/README.rdoc

@@ -86,7 +86,7 @@ Maybe caterpillar could have an upgrade task to handle this?
 == Useful tasks 
 Here are the most useful tasks; see the rdoc documentation and caterpillar --describe for the full feature list.
 
-<tt>xml</tt>::  processes the portlet XML configuration in accordance with the named routes
+<tt>makexml</tt>::  processes the portlet XML configuration in accordance with the named routes
 
 <tt>xml:deploy</tt>::  deploys the created XML to the J2EE portlet container 
 
@@ -134,13 +134,22 @@ We have two kinds of portlets, the instanceable ones and not instaceables ones.
     :instanceable => false
   }
 
-Each mapped portlet requires a <b>preferences</b> method which will handle the edit mode features. 
+Each mapped portlet requires a <b>preferences</b> method, by convention, which will handle the edit mode features.
 For example:
   def preferences
     if request.post?
       flash[:notice] = 'Success!'
     end
   end
+                                                                                                                  
+If you want is possible to set the <b>preferences_route</b> in <b>portlets.rb</b> file.
+For example:
+  portlet.instances << {
+    :name => 'test',
+    :edit_mode => true,
+    :instanceable => true,
+    :preferences_route => '/my_portlet/test/preferences'
+  }
 
 Rails-portlet will provide us a hash with all saved preferences, to access this method we need to include the Caterpillar::PortletSupport module, like:
   include Caterpillar::PortletSupport
@@ -162,7 +171,7 @@ This module will provide <b>get_liferay_preferences</b> method which returns the
 
   end
 
-In your erb file you will have a form like this, where each attribute (that has to be saved) needs to have prefix <b>_preference</b> on its name. For example:
+In your erb file you will have a form like this, where each attribute (that has to be saved) needs to have sufix <b>_preference</b> on its name. For example:
   <% form_tag :controller => :test , :action => :preferences do %>
     <p>
       Cor de fundo: <%= text_field_tag :background_color_preference, @preferences[:background_color_preference] %>
@@ -176,10 +185,28 @@ In your erb file you will have a form like this, where each attribute (that has
     <%= submit_tag "Salve" %>
   <% end %>
 
+== Public Render Parameters
 
+To enable public parameters to your portlets, you must create the array <b>public_render_parameters</b>, in your <em>portlets.rb</em> instance configuration, where you will add the public variables (in our example, <b>param1</b> and <b>param2</b>). 
+  portlet.instances << {   
+    :name => 'home',
+    :public_render_parameters => [:param1, :param2]
+  }
 
+In your erb file, for each public parameter, you must use the sufix <b>_prp</b> in it's name . For example, to use the public variable param1 in a textfield: 
+  <%= text_field_tag :param1_prp, '' %>
 
 
+<b> Watch it! </b> 
+* You should <b>not</b> use the sufix <b>_prp</b> in <em>portlets.rb</em>. 
+* You must use the public render parameters in your erb file, <b>in a form</b>, using POST method. [It has to go through processAction]
+* Even if you've got only one variable to add to <b>public_render_parameters</b>, you <b>have</b> to use the brackets.
+  
+    portlet.instances << {   
+      :name => 'home',
+      :public_render_parameters => [:param1]
+    }
+* And remember, the <b>_prp</b> sufix is <b>removed</b> when the param is published, so "tag_prp" become just "tag" for the portlets that are listening to this parameter.
 
 
 

data/Rakefile

@@ -4,9 +4,31 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 load 'caterpillar.gemspec'
 
+# gem install rspec -v 1.3.0
+require 'spec/rake/spectask'
+# gem install rcov
+require 'spec/rake/verify_rcov'
+
 desc 'Default: create API doc.'
 task :default => :rdoc
 
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts ||= []
+  t.spec_opts << "--options" << "spec/spec.opts"
+end
+
+Spec::Rake::SpecTask.new("spec:rcov") do |t|
+  t.spec_opts ||= []
+  t.spec_opts << "--options" << "spec/spec.opts"
+  t.rcov = true
+#  t.rcov_opts = ['--text-report', '--exclude', "gems/,spec/,rcov.rb,#{File.expand_path(File.join(File.dirname(__FILE__),'../../..'))}"] 
+  t.rcov_opts = ['--exclude', 'diff-lcs,rake,spec,rcov,active_support,action_controller,action_view,json,rack']
+end
+
+RCov::VerifyTask.new(:rcov => "spec:rcov") do |t|
+  t.threshold = 100
+end
+
 desc 'Generate documentation for the example plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'

data/bin/caterpillar

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
-#
 #--
-# (c) Copyright 2008 Mikael Lammentausta, Cel'Amanzi Ltd
-#               2010 Mikael Lammentausta, Youleaf Ltd
+# (c) Copyright 2008-2010 Mikael Lammentausta
 #
 # Constructed heavily upon Warbler's structure.
 # Thanks to Nick Sieger!
@@ -31,8 +29,11 @@ Rake.application = application
 application.standard_exception_handling do
   application.init
 
-  # Load the main tasks - choose the namespace
-  Caterpillar::Task.new(ARGV[0] ? ARGV[0].gsub(/:.*/,'') : :usage)
+  # Load the main tasks - 
+  # if first argument is a Ruby (config) file, take the task name from second arg
+  config = ARGV[0][/.rb$/] ? File.expand_path(ARGV.shift) : nil
+  name = ARGV[0] ? ARGV[0].gsub(/:.*/,'') : nil
+  Caterpillar::Task.new(name, config)
   
   task :default => :usage
 

data/generators/caterpillar/caterpillar_generator.rb

@@ -4,6 +4,9 @@
 # This generator installs the required files into the main Rails application.
 # This generator should always be run after upgrading the plugin.
 class CaterpillarGenerator < Rails::Generator::Base
+  
+  attr_accessor :project_name
+  
   def msg(txt)
     _txt = " *\n"
     txt.split("\n").each do |line|
@@ -28,15 +31,16 @@ class CaterpillarGenerator < Rails::Generator::Base
     this_dir = File.dirname(File.expand_path(file))
     tmpl = File.join(this_dir,'templates')
 
+    @project_name = RAILS_ROOT.split('/')[-1]
     msg 'Installing configuration file with images, stylesheets and javascripts.'
 
     record do |m|
 
       ### config ###
-      m.directory('config')
-      file = 'portlets.rb'
-      m.file(File.join('config',file), File.join('config',file))
-
+#     m.directory('config')
+#     file = 'portlets.rb'
+#     m.file(File.join('config',file), File.join('config',file))
+      m.template('config/portlets.rb','config/portlets.rb')
 
       ### Navigation ###
       target = File.join('public','images')
@@ -44,9 +48,9 @@ class CaterpillarGenerator < Rails::Generator::Base
       file = 'caterpillar.gif'
       m.file(File.join('images','caterpillar',file), File.join(target,file))
 
-
       ### Test bench ###
       testb = 'portlet_test_bench'
+      
       #
       # images
       #
@@ -61,6 +65,7 @@ class CaterpillarGenerator < Rails::Generator::Base
           m.file(File.join('images',testb,img), File.join(target,img))
         end
       end
+      
       #
       # stylesheets
       #
@@ -68,6 +73,7 @@ class CaterpillarGenerator < Rails::Generator::Base
       m.directory(target)
       file = 'main.css'
       m.file(File.join('stylesheets',testb,file), File.join(target,file))
+      
       #
       # javascripts
       #

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

@@ -1,9 +1,6 @@
 # encoding: utf-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.
@@ -26,24 +23,28 @@ Caterpillar::Config.new do |portlet|
   #  - 'JBoss/Tomcat'
   # portlet.container.server = 'JBoss/Tomcat'
 
-  # The server dir is only meaningful with JBoss.
-  # This is the name of the directory in server/.
-  # By default the first entry in the directory is chosen.
-  # portlet.container.server_dir = 'default'
+  # The server dir is only meaningful with JBoss, and is ignored with Tomcat.
+  # This should be set to the tree starting from container.root set above,
+  # and the top level should contain the WEB-INF directory.
+  # portlet.container.server_dir = 'server/default/deploy/ROOT.war'
 
-  # Allow to defining the deploy_dir - just the WAR file will be deployed under this directory.
-  # Since version 1.3.0
+  # Deploy directory for the WAR file.
+  # Please use absolute path.
+  # Not needed for Tomcat unless you have a complex setup.
   # portlet.container.deploy_dir = '/opt/myDeployDir'
 
+  # JRUBY_HOME can be set here, unless the environment variable can be used.
+  # portlet.class::JRUBY_HOME = '/usr/local/jruby'
+
   # The hostname and port.
   # By default the values are taken from the request.
-  portlet.host = 'http://0.0.0.0:3000'
+  portlet.host = 'http://localhost:3000'
  
   # If the Rails is running inside a servlet container such as Tomcat,
   # you can define the servlet here.
   # By default the servlet is the name of the Rails app.
   # Without Warbler this should be an empty string.
-  portlet.servlet = ''
+  portlet.servlet = '<%= project_name %>-portlet'
  
   # Portlet category. This is only available for Liferay.
   # By default this is the same as the servlet.
@@ -59,18 +60,25 @@ Caterpillar::Config.new do |portlet|
   # Most likely you will want to let ActionController::Routing to set the route.
   #
   # Available keys are:
-  #  - :name         -- named route
-  #  - :category     -- portlet category (Liferay only)
-  #  - :title        -- the title in portlet container's category (Liferay only)
-  #  - :edit_mode    -- enables edit mode for the portlet, adds <portlet-mode>edit</portlet-mode> to portlet-ext.xml
-  #                     Default value is false
-  #  - :instanceable -- enables instanceable for the portlet, add <instanceable>true</instanceable> to
-  #                     liferay-portlet-ext.xml. Default value is false
-  #  - :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
+  #  - :name                     -- named route
+  #  - :category                 -- portlet category (Liferay only)
+  #  - :title                    -- the title in portlet container's category (Liferay only)
+  #  - :edit_mode                -- enables edit mode for the portlet, adds <portlet-mode>edit</portlet-mode> 
+  #                                 to portlet-ext.xml. Default value is false
+  #  - :instanceable             -- enables instanceable for the portlet, add <instanceable>true</instanceable> to
+  #                                 liferay-portlet-ext.xml. Default value is false
+  #  - :preferences_route        -- To customize the preferences route for the portlet
+  #  - :public_render_parameters -- enables public render parameters. The variables should not have the sufix '_prp', 
+  #                                 they have to be the same as requested by portlets.
+  #                                 Ex: portlets.instances << {
+  #                                       :name => 'portlet_name',
+  #                                       :public_render_parameters => [:tag, :param2, :param3]
+  #                                     }
+  #  - :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
 
   # Rails-portlet testing application.
   # NOTE: this needs to be activated by 'map.caterpillar' in RAILS_ROOT/config/routes.rb

data/generators/caterpillar/templates/stylesheets/portlet_test_bench/main.css

@@ -78,18 +78,18 @@ padding: 30px;
 padding-top: 0px;
 }
 /* form input label */
-#http_postform span {
+.http_postform span {
 margin-left: 10px;
 margin-right: 5px;
 }
 /* form input paragraph */
-#http_postform p {
+.http_postform p {
 padding: 4px;
 margin: 3px;
 /* border: 1px dotted gray; */
 }
 /* form submit */
-#submit_tags {
+.submit_tags {
 margin-left: 10px;
 margin-right: 5px;
 }
@@ -97,21 +97,22 @@ margin-right: 5px;
 #http_post h1 {
 font: 21px Times New Roman;
 padding: 3px;
+border-bottom: 1px dotted gray;
 }
 #http_post h2 {
-font: 12px Times New Roman;
+font: 15px Times New Roman;
 border-bottom: 1px dashed gray;
 padding: 3px;
 }
 #post_msg {
 font: 21px Arial;
 font-style: italic;
-padding-left: 20px;
+padding-left: 0px;
 }
 #post_info {
 font: 14px Arial;
 font-style: italic;
-padding-left: 20px;
+padding: 0 0.1em 1.5em;
 }
 
 /* login */

data/generators/html_template/html_template_generator.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+class HtmlTemplateGenerator < Rails::Generator::Base
+
+  attr_accessor :project_name
+
+  def after_generate
+    STDOUT.puts "Done!"
+  end
+
+  def manifest
+    record do |m|
+      @project_name = RAILS_ROOT.split('/')[-1]
+      m.template('application.html.erb', 'app/views/layouts/application.html.erb')
+    end
+  end
+  
+end

data/generators/html_template/templates/application.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+	<title><%= project_name %></title>
+</head>
+<body>
+	<%%= yield %>
+</body>
+</html>

data/lib/caterpillar.rb

@@ -1,34 +1,45 @@
 # encoding: utf-8
 #--
 # (c) Copyright 2008-2010 Mikael Lammentausta
-#                    2010 Túlio Ornelas
+#                    2010 Tulio Ornelas
 #
 # See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 
-module Caterpillar
-  VERSION='1.3.1'
+module Caterpillar   
+  VERSION = '1.4.0'
 end
 
 this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 this_dir = File.dirname(File.expand_path(this_file))
 
-CATERPILLAR_LIBS=this_dir unless defined?(CATERPILLAR_LIBS)
-
-RAILS_ROOT = Dir.pwd unless defined? RAILS_ROOT
+CATERPILLAR_LIBS = this_dir unless defined? CATERPILLAR_LIBS
+
+# detect if running in Rails directory
+if not defined? RAILS_ROOT
+  rails_conf = File.join(Dir.pwd,'config','environment.rb')
+  if File.exists?(rails_conf)
+     # read from Rails config file
+     f=File.open(rails_conf)
+     _config = f.read
+     f.close
+     RAILS_ROOT = Dir.pwd if _config[/RAILS/]
+  end
+end
 
 require 'find'
 require 'rake'
 require 'rake/tasklib'
 
-# NOTE: During normal startup (not while building the gem),
-# ActiveRecord should be loaded at this point, before loading any of the models.
-# However, this may conflict later when Rails' rake task activates the boot process.
-# The correct versions should be loaded at this point.
-# Maybe this is too heavy, as some tasks do not need any Rails modules.
-require File.join(this_dir,'rails_gem_chooser')
-RailsGemChooser.__load # detects the Rails config file from RAILS_ROOT
+if defined? RAILS_ROOT
+	# NOTE: During normal startup (not while building the gem),
+	# ActiveRecord should be loaded at this point, before loading any of the models.
+	# However, this may conflict later when Rails' rake task activates the boot process.
+	# The correct versions should be loaded at this point.
+	require File.join(this_dir,'rails_gem_chooser')
+	RailsGemChooser.__load # detects the Rails config file from RAILS_ROOT
+end
 
 # include all ruby files
 Find.find(this_dir) do |file|
@@ -37,7 +48,7 @@ Find.find(this_dir) do |file|
       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'))
+    elsif (not defined?(RAILS_ENV) and %w{web helpers}.include?(File.basename(file)))
       Find.prune
 
     else