caterpillar 0.9.0

data/LICENSES.txt

@@ -0,0 +1,25 @@
+= Caterpillar
+
+Caterpillar is provided under the terms of the MIT license.
+
+(c) Copyright 2008 Cel'Amanzi Ltd and Mikael Lammentausta
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,21 @@
+Caterpillar helps you with building Rails applications to be used in Java
+JSR286 portlets. This is possible with the help of Rails-portlet[http://rails-portlet.rubyforge.org].
+
+Rails portlets have been used on Liferay and the helpers offer specialized methods to support better Liferay integration.
+
+This package offers these functionalities:
+
+ - processes the portlet XML configuration in accordance with the named routes
+See Caterpillar::Config
+
+ - provides a navigation view in development (you will have to enable it manually)
+See Caterpillar::Navigation
+
+ - offers a set of migrations to help with Liferay integration
+
+ - provides a Rake task 'fixtures', which imports live data
+   from the production database for testing
+
+
+
+See the rdoc documentation and caterpillar --describe for the feature list.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: create API doc.'
+task :default => :rdoc
+
+desc 'Test the example plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the example plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Caterpillar'
+  rdoc.main = 'README'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('generators/**/*.rb')
+  rdoc.options << '--line-numbers' << '--inline-source' << '-U'
+end
+
+

data/bin/caterpillar

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+#--
+# (c) Copyright 2008 Mikael Lammentausta, Cel'Amanzi Ltd
+#
+# Constructed heavily upon Warbler's structure.
+# Thanks to Nick Sieger!
+#
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require 'rubygems'
+require 'rake'
+require 'caterpillar'
+
+application = Rake.application
+
+# Load any application rakefiles to aid in autodetecting applications
+Caterpillar.project_application = Rake::Application.new
+Rake.application = Caterpillar.project_application
+Rake::Application::DEFAULT_RAKEFILES.each do |rf|
+  if File.exist?(rf)
+    load rf
+    break
+  end
+end
+
+Rake.application = application
+application.standard_exception_handling do
+  application.init
+
+  # Load the main tasks - choose the namespace
+  Caterpillar::Task.new(ARGV[0] ? ARGV[0].gsub(/:.*/,'') : :usage)
+
+  task :default => :usage
+
+  application.top_level
+end

data/db/migrate/20081205000001_lportal_portlets.rb

@@ -0,0 +1,12 @@
+class LportalPortlets < ActiveRecord::Migration
+  def self.up
+    create_table :lportal_portlets do |t|
+      t.column :name,  :string
+      t.column :title, :string
+    end
+  end
+
+  def self.down
+    drop_table :lportal_portlets
+  end
+end

data/db/migrate/20081205000002_lportal_sequences.rb

@@ -0,0 +1,50 @@
+require 'lportal'
+
+class LportalSequences < ActiveRecord::Migration
+  @@tables = [
+    Account,
+    Address,
+    Asset,
+    Contact,
+    Group,
+    Permission,
+    Phone,
+    ResourceCode,
+    Resource,
+    Role,
+    User,
+    MB::Message,
+    MB::Thread,
+    MB::Discussion,
+    MB::Category,
+    Tag::Entry,
+    Tag::Property,
+    Web::Layout,
+    Web::LayoutSet,
+    Web::PortletPreferences,
+    Web::Portlet
+  ]
+
+  def self.up
+#     start = 8400000 # bigint = 8^8 bytes = 16 million bits, this is halfway up the possible range, rounded up
+#     sql = ""
+#     @@tables.each do |model|
+#       table = model.table_name
+#       primkey = model.primary_key
+#       seq = table+'_'+primkey+'_seq'
+#       sql += "CREATE SEQUENCE #{seq} START #{start}; ALTER TABLE #{table} ALTER #{primkey} SET default nextval('#{seq}');"
+#     end
+#     ActiveRecord::Base.connection.execute(sql)
+  end
+
+  def self.down
+#     sql = ""
+#     @@tables.each do |model|
+#       table = model.table_name
+#       primkey = model.primary_key
+#       seq = table+'_'+primkey+'_seq'
+#       sql += "ALTER TABLE #{table} ALTER #{primkey} DROP default; DROP SEQUENCE #{seq};"
+#     end
+#     ActiveRecord::Base.connection.execute(sql)
+  end
+end

data/generators/caterpillar/USAGE

@@ -0,0 +1 @@
+This writes a set of Caterpillar files into the Rails application.

data/generators/caterpillar/caterpillar_generator.rb

@@ -0,0 +1,52 @@
+# This generator installs the required files into the main Rails application.
+# This generator should always be run after upgrading the plugin.
+class CaterpillarGenerator < Rails::Generator::Base
+  def manifest
+
+    require 'find'
+    file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+    this_dir = File.dirname(File.expand_path(file))
+    tmpl = this_dir+'/templates'
+
+    STDOUT.puts ' * Installing config, stylesheets and images'
+
+    record do |m|
+
+      ### migrations ###
+      m.directory('config')
+      file = 'portlets.rb'
+      m.file('config/'+file, 'config/'+file)
+      ####################################
+
+
+      ### stylesheet ###
+      target = 'public/stylesheets/caterpillar'
+      m.directory(target)
+      file = 'caterpillar.css'
+      m.file('stylesheets/caterpillar/'+file, target+'/'+file)
+      ####################################
+
+      ### javascript ###
+      target = 'public/javascripts/caterpillar'
+      m.directory(target)
+      file = 'caterpillar.js'
+      m.file('javascripts/caterpillar/'+file, target+'/'+file)
+      ####################################
+
+      ### images ###
+      target = 'public/images/caterpillar'
+      m.directory(target)
+      file = 'caterpillar.gif'
+      m.file('images/caterpillar/'+file, target+'/'+file)
+      ####################################
+
+#       ### views ###
+#       target = 'app/views/caterpillar'
+#       m.directory(target)
+#       file = '_navigation.html.erb'
+#       m.file('views/caterpillar/'+file, target+'/'+file)
+#       ####################################
+# 
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+Caterpillar::Config.new do |portlet|
+
+  # 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.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/'
+
+  # The hostname and port.
+  # By default the values are taken from the request.
+  # portlet.host
+
+  # 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.
+  # Remember to update this if you override Warbler's default.
+  # portlet.servlet
+
+  # Portlet category. This is only available for Liferay.
+  # By default this is the same as the servlet.
+  # portlet.category = 'Zcore'
+
+  # 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)
+  #  - :javascripts -- portlet-specific javascripts that are not in the HTML head section (Liferay only)
+  #  - :host
+  #  - :servlet
+  #  - :path        -- unless you're using named routes, you can define the path here
+
+  # example:
+  #   portlet.instances << {
+  #     :name     => 'rails286_test',
+  #     :title    => 'Rails-portlet testing application',
+  #     :category => 'Testing',
+  #     :servlet  => 'RailsTestBench',
+  #     :path     => '/'
+  #   }
+
+  # this will include all named routes without further configuration
+  portlet.include_all_named_routes = true
+
+end

data/generators/caterpillar/templates/javascripts/caterpillar/caterpillar.js

@@ -0,0 +1,15 @@
+function cp_toggle_category(c,categories) {
+  c_el = document.getElementById(c);
+  p_el = document.getElementById(c+'_portlets');
+
+  if (p_el.style.display=='none') {
+    p_el.style.display='block';
+    c_el.style.background='yellow';
+  }
+  else {
+    p_el.style.display='none';
+    c_el.style.background='white';
+  }
+
+
+}

data/generators/caterpillar/templates/stylesheets/caterpillar/caterpillar.css

@@ -0,0 +1,48 @@
+.caterpillar_navigation {
+background: url('/images/caterpillar/caterpillar.gif') no-repeat;
+padding: 10px 0 0 50px;
+margin-left: 10px;
+min-height: 50px;
+filter:alpha(opacity=81);-moz-opacity:.81;opacity:.81;
+/* css3 tags, works on Firefox and Safari */
+-moz-border-radius: 15px;
+-webkit-border-radius: 15px;
+}
+
+.caterpillar_navigation ul {
+list-style-type: none;
+}
+
+.cp_category {
+float: left;
+border: 3px double blue;
+margin: 0 14px 5px 14px;
+padding: 5px;
+-moz-border-radius: 12px;
+-webkit-border-radius: 12px;
+background: white;
+}
+
+.cp_portlets {
+float: break;
+overflow: hidden;
+margin: 0 40px 10px 40px;
+border: 3px double green;
+padding: 5px;
+}
+
+.navlink {
+margin: 5px 14px 5px 14px;
+padding: 5px;
+-moz-border-radius: 12px;
+-webkit-border-radius: 12px;
+}
+
+.navlink a {
+text-decoration: none;
+}
+
+.navlink a:hover {
+-moz-border-radius: 8px;
+-webkit-border-radius: 8px;
+}

data/init.rb

@@ -0,0 +1,8 @@
+file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+this_dir = File.dirname(File.expand_path(file))
+
+# append the views path
+ActionController::Base.append_view_path File.join(this_dir, 'views')
+
+# load the main file
+require File.join(this_dir, 'lib', 'caterpillar')

data/install.rb

@@ -0,0 +1,3 @@
+# This will install required files into the main Rails application.
+system('./script/generate caterpillar')
+

data/lib/caterpillar.rb

@@ -0,0 +1,27 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+
+module Caterpillar
+end
+
+file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+this_dir = File.dirname(File.expand_path(file))
+
+require 'find'
+
+# include all ruby files
+Find.find(this_dir) do |file|
+  if FileTest.directory?(file)
+    if File.basename(file) == 'deprecated'
+      Find.prune # Don't look any further into this directory.
+    else
+      next
+    end
+  else
+    require file if file[/.rb$/]
+  end
+end

data/lib/caterpillar/config.rb

@@ -0,0 +1,57 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  # Portlet configuration. The config file 'config/portlets.rb' should be installed in your Rails application. See the comments in the configuration file for more specific information about each option.
+  class Config
+    FILE = "config/portlets.rb"
+
+    # Are all named routes used, or only the ones specifically defined in the config FILE?
+    attr_accessor :include_all_named_routes
+
+    attr_accessor :category
+
+    attr_accessor :host
+
+    attr_accessor :servlet
+
+    attr_accessor :instances
+
+    attr_reader   :rails_root
+
+    attr_accessor :_container
+
+    attr_accessor :javascripts
+
+    attr_accessor :routes
+
+    # Sets sane defaults that are overridden in the config file.
+    def initialize
+      @rails_root  = File.expand_path(defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)
+      @servlet = File.basename(@rails_root)
+      @category = @servlet
+      @instances = []
+      @javascripts = []
+      @include_all_named_routes = true
+
+      yield self if block_given?
+    end
+
+    # The container class is used for parsing XML files.
+    #
+    # Possible values: Liferay
+    def container
+      self._container
+    end
+
+    # Accepts the configuration option, and instantates the container class.
+    def container=(_class)
+      self._container = _class.new
+    end
+
+
+  end
+end