caterpillar 0.9.8 → 0.9.15

data/lib/caterpillar/portlet.rb

@@ -56,24 +56,33 @@ module Caterpillar
     # portlet.xml template.
     def template(portlet)
       xml =  "  <!-- %s -->\n" % portlet[:title]
+
       xml << "  <portlet>\n"
+      ### identification
       xml << "    <portlet-name>%s</portlet-name>\n" % portlet[:name]
       xml << "    <portlet-class>%s</portlet-class>\n" % self.portlet_class
+      ### supported portlet modes
       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
+      # edit mode is not used. this is for development.
+      if portlet[:edit]==true
+        xml << "      <portlet-mode>edit</portlet-mode>\n"
+      end
       xml << "    </supports>\n"
+      ### title for portlet container
       xml << "    <portlet-info>\n"
       xml << "      <title>%s</title>\n" % portlet[:title]
       xml << "    </portlet-info>\n"
-      xml << "  </portlet>\n"
-      xml << ""
+      xml << "  </portlet>\n\n"
+
+      ### portlet filters
       xml << "  <filter>\n"
+      # the filter reads the settings and sets the portlet session
       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"
+      # define host, servlet and route (path to be more precise)
       xml << "    <init-param>\n"
       xml << "      <name>host</name>\n"
       xml << "      <value>%s</value>\n" % portlet[:host] || ""
@@ -86,8 +95,8 @@ module Caterpillar
       xml << "      <name>route</name>\n"
       xml << "      <value>%s</value>\n" % portlet[:path].gsub(/&/,"&amp;")
       xml << "    </init-param>\n"
-      xml << "  </filter>\n"
-      xml << ""
+      xml << "  </filter>\n\n"
+
       xml << "  <filter-mapping>\n"
       xml << "    <filter-name>%s_filter</filter-name>\n" % portlet[:name]
       xml << "    <portlet-name>%s</portlet-name>\n" % portlet[:name]

data/lib/caterpillar/task.rb

@@ -39,14 +39,16 @@ module Caterpillar
     # The main task.
     # Reads the configuration file and launches appropriate tasks.
     def initialize(name = :usage, config = nil, tasks = :define_tasks)
+      STDOUT.puts 'Caterpillar v.%s (c) Copyright 2008,2009 Mikael Lammentausta' % VERSION
+      STDOUT.puts 'Provided under the terms of the MIT license.'
+      STDOUT.puts
       @name   = name
       @config = Util.eval_configuration(config)
+      @logger = @config.logger
+
       yield self if block_given?
       @xml_files = []
-      STDOUT.puts 'Caterpillar v.%s (c) Copyright 2008,2009 Mikael Lammentausta' % VERSION
-      #STDOUT.puts 'Caterpillar v.%s' % Caterpillar::VERSION
-      STDOUT.puts 'Provided under the terms of the MIT license.'
-      STDOUT.puts
+
       send tasks
     end
 
@@ -55,6 +57,7 @@ module Caterpillar
     def define_tasks
       define_xml_task
       define_usage_task
+      define_config_task
       define_pluginize_task
       define_environment_task
       define_portletxml_task
@@ -64,8 +67,9 @@ module Caterpillar
       define_portlets_task
       define_fixtures_task
       define_liferayportlets_task
-      define_migrate_task
-      define_rollback_task
+      define_db_migrate_task
+      define_db_rollback_task
+      define_db_update_task
       define_jar_install_task
       define_jar_uninstall_task
       define_jar_version_task
@@ -75,28 +79,19 @@ module Caterpillar
       define_deploy_war_task
     end
 
-    # the main XML generator task
-    def define_xml_task
-      @name = :xml
-      desc 'Create all XML files according to configuration'
-      tasks = [:parse,"#{@name}:portlet"]
-      if @config.container.kind_of? Liferay
-        tasks << "#{@name}:liferayportletapp"
-        tasks << "#{@name}:liferaydisplay"
-      end
-
-      # print produced portlets
-      tasks << :portlets
-
-      task :xml => tasks
-    end
-
     def define_usage_task
       task :usage do
         Usage.show
       end
     end
 
+    # TODO: copy and diff config file
+    def define_config_task
+      task :config do
+        STDOUT.puts 'TODO'
+      end
+    end
+
     def define_pluginize_task
       desc "Unpack Caterpillar as a plugin in your Rails application"
       task :pluginize do
@@ -115,41 +110,65 @@ module Caterpillar
       end
     end
 
-    # navigation debugging task
+
+    ### MAIN TASKS
+
+    # Main XML generator task
+    def define_xml_task
+      @name = :xml
+      desc 'Create all XML files according to configuration'
+      tasks = [:parse,"#{@name}:portlet"]
+      if @config.container.kind_of? Liferay
+        tasks << "#{@name}:liferayportletapp"
+        tasks << "#{@name}:liferaydisplay"
+      end
+
+      # print produced portlets
+      tasks << :portlets
+
+      task :xml => tasks
+    end
+
+    # Prints the list of portlets.
     def define_portlets_task
       desc 'Prints portlet configuration'
       task :portlets => :parse do
+        portal_info
         info 'Portlet configuration ***********************'
         print_portlets(@portlets)
       end
     end
 
-  def define_fixtures_task
-    desc 'Creates YAML fixtures from live data for testing.'
-    task :fixtures => :environment do
-      require 'active_record'
+    # Creates live fixtures from the RAILS_ENV database for testing.
+    def define_fixtures_task
+      desc 'Creates YAML fixtures from live data for testing.'
+      task :fixtures => :environment do
 
-      sql = "SELECT * from %s"
+        sql = "SELECT * from %s"
 
-      skip_tables = []
-      begin
-        skip_tables = @config.container.skip_fixture_tables
-      end
+        skip_tables = []
+        begin
+          skip_tables = @config.container.skip_fixture_tables
+        end
 
-      ActiveRecord::Base.establish_connection
-      (ActiveRecord::Base.connection.tables - skip_tables).each do |table|
-        i = "000"
-        File.open("#{RAILS_ROOT}/test/fixtures/#{table}.yml", 'w') do |file|
-          puts "* %s" % file.inspect
-          data = ActiveRecord::Base.connection.select_all(sql % table)
-          file.write data.inject({}) { |hash, record|
-            hash["#{table}_#{i.succ!}"] = record
-            hash
-          }.to_yaml
+        ActiveRecord::Base.establish_connection
+        info 'Creating YAML fixtures from %s database' % RAILS_ENV
+
+        (ActiveRecord::Base.connection.tables - skip_tables).each do |table|
+          i = "000"
+          File.open(
+            File.join(RAILS_ROOT,'test','fixtures',table+'.yml'), 'w'
+          ) do |file|
+            info file.inspect
+            data = ActiveRecord::Base.connection.select_all(sql % table)
+            file.write data.inject({}) { |hash, record|
+              hash["#{table}_#{i.succ!}"] = record
+              hash
+            }.to_yaml
+          end
         end
       end
     end
-  end
 
     ### SUB-TASKS
 
@@ -158,6 +177,10 @@ module Caterpillar
       task :default => :test
       task :environment do
         require(File.join(@config.rails_root, 'config', 'environment'))
+        if @config.container.is_a?(Caterpillar::Liferay)
+          @config.container.version ||= Lportal::Schema.version
+          portal_info
+        end
       end
     end
 
@@ -182,11 +205,9 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Create JSR286 portlet XML'
         task :portlet do
-          info 'Configured to use %s version %s' % [
-            @config.container.class.to_s.sub('Caterpillar::',''), @config.container.version
-          ]
+          portal_info
 
-          system('touch %s' % file)
+          exit 1 unless system('touch %s' % file)
           f=File.open(file,'w')
           f.write Portlet.xml(@portlets)
           f.close
@@ -203,7 +224,7 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Create Liferay portlet XML'
         task :liferayportletapp do
-          system('touch %s' % file)
+          exit 1 unless system('touch %s' % file)
           f=File.open(file,'w')
           f.write config.container.portletapp_xml(@portlets)
           f.close
@@ -217,12 +238,13 @@ module Caterpillar
       @name = :xml
       file = File.join('tmp','liferay-display.xml')
       @xml_files << file
-      raise 'This version of Liferay is broken!' if @config.container.version == '5.1.2'
 
       with_namespace_and_config do |name, config|
         desc 'Create Liferay display XML'
         task :liferaydisplay do
-          system('touch %s' % file)
+          raise 'Version 5.1.2 of Liferay is broken!' if config.container.version == '5.1.2'
+
+          exit 1 unless system('touch %s' % file)
           f=File.open(file,'w')
           f.write config.container.display_xml(@portlets)
           f.close
@@ -243,67 +265,116 @@ module Caterpillar
     end
 
 
-    def define_migrate_task
+    ### MIGRATIONS AND JAR-INSTALL
+
+    def define_db_migrate_task
       @name = :db
       with_namespace_and_config do |name, config|
-        desc "Migrates Caterpillar database tables"
+        desc "Migrates lportal and Caterpillar database tables"
         task :migrate => :environment do
-          require 'active_record'
-          ActiveRecord::Migrator.migrate(
-            File.expand_path(
-              File.dirname(__FILE__) + "/../../db/migrate"))
-          STDOUT.puts 'Now, run rake db:schema:dump'
+
+          # first run lportal sequence migrations (TODO)
+          info('Running lportal migrations')
+          ActiveRecord::Migrator.migrate(LPORTAL_MIGRATIONS)
+
+          # info('running Caterpillar migrations')
+          # ActiveRecord::Migrator.migrate(
+          #   File.expand_path(
+          #     File.join(CATERPILLAR_LIBS,'..','db','migrate')))
+
           #Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+          info 'You need to manually run rake db:schema:dump'
 
-          @portlets = config.container.analyze(:native)
-          @portlets.each do |portlet|
-            Web::PortletName.create(
-              :portletid => portlet[:id],
-              :name      => portlet[:name],
-              :title     => portlet[:title]
-            )
-          end
+          Rake::Task['db:update'].invoke
         end
       end
     end
 
-    def define_rollback_task
+    def define_db_rollback_task
       @name = :db
       with_namespace_and_config do |name, config|
         desc "Wipes out Caterpillar database tables"
         task :rollback => :environment do
-          require 'active_record'
+
           version = ENV['VERSION'].to_i || 0
-          ActiveRecord::Migrator.migrate(
-            File.expand_path(
-              File.dirname(__FILE__) + "/../../db/migrate"), version)
-          STDOUT.puts 'Now, run rake db:schema:dump'
+
+          info('Reverting lportal migrations')
+          ActiveRecord::Migrator.migrate(LPORTAL_MIGRATIONS, version)
+
+          # info('Reverting Caterpillar migrations')
+          # ActiveRecord::Migrator.migrate(
+          #   File.expand_path(
+          #     File.join(CATERPILLAR_LIBS,'..','db','migrate')), version)
+
           #Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+          info 'You need to manually run rake db:schema:dump'
+        end
+      end
+    end
+
+    def define_db_update_task
+      @name = :db
+      with_namespace_and_config do |name, config|
+        desc 'Updates the portletproperties table'
+        task :update => :environment do
+
+          info 'analyzing portlet XML configuration'
+          @portlets = config.container.analyze(:native)
+
+          info 'updating database'
+          Web::PortletProperties.all.each(&:destroy)
+          @portlets.each do |portlet|
+            Web::PortletProperties.create(
+              :portletid    => portlet[:id],
+              :name         => portlet[:name],
+              :title        => portlet[:title],
+              :instanceable => portlet[:instanceable]
+            )
+          end
         end
       end
     end
 
+    # Install the Rails-portlet JAR
     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'
+        task :install => :environment do
+          source = File.join(CATERPILLAR_LIBS,'java')
+
+          unless @config.container.kind_of? Liferay
+            info 'Installation of the JAR is only supported on Liferay. Patches are welcome.'
+            info 'Copy the JAR from this directory into the CLASSPATH of the portlet container.'
+            info source
+            exit 1
+          end
+
+          container_v = @config.container.version
+
+          unless container_v
+            info 'Unable to detect the version of the portlet container. Installing the latest version.'
+          end
 
           version = (
-            if @config.container.version[/^5.2/]
-              '0.6.1'
+            if container_v and container_v[/^5.1/]
+              '0.6.0' #'0.5.2' # FIXME: branch properly
             else
-              version = '0.5.2' # think of a way to branch properly
+              '0.6.1'
             end
           )
 
           portlet_jar = nil
           old_jar = nil
-          source = File.join(CATERPILLAR_LIBS,'java')
           target = File.join(@config.container.WEB_INF,'lib')
 
+          # check that target exists
+          unless File.exists?(target)
+            info 'JAR directory %s does not exist' % target
+            exit 1
+          end
+
+          require 'find'
           Find.find(source) do |file|
             if File.basename(file) =~ /rails-portlet-#{version}/
               portlet_jar = file
@@ -325,10 +396,10 @@ module Caterpillar
             end
           end
 
-          system('cp %s %s' % [portlet_jar,target])
+          exit 1 unless system('cp %s %s' % [portlet_jar,target])
           info 'installed Rails-portlet version %s to %s' % [version, target]
           if old_jar
-            system('rm -f %s' % old_jar)
+            exit 1 unless system('rm -f %s' % old_jar)
             info '..removed the old version %s' % old_jar
           end
 
@@ -342,14 +413,20 @@ module Caterpillar
         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')
 
+          # check that target exists
+          unless File.exists?(target)
+            info 'JAR directory %s does not exist' % target
+            exit 1
+          end
+
+          require 'find'
           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 1 unless system('rm -f %s' % file)
               exit 0
             end
           end
@@ -389,44 +466,41 @@ module Caterpillar
     def define_warble_task
       desc 'Create a WAR package with Warbler'
       task :warble do
-        unless ENV['JRUBY_HOME']
-          info ''
-          info 'Environment variable JRUBY_HOME is not set, exiting -'
-          info 'You should `export JRUBY_HOME="/usr/local/jruby"` and `sudo -E caterpillar %s`' % ARGV[0]
+        jruby_home = (ENV['JRUBY_HOME'] || @config.class::JRUBY_HOME)
+        unless jruby_home
+          info 'JRUBY_HOME is not set.'
+          info 'First preference is the environment variable JRUBY_HOME.'
+          info ' `export JRUBY_HOME="/usr/local/jruby"` and `sudo -E caterpillar %s`' % ARGV[0]
+          info 'Another option is to define portlet.class::JRUBY_HOME in %s.' % @config.class::FILE
           exit 1
         end
-        jruby = File.join(ENV['JRUBY_HOME'],'bin','jruby')
+        jruby = File.join(jruby_home,'bin','jruby')
         unless File.exists?(jruby)
-          info ''
           info 'JRuby executable was not found in %s, exiting' % jruby
           exit 1
         end
         begin
           require 'warbler'
         rescue
-          info ''
           info 'Warbler module was not found, exiting. Install Warbler for JRuby.'
           exit 1
         end
         unless File.exists?(@config.warbler_conf)
-          info ''
           info 'Warbler configuration file %s was not found, exiting' % @config.warbler_conf
           exit 1
         end
+        info 'Building WAR using Warbler %s on JRuby %i (%s)' % [
+          Warbler::VERSION, JRUBY_VERSION, jruby]
         info ''
-        info 'Building WAR using Warbler %s on JRuby (%s)' % [
-          Warbler::VERSION, jruby]
-        info ''
-        system(jruby+' -S warble war')
+        exit 1 unless system(jruby+' -S warble war')
+        info 'Warbler finished successfully'
       end
     end
 
     def define_deploy_task
       desc 'Deploy XML files and the application WAR to the portlet container'
-      #info 'Deploying XML files and the application WAR'
 
-      raise 'Only deployment to Liferay on Tomcat is supported' unless @config.container.kind_of? Liferay
-      tasks = [:xml, :warble, 'deploy:xml', 'deploy:war']
+      tasks = ['db:update', :xml, :warble, 'deploy:xml', 'deploy:war']
       task :deploy => tasks
     end
 
@@ -435,11 +509,12 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Deploys the XML files'
         task :xml do
+          raise 'Only deployment to Liferay on Tomcat is supported' unless @config.container.kind_of? Liferay
           target = @config.container.WEB_INF
           info 'deploying XML files to %s' % target
 
           @xml_files.each do |file|
-            system('cp %s %s' % [file,target])
+            exit 1 unless system('cp %s %s' % [file,target])
             info ' %s' % [file]
           end
         end
@@ -450,6 +525,7 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Deploys the WAR file'
         task :war do
+          raise 'Only deployment to Liferay on Tomcat is supported' unless @config.container.kind_of? Liferay
           file = @config.servlet+'.war'
           unless File.exists?(file)
             info 'cannot find the WAR file %s, exiting' % file
@@ -459,10 +535,10 @@ module Caterpillar
           target = File.join(@config.container.root,'webapps')
 
           info '..removing previous installs..'
-          system('rm -rf %s' % File.join(target,@config.servlet+'*'))
+          exit 1 unless system('rm -rf %s' % File.join(target,@config.servlet+'*'))
 
           info 'deploying the WAR package to %s' % target
-          system('cp %s %s' % [file,target])
+          exit 1 unless system('cp %s %s' % [file,target])
 
         end
       end
@@ -502,7 +578,7 @@ module Caterpillar
 
           #field = :path
           #fields = [:name, :id]
-          STDOUT.puts "\t" + portlet[:title] +spaces+ portlet[:id].inspect + "\t" + portlet[:name].inspect
+          STDOUT.puts "\t" + portlet[:title] +spaces+ portlet[:name].inspect + "\t" + portlet[:vars].inspect
         end
       end
     end
@@ -511,6 +587,13 @@ module Caterpillar
       STDOUT.puts ' * ' + msg
     end
 
+    def portal_info(config=@config)
+      msg = 'Caterpillar configured for %s version %s at %s' % [
+        config.container.name, config.container.version, config.container.root
+      ]
+      @logger ? @logger.info(msg) : STDOUT.puts(msg)
+    end
+
 
 
   end