caterpillar 1.3.1 → 1.4.0

data/lib/caterpillar/usage.rb

@@ -12,8 +12,9 @@ module Caterpillar
     def self.show
       STDOUT.puts 'Usage:'
       STDOUT.puts '  See "%s --describe" for an overview of the tasks.' % $0
-      STDOUT.puts
-      STDOUT.puts '  cd to Rails root, and run the "%s pluginize" task' % $0
+      STDOUT.puts       
+      STDOUT.puts 'How to start up a new rails-portlet project?'
+      STDOUT.puts '  caterpillar rails project_name'
       STDOUT.puts
     end
   end

data/lib/caterpillar/util.rb

@@ -10,17 +10,18 @@ module Caterpillar
   class Util
     class << self
 
-    # Reads the configuration
-    def eval_configuration(config=nil)
-      cf = File.join([RAILS_ROOT,Caterpillar::Config::FILE])
-      STDERR.puts 'Caterpillar configuration file could not be found' unless File.exists?(cf)
-
-      if config.nil? && File.exists?(cf)
-        config = eval(File.open(cf) {|f| f.read})
+    # Reads and evaluates the configuration.
+    # If parameter is not given, read from default location (RAILS_ROOT/config/portlets.rb)
+    def eval_configuration(conf_file=nil)
+      return Config.new if not (conf_file or defined?(RAILS_ROOT))
+      # else . . .
+      conf_file ||= File.join([RAILS_ROOT,Caterpillar::Config::FILE])
+      if File.exists?(conf_file)
+        #$stdout.puts "Reading configuration from #{conf_file}" 
+        config = eval(File.open(conf_file) {|f| f.read})
       end
-      config ||= Config.new
       unless config.kind_of? Config
-        warn "Portlet config not provided by override in initializer or #{Config::FILE}; using defaults"
+        $stderr.puts "Configuration was not parsed properly"
         config = Config.new
       end
       return config
@@ -28,39 +29,59 @@ module Caterpillar
 
     # Collects Rails' named routes
     def parse_routes(config)
-# taken from Rails' "routes" task
-#         routes = ActionController::Routing::Routes.routes.collect do |route|
-#           name = ActionController::Routing::Routes.named_routes.routes.index(route).to_s
-#           verb = route.conditions[:method].to_s.upcase
-#           segs = route.segments.inject("") { |str,s| str << s.to_s }
-#           segs.chop! if segs.length > 1
-#           reqs = route.requirements.empty? ? "" : route.requirements.inspect
-#           {:name => name, :verb => verb, :segs => segs, :reqs => reqs}
-#         end
-
-      ActionController::Routing::Routes.named_routes.collect do |route|
-
-        # Ruby 1.9
-        if route.class == Symbol
-          name = route
-          _route = ActionController::Routing::Routes.named_routes.routes[route]
-        # Ruby 1.8
-        elsif route.class == Array
-          name = route[0]
-          _route = route[1] # 'ActionController::Routing::Route'
+      require 'action_controller'
+      require File.join(CATERPILLAR_LIBS, '..','portlet_test_bench', 'routing')
+      ActionController::Routing::RouteSet::Mapper.send :include, Caterpillar::Routing::MapperExtensions
+
+      routes = []
+      config.instances.each do |portlet|
+
+        # clear old routes from memory and reload ActionController
+        ActionController::Routing::Routes.clear!
+
+        # prefer portlet rails_root
+        if portlet[:rails_root]
+          rails_root = portlet[:rails_root]
+        elsif config.rails_root
+          rails_root = config.rails_root
+        else
+          next
         end
-
-        # segments; the path
-        segs = _route.segments.inject("") { |str,s| str << s.to_s }
-        segs.chop! if segs.length > 1
-        # controller and action
-        reqs = _route.requirements
-        # extra variables
-        keys = _route.significant_keys
-        vars = keys - [:action, :controller]
-
-        {:name => name, :path => segs, :reqs => reqs, :vars => vars}
+        # load routes
+        f = File.open(
+          File.join(
+            rails_root,'config','routes.rb'
+            ))
+        eval(f.read())
+        f.close()
+
+        routes <<
+          ActionController::Routing::Routes.named_routes.collect do |route| 
+            # Ruby 1.9
+            if route.class == Symbol
+              name = route
+              _route = ActionController::Routing::Routes.named_routes.routes[route]
+              defaults = {} #TODO: Get default values in ruby 1.9
+            # Ruby 1.8
+            elsif route.class == Array
+              name = route[0]
+              _route = route[1] # 'ActionController::Routing::Route'
+              defaults = route[-1].defaults
+            end
+
+            # segments; the path
+            segs = _route.segments.inject("") { |str,s| str << s.to_s }
+            segs.chop! if segs.length > 1
+            # controller and action
+            reqs = _route.requirements
+            # extra variables
+            keys = _route.significant_keys
+            vars = keys - [:action, :controller]
+
+            {:name => name, :path => segs, :reqs => reqs, :vars => vars, :defaults => defaults}
+          end
       end
+      return routes.flatten
     end
 
     # Reorganizes the portlets hash by category.
@@ -94,6 +115,12 @@ module Caterpillar
         ret.update(category => _portlets)
       end
 
+      # add portlets without category
+      uncategorized = portlets.select {|p| p[:category].nil?}
+      if uncategorized.any?
+        ret.update('undefined' => uncategorized)
+      end
+
       return ret
     end
 

data/lib/rails_gem_chooser.rb

@@ -31,7 +31,7 @@ class RailsGemChooser
         STDERR.puts 'Could not detect Rails version'
         return nil
       end
-	end
+	  end
     # don't attempt to load Rails if building a Rubygem..!
     if $0[/gem$/] or !File.exist?(config_file)
       return nil
@@ -47,10 +47,13 @@ class RailsGemChooser
   end
 
   # Load a specific GEM
-  def __load_gem(name,version)
-    #p 'require gem %s v%s' % [name,version]
-    version ? gem(name, '= '+version) : gem(name)
-    require name
+  def __load_gem(require_name, gem_name, version)
+    version ? gem(gem_name, '= '+version) : gem(gem_name)
+    begin
+      require require_name
+    rescue LoadError
+      require gem_name
+    end
   end
 
   # Either define +rails_gem_version+ or +config_file+
@@ -60,19 +63,20 @@ class RailsGemChooser
     rails_gem_version ||= version(config_file) # also detects ENV['RAILS_GEM_VERSION']
 
     #STDOUT.puts 'Loading Rails version %s' % rails_gem_version
+    # the gem without underline will be removed in Rails3..
+    #rails_gems = %w{ active_support action_pack active_record }
+    # except that with the underline divider the gem is not found ..
+    #rails_gems = %w{ activesupport actionpack activerecord }
+    
+    rails_gems = {              
+      # require name      gem name
+      "active_support" => "activesupport",
+      "action_pack"    => "actionpack",
+      "active_record"  => "activerecord"
+    }
 
-    # XXX: silly hack because gem loading seems to have a problem..
-    # >> gem('active_support', '=2.3.5')
-    # Gem::LoadError: Could not find RubyGem active_support (= 2.3.5)
-    # >> require 'activesupport'
-    # DEPRECATION WARNING: require "activesupport" is deprecated and will be removed in Rails 3. Use require "active_support" instead..
-    require 'active_support' 
-    rails_gems = %w{ actionpack activerecord }
-
-    ActiveSupport::Deprecation.silence do
-      rails_gems.each do |rg|
-        __load_gem(rg,rails_gem_version)
-      end
+    rails_gems.keys.each do |rg_key|
+      __load_gem(rg_key, rails_gems[rg_key], rails_gem_version)
     end
     require 'action_controller'
 

data/portlet_test_bench/README.rdoc

@@ -9,17 +9,17 @@ Caterpillar includes this portlet into a vanilla Rails application:
   cd new_app
   caterpillar pluginize
 
-Edit the config/routes as instructed by the previous command.
+Add "map.caterpillar" to your config/routes.rb!
 
-The command
+Now the command
   caterpillar portlets
 
 Should output
 
  * Portlet configuration ***********************
-Caterpillar
-	Rails-portlet test bench      "portlet_test_bench"	[]
+ Caterpillar
+         Rails-portlet test bench      /caterpillar/test_bench
 
 
-Now launch the Webrick server and navigate to http://localhost:3000/caterpillar/test_bench
+Launch the Webrick server and navigate to http://localhost:3000/caterpillar/test_bench
 

data/portlet_test_bench/controllers/caterpillar/http_methods_controller.rb

@@ -4,8 +4,19 @@
 class Caterpillar::HttpMethodsController < Caterpillar::ApplicationController
 
   def post
-    @msg      = params[:msg] if request.post?
-    @checkbox = params[:checkbox]
+    @postcode = 'SW1A 0AA'
+
+    if request.post?
+      @msg      = params[:msg]
+      @checkbox = params[:checkbox]
+      if params[:postcode]
+        @msg = params[:postcode][@postcode]
+      end
+	  if params[:'_encoding_']
+	    @msg << " with IE hack"
+	  end
+    end
+ 
     render :action => :post
   end
 

data/portlet_test_bench/controllers/caterpillar/junit_controller.rb

@@ -1,8 +1,4 @@
 # encoding: utf-8
-
-
-# encoding: utf-8
-
 class Caterpillar::JunitController < Caterpillar::ApplicationController
 
   layout false
@@ -16,7 +12,13 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
     render :nothing => true
   end
 
-  def basic_tags
+  def images
+    @host = request.host
+    @port = request.port
+    @netloc = 'http://%s:%s' % [@host, @port]
+  end
+
+  def links
     @host = request.host
     @port = request.port
     @netloc = 'http://%s:%s' % [@host, @port]
@@ -104,7 +106,7 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
   
   def preferences
     render :text => "Preferences view"
-  end
+  end    
   
   # Sets a session value so the single SESSION_KEY cookie is set.
   # The output XML prints the session ID and the JUnit test compares this

data/portlet_test_bench/views/caterpillar/http_methods/post.html.erb

@@ -1,11 +1,29 @@
 <div id="http_post">
-  <h1>POST test</h1>
+  <h1>POST tests</h1>
 
-  <div id="http_postform">
+  <%# information of received POST -%>
+  <% if @msg -%>
+    <span id="post_info">
+    Message from last POST:
+      <span id="post_msg">
+        <%= @msg -%>
+      </span>
+    </span>
+  <% end -%>
+
+	<% if @checkbox -%>
+		<span id="post_info">
+		Checkbox was checked
+		</span>
+	<% end -%>
+
+
+  <div class="http_postform">
+  <h2>Regular POST</h2>
     <%= form_tag :action => "post" %>
       <p>
         <span>Input text:</span>
-        <%= text_field_tag "msg", "The Java language was created by James Gosling in June 1991", :size => 42 %>
+        <%= text_field_tag "msg", "The Java language was created by James Gosling in June 1991", :size => 89 %>
       </p>
 
       <p>
@@ -13,40 +31,77 @@
         <input type="checkbox" name="checkbox" value="yay" true />
       </p>
 
-      <p id="submit_tags">
-        <input type="submit" value="Submit values" />
-        <input type="reset" value="Reset to defaults" />
+      <p class="submit_tags">
+        <input type="submit" value="Submit" />
       </p>
     </form>
   </div>
 
 
-  <h2>Message from last POST:</h2>
-  <span id="post_msg">
-    <%= @msg -%>
-  </span>
-  <br />
-  <span id="post_info">
-    <% if @checkbox -%>
-      Checkbox was checked
-    <% else -%>
-      <% if @checkbox == false %>
-<!--
-        Checkbox was unchecked
--->
-      <% end %>
-    <% end -%>
-  </span>
-
-	<h1>Exit portlet w/ POST:</h1>
-Sometimes it is useful to send an action outside the portlet.
-Test this by pressing this button:
-
-	<form action="http://www.google.com/search?exit_portlet=true">
-		<input name="q" value="success" type="hidden" />
-		<input type="submit" value="test" />
-	</form>
+  <h2>POST with accept-charset="UTF-8"</h2>
+  <div class="http_postform">
+    <% form_tag({ :action => "post" }, {:'accept-charset' => "UTF-8"} ) do %>
+      <p>
+        <%= text_field_tag "msg", "å ä ö ♥", :size => 12 %>
+      </p>
+      <p class="submit_tags">
+        <%= submit_tag 'Submit' %>
+      </p>
+    <% end %>
+  </div>
+
+
+  <h2>POST with awkward field names sent as ISO-8859-1</h2>
+  <div class="http_postform">
+    <% form_tag({ :action => "post" }, {:'accept-charset' => "ISO-8859-1"} ) do %>
+      <p>
+			  <%= text_field_tag "postcode[#{@postcode}][]", "è"  %>
+      </p>
+      <p class="submit_tags">
+        <%= submit_tag 'Submit' %>
+      </p>
+    <% end %>
+  </div>
+
+
+  <h2>POST as ISO-8859-1, with IE hack</h2>
+    <script type="text/javascript">
+	function isIE() {
+	  return /msie/i.test(navigator.userAgent) && !/opera/i.test(navigator.userAgent);
+	}
+	function formEncodingIEHack(form) {
+	  if (isIE()) {
+		form.appendChild(
+		  document.createElement("<input name='_encoding_' value='CP1252' type='hidden' />")
+          );
+      }
+      return true;
+    }
+    </script>
+  <div class="http_postform">
+    <% form_tag({ :action => "post" }, {:'accept-charset' => "ISO-8859-1", :onsubmit => "return formEncodingIEHack(this);"} ) do %>
+      <p>
+        <%= text_field_tag "postcode[#{@postcode}][]", "è"  %>
+      </p>
+      <p class="submit_tags">
+        <%= submit_tag 'Submit' %>
+      </p>
+    <% end %>
+  </div>
 
 
+  <h2>Exit portlet w/ POST:</h2>
+  <p>
+	Sometimes it is useful to send an action outside the portlet.
+	Test this with this button:
+  </p>
+  <div class="http_postform">
+    <form action="http://www.google.com/search?exit_portlet=true">
+      <input name="q" value="HTTP POST form" type="hidden" />
+      <p class="submit_tags">
+        <input type="submit" value="Google search" />
+      </p>
+    </form>
+  </div>
 
 </div>

data/portlet_test_bench/views/caterpillar/junit/links.html.erb

@@ -0,0 +1,18 @@
+<html>
+  <head>
+    <title>Portlet title</title>
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
+    <base href="<%= @netloc -%>/images/portlet_test_bench/" />
+  </head>
+  <body>
+    <div id="anchor_absolute_url">
+      <a href="<%= @netloc -%>/caterpillar/test_bench">Absolute url</a>
+    </div>
+    <div id="anchor_absolute_path">
+      <a href="/caterpillar/test_bench">Absolute path</a>
+    </div>
+    <div id="anchor_relative_path">
+      <a href="../../caterpillar/test_bench">Relative path</a>
+    </div>
+  </body>
+</html>

data/portlets-config.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+Caterpillar::Config.new do |portlet|
+
+  # JRUBY_HOME can be set here, unless the environment variable can be used.
+  # portlet.class::JRUBY_HOME = '/usr/local/jruby'
+
+  # The portlet container.
+  # By default only portlet.xml is created.
+  # Currently only Liferay is supported. You may optionally define the version.
+  portlet.container = Liferay
+  # portlet.container.version = '5.2.3'
+
+  # 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/tomcat/'
+
+  # The server that the container is running on.
+  # Possible values:
+  #  - 'Tomcat' (default)
+  #  - 'JBoss/Tomcat'
+  # portlet.container.server = 'JBoss/Tomcat'
+
+  # The server dir is only meaningful with JBoss.
+  # This is the name of the directory in server/.
+  # By default the first entry in the directory is chosen.
+  # portlet.container.server_dir = 'default'
+
+  # Allow to defining the deploy_dir - just the WAR file will be deployed under this directory.
+  # Since version 1.3.0
+  # portlet.container.deploy_dir = '/opt/myDeployDir'
+
+  # The hostname and port.
+  # By default the values are taken from the request.
+  portlet.host = 'http://0.0.0.0:3000'
+ 
+  # If the Rails is running inside a servlet container such as Tomcat,
+  # you can define the servlet here.
+  # By default the servlet is the name of the Rails app.
+  # Without Warbler this should be an empty string.
+  portlet.servlet = ''
+ 
+  # Portlet category. This is only available for Liferay.
+  # By default this is the same as the servlet.
+  # portlet.category = 'Example Rails app'
+
+  # Portlet instances.
+  #
+  # Each named route is mapped to a portlet.
+  #
+  # All keys except for 'name' are obligatory. If the name does not map to a route,
+  # you have to define the route here.
+  # You may override the host, servlet and category here.
+  # Most likely you will want to let ActionController::Routing to set the route.
+  #
+  # Available keys are:
+  #  - :name         -- named route
+  #  - :category     -- portlet category (Liferay only)
+  #  - :title        -- the title in portlet container's category (Liferay only)
+  #  - :edit_mode    -- enables edit mode for the portlet, adds <portlet-mode>edit</portlet-mode> to portlet-ext.xml
+  #                     Default value is false
+  #  - :instanceable -- enables instanceable for the portlet, add <instanceable>true</instanceable> to
+  #                     liferay-portlet-ext.xml. Default value is false
+  #  - :javascripts  -- portlet-specific javascripts that are included at
+  #                     the head of master HTML, such as body onload functions (Liferay only)
+  #  - :host         -- hostname:port of the deployment server
+  #  - :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.
+  # NOTE: this needs to be activated by 'map.caterpillar' in RAILS_ROOT/config/routes.rb
+  portlet.instances << {
+    :name     => 'portlet_test_bench',
+    :title    => 'Rails-portlet test bench',
+    :category => 'Caterpillar',
+    :path     => '/caterpillar/test_bench'
+  }
+
+  # this will include all named routes without further configuration
+  portlet.include_all_named_routes = true
+
+end