caterpillar 0.9.16 → 1.0.0

data/ChangeLog

@@ -1,4 +1,12 @@
-
+= 1.0.0
+	- improved rubygem loading; detect RAILS_GEM_VERSION
+	- included portlet test bench
+	- generator is now filesystem independent
+
+= 0.9.17
+	- add role definitions; all portlets are only addable by admin
+	- define control panel category in Liferay 5.2
+	
 = 0.9.16
 	- fixed undefined RAILS_ROOT bug
 	- cleaned out unused JARs; the gem is now smaller

data/README

@@ -2,7 +2,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].
 
 Writing Rails portlets for Liferay is great fun!
-Caterpillar tasks offer specialized methods for better Liferay integration:
+Caterpillar tasks offer specialized tasks for better Liferay integration,
+the Rails-portlet JAR for the portlet container and a portlet test bench application,
+that integrates into any Rails project when you 'pluginize' Caterpillar.
+
+== Quickstart ==
+Start up a new Rails project:
+
+  $ rails shiny_app
+  $ cd shiny_app
+  $ caterpillar pluginize
+
+Activate the test bench portlet by inserting 'map.caterpillar' in RAILS_ROOT/config/routes.rb before any other routes.
+
+If you are using Liferay, +require 'lportal'+ in the Rails startup:
+
+  $ echo "require 'lportal'" > config/initializers/lportal.rb
+
+Finally, set up the database connection. Then you should run +caterpillar portlets+ to check if your installation is working. The output should be something like this:
+
+  Caterpillar: version 0.9.9999
+  Using Liferay schema build 5101, version 5.1.1
+  Caterpillar configured for Liferay version 5.1.1 at /usr/local/liferay/
+  * Portlet configuration ***********************
+  Caterpillar
+    Rails-portlet test bench      "portlet_test_bench"  []
+
+Then you can start up the server (./script/server) and navigate to http://localhost:3000/caterpillar/test_bench
+
+
+== Useful tasks ==
+Here are the most useful tasks; see the rdoc documentation and caterpillar --describe for the full feature list.
 
 ++xml++ and ++xml:deploy++
  - processes the portlet XML configuration in accordance with the named routes
@@ -15,10 +45,11 @@ See Caterpillar::Config
  - 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
+ - provides a navigation view in development (you will have to enable it manually).
+   See Caterpillar::Navigation
+ - includes the portlet test bench
 
-++db:migrate++
+++db:migrate++ and ++db:update++
  - offers a set of migrations to help with Liferay integration
 
  - patches Web::Portlet in the lportal[http://lportal.rubyforge.org] library, so manipulating
@@ -28,10 +59,9 @@ See Caterpillar::Navigation
  - 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.
 
 Caterpillar is written by Mikael Lammentausta for Cel'Amanzi Ltd.
+

data/generators/caterpillar/USAGE

@@ -1 +1 @@
-This writes a set of Caterpillar files into the Rails application.
+This installs Caterpillar development navigation and the portlet test bench images, javascripts and stylesheets into the Rails' public folder.

data/generators/caterpillar/caterpillar_generator.rb

@@ -6,40 +6,59 @@ class CaterpillarGenerator < Rails::Generator::Base
     require 'find'
     file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
     this_dir = File.dirname(File.expand_path(file))
-    tmpl = this_dir+'/templates'
+    tmpl = File.join(this_dir,'templates')
 
-    STDOUT.puts ' * Installing config and images'
+    STDOUT.puts ' * Installing configuration file with images, stylesheets and javascripts.'
+    STDOUT.puts ' * If you want to use the portlet test bench,'
+    STDOUT.puts ' * put the following line in your config/routes.rb before other routes.'
+    STDOUT.puts ' *   map.caterpillar'
+    STDOUT.puts ' *'
 
     record do |m|
 
       ### config ###
       m.directory('config')
       file = 'portlets.rb'
-      m.file('config/'+file, 'config/'+file)
-      ####################################
-
-
-# these are now cramped inline to the view partial
-#       ### stylesheet ###
-#       target = 'public/stylesheets/caterpillar'
-#       m.directory(target)
-#       file = 'caterpillar.css'
-#       m.file('stylesheets/caterpillar/'+file, target+'/'+file)
-#       ####################################
-# 
-#       ### javascript ###
-#       target = 'public/javascripts/caterpillar'
-#       m.directory(target)
-#       file = 'caterpillar.js'
-#       m.file('javascripts/caterpillar/'+file, target+'/'+file)
-#       ####################################
-
-      ### images ###
-      target = 'public/images'
+      m.file(File.join('config',file), File.join('config',file))
+
+
+      ### Navigation ###
+      target = File.join('public','images')
       m.directory(target)
       file = 'caterpillar.gif'
-      m.file('images/caterpillar/'+file, target+'/'+file)
-      ####################################
+      m.file(File.join('images','caterpillar',file), File.join(target,file))
+
+
+      ### Test bench ###
+      testb = 'portlet_test_bench'
+      #
+      # images
+      #
+      target = File.join('public','images',testb)
+      m.directory(target)
+      Find.find(File.join(tmpl,'images',testb)) do |file|
+        if FileTest.directory?(file)
+          next
+        else
+          img = File.basename(file)
+          next unless img[/(.jpg|.png|.gif)$/]
+          m.file(File.join('images',testb,img), File.join(target,img))
+        end
+      end
+      #
+      # stylesheets
+      #
+      target = File.join('public','stylesheets',testb)
+      m.directory(target)
+      file = 'main.css'
+      m.file(File.join('stylesheets',testb,file), File.join(target,file))
+      #
+      # javascripts
+      #
+      target = File.join('public','javascripts',testb)
+      m.directory(target)
+      file = 'main.js'
+      m.file(File.join('javascripts',testb,file), File.join(target,file))
 
     end
   end

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

@@ -52,12 +52,12 @@ Caterpillar::Config.new do |portlet|
   #  - :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:
+  # Rails-portlet testing application.
+  # NOTE: this needs to be activated by 'map.caterpillar' in RAILS_ROOT/config/routes.rb
   portlet.instances << {
-    :name     => 'test',
-    :title    => 'Rails-portlet testing application',
-    :category => 'Caterpillar',
-    :path     => '/RailsTestBench'
+    :name     => 'portlet_test_bench',
+    :title    => 'Rails-portlet test bench',
+    :category => 'Caterpillar'
   }
 
   # this will include all named routes without further configuration

data/generators/caterpillar/templates/javascripts/portlet_test_bench/main.js

@@ -0,0 +1,3 @@
+function simple_alert() {
+  alert('alert from main.js');
+}

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

@@ -0,0 +1,163 @@
+/* main.css */
+
+body {
+background-color: #FFFFCC;
+}
+
+/* testing leading whitespaces */
+  body {
+font: 11px Arial,Helvetica;
+}
+
+/* testing another id with "body" */
+#some_other_body {}
+
+.info {
+padding: 10px; 
+border: 5px double #000000; 
+background: #FFEE31; 
+text-align: center; 
+width: auto; 
+margin: 20%; 
+margin-top: 25px; 
+margin-bottom: 25px;
+font: 17px Times New Roman;
+}
+
+.notice {
+padding: 10px; 
+border: 5px double #000000; 
+background: #FF575A; 
+text-align: center; 
+width: auto; 
+margin: 20%; 
+margin-top: 25px; 
+margin-bottom: 25px;
+font: 14px Times New Roman;
+}
+
+/* used on css test page */
+#simple_content {
+margin: 25px; padding: 10px; border: 1px solid #000000; background: #93FFE4;
+}
+
+/* resource test page */
+.resource_image_box {
+margin: 25px; padding: 10px; border: 3px groove #74FFF6; background: #FFFFFF;
+text-align: center;
+}
+
+.resource_image_description {
+/* width: 49%; */
+/* float: break; */
+margin-left: 0%;
+border-bottom: 1px solid #000000; 
+/* padding-right: 12px; */
+/* margin-top: 20px; */
+
+font: 21px Times New Roman;
+}
+
+.resource_image_tag {
+width: auto;
+margin-top: 5px;
+/* float: break; */
+/* margin-left: 51%; */
+/* border: 1px solid #000000; */
+}
+
+/* HTTP POST */
+#http_post {
+background: white;
+border: 3px dashed #278F19;
+
+margin: 30px;
+margin-top: 0px;
+margin-bottom: 5px;
+padding: 30px;
+padding-top: 0px;
+}
+/* form input label */
+#http_postform span {
+margin-left: 10px;
+margin-right: 5px;
+}
+/* form input paragraph */
+#http_postform p {
+padding: 4px;
+margin: 3px;
+/* border: 1px dotted gray; */
+}
+/* form submit */
+#submit_tags {
+margin-left: 10px;
+margin-right: 5px;
+}
+
+#http_post h1 {
+font: 21px Times New Roman;
+padding: 3px;
+}
+#http_post h2 {
+font: 12px Times New Roman;
+border-bottom: 1px dashed gray;
+padding: 3px;
+}
+#post_msg {
+font: 21px Arial;
+font-style: italic;
+padding-left: 20px;
+}
+#post_info {
+font: 14px Arial;
+font-style: italic;
+padding-left: 20px;
+}
+
+/* login */
+.login_link {
+padding: 20px;
+font: 14px Arial;
+border: 3px solid green;
+background: white;
+/* float: left; */
+width: 20%;
+margin: 4px;
+}
+
+/* Drag & drop test */
+.dragdrop {
+height: 200px;
+border: 3px dotted blue;
+float:left;
+margin: 2%;
+}
+
+.dragdrop_id, #drop_status{
+padding: 20px;
+font: 14px Arial;
+border: 3px solid green;
+background: white;
+width: 20%;
+margin: 4px;
+-moz-border-radius: 0 0 2em 0;
+-webkit-border-radius: 0 0 2em 0;
+}
+
+#draggables {
+width: 25%;
+}
+#droppables {
+width: 65%;
+}
+
+.draggable {
+float: left;
+margin: 40px 0 0 24%;
+cursor: move;
+/* padding-left: 12%; */
+}
+
+#drop_status {
+font: 14px Arial;
+}

data/init.rb

@@ -1,8 +1,35 @@
+# Rails plugin initialization.
+
 file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 this_dir = File.dirname(File.expand_path(file))
 
-# append the views path
-ActionController::Base.append_view_path File.join(this_dir, 'views')
-
 # load the main file
 require File.join(this_dir, 'lib', 'caterpillar')
+
+STDERR.puts 'Caterpillar: version %s' % Caterpillar::VERSION
+
+# Add Caterpillar portlet navigation to views paths
+ActionController::Base.append_view_path File.join(this_dir, 'views')
+
+### Portlet test bench
+  # Adding directories to the load path makes them appear just like files in the the main app directory.
+  ActiveSupport::Dependencies.load_paths << File.join(this_dir, 'portlet_test_bench', 'controllers')
+  ActiveSupport::Dependencies.load_paths << File.join(this_dir, 'portlet_test_bench', 'helpers')
+
+  # Removing a directory from the load once paths allow changes
+  # to be picked up as soon as you save the file – without having to restart the web server.
+  ActiveSupport::Dependencies.load_once_paths.delete(File.join(this_dir, 'portlet_test_bench'))
+
+  # Add views
+  ActionController::Base.append_view_path File.join(this_dir, 'portlet_test_bench','views')
+
+  # Define routes
+  # NOTE: the routes need to be activated by 'map.caterpillar' in RAILS_ROOT/config/routes.rb
+  require File.join(this_dir, 'portlet_test_bench', 'routing')
+  ActionController::Routing::RouteSet::Mapper.send :include, Caterpillar::Routing::MapperExtensions
+
+  # hack; the application controller needs to be loaded explicitly,
+  # but NOT for standard Caterpillar tasks (breaks the tasks)
+  unless $0[/caterpillar|generate/]
+    require File.join(this_dir, 'portlet_test_bench','controllers','caterpillar','application')
+  end

data/lib/caterpillar.rb

@@ -5,7 +5,7 @@
 #++
 
 module Caterpillar
-  VERSION='0.9.16'
+  VERSION='1.0.0'
 end
 
 this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
@@ -16,6 +16,41 @@ CATERPILLAR_LIBS=this_dir unless defined?(CATERPILLAR_LIBS)
 RAILS_ROOT = Dir.pwd unless defined? RAILS_ROOT
 
 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.
+# Otherwise only one version of Rails & co. rubygems should exist on the system.
+
+if $0[/gem$/]
+  rails_gem_version = nil
+else
+  # Attempt to guess proper Rails version by reading Rails' config file
+  f=File.open(
+    File.join(
+      File.expand_path(RAILS_ROOT),
+      'config',
+      'environment.rb'
+    )
+  )
+  config = f.read
+  rails_gem_version = config[/RAILS_GEM_VERSION.*(\d\.\d\.\d)/,1]
+  f.close
+end
+
+# Load the proper versions of Rails etc.
+# Not tested on all setups.
+require 'rubygems'
+['activesupport',
+'actionpack',
+'activerecord'].each { |rg|
+  gem(rg, '= '+rails_gem_version) if rails_gem_version
+  require rg
+}
+require 'action_controller'
 
 # include all ruby files
 Find.find(this_dir) do |file|