caterpillar 1.4.4 → 1.6.0

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

@@ -0,0 +1,15 @@
+<% if @resource_url  %>
+
+  <p>
+    <%= link_to 'resource url (with params)', liferay_resource_url(@r_u_params) %>
+    stored to cookie:<br />
+    <span style="font-size:1.2em; text-style: italic;">
+      <%= @resource_url %>
+    </span>
+  </p>
+
+<% else %>
+
+Sorry, the cookie "Liferay_resourceUrl" is not set.
+
+<% end %>

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

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

data/spec/app1/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.caterpillar
+end

data/spec/app2/config/routes.rb

@@ -0,0 +1,7 @@
+ActionController::Routing::Routes.draw do |map|
+  map.caterpillar
+
+  map.hungry_bear(
+    'bear/hungry',
+    { :controller => 'Bear',  :action => 'hungry' })
+end

data/spec/app3/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  map.adorable_otters(
+    '/otters/adorable',
+    { :controller => 'Otter', :action => 'adorable' }) 
+end

data/spec/caterpillar/helper_spec.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+#--
+# Copyright (c) 2010 Mikael Lammentausta
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+require File.join(File.dirname(__FILE__),'..','..','lib','caterpillar')
+require File.join(File.dirname(__FILE__),'..','..','lib','caterpillar','helpers','portlet')
+require File.join(File.dirname(__FILE__),'..','..','lib','caterpillar','helpers','liferay')
+
+class MockController
+  include Caterpillar::Helpers::Liferay
+  attr_accessor :cookies
+end
+
+
+describe Caterpillar::Task do
+
+  before(:all) do
+  end
+
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    verbose(false)
+    @task = Caterpillar::Task.new
+  end
+
+  after(:each) do
+    @task = nil
+  end
+  
+  it "should form resource url" do
+    mock = MockController.new
+    resource_url = 'http://liferay-resource.url:80/'
+    mock.cookies = {
+      :Liferay_resourceUrl => resource_url,
+      :Portlet_namespace => '_test_'
+    }
+
+=begin
+    params = {:route => '/MockController/index'}
+    given_params = params.dup
+    url = mock.liferay_resource_url(params)
+    params.should == given_params # original params should not change
+    url.should == resource_url + '&__test__railsRoute=/MockController/index'
+=end
+
+    # test action
+    params = {:route => '/MockController/moo_action'}
+    #params.update(:action => 'moo_action')
+    given_params = params.dup
+    url = mock.liferay_resource_url(params)
+    params.should == given_params # original params should not change
+    url.should == resource_url + '?__test__railsRoute=/MockController/moo_action'
+
+    # test extra keys
+    params.update(:foo => :bar, :baz => 3)
+    given_params = params.dup
+    url = mock.liferay_resource_url(params)
+    params.should == given_params # original params should not change
+    url.should == resource_url + '?__test__railsRoute=/MockController/moo_action&__test__foo=bar&__test__baz=3'
+
+  end
+
+
+end

data/spec/caterpillar/task_spec.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+#--
+# Copyright (c) 2010 Mikael Lammentausta
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+require File.join(File.dirname(__FILE__),'..','..','lib','caterpillar')
+require 'tmpdir'
+
+describe Caterpillar::Task do
+
+  before(:all) do
+    @liferay_xml_dir = File.dirname(File.expand_path(__FILE__)) + '/../xml'
+  end
+
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    verbose(false)
+    @task = Caterpillar::Task.new
+    @pwd = Dir.pwd
+    @tmpdir = Dir.tmpdir + '/caterpillar'
+    Dir.mkdir(@tmpdir) unless File.exists?(@tmpdir)
+  end
+
+  after(:each) do
+    @task = nil
+    FileUtils.rm_rf @tmpdir
+    Dir.chdir @pwd
+  end
+
+  it "should print version" do
+    capture { Rake::Task["version"].invoke }.should =~ /Caterpillar #{Caterpillar::VERSION}/
+  end
+
+  it "should create a conf file" do
+    Dir.chdir(@tmpdir)
+    fn = "portlets-config.rb"
+    File.exist?(fn).should == false
+    silence { Rake::Task["generate"].invoke }
+    File.exist?(fn).should == true
+  end
+
+  it "should print no route" do
+    portlet = {
+        :name     => 'portlet_test_bench',
+    }
+    @task.config.instances << portlet
+    capture { Rake::Task["portlets"].invoke }.should =~ /no route for portlet_test_bench/
+  end
+
+  it "should print routes" do
+    portlet = {
+        :name     => 'portlet_test_bench',
+    }
+    @task.config.instances << portlet
+    @task.config.rails_root = File.join(File.dirname(__FILE__),'..','app1')
+    capture { Rake::Task["portlets"].invoke }.should =~ /\/caterpillar\/test_bench/
+  end
+
+  it "should parse routes without config.rails_root" do
+    portlet = {
+        :name     => 'portlet_test_bench',
+        :rails_root => File.join(File.dirname(__FILE__),'..','app1')
+    }
+    @task.config.instances << portlet
+    capture { Rake::Task["portlets"].invoke }.should =~ /\/caterpillar\/test_bench/
+  end
+
+  it "should parse routes" do
+    config = Caterpillar::Config.new
+    config.rails_root = File.join(File.dirname(__FILE__),'..','app3')
+    config.instances = [
+    {
+        :name     => 'portlet_test_bench',
+        :title    => 'Rails-portlet test bench',
+        :category => 'Caterpillar',
+        :rails_root => File.join(File.dirname(__FILE__),'..','app1')
+    },
+    {
+        :name     => 'hungry_bear',
+        :rails_root => File.join(File.dirname(__FILE__),'..','app2')
+    },
+    {
+        :name     => 'adorabe_otters'
+    }
+    ]
+    routes = Caterpillar::Util.parse_routes(config)
+    routes.size.should == 6 # "/caterpillar" and "/test_bench" twice
+
+    paths = routes.map {|r| r[:path]}
+    paths.each do |path|
+      route = routes.select {|r| r[:path] == path }.first
+
+      case path
+      when '/caterpillar'
+        route[:reqs][:controller].should == 'Caterpillar::Application'
+        route[:reqs][:action].should == 'index'
+
+      when '/caterpillar/test_bench'
+        route[:reqs][:controller].should == 'Caterpillar::Application'
+        route[:reqs][:action].should == 'portlet_test_bench'
+
+      when '/bear/hungry'
+        route[:reqs][:controller].should == 'Bear'
+        route[:reqs][:action].should == 'hungry'
+
+      when '/otters/adorable'
+        route[:reqs][:controller].should == 'Otter'
+        route[:reqs][:action].should == 'adorable'
+
+      end
+    end
+  end
+
+  it "should define Tomcat WEB-INF location" do
+    container_root = @tmpdir
+
+    @task.config.container = Caterpillar::Liferay
+    @task.config.container.root = container_root
+    @task.config.container.root.should == container_root
+
+    @task.config.container.server = 'Tomcat'
+    @task.config.container.deploy_dir.should == container_root + '/webapps' 
+    @task.config.container.WEB_INF.should == container_root + '/webapps/ROOT/WEB-INF'
+  end
+
+  it "should define JBoss/Tomcat WEB-INF location" do
+    container_root = @tmpdir
+
+    @task.config.container = Caterpillar::Liferay
+    @task.config.container.root = container_root
+    @task.config.container.root.should == container_root
+
+    @task.config.container.server = 'JBoss/Tomcat'
+    # no server_dir!
+    lambda { @task.config.container.WEB_INF }.should raise_error(RuntimeError, /Please configure server_dir/)
+
+    @task.config.container.server_dir = 'server/default/deploy/ROOT.war'
+    @task.config.container.WEB_INF.should == container_root + '/server/default/deploy/ROOT.war/WEB-INF'
+  end
+
+  it "should make XML" do
+    portlet = {:name => 'portlet_test_bench'}
+    @task.config.instances << portlet
+    @task.config.session_secret = {:key => 'test', :secret => 'test_secret'}
+
+    Dir.chdir(@tmpdir)
+    Dir.glob('*.xml').size.should == 0
+
+    silence { Rake::Task["makexml"].invoke }
+
+    File.exists?('portlet-ext.xml').should == true
+    File.exists?('liferay-portlet-ext.xml').should == true
+    File.exists?('liferay-display.xml').should == true
+    File.size('portlet-ext.xml').should > 0
+    File.size('liferay-portlet-ext.xml').should > 0
+    File.size('liferay-display.xml').should > 0
+  end
+
+  it "should deploy XML on Tomcat" do
+    portlet = {:name => 'portlet_test_bench'}
+    @task.config.instances << portlet
+    @task.config.session_secret = {:key => 'test', :secret => 'test_secret'}
+
+    container_root = @tmpdir
+    @task.config.container.root = container_root
+    @task.config.container.server = 'Tomcat'
+
+    web_inf = container_root + '/webapps/ROOT/WEB-INF'
+    @task.config.container.WEB_INF.should == web_inf
+
+    File.exists?(web_inf).should == false
+    FileUtils.cp_r(
+      @liferay_xml_dir + '/liferay-portal-5.2.3/tomcat-6.0.18/webapps',
+      container_root)
+    File.exists?(web_inf).should == true
+
+    silence { Rake::Task["deploy:xml"].invoke }
+
+    Dir.chdir(web_inf)
+    File.exists?('portlet-ext.xml').should == true
+    File.exists?('liferay-portlet-ext.xml').should == true
+    File.exists?('liferay-display.xml').should == true
+    File.size('portlet-ext.xml').should > 0
+    File.size('liferay-portlet-ext.xml').should > 0
+    File.size('liferay-display.xml').should > 0
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format nested
+--loadby mtime
+--reverse
+--diff unified

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+raise %{Error: detected running specs in a Rails app;
+Caterpillar specs are destructive to application directories.} if File.directory?("app")
+
+def silence(io = nil)
+  require 'stringio'
+  old_stdout = $stdout
+  old_stderr = $stderr
+  $stdout = io || StringIO.new
+  $stderr = io || StringIO.new
+  yield
+ensure
+  $stdout = old_stdout
+  $stderr = old_stderr
+end
+
+def capture(&block)
+  require 'stringio'
+  io = StringIO.new
+  silence(io, &block)
+  io.string
+end
+
+Spec::Runner.configure do |config|
+  config.after(:each) do
+    class << Object
+      public :remove_const
+    end
+    Object.remove_const("Rails") rescue nil
+    rm_rf "vendor"
+  end
+end

data/test/README

@@ -0,0 +1,4 @@
+Run the tests from Rails, by rake test:plugins.      
+
+Spec tests should be run at Caterpillar root, by "spec ."
+

data/test/dtd/liferay-display_5_1_0.dtd

@@ -1,45 +1,45 @@
-<!--
-This is the DTD for the Display parameters for Liferay Portal.
-
-<!DOCTYPE display PUBLIC
-	"-//Liferay//DTD Display 5.1.0//EN"
-	"http://www.liferay.com/dtd/liferay-display_5_1_0.dtd">
--->
-
-<!--
-The display element is the root of the deployment descriptor that describes how
-portlets are categorized and displayed for users to choose when personalizing a
-page in Liferay Portal.
--->
-<!ELEMENT display (category*)>
-
-<!--
-The category element organizes a set of portlets. A portlet can exist in more
-than one category.
--->
-<!ELEMENT category (category*, portlet*)>
-
-<!--
-The name of a category is mapped to the portal's Language properties. If the
-category name is "test", then the key in the portal's resource bundle will be
-"category.test".
-
-See:
-
-http://www.liferay.com/page/guest/documentation/development/languages
--->
-<!ATTLIST category
-	name CDATA #REQUIRED
->
-
-<!--
-The portlet element represents a portlet.
--->
-<!ELEMENT portlet (#PCDATA)>
-
-<!--
-The id must match the unique portlet-name specified in portlet.xml.
--->
-<!ATTLIST portlet
-	id CDATA #REQUIRED
+<!--
+This is the DTD for the Display parameters for Liferay Portal.
+
+<!DOCTYPE display PUBLIC
+	"-//Liferay//DTD Display 5.1.0//EN"
+	"http://www.liferay.com/dtd/liferay-display_5_1_0.dtd">
+-->
+
+<!--
+The display element is the root of the deployment descriptor that describes how
+portlets are categorized and displayed for users to choose when personalizing a
+page in Liferay Portal.
+-->
+<!ELEMENT display (category*)>
+
+<!--
+The category element organizes a set of portlets. A portlet can exist in more
+than one category.
+-->
+<!ELEMENT category (category*, portlet*)>
+
+<!--
+The name of a category is mapped to the portal's Language properties. If the
+category name is "test", then the key in the portal's resource bundle will be
+"category.test".
+
+See:
+
+http://www.liferay.com/page/guest/documentation/development/languages
+-->
+<!ATTLIST category
+	name CDATA #REQUIRED
+>
+
+<!--
+The portlet element represents a portlet.
+-->
+<!ELEMENT portlet (#PCDATA)>
+
+<!--
+The id must match the unique portlet-name specified in portlet.xml.
+-->
+<!ATTLIST portlet
+	id CDATA #REQUIRED
 >