caterpillar 1.4.3 → 1.4.4

data/ChangeLog

@@ -1,3 +1,7 @@
+= 1.4.4
+	- XML fixes
+	- added /caterpillar view
+
 = 1.4.3
 	- regression fix for XML format; Liferay is very picky about newlines
 

data/lib/caterpillar.rb

@@ -8,7 +8,7 @@
 #++
 
 module Caterpillar   
-  VERSION = '1.4.3' unless defined? Caterpillar::VERSION
+  VERSION = '1.4.4' unless defined? Caterpillar::VERSION
 end
 
 this_file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__

data/lib/caterpillar/liferay.rb

@@ -165,9 +165,6 @@ module Caterpillar # :nodoc:
             else
               _p.update(:category => categories.first)
             end
-            # debug
-            #puts _p.inspect
-
           end
         end
 
@@ -190,33 +187,41 @@ module Caterpillar # :nodoc:
       portlets.each do |portlet|
         # <portlet>
         app.elements << self.portlet_element(portlet)
-        # <role-mapper>s
-        roles.each {|role| app.elements << role}
       end
 
-      xml = ''
-      doc.write(xml, -1) # no indentation, tag and text should be on same line
-      #doc.write(xml, 4) # without identation is very dificult to reconfigure those files in production
-      return xml.gsub('\'', '"') # fix rexml attribute single quotes to double quotes
+      # define role-mappers only once, at the end
+      roles.each {|role| app.elements << role}
+
+      return Util.xml_to_s(doc)
     end
 
     # liferay-display XML
     def display_xml(portlets)
       liferay_display_file = File.join(self.WEB_INF,'liferay-display.xml')
-      
-      doc = REXML::Document.new File.new(liferay_display_file)
-      display = doc.root
-                    
+
+      # read existing configuration
+      _doc = REXML::Document.new File.new(liferay_display_file)
+      display = _doc.root
+
+      doc = REXML::Document.new
+      doc << REXML::XMLDecl.new('1.0', 'utf-8') 
+      doc << REXML::DocType.new('display',
+        'PUBLIC  '+\
+        '"-//Liferay//DTD Display %s//EN"  ' % (self.dtd_version) +\
+        '"http://www.liferay.com/dtd/liferay-display_%s.dtd"' % self.dtd_version.gsub('.','_')
+        )
+      doc << display
+
       # include portlets
       Util.categorize(portlets).each_pair do |category_name, portlets|
         category = nil
         display.each_element {|e| if e.attributes['name'] == category_name.to_s then category = e; break end}
-        
+
         unless category
           category = REXML::Element.new('category', display)
           category.attributes['name'] = category_name.to_s
         end
-        
+
         portlets.each do |portlet|
           if category.has_elements?
             # unless he holds does not add again              
@@ -229,14 +234,10 @@ module Caterpillar # :nodoc:
           else
             category.add_element 'portlet', {'id' => portlet[:name]}
           end
-        end                         
-        
+        end
       end
 
-      xml = ''
-      doc.write(xml, -1) # no indentation, tag and text should be on same line
-      #doc.write(xml, 4) # without identation is very dificult to reconfigure those files in production
-      return xml.gsub('\'', '"') # fix rexml attribute single quotes to double quotes
+      return Util.xml_to_s(doc)
     end
 
     protected

data/lib/caterpillar/portlet.rb

@@ -14,6 +14,7 @@ else
 end
 
 module Caterpillar
+
   # Formulates generic JSR286 portlet XML
   class Portlet
     class << self
@@ -54,18 +55,20 @@ module Caterpillar
         end
 
       # create XML element tree
+      # (in proper order so the validation passes)
       portlets.each do |portlet|
         # <portlet>
         app.elements << self.portlet_element(portlet, session, app)
+      end
+      portlets.each do |portlet|
         # <filter>
         app.elements << self.filter_element(portlet)
+      end
+      portlets.each do |portlet|
         # filter mapping
         app.elements << self.filter_mapping(portlet)
       end
-      xml = ''
-      doc.write(xml, -1) # no indentation, tag and text should be on same line
-      #doc.write(xml, 4) # without identation is very dificult to reconfigure those files in production
-      return xml.gsub('\'', '"') # fix rexml attribute single quotes to double quotes
+      return Util.xml_to_s(doc)
     end
 
     # <portlet> element.

data/lib/caterpillar/security.rb

@@ -106,14 +106,18 @@ module Caterpillar # :nodoc:
     # Return Rails' session key    
     def self.get_session_key
       # Rails before 2.3 had a different way
-      if RAILS_GEM_VERSION.gsub('.','').to_i < 230
+      if defined?(RAILS_GEM_VERSION) and RAILS_GEM_VERSION.gsub('.','').to_i < 230
         ActionController::Base.session_options_for(nil,nil)[:session_key]
       # On Rails 2.3:
       else
         key = ActionController::Base.session_options[:key]
         return key unless key.nil?
         # try session_key
-        ActionController::Base.session_options[:session_key]
+        key = ActionController::Base.session_options[:session_key]
+        return key unless key.nil?
+        # XXX: Rails changed sometime during 2.3.8 ..
+        STDERR.puts 'Failed to read session key - consider this a bug'
+        return nil
       end
     end
 

data/lib/caterpillar/task.rb

@@ -140,7 +140,7 @@ module Caterpillar
       end              
       
       task :makexml => tasks
-      puts 'Done!'
+      #puts 'Done!'
     end
 
     # Prints the list of portlets.

data/lib/caterpillar/util.rb

@@ -124,6 +124,19 @@ module Caterpillar
       return ret
     end
 
+    def xml_to_s(doc)
+      # Serializes the REXML::Document to String.
+      # It has to pass Ruby unit test validation and Liferay runtime validation.
+      # The XML requires strict ordering of the child nodes,
+      # and also tags and values have to be on a single line.
+      require 'rexml/formatters/pretty'
+      str = String.new
+      fmt = REXML::Formatters::Pretty.new(4)
+      fmt.compact = true
+      fmt.write(doc,str)
+      return str.gsub('\'', '"') # fix rexml attribute single quotes to double quotes
+    end
+
     end # static
   end
 end

data/lib/rails_gem_chooser.rb

@@ -41,7 +41,7 @@ class RailsGemChooser
       config = f.read
       f.close
       rails_gem_version = config[/^RAILS_GEM_VERSION.*(\d\.\d\.\d)/,1]
-      STDOUT.puts 'Detected Rails version %s from the config file %s' % [rails_gem_version,config_file]
+      #STDOUT.puts 'Detected Rails version %s from the config file %s' % [rails_gem_version,config_file]
       return rails_gem_version
     end
   end

data/portlet_test_bench/controllers/caterpillar/xhr_controller.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+class Caterpillar::XhrController < Caterpillar::ApplicationController
+
+  def prototype
+    # the page with the XHR triggers
+    @javascripts = %w{prototype}
+    render :action => 'time'
+  end
+
+  def jquery
+    # the page with the XHR triggers
+    @javascripts = %w{jquery-1.4.2.min}
+    render :action => 'time'
+  end
+
+  def get_time
+    send_data Time.now.to_s, :type => 'text/html'
+  end
+
+end

data/portlet_test_bench/routing.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 
-
 module Caterpillar #:nodoc:
   # Routes for Portlet Test Bench.
   module Routing
@@ -10,7 +9,7 @@ module Caterpillar #:nodoc:
         @set.add_named_route(
           'portlet_test_bench',
           'caterpillar/test_bench',
-          {:controller => 'Caterpillar::Application'})
+          {:controller => 'Caterpillar::Application', :action => 'portlet_test_bench'})
 
         @set.add_route(
           'caterpillar/test_bench/http_methods/:action',
@@ -44,6 +43,10 @@ module Caterpillar #:nodoc:
           'caterpillar/test_bench/liferay/:action',
           {:controller => 'Caterpillar::Liferay'})
 
+        @set.add_route(
+          'caterpillar/test_bench/xhr/:action',
+          {:controller => 'Caterpillar::Xhr'})
+
         # Liferay GID
         @set.add_route(
           'caterpillar/test_bench/liferay/:action/gid/:gid',
@@ -54,6 +57,12 @@ module Caterpillar #:nodoc:
           'caterpillar/test_bench/junit/:action',
           {:controller => 'Caterpillar::Junit'})
 
+        # index
+        @set.add_named_route(
+          'caterpillar',
+          'caterpillar/',
+          {:controller => 'Caterpillar::Application'})
+
       end
     end
   end

data/portlet_test_bench/views/caterpillar/application/index.html.erb

@@ -1,143 +1,5 @@
-<body>
-<style type="text/css">
-body {
-background: white;
-}
-#testBenchContainer {
-  background: #FFFFCC;
-  border: 1px solid #B9B9B9;
-  padding: 8px;
-  font-size: 11px;
-  line-height: 15px;
-}
-#testBenchContainer h1 {
-  border-bottom: 1px solid #B9B9B9;
-  color: #990000;
-  font-size: 18px;
-  font-weight: bold;
-  margin-bottom: 20px;
-  padding: 0 0 0 15px;
-}
-#testBenchContainer h2 {
-  border: 1px solid #B9B9B9;
-  color: #990000;
-  font-size: 14px;
-  font-weight: bold;
-  padding: 4px 0 3px 25px;
-  background: white;
-}
-.testContainer {
-  padding: 12px;
-}
-</style>
+Caterpillar <%= Caterpillar::VERSION %>
 
-<div id="testBenchContainer">
+<hr />
 
-<h1>Rails-portlet test bench</h1>
-
-<p style="font-size: 14px;">
-These are isolated test cases of the Rails-portlet, for manual testing in the browser. The <%= link_to_exit_portlet 'source code', 'http://rails-portlet.rubyforge.org/svn/trunk/caterpillar/portlet_test_bench/' -%> can be used as a reference for using the same features in other Rails apps.
-</p>
-
-<h2>HTTP</h2>
-<div class="testContainer">
-
-  <%= link_to 'URL parameter passing',
-        :controller => 'Caterpillar::HttpMethods', :action => :parameter  -%><br />
-
-  <%= link_to 'HTTP POST form',
-        :controller => 'Caterpillar::HttpMethods', :action => :post  -%><br />
-
-  <%= link_to 'HTTP POST and GET redirect',
-        :controller => 'Caterpillar::HttpMethods', :action => :post_and_redirect  -%><br />
-
-  <%= link_to 'HTTP referer (back)',
-        :controller => 'Caterpillar::HttpMethods', :action => :back  -%><br />
-
-  <%= link_to 'HTTP redirect',
-        :controller => 'Caterpillar::HttpMethods', :action => :redirect -%><br />
-
-</div>
-
-
-<h2>JavaScripts</h2>
-<div class="testContainer">
-
-  <%= link_to 'Simple JavaScript',
-        :controller => 'Caterpillar::Js', :action => :simple  -%><br />
-
-  <%= link_to 'Prototype JavaScript',
-        :controller => 'Caterpillar::Js', :action => :prototype  -%><br />
-
-  <%= link_to 'Script.aculo.us JavaScript',
-        :controller => 'Caterpillar::Js', :action => :scriptaculous  -%><br />
-
-  <%= link_to 'jQuery JavaScript',
-        :controller => 'Caterpillar::Js', :action => :jquery  -%><br />
-
-  <%= link_to 'Drag and drop',
-        :controller => 'Caterpillar::Js', :action => :dragndrop  -%><br />
-
-  <%= link_to 'link_to :method => :post',
-        :controller => 'Caterpillar::Js', :action => :link_to_post  -%><br />
-
-</div>
-
-
-<h2>CSS</h2>
-<div class="testContainer">
-
-  <%= link_to 'Simple CSS',
-        :controller => 'Caterpillar::Css', :action => :simple  -%><br />
-
-  <%= link_to 'CSS background image',
-        :controller => 'Caterpillar::Css', :action => :background  -%><br />
-
-</div>
-
-
-<h2>Misc</h2>
-<div class="testContainer">
-
-  <%= link_to 'Image resources',
-        :controller => 'Caterpillar::Resource', :action => :images  -%><br />
-
-  <%= link_to 'Inline text',
-        :controller => 'Caterpillar::Resource', :action => :inline  -%><br />
-
-  <%= link_to 'Link outside the portlet',
-        :controller => 'Caterpillar::Resource', :action => :exit_portlet  -%><br />
-
-  <%= link_to 'Liferay session variables',
-        url_for(
-          :controller => 'Caterpillar::Liferay',
-          :action => :session_variables
-        )+'/uid/%UID%/gid/%GID%'
-  -%><br />
-
-  <%= link_to 'Flash message',
-        :controller => 'Caterpillar::Session', :action => :flash_msg -%><br />
-
-</div>
-
-
-<h2>JUnit</h2>
-
-The JUnit tests are used for automatic testing and they output XML. 
-
-<div class="testContainer">
-
-  <%= link_to 'Session cookie',
-        :controller => 'Caterpillar::Junit', :action => :session_cookie -%><br />
-
-  <%= link_to 'Redirect',
-        :controller => 'Caterpillar::Junit', :action => :redirect -%><br />
-
-  <%= link_to 'Session cookies & redirect',
-        :controller => 'Caterpillar::Junit', :action => :cookies_with_redirect -%><br />
-
-</div>
-
-
-</div>
-</body>
+Includes <%= link_to 'portlet test bench', portlet_test_bench_url %>.

data/portlet_test_bench/views/caterpillar/application/portlet_test_bench.html.erb

@@ -0,0 +1,155 @@
+<body>
+<style type="text/css">
+body {
+background: white;
+}
+.testBenchContainer {
+  background: #FFFFCC;
+  border: 1px solid #B9B9B9;
+  padding: 8px;
+  font-size: 11px;
+  line-height: 15px;
+}
+.testBenchHeader {
+  border-bottom: 1px solid #B9B9B9;
+  color: #990000;
+  font-size: 18px;
+  font-weight: bold;
+  margin-bottom: 20px;
+  padding: 0 0 0 15px;
+}
+.testBenchSuite {
+  border: 1px solid #B9B9B9;
+  color: #990000;
+  font-size: 14px;
+  font-weight: bold;
+  padding: 4px 0 3px 25px;
+  background: white;
+}
+.testContainer {
+  padding: 12px;
+}
+</style>
+
+<div class="testBenchContainer">
+
+<div class="testBenchHeader">Rails-portlet test bench</div>
+
+<p style="font-size: 14px;">
+These are isolated test cases of the Rails-portlet, for manual testing in the browser. The <%= link_to_exit_portlet 'source code', 'http://rails-portlet.rubyforge.org/svn/trunk/caterpillar/portlet_test_bench/' -%> can be used as a reference for using the same features in other Rails apps.
+</p>
+
+<div class="testBenchSuite">HTTP</div>
+<div class="testContainer">
+
+  <%= link_to 'URL parameter passing',
+        :controller => 'Caterpillar::HttpMethods', :action => :parameter  -%><br />
+
+  <%= link_to 'HTTP POST form',
+        :controller => 'Caterpillar::HttpMethods', :action => :post  -%><br />
+
+  <%= link_to 'HTTP POST and GET redirect',
+        :controller => 'Caterpillar::HttpMethods', :action => :post_and_redirect  -%><br />
+
+  <%= link_to 'HTTP referer (back)',
+        :controller => 'Caterpillar::HttpMethods', :action => :back  -%><br />
+
+  <%= link_to 'HTTP redirect',
+        :controller => 'Caterpillar::HttpMethods', :action => :redirect -%><br />
+
+</div>
+
+
+<div class="testBenchSuite">JavaScripts</div>
+<div class="testContainer">
+
+  <%= link_to 'Simple JavaScript',
+        :controller => 'Caterpillar::Js', :action => :simple  -%><br />
+
+  <%= link_to 'Prototype JavaScript',
+        :controller => 'Caterpillar::Js', :action => :prototype  -%><br />
+
+  <%= link_to 'Script.aculo.us JavaScript',
+        :controller => 'Caterpillar::Js', :action => :scriptaculous  -%><br />
+
+  <%= link_to 'jQuery JavaScript',
+        :controller => 'Caterpillar::Js', :action => :jquery  -%><br />
+
+  <%= link_to 'Drag and drop',
+        :controller => 'Caterpillar::Js', :action => :dragndrop  -%><br />
+
+  <%= link_to 'link_to :method => :post',
+        :controller => 'Caterpillar::Js', :action => :link_to_post  -%><br />
+
+</div>
+
+
+<div class="testBenchSuite">CSS</div>
+<div class="testContainer">
+
+  <%= link_to 'Simple CSS',
+        :controller => 'Caterpillar::Css', :action => :simple  -%><br />
+
+  <%= link_to 'CSS background image',
+        :controller => 'Caterpillar::Css', :action => :background  -%><br />
+
+</div>
+
+
+<div class="testBenchSuite">XHR</div>
+<div class="testContainer">
+
+  <%= link_to 'Get time (Prototype)',
+        :controller => 'Caterpillar::Xhr', :action => :prototype  -%><br />
+
+  <%= link_to 'Get time (jQuery)',
+        :controller => 'Caterpillar::Xhr', :action => :jquery  -%><br />
+
+</div>
+
+
+<div class="testBenchSuite">Misc</div>
+<div class="testContainer">
+
+  <%= link_to 'Image resources',
+        :controller => 'Caterpillar::Resource', :action => :images  -%><br />
+
+  <%= link_to 'Inline text',
+        :controller => 'Caterpillar::Resource', :action => :inline  -%><br />
+
+  <%= link_to 'Link outside the portlet',
+        :controller => 'Caterpillar::Resource', :action => :exit_portlet  -%><br />
+
+  <%= link_to 'Liferay session variables',
+        url_for(
+          :controller => 'Caterpillar::Liferay',
+          :action => :session_variables
+        )+'/uid/%UID%/gid/%GID%'
+  -%><br />
+
+  <%= link_to 'Flash message',
+        :controller => 'Caterpillar::Session', :action => :flash_msg -%><br />
+
+</div>
+
+
+<div class="testBenchSuite">JUnit</div>
+
+The JUnit tests are used for automatic testing and they output XML. 
+
+<div class="testContainer">
+
+  <%= link_to 'Session cookie',
+        :controller => 'Caterpillar::Junit', :action => :session_cookie -%><br />
+
+  <%= link_to 'Redirect',
+        :controller => 'Caterpillar::Junit', :action => :redirect -%><br />
+
+  <%= link_to 'Session cookies & redirect',
+        :controller => 'Caterpillar::Junit', :action => :cookies_with_redirect -%><br />
+
+</div>
+
+
+</div>
+</body>

data/portlet_test_bench/views/caterpillar/xhr/time.html.erb

@@ -0,0 +1,29 @@
+<% if @javascripts.include? 'prototype' %>
+<h2>Prototype</h2>
+<p>
+	<%= link_to_remote 'What time it is?', :update => 'result1', :url => {:action => 'get_time'} %>
+</p>
+<div id="result1"></div>
+
+
+<% else %>
+<h2>jQuery</h2>
+<p>
+  <a href="#" id="jq_link">What time it is?</a>
+  <script type="text/javascript">
+  $('#jq_link').click(function(){
+    $.ajax({
+      url: "<%= url_for :action => 'get_time' %>",
+      type: 'POST',
+      data: '',
+      success: function(data) {
+        $('#result2').html(data);
+      }
+    });
+  });
+  </script>
+</p>
+<div id="result2"></div>
+
+
+<% end %>

data/test/portlets_test.rb

@@ -15,6 +15,13 @@ class PortletsTest < Caterpillar::TestCase # :nodoc:
 #     end
 #   end
 
+  def test_session
+    key = Caterpillar::Security.get_session_key()
+    assert_not_nil key
+    secret = Caterpillar::Security.get_secret()
+    assert_not_nil secret
+  end
+
   def test_name
     @portlets.each do |portlet|
       assert_not_nil portlet[:name], '%s has no name' % portlet

data/test/xml_test.rb

@@ -15,6 +15,7 @@ class XmlTest < Caterpillar::TestCase # :nodoc:
     @liferay_tld_table = {
       '5.1.1' => '5.1.0',
       '5.2.0' => '5.2.0',
+      '5.2.3' => '5.2.0',
       '6.0.1' => '6.0.0'
     }
   end
@@ -70,8 +71,8 @@ class XmlTest < Caterpillar::TestCase # :nodoc:
       @config.container.version = version
       xml = @config.container.display_xml(@portlets)
 
-      assert xml[/liferay-display.*#{tld}/],
-        'Failed to create DTD with proper version; liferay %s' % version
+      dtd_v = xml[/liferay-display_(._._.)/,1]
+      assert_equal(tld.gsub('.','_'), dtd_v, 'Failed to create DTD with proper version')
 
       # parse DTD
       dtd_file = File.join(@dtd_dir,'liferay-display_%s.dtd' % tld.gsub('.','_'))
@@ -89,8 +90,8 @@ class XmlTest < Caterpillar::TestCase # :nodoc:
     @liferay_tld_table.each_pair do |version,tld|
       @config.container.version = version
       xml = @config.container.portletapp_xml(@portlets)
-      assert xml[/liferay-portlet-app.*#{tld}/],
-        'Failed to create DTD with proper version; liferay %s' % version
+      dtd_v = xml[/liferay-portlet-app_(._._.)/,1]
+      assert_equal(tld.gsub('.','_'), dtd_v, 'Failed to create DTD with proper version')
 
       # parse DTD
       dtd_file = File.join(@dtd_dir,'liferay-portlet-app_%s.dtd' % tld.gsub('.','_'))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: caterpillar
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: false
   segments: 
   - 1
   - 4
-  - 3
-  version: 1.4.3
+  - 4
+  version: 1.4.4
 platform: ruby
 authors: 
 - Mikael Lammentausta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-03 00:00:00 +03:00
+date: 2010-07-07 00:00:00 +03:00
 default_executable: caterpillar
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,6 +118,7 @@ files:
 - portlet_test_bench/controllers/caterpillar/resource_controller.rb
 - portlet_test_bench/controllers/caterpillar/session_controller.rb
 - portlet_test_bench/controllers/caterpillar/user_controller.rb
+- portlet_test_bench/controllers/caterpillar/xhr_controller.rb
 - portlet_test_bench/helpers/caterpillar/application_helper.rb
 - portlet_test_bench/helpers/caterpillar/junit_helper.rb
 - portlet_test_bench/README.rdoc
@@ -125,6 +126,7 @@ files:
 - portlet_test_bench/routing.rb
 - portlet_test_bench/views/caterpillar/application/_back_to_menu.html.erb
 - portlet_test_bench/views/caterpillar/application/index.html.erb
+- portlet_test_bench/views/caterpillar/application/portlet_test_bench.html.erb
 - portlet_test_bench/views/caterpillar/css/background.html.erb
 - portlet_test_bench/views/caterpillar/css/simple.html.erb
 - portlet_test_bench/views/caterpillar/http_methods/back.html.erb
@@ -162,6 +164,7 @@ files:
 - portlet_test_bench/views/caterpillar/session/cookie.html.erb
 - portlet_test_bench/views/caterpillar/session/flash_display.html.erb
 - portlet_test_bench/views/caterpillar/user/home.html.erb
+- portlet_test_bench/views/caterpillar/xhr/time.html.erb
 - portlet_test_bench/views/layouts/bare.html.erb
 - portlet_test_bench/views/layouts/basic.html.erb
 - test/dtd/liferay-display_5_1_0.dtd