rsence 2.0.0.5.pre → 2.0.0.6.pre

data/lib/plugins/plugin_plugins.rb

@@ -1,4 +1,4 @@
-##   Riassence Framework
+##   RSence
  #   Copyright 2010 Riassence Inc.
  #   http://riassence.com/
  #
@@ -6,6 +6,8 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
+module ::RSence
+module Plugins
 ## Interface to enable plugins in a plugin. Just include this in your subclass of Plugin.
 module PluginPlugins
   def init
@@ -45,3 +47,5 @@ module PluginPlugins
     @plugin_plugins.delegate(:cloned_source,msg,target_session)
   end
 end
+end
+end

data/lib/plugins/plugin_sqlite_db.rb

@@ -1,4 +1,4 @@
-##   Riassence Framework
+##   RSence
  #   Copyright 2009 Riassence Inc.
  #   http://riassence.com/
  #
@@ -6,6 +6,8 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
+module ::RSence
+module Plugins
 # Include this module in your plugin class to automatically
 # create and connect/disconnect an sqllite database.
 # The plugin instance will have a @db Sequel object refering
@@ -70,3 +72,5 @@ module PluginSqliteDB
   end
 end
 
+end
+end

data/lib/plugins/plugin_util.rb

@@ -1,8 +1,28 @@
+##   RSence
+ #   Copyright 2010 Riassence Inc.
+ #   http://riassence.com/
+ #
+ #   You should have received a copy of the GNU General Public License along
+ #   with this software package. If not, contact licensing@riassence.com
+ ##
 
+module ::RSence
+module Plugins
 module PluginUtil
   
   include RSence
 
+  # 
+  # def self.method_missing( name, *args, &block )
+  #   puts "method_missing:"
+  #   puts "  name: #{name.inspect}"
+  #   puts "  args: #{args.inspect}"
+  #   puts "  block: #{block.inspect}"
+  #   if name == :bundle_path
+  #     return Info.new( Module.nesting ).bundle_path
+  #   end
+  # end
+  
   # Extend to do any initial configuration. Not doing anything by default.
   def init
   end
@@ -92,3 +112,5 @@ module PluginUtil
   end
   
 end
+end
+end

data/lib/plugins/pluginmanager.rb

@@ -1,65 +1,69 @@
-##   Riassence Framework
+##   RSence
  #   Copyright 2006 Riassence Inc.
  #   http://riassence.com/
  #
  #   You should have received a copy of the GNU General Public License along
  #   with this software package. If not, contact licensing@riassence.com
  ##
+# if RUBY_VERSION.to_f >= 1.9
+#   # with_module comes from:
+#   # http://coderrr.wordpress.com/2009/05/18/dynamically-adding-a-constant-nesting-in-ruby-1-9/
+#   module Kernel
+#     def with_module(*consts, &blk)
+#       slf = blk.binding.eval('self')
+#       l = lambda { slf.instance_eval(&blk) }
+#       consts.reverse.inject(l) {|l, k| lambda { k.class_eval(&l) } }.call
+#     end
+#   end
+# end
 
-
-def bundle_loader( params )
-  src_path = params[:src_path]
-  mod = Module.new do |m|
-    @@bundle_path    = params[:bundle_path   ]
-    @@bundle_name    = params[:bundle_name   ]
-    @@bundle_info    = params[:bundle_info   ]
-    @@plugin_manager = params[:plugin_manager]
-    begin
-      if params[:bundle_info][:inits_self] == false
-        m::module_eval( File.read(src_path) )
-      elsif params[:bundle_info][:reloadable] == false
-        require src_path[0..-4]
-      else
-        load src_path
-      end
-    rescue => e
-      @@plugin_manager.plugin_error(
-        e,
-        'BundleLoaderError',
-        "An error occurred while loading the plugin bundle #{@@bundle_name}.",
-        @@bundle_path
-      )
-    end
-  end
-  return mod
-end
-
+# def bundle_loader( params )
+#   src_path = params[:src_path]
+#   mod = Module.new do |m|
+#     @@bundle_path    = params[:bundle_path   ]
+#     @@bundle_name    = params[:bundle_name   ]
+#     @@bundle_info    = params[:bundle_info   ]
+#     @@plugin_manager = params[:plugin_manager]
+#     def m.bundle_path; @@bundle_path; end
+#     def m.bundle_name; @@bundle_name; end
+#     def m.bundle_info; @@bundle_info; end
+#     def m.bundle_manager; @@bundle_manager; end
+#     begin
+# #       if RUBY_VERSION.to_f >= 1.9
+# #         # with_module(m) do
+# #           src = File.read(src_path)
+# #           self.module_eval(
+# # <<-SRC
+# # puts %{--- bundle_path: #{bundle_path.inspect}}
+# # #{src}
+# # SRC
+# #           )
+# #         # end
+# #       else
+#         if params[:bundle_info][:inits_self] == false or RUBY_VERSION.to_f >= 1.9
+#           m::module_eval( File.read(src_path) )
+#         elsif params[:bundle_info][:reloadable] == false
+#           require src_path[0..-4]
+#         else
+#           load src_path
+#         end
+#       # end
+#     rescue => e
+#       @@plugin_manager.plugin_error(
+#         e,
+#         'BundleLoaderError',
+#         "An error occurred while loading the plugin bundle #{@@bundle_name}.",
+#         @@bundle_path
+#       )
+#     end
+#   end
+#   return mod
+# end
+# 
 
 module RSence
 
-# Contains the PluginUtil module which has common methods for the bundle classes
-require 'plugins/plugin_util'
-
-# plugin.rb contains the Plugin skeleton class
-require 'plugins/plugin'
-
-# guiparser.rb contains the Yaml serializer for gui trees.
-# It uses JSONRenderer on the client to build user interfaces.
-require 'plugins/guiparser'
-
-# gui_plugin.rb is an extension of Plugin that uses
-# GUIParser to init the gui automatically.
-require 'plugins/gui_plugin'
-
-# plugin_sqlite_db.rb contains automatic local sqlite database
-# creation for a plugin that includes it.
-require 'plugins/plugin_sqlite_db'
-
-# servlet includes the Servlet class, for handling any requests / responses
-require 'plugins/servlet'
-
-# Interface for plugins in a plugin bundle
-require 'plugins/plugin_plugins'
+require 'plugins/plugins'
 
 ## = Abstract
 ## PluginManager is the service that loads and provides method delegation
@@ -280,7 +284,7 @@ class PluginManager
       
       # A flag (when false) enables automatic construction
       # of the Plugin and Servlet classes contained.
-      :inits_self => true,
+      :inits_self => false,
       
       # System version requirement.
       :sys_version => '>= 1.0.0',
@@ -323,47 +327,32 @@ class PluginManager
     
     bundle_src = File.read( bundle_file_path )
     
-    if RUBY_VERSION.to_f >= 1.9
-      puts "ruby 1.9.x"
-      puts "ruby version: #{RUBY_VERSION.inspect}"
-      src_path = bundle_file_path
-      plugin_manager = self
-      module_ns = Module.new do |m|
-        @@bundle_path    = bundle_path
-        @@bundle_name    = bundle_name
-        @@bundle_info    = bundle_info
-        @@plugin_manager = plugin_manager
-        def m.bundle_path; @@bundle_path; end
-        puts "using load"
-        load src_path
-      end
-    else
-      module_ns         = bundle_loader( {
-        :bundle_path    => bundle_path,
-        :bundle_name    => bundle_name,
-        :bundle_info    => bundle_info,
-        :plugin_manager => self,
-        :src_path       => bundle_file_path,
-        :src            => bundle_src
-      } )
-    end
+    module_ns         = Plugins.bundle_loader( {
+      :bundle_path    => bundle_path,
+      :bundle_name    => bundle_name,
+      :bundle_info    => bundle_info,
+      :plugin_manager => self,
+      :src_path       => bundle_file_path,
+      :src            => bundle_src
+    } )
     
-    unless bundle_info[:inits_self]
+    if bundle_info[:inits_self]
+      warn "Plugins can't init them self anymore. Please fix plugin: #{bundle_name.inspect}"
+    else
       module_ns.constants.each do |module_const_name|
         module_const = module_ns.const_get( module_const_name )
         if module_const.class == Class
-          module_const.ancestors.each do |ancestor|
-            if ancestor.to_s == "Servlet"
-              module_const.new
-              break
-            elsif ancestor.to_s == "Plugin"
-              module_const.new.register( bundle_name )
-              break
-            elsif ancestor.to_s == "Object"
-              puts "Can't init class: #{module_const.to_s}"
-              break
-            end
+          bundle_type = module_const.bundle_type
+          if [:Servlet, :Plugin, :GUIPlugin].include? bundle_type
+            bundle_inst = module_const.new( bundle_name, bundle_info, bundle_path, self )
+            bundle_inst.register( bundle_name ) if [ :Plugin, :GUIPlugin ].include?( bundle_type )
+            break
+          else
+            warn "Can't init class: #{module_const.to_s}"
+            break
           end
+        else
+          warn "module_const.class: #{module_const.class.inspect}"
         end
       end
     end
@@ -381,7 +370,8 @@ class PluginManager
     else
       inst.init if inst.respond_to? :init and not inst.inited
       @registry[ bundle_name ] = inst
-      if inst.respond_to?( :match )
+      if inst.respond_to?( :match ) and ( inst.respond_to?( :get ) or inst.respond_to?( :post ) )
+        puts " --- servlet: #{bundle_name.inspect}, #{inst.respond_to?(:match)}, #{inst.post}" if bundle_name == :welcome
         @servlets.push( bundle_name )
       end
     end
@@ -405,11 +395,11 @@ class PluginManager
       "\t"+e.backtrace.join("\n\t"),
       "*"*40
     ].join("\n")+"\n"
-    puts
-    puts "eval repl: #{eval_repl}"
-    puts
     if eval_repl
-      err_msg = err_msg.gsub('from (eval):',"from #{eval_repl}:")
+      puts
+      puts "plugin: #{eval_repl}"
+      puts
+      err_msg = err_msg.gsub(/^\t\(eval\)\:/s,"\t#{eval_repl}:")
     end
     $stderr.write( err_msg )
   end
@@ -458,7 +448,16 @@ class PluginManager
   def delegate( method_name, *args )
     @registry.each do | plugin_name, plugin |
       if plugin.respond_to?( method_name )
-        plugin.send( method_name, *args  )
+        begin
+          plugin.send( method_name, *args  )
+        rescue => e
+          plugin_error(
+            e,
+            "RSence::PluginManager.delegate error",
+            "plugin_name: #{plugin_name.inspect}, method_name: #{method_name.inspect}",
+            plugin_name
+          )
+        end
       end
     end
   end
@@ -490,6 +489,7 @@ class PluginManager
     matches_order = match_servlet_uri( req_uri, req_type )
     return false unless matches_order
     matches_order.each do |servlet_name|
+      # puts "servlet name: #{servlet_name.inspect}" if RSence.args[:debug]
       begin
         @registry[servlet_name].send( req_type, req, resp, session )
         return true

data/lib/plugins/plugins.rb

@@ -0,0 +1,117 @@
+##   RSence
+ #   Copyright 2009 Riassence Inc.
+ #   http://riassence.com/
+ #
+ #   You should have received a copy of the GNU General Public License along
+ #   with this software package. If not, contact licensing@riassence.com
+ ##
+
+# Contains the PluginUtil module which has common methods for the bundle classes
+require 'plugins/plugin_util'
+
+# guiparser.rb contains the Yaml serializer for gui trees.
+# It uses JSONRenderer on the client to build user interfaces.
+require 'plugins/guiparser'
+
+# plugin_sqlite_db.rb contains automatic local sqlite database
+# creation for a plugin that includes it.
+require 'plugins/plugin_sqlite_db'
+
+# Interface for plugins in a plugin bundle
+require 'plugins/plugin_plugins'
+
+module ::RSence
+  module Plugins
+    
+    # plugin.rb contains the Plugin skeleton class
+    require 'plugins/plugin'
+    def self.PluginMaker
+      lambda do |ns|
+        klass = Class.new( PluginTemplate ) do
+          def self.ns=(ns)
+            define_method( :bundle_info ) do
+              ns.bundle_info
+            end
+          end
+        end
+        klass.ns = ns if ns
+        klass
+      end
+    end
+    
+    # gui_plugin.rb is an extension of Plugin that uses
+    # GUIParser to init the gui automatically.
+    require 'plugins/gui_plugin'
+    def self.GUIPluginMaker
+      lambda do |ns|
+        klass = Class.new( GUIPluginTemplate ) do
+          def self.ns=(ns)
+            define_method( :bundle_info ) do
+              ns.bundle_info
+            end
+          end
+        end
+        klass.ns = ns if ns
+        klass
+      end
+    end
+    
+    # servlet includes the Servlet class, for handling any requests / responses
+    require 'plugins/servlet'
+    def self.ServletMaker
+      lambda do |ns|
+        klass = Class.new( ServletTemplate ) do
+          def self.ns=(ns)
+            define_method( :bundle_info ) do
+              ns.bundle_info
+            end
+          end
+        end
+        klass.ns = ns if ns
+        klass
+      end
+    end
+    
+    def self.bundle_loader( params )
+      src_path = params[:src_path]
+      begin
+        mod = Module.new do |m|
+          if RUBY_VERSION.to_f >= 1.9
+            m.define_singleton_method( :bundle_path ) do
+              params[:bundle_path]
+            end
+          end
+          def self.inspect; "#<module BundleWrapper of #{@@bundle_name}}>"; end
+          def self.const_missing( name )
+            if name == :Servlet
+              return Plugins.ServletMaker.call( self )
+            elsif name == :ServletPlugin
+              warn "'ServletPlugin' is deprecated, use 'Servlet' instead."
+              return Plugins.ServletMaker.call( self )
+            elsif name == :Plugin
+              return Plugins.PluginMaker.call( self )
+            elsif name == :GUIPlugin
+              return Plugins.GUIPluginMaker.call( self )
+            else
+              warn "Known const missing: #{name.inspect}"
+              super
+            end
+          end
+          plugin_src = File.read( src_path )
+          unless RUBY_VERSION.to_f >= 1.9
+            plugin_src = ["bundle_path = #{params[:bundle_path].inspect}", plugin_src].join("\n")
+          end
+          m.module_eval( plugin_src )
+        end
+        return mod
+      rescue => e
+        params[:plugin_manager].plugin_error(
+          e,
+          'BundleLoaderError',
+          "An error occurred while loading the plugin bundle #{params[:bundle_name]}.",
+          src_path
+        )
+      end
+    end
+  end
+end

data/lib/plugins/servlet.rb

@@ -1,4 +1,4 @@
-##   Riassence Framework
+##   RSence
  #   Copyright 2009 Riassence Inc.
  #   http://riassence.com/
  #
@@ -6,64 +6,54 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
-## Register the ServletPlugin with a regular expression that
+## Register the Servlet with a regular expression that
 ## should match its uri. Alternatively just a string, but
 ## that needs to be an exact match.
-## servlet_plug = ServletPlugin.new
-## servlet_plug.register_get( /\/about\/.*/ )
-## servlet_plug.register_post( '/mailsender' )
-## servlet_plug.register( /\/feedback\/.*/ )
-class Servlet
-  
-  include PluginUtil
-  
-  # Initializes and registers the ServletPlugin.
-  def initialize( name = false )
-    @info    = @@bundle_info
-    if name
-      @name = name
-    else
-      @name    = @@bundle_name
-    end
-    @path    = @@bundle_path
-    @plugins = @@plugin_manager
-    register
-    @inited = false
-  end
-  
-  # Servlet ID
-  attr_reader :name, :path, :info, :inited
-  def register # :nodoc
-    @plugins.register_bundle( self, @name )
-    @inited = true
-  end
-  
-  ## Extendables
-  
-  # Return true to match, false to not match. Returns false as default if 
-  # not extended.
-  def match( uri, request_type=:get )
-    return false
-  end
-  
-  # If match, return score (lower is better). Returns 100 by defalt if not 
-  # extended
-  def score
-    return 100
-  end
-  
-  # Extend to do any GET request processing. Not doing anything by default.
-  def get( req, res, ses )
-    
-  end
-  
-  # Extend to do any POST request processing. Not doing anything by default.
-  def post( req, res, ses )
-    
-  end
-  
-end
+module ::RSence
+  module Plugins
+    class ServletTemplate
+      include PluginUtil
+      def self.bundle_type; :Servlet; end
+      # Initializes and registers the ServletPlugin.
+      def initialize( bundle_name, bundle_info, bundle_path, plugin_manager )
+        @info    = bundle_info
+        @name    = bundle_name
+        @path    = bundle_path
+        @plugins = plugin_manager
+        register
+        @inited = false
+      end
 
-ServletPlugin = Servlet
+      # Servlet ID
+      attr_reader :name, :path, :info, :inited
+      def register # :nodoc
+        @plugins.register_bundle( self, @name )
+        @inited = true
+      end
 
+      ## Extendables
 
+      # Return true to match, false to not match. Returns false as default if 
+      # not extended.
+      def match( uri, request_type=:get )
+        return false
+      end
+
+      # If match, return score (lower is better). Returns 100 by defalt if not 
+      # extended
+      def score
+        return 100
+      end
+
+      # Extend to do any GET request processing. Not doing anything by default.
+      def get( req, res, ses )
+
+      end
+
+      # Extend to do any POST request processing. Not doing anything by default.
+      def post( req, res, ses )
+
+      end
+    end
+  end
+end