caterpillar 0.9.0 → 0.9.1

data/ChangeLog

@@ -0,0 +1,8 @@
+= 0.9.1
+Released at 2008-12-18
+  - task to install the Rails-portlet
+
+
+= 0.9.0
+Released at 2008-12-17
+  - the initial release

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

@@ -6,11 +6,15 @@ Caterpillar::Config.new do |portlet|
   portlet.container = Liferay
   # portlet.container.version = '5.1.1'
 
-  # Dince liferay-display-ext.xml does not exist, all portlets are categorized in
-  # liferay-display.xml. If you intend to keep other portlets still intact,
-  # you need to specify the location of WEB-INF.
-  # No changes are made to any of the files in this directory.
-  portlet.container.WEB_INF = '/usr/local/liferay/webapps/ROOT/WEB-INF/'
+  # If you want to install the Rails-portlet JAR into the container, the container
+  # WEB-INF will be used.
+  #
+  # Since liferay-display-ext.xml does not exist, all portlets are categorized in
+  # liferay-display.xml. Caterpillar parses this file and appends Rails portlets.
+  #
+  # No changes are made to any of the files in this directory while making XML,
+  # only the deploy and install tasks make any changes.
+  portlet.container.root = '/usr/local/liferay/'
 
   # The hostname and port.
   # By default the values are taken from the request.

data/lib/caterpillar.rb

@@ -4,12 +4,14 @@
 # software license details.
 #++
 
-
 module Caterpillar
+  VERSION='0.9.1'
 end
 
-file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
-this_dir = File.dirname(File.expand_path(file))
+this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+this_dir = File.dirname(File.expand_path(this_file))
+
+CATERPILLAR_LIBS=this_dir
 
 require 'find'
 
@@ -22,6 +24,7 @@ Find.find(this_dir) do |file|
       next
     end
   else
-    require file if file[/.rb$/]
+    # do not require this file twice
+    require file if file[/.rb$/] and File.basename(file) != File.basename(this_file)
   end
-end
+end

data/lib/caterpillar/liferay.rb

@@ -12,15 +12,21 @@ module Caterpillar
     # Liferay version
     attr_accessor :version
 
-    # The location of Liferay's WEB-INF folder for XML analyzation
-    attr_accessor :WEB_INF
+    # the installation directory
+    attr_accessor :root
 
     def initialize(version='5.1.1')
       @version = version
     end
 
+    # The location of Liferay's WEB-INF folder for XML analyzation.
+    # This is relative to installation directory (self.root)
+    def WEB_INF
+      raise 'Configure container root folder' unless self.root
+      File.join(self.root,'webapps','ROOT','WEB-INF')
+    end
+
     def analyze(type)
-      raise 'Configure WEB-INF' unless self.WEB_INF
       require 'hpricot'
       return nil unless type==:native
 

data/lib/caterpillar/task.rb

@@ -38,7 +38,6 @@ module Caterpillar
 
     # The main task.
     # Reads the configuration file and launches appropriate tasks.
-    # Defines the rake task prefix 'jsr'.
     def initialize(name = :usage, config = nil, tasks = :define_tasks)
       @name   = name
       @config = Util.eval_configuration(config)
@@ -62,18 +61,21 @@ module Caterpillar
       define_liferayportlets_task
       define_migrate_task
       define_rollback_task
+      define_jar_install_task
+      define_jar_uninstall_task
+      define_jar_version_task
     end
 
     # the main XML generator task
     def define_main_task
       desc 'Create all XML files according to configuration'
-      tasks = [:parse,"#{@name}:portletxml"]
+      tasks = [:parse,"#{@name}:portlet"]
       if @config.container.kind_of? Liferay
-        tasks << "#{@name}:liferayportletappxml"
-        tasks << "#{@name}:liferaydisplayxml"
+        tasks << "#{@name}:liferayportletapp"
+        tasks << "#{@name}:liferaydisplay"
       end
       tasks << "portlets" # finally print produced portlets
-      task :jsr => tasks
+      task :xml => tasks
     end
 
     def define_usage_task
@@ -155,7 +157,7 @@ module Caterpillar
 
     # Writes the portlet.xml file
     def define_portletxml_task
-      @name = :jsr
+      @name = :xml
       # set the output filename
       if @config.container.kind_of? Liferay
         file = 'portlet-ext.xml'
@@ -163,8 +165,8 @@ module Caterpillar
         file = 'portlet.xml'
       end
       with_namespace_and_config do |name, config|
-        desc "Create JSR286 portlet XML"
-        task "portletxml" do
+        desc 'Create JSR286 portlet XML'
+        task :portlet do
           system('touch %s' % file)
           f=File.open(file,'w')
           f.write Portlet.xml(@portlets)
@@ -176,11 +178,11 @@ module Caterpillar
 
     # Writes liferay-portlet-ext.xml
     def define_liferayportletappxml_task
-      @name = :jsr
+      @name = :xml
       file = 'liferay-portlet-ext.xml'
       with_namespace_and_config do |name, config|
         desc 'Create Liferay portlet XML'
-        task "liferayportletappxml" do
+        task :liferayportletapp do
           system('touch %s' % file)
           f=File.open(file,'w')
           f.write config.container.portletapp_xml(@portlets)
@@ -192,11 +194,11 @@ module Caterpillar
 
     # Writes liferay-display.xml
     def define_liferaydisplayxml_task
-      @name = :jsr
+      @name = :xml
       file = 'liferay-display.xml'
       with_namespace_and_config do |name, config|
-        desc "Create Liferay display XML"
-        task "liferaydisplayxml" do
+        desc 'Create Liferay display XML'
+        task :liferaydisplay do
           system('touch %s' % file)
           f=File.open(file,'w')
           f.write config.container.display_xml(@portlets)
@@ -207,10 +209,10 @@ module Caterpillar
     end
 
     def define_liferayportlets_task
-      @name = :jsr
+      @name = :liferay
       with_namespace_and_config do |name, config|
-        desc 'Analyses native Liferay portlets XML'
-        task "portlets" do
+        desc 'Analyses native Liferay portlet-display XML'
+        task :portlets do
           @portlets = config.container.analyze(:native)
           print_portlets(@portlets)
         end
@@ -241,6 +243,7 @@ module Caterpillar
     end
 
     def define_rollback_task
+      @name = :db
       with_namespace_and_config do |name, config|
         desc "Wipes out Caterpillar database tables"
         task :rollback => :environment do
@@ -254,6 +257,100 @@ module Caterpillar
       end
     end
 
+    def define_jar_install_task
+      @name = :jar
+      with_namespace_and_config do |name, config|
+        desc 'Installs Rails-portlet JAR into the portlet container'
+        task :install do
+          raise 'Only Liferay is supported' unless @config.container.kind_of? Liferay
+          require 'find'
+
+          portlet_jar = nil
+          old_jar = nil
+          version = nil
+          source = File.join(CATERPILLAR_LIBS,'java')
+          target = File.join(@config.container.WEB_INF,'lib')
+
+          Find.find(source) do |file|
+            if File.basename(file) =~ /rails-portlet/
+              portlet_jar = file
+              version = file[/(\d.\d.\d).jar/,1]
+            end
+          end
+
+          # check for previous installs..
+          Find.find(target) do |file|
+            if File.basename(file) =~ /rails-portlet/
+              old_version = file[/(\d.\d.\d).jar/,1]
+              # check if there's an update available
+              if version.gsub(/\./,'').to_i > old_version.gsub(/\./,'').to_i
+                info 'Rails-portlet version %s is found, but an update is available.' % old_version
+                old_jar = file
+              else
+                info 'Rails-portlet version %s is already installed.' % old_version
+                exit 0
+              end
+            end
+          end
+
+          info 'Installing Rails-portlet version %s to %s' % [version, target]
+          system('cp %s %s' % [portlet_jar,target])
+          if old_jar
+            info 'Removing old version'
+            system('rm -f %s' % old_jar)
+          end
+
+        end
+      end
+    end
+
+    def define_jar_uninstall_task
+      @name = :jar
+      with_namespace_and_config do |name, config|
+        desc 'Uninstalls Rails-portlet JAR from the portlet container'
+        task :uninstall do
+          raise 'Only Liferay is supported' unless @config.container.kind_of? Liferay
+          require 'find'
+          target = File.join(@config.container.WEB_INF,'lib')
+
+          Find.find(target) do |file|
+            if File.basename(file) =~ /rails-portlet/
+              version = file[/(\d.\d.\d).jar/,1]
+              info 'Uninstalling Rails-portlet version %s from %s' % [version, target]
+              system('rm -f %s' % file)
+              exit 0
+            end
+          end
+
+          info 'Rails-portlet was not found in %s' % target
+          exit 1
+        end
+      end
+    end
+
+    def define_jar_version_task
+      @name = :jar
+      with_namespace_and_config do |name, config|
+        desc 'Checks the installed Rails-portlet version'
+        task :version do
+          raise 'Only Liferay is supported' unless @config.container.kind_of? Liferay
+          require 'find'
+          target = File.join(@config.container.WEB_INF,'lib')
+
+          Find.find(target) do |file|
+            if File.basename(file) =~ /rails-portlet/
+              version = file[/(\d.\d.\d).jar/,1]
+              info 'Rails-portlet version %s found in %s' % [version, target]
+              exit 0
+            end
+          end
+
+          info 'Rails-portlet was not found in %s' % target
+          exit 1
+        end
+      end
+    end
+
     def with_namespace_and_config
       name, config = @name, @config
       namespace name do
@@ -279,6 +376,10 @@ module Caterpillar
       end
     end
 
+    def info(msg)
+      STDOUT.puts ' * ' + msg
+    end
+
 
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: caterpillar
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - Mikael Lammentausta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-17 00:00:00 +02:00
+date: 2008-12-18 00:00:00 +02:00
 default_executable: caterpillar
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,15 +43,17 @@ extra_rdoc_files:
 - LICENSES.txt
 files: 
 - Rakefile
+- ChangeLog
 - install.rb
 - init.rb
+- lib/java
+- lib/java/rails-portlet-0.5.2.jar
 - lib/caterpillar
 - lib/caterpillar/config.rb
 - lib/caterpillar/navigation.rb
 - lib/caterpillar/liferay_portlet.rb
 - lib/caterpillar/usage.rb
 - lib/caterpillar/liferay.rb
-- lib/caterpillar/version.rb
 - lib/caterpillar/portlet.rb
 - lib/caterpillar/parser.rb
 - lib/caterpillar/util.rb

data/lib/caterpillar/version.rb

@@ -1,9 +0,0 @@
-#--
-# (c) Copyright 2008 Mikael Lammentausta
-# See the file LICENSES.txt included with the distribution for
-# software license details.
-#++
-
-module Caterpillar
-  VERSION = '0.9.0'
-end