caterpillar 0.9.0

data/lib/caterpillar/task.rb

@@ -0,0 +1,285 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+#
+# Thanks to Nick Sieger for the rake structure!
+#
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require 'rake'
+require 'rake/tasklib'
+
+require 'actionpack'
+require 'action_controller'
+
+# --
+# Rake task.  Allows defining multiple configurations inside the same
+# Rakefile by using different task names.
+# ++
+module Caterpillar
+  class << self
+    attr_writer :project_application
+    def project_application
+      @project_application || Rake.application
+    end
+  end
+
+  class Task < Rake::TaskLib
+
+    # Task name
+    attr_accessor :name
+
+    # Config
+    attr_accessor :config
+
+    # Portlets
+    attr_reader :portlets
+
+    # The main task.
+    # Reads the configuration file and launches appropriate tasks.
+    # Defines the rake task prefix 'jsr'.
+    def initialize(name = :usage, config = nil, tasks = :define_tasks)
+      @name   = name
+      @config = Util.eval_configuration(config)
+      yield self if block_given?
+      send tasks
+    end
+
+    private
+
+    def define_tasks
+      define_main_task
+      define_usage_task
+      define_pluginize_task
+      define_environment_task
+      define_portletxml_task
+      define_liferayportletappxml_task
+      define_liferaydisplayxml_task
+      define_parse_task
+      define_portlets_task
+      define_fixtures_task
+      define_liferayportlets_task
+      define_migrate_task
+      define_rollback_task
+    end
+
+    # the main XML generator task
+    def define_main_task
+      desc 'Create all XML files according to configuration'
+      tasks = [:parse,"#{@name}:portletxml"]
+      if @config.container.kind_of? Liferay
+        tasks << "#{@name}:liferayportletappxml"
+        tasks << "#{@name}:liferaydisplayxml"
+      end
+      tasks << "portlets" # finally print produced portlets
+      task :jsr => tasks
+    end
+
+    def define_usage_task
+      task :usage do
+        Usage.show
+      end
+    end
+
+    def define_pluginize_task
+      desc "Unpack Caterpillar as a plugin in your Rails application"
+      task :pluginize do
+        if !Dir["vendor/plugins/caterpillar*"].empty?
+          puts "I found an old nest in vendor/plugins; please trash it so I can make a new one"
+          puts "(directory vendor/plugins/caterpillar* exists)"
+        elsif !File.directory?("vendor/plugins")
+          puts "I can't find a place to build my nest"
+          puts "(directory 'vendor/plugins' is missing)"
+        else
+          Dir.chdir("vendor/plugins") do
+            ruby "-S", "gem", "unpack", "caterpillar"
+          end
+          ruby "./script/generate caterpillar"
+        end
+      end
+    end
+
+    # navigation debugging task
+    def define_portlets_task
+      desc 'Prints portlet configuration'
+      task :portlets => :parse do
+        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'
+
+      sql = "SELECT * from %s"
+
+      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
+        end
+      end
+    end
+  end
+
+    ### SUB-TASKS
+
+    # reads Rails environment configuration
+    def define_environment_task
+      task :default => :test
+      task :environment do
+        require(File.join(@config.rails_root, 'config', 'environment'))
+      end
+    end
+
+    # collects Rails' routes and parses the config
+    def define_parse_task
+      task :parse => :environment do
+        @config.routes = Util.parse_routes(@config)
+        @portlets = Parser.new(@config).portlets
+      end
+    end
+
+    # Writes the portlet.xml file
+    def define_portletxml_task
+      @name = :jsr
+      # set the output filename
+      if @config.container.kind_of? Liferay
+        file = 'portlet-ext.xml'
+      else
+        file = 'portlet.xml'
+      end
+      with_namespace_and_config do |name, config|
+        desc "Create JSR286 portlet XML"
+        task "portletxml" do
+          system('touch %s' % file)
+          f=File.open(file,'w')
+          f.write Portlet.xml(@portlets)
+          f.close
+          STDOUT.puts 'Created %s' % file
+        end
+      end
+    end
+
+    # Writes liferay-portlet-ext.xml
+    def define_liferayportletappxml_task
+      @name = :jsr
+      file = 'liferay-portlet-ext.xml'
+      with_namespace_and_config do |name, config|
+        desc 'Create Liferay portlet XML'
+        task "liferayportletappxml" do
+          system('touch %s' % file)
+          f=File.open(file,'w')
+          f.write config.container.portletapp_xml(@portlets)
+          f.close
+          STDOUT.puts 'Created %s' % file
+        end
+      end
+    end
+
+    # Writes liferay-display.xml
+    def define_liferaydisplayxml_task
+      @name = :jsr
+      file = 'liferay-display.xml'
+      with_namespace_and_config do |name, config|
+        desc "Create Liferay display XML"
+        task "liferaydisplayxml" do
+          system('touch %s' % file)
+          f=File.open(file,'w')
+          f.write config.container.display_xml(@portlets)
+          f.close
+          STDOUT.puts 'Created %s' % file
+        end
+      end
+    end
+
+    def define_liferayportlets_task
+      @name = :jsr
+      with_namespace_and_config do |name, config|
+        desc 'Analyses native Liferay portlets XML'
+        task "portlets" do
+          @portlets = config.container.analyze(:native)
+          print_portlets(@portlets)
+        end
+      end
+    end
+
+
+    def define_migrate_task
+      @name = :db
+      with_namespace_and_config do |name, config|
+        desc "Migrates Caterpillar database tables"
+        task :migrate => :environment do
+          require 'active_record'
+          ActiveRecord::Migrator.migrate(
+            File.expand_path(
+              File.dirname(__FILE__) + "/../../db/migrate"))
+  #         Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+
+          @portlets = config.container.analyze(:native)
+          @portlets.each do |portlet|
+            LiferayPortlet.create(
+              :name => portlet[:name],
+              :title => portlet[:title]
+            )
+          end
+        end
+      end
+    end
+
+    def define_rollback_task
+      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)
+  #         Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+        end
+      end
+    end
+
+    def with_namespace_and_config
+      name, config = @name, @config
+      namespace name do
+        yield name, config
+      end
+    end
+
+    protected
+
+    def print_portlets(hash)
+      Util.categorize(hash).each_pair do |category,portlets|
+        puts category
+        portlets.each do |portlet|
+          # spaces
+          spaces = ''
+          0.upto(50-portlet[:title].size+1) do
+            spaces << ' '
+          end
+
+          field = :path
+          puts "\t"+ portlet[:title] +spaces+ portlet[field].inspect
+        end
+      end
+    end
+
+
+
+  end
+end

data/lib/caterpillar/usage.rb

@@ -0,0 +1,21 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  class Usage
+    def self.show
+puts 'Caterpillar v.%s (c) Copyright 2008 Mikael Lammentausta' % VERSION
+puts 'Caterpillar is provided under the terms of the MIT license.'
+puts
+puts 'Usage:'
+puts '  See "%s --describe" for an overview of the tasks.' % $0
+puts
+puts '  cd to Rails root, and run the "%s pluginize" task' % $0
+# puts '  Run "%s" in Rails root' % $0
+# puts '  See 
+    end
+  end
+end

data/lib/caterpillar/util.rb

@@ -0,0 +1,80 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  # Common utility methods
+  class Util
+    class << self
+
+    # Reads the configuration
+    def eval_configuration(config=nil)
+      if config.nil? && File.exists?(Config::FILE)
+        config = eval(File.open(Config::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"
+        config = Config.new
+      end
+      return config
+    end
+
+    # Collects Rails' routes and parses the config
+    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|
+        name = route[0]
+        # segments; the path
+        segs = route[1].segments.inject("") { |str,s| str << s.to_s }
+        segs.chop! if segs.length > 1
+        # controller and action
+        reqs = route[1].requirements
+
+        # extra variables
+        keys = route[1].significant_keys
+        vars = keys - [:action, :controller]
+
+        {:name => name, :path => segs, :reqs => reqs, :vars => vars}
+      end
+    end
+
+    # Reorganizes the portlets hash by category.
+    #
+    #  {'Category 1' => [portlets], 'Category 2' => [portlets]}
+    def categorize(portlets)
+      ret = {}
+# STDERR.puts portlets.first.inspect
+
+      # organize into categories
+      categories = portlets.collect{|p| p[:category]}.uniq.each do |category|
+        # select the portlets in this category
+        _portlets = portlets.select{|p| p[:category]==category}
+        ret.update(category => _portlets)
+      end
+
+# puts ret.inspect
+
+
+#       {'Zcore' => [], 'Foo' => []}
+
+      return ret
+    end
+
+
+
+
+    end # static
+  end
+end

data/lib/caterpillar/version.rb

@@ -0,0 +1,9 @@
+#--
+# (c) Copyright 2008 Mikael Lammentausta
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Caterpillar
+  VERSION = '0.9.0'
+end

data/lib/web/portlet_name.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+module Web # :nodoc:
+  # This model does not appear in the lportal database. This is created by a migration and contains the portlet id => name mappings.
+  class PortletName < ActiveRecord::Base # :nodoc:
+    set_table_name       :web_portlet_names
+  end
+end

data/test/portlets_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+require File.dirname(File.expand_path(__FILE__))+'/test_helper'
+
+class PortletsTest < Caterpillar::TestCase # :nodoc:
+
+#   def test_get
+#     @portlets.each do |portlet|
+#       next if portlet[:reqs].empty?
+#       @controller = portlet[:reqs][:controller]
+#       action = portlet[:reqs][:action]
+#       get action
+#     end
+#   end
+
+  def test_name
+    @portlets.each do |portlet|
+      assert_not_nil portlet[:name], '%s has no name' % portlet
+    end
+  end
+
+  def test_path
+    @portlets.each do |portlet|
+      assert_not_nil portlet[:path], '%s has no path' % portlet[:name]
+    end
+  end
+
+  def test_reqs
+    @portlets.each do |portlet|
+      assert_not_nil portlet[:reqs], '%s has no reqs' % portlet[:name]
+    end
+  end
+
+  def test_vars
+    valid_variables = [:uid,:gid] # the rails-portlet can handle these
+    @portlets.each do |portlet|
+      assert_not_nil portlet[:vars], '%s has no vars' % portlet[:name]
+      portlet[:vars].each do |var|
+        assert valid_variables.include?(var), '%s is not supported by Rails-portlet, file a feature request' % var
+      end
+    end
+  end
+
+end