rUtilAnts 0.3.0.20110825 → 1.0.0.20120223

data/lib/rUtilAnts/SingletonProxy.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RUtilAnts
+
+  # Make public methods from a module accessible in another module, using a singleton as proxy
+  #
+  # Parameters::
+  # * *iSrcModule* (_Module_): Module to get public methods from
+  # * *oDstModule* (_Module_): Module that will encapsulate the singleton and route all public methods through that singleton
+  def self.make_singleton_proxy(iSrcModule, oDstModule)
+    lSrcModuleConstName = iSrcModule.name.gsub(/\W/,'_')
+
+    # Create the singleton class
+    lSingletonClass = oDstModule.const_set("SingletonClassForModule__#{lSrcModuleConstName}", Class.new)
+    lSingletonClass.class_eval("include #{iSrcModule}")
+
+    # Instantiate it in the module
+    lSymSingletonVarName = "@@__SingletonForModule__#{lSrcModuleConstName}".to_sym
+    oDstModule.send(:class_variable_set, lSymSingletonVarName, lSingletonClass.new)
+
+    # Create public methods from iSrcModule to oDstModule, using the singleton as a proxy
+    iSrcModule.instance_methods.map { |iMethodName| iMethodName.to_sym }.each do |iSymMethodName|
+      oDstModule.send(:define_method, iSymMethodName) do |*iArgs, &iBlock|
+        oDstModule.send(:class_variable_get, lSymSingletonVarName).send(iSymMethodName, *iArgs, &iBlock)
+      end
+    end
+
+  end
+
+end

data/lib/rUtilAnts/URLAccess.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -18,11 +18,10 @@ module RUtilAnts
     class RedirectionError < RuntimeError
     end
 
-    # Class
-    class Manager
+    module URLAccessInterface
 
       # Constructor
-      def initialize
+      def init_url_access
         # Get the map of plugins to read URLs
         # map< String, [ list<Regexp>, String ] >
         # map< PluginName, [ List of matching regexps, Plugin class name ] >
@@ -32,11 +31,11 @@ module RUtilAnts
             lPluginName = File.basename(iFileName)[0..-4]
             require "rUtilAnts/URLHandlers/#{lPluginName}"
             @Plugins[lPluginName] = [
-              eval("RUtilAnts::URLCache::URLHandlers::#{lPluginName}::getMatchingRegexps"),
-              "RUtilAnts::URLCache::URLHandlers::#{lPluginName}"
+              eval("RUtilAnts::URLAccess::URLHandlers::#{lPluginName}::get_matching_regexps"),
+              "RUtilAnts::URLAccess::URLHandlers::#{lPluginName}"
             ]
           rescue Exception
-            logExc$!, "Error while requiring URLHandler plugin #{iFileName}"
+            log_exc$!, "Error while requiring URLHandler plugin #{iFileName}"
           end
         end
       end
@@ -45,27 +44,27 @@ module RUtilAnts
       # No cache.
       # It calls a code block with the binary content of the URL (or a local file name if required).
       #
-      # Parameters:
+      # Parameters::
       # * *iURL* (_String_): The URL (used to detect cyclic redirections)
       # * *iParameters* (<em>map<Symbol,Object></em>): Additional parameters:
-      # ** *:FollowRedirections* (_Boolean_): Do we follow redirections ? [optional = true]
-      # ** *:NbrRedirectionsAllowed* (_Integer_): Number of redirections allowed [optional = 10]
-      # ** *:LocalFileAccess* (_Boolean_): Do we need a local file to read the content from ? If not, the content itslef will be given the code block. [optional = false]
-      # ** *:URLHandler* (_Object_): The URL handler, if it has already been instantiated, or nil otherwise [optional = nil]
+      #   * *:follow_redirections* (_Boolean_): Do we follow redirections ? [optional = true]
+      #   * *:nbr_redirections_allowed* (_Integer_): Number of redirections allowed [optional = 10]
+      #   * *:local_file_access* (_Boolean_): Do we need a local file to read the content from ? If not, the content itslef will be given the code block. [optional = false]
+      #   * *:url_handler* (_Object_): The URL handler, if it has already been instantiated, or nil otherwise [optional = nil]
       # * _CodeBlock_: The code returning the object corresponding to the content:
-      # ** *iContent* (_String_): File content, or file name if :LocalFileAccess was true
-      # ** *iFileBaseName* (_String_): The base name the file could have. Useful to get file name extensions.
-      # ** Return:
-      # ** _Exception_: The error encountered, or nil in case of success
-      # Return:
+      #   * *iContent* (_String_): File content, or file name if :local_file_access was true
+      #   * *iFileBaseName* (_String_): The base name the file could have. Useful to get file name extensions.
+      #   * Return::
+      #   * _Exception_: The error encountered, or nil in case of success
+      # Return::
       # * _Exception_: The error encountered, or nil in case of success
-      def accessFile(iURL, iParameters = {})
+      def access_file(iURL, iParameters = {})
         rError = nil
 
         lFollowRedirections = iParameters[:lFollowRedirections]
-        lNbrRedirectionsAllowed = iParameters[:NbrRedirectionsAllowed]
-        lLocalFileAccess = iParameters[:LocalFileAccess]
-        lURLHandler = iParameters[:URLHandler]
+        lNbrRedirectionsAllowed = iParameters[:nbr_redirections_allowed]
+        lLocalFileAccess = iParameters[:local_file_access]
+        lURLHandler = iParameters[:url_handler]
         if (lFollowRedirections == nil)
           lFollowRedirections = true
         end
@@ -76,10 +75,10 @@ module RUtilAnts
           lLocalFileAccess = false
         end
         if (lURLHandler == nil)
-          lURLHandler = getURLHandler(iURL)
+          lURLHandler = get_url_handler(iURL)
         end
         # Get the content from the handler
-        lContentFormat, lContent = lURLHandler.getContent(lFollowRedirections)
+        lContentFormat, lContent = lURLHandler.get_content(lFollowRedirections)
         case (lContentFormat)
         when CONTENT_ERROR
           rError = lContent
@@ -92,10 +91,10 @@ module RUtilAnts
           elsif (lFollowRedirections)
             # Follow the redirection if we want it
             lNewParameters = iParameters.clone
-            lNewParameters[:NbrRedirectionsAllowed] = lNbrRedirectionsAllowed - 1
+            lNewParameters[:nbr_redirections_allowed] = lNbrRedirectionsAllowed - 1
             # Reset the URL handler for the new parameters.
-            lNewParameters[:URLHandler] = nil
-            rError = accessFile(lContent, lNewParameters) do |iContent, iBaseName|
+            lNewParameters[:url_handler] = nil
+            rError = access_file(lContent, lNewParameters) do |iContent, iBaseName|
               yield(iContent, iBaseName)
             end
           else
@@ -106,7 +105,7 @@ module RUtilAnts
           if (lLocalFileAccess)
             # Write the content in a local temporary file
             require 'tmpdir'
-            lBaseName = lURLHandler.getCorrespondingFileBaseName
+            lBaseName = lURLHandler.get_corresponding_file_base_name
             lLocalFileName = "#{Dir.tmpdir}/URLCache/#{lBaseName}"
             begin
               require 'fileutils'
@@ -125,7 +124,7 @@ module RUtilAnts
             end
           else
             # Give it to the code block directly
-            yield(lContent, lURLHandler.getCorrespondingFileBaseName)
+            yield(lContent, lURLHandler.get_corresponding_file_base_name)
           end
         when CONTENT_LOCALFILENAME, CONTENT_LOCALFILENAME_TEMPORARY
           lLocalFileName = lContent
@@ -142,7 +141,7 @@ module RUtilAnts
             end
           end
           if (rError == nil)
-            yield(lContent, lURLHandler.getCorrespondingFileBaseName)
+            yield(lContent, lURLHandler.get_corresponding_file_base_name)
           end
           # If the file was temporary, delete it
           if (lContentFormat == CONTENT_LOCALFILENAME_TEMPORARY)
@@ -155,11 +154,11 @@ module RUtilAnts
 
       # Get the URL handler corresponding to this URL
       #
-      # Parameters:
+      # Parameters::
       # * *iURL* (_String_): The URL
-      # Return:
+      # Return::
       # * _Object_: The URL handler
-      def getURLHandler(iURL)
+      def get_url_handler(iURL)
         rURLHandler = nil
 
         # Try out every regexp unless it matches.
@@ -187,44 +186,23 @@ module RUtilAnts
 
     end
 
-    # Initialize a global plugins cache
-    def self.initializeURLAccess
-      $rUtilAnts_URLAccess_Manager = Manager.new
-      Object.module_eval('include RUtilAnts::URLAccess')
-    end
+    # A class giving access to the URL access functionnality
+    class Manager
 
-    # Access the content of a URL.
-    # No cache.
-    # It calls a code block with the binary content of the URL (or a local file name if required).
-    #
-    # Parameters:
-    # * *iURL* (_String_): The URL (used to detect cyclic redirections)
-    # * *iParameters* (<em>map<Symbol,Object></em>): Additional parameters:
-    # ** *:FollowRedirections* (_Boolean_): Do we follow redirections ? [optional = true]
-    # ** *:NbrRedirectionsAllowed* (_Integer_): Number of redirections allowed [optional = 10]
-    # ** *:LocalFileAccess* (_Boolean_): Do we need a local file to read the content from ? If not, the content itself will be given the code block. [optional = false]
-    # ** *:URLHandler* (_Object_): The URL handler, if it has already been instantiated, or nil otherwise [optional = nil]
-    # * _CodeBlock_: The code returning the object corresponding to the content:
-    # ** *iContent* (_String_): File content, or file name if :LocalFileAccess was true
-    # ** *iFileBaseName* (_String_): The base name the file could have. Useful to get file name extensions.
-    # ** Return:
-    # ** _Exception_: The error encountered, or nil in case of success
-    # Return:
-    # * _Exception_: The error encountered, or nil in case of success
-    def accessFile(iURL, iParameters = {})
-      return $rUtilAnts_URLAccess_Manager.accessFile(iURL, iParameters) do |iContent, iBaseName|
-        yield(iContent, iBaseName)
+      include URLAccessInterface
+
+      # Constructor
+      def initialize
+        init_url_access
       end
+
     end
 
-    # Get the URL handler corresponding to this URL
-    #
-    # Parameters:
-    # * *iURL* (_String_): The URL
-    # Return:
-    # * _Object_: The URL handler
-    def getURLHandler(iURL)
-      return $rUtilAnts_URLAccess_Manager.getURLHandler(iURL)
+    # Initialize a global plugins cache
+    def self.install_url_access_on_object
+      require 'rUtilAnts/SingletonProxy'
+      RUtilAnts::make_singleton_proxy(RUtilAnts::URLAccess::URLAccessInterface, Object)
+      init_url_access
     end
 
   end

data/lib/rUtilAnts/URLCache.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -7,17 +7,14 @@ module RUtilAnts
 
   module URLCache
 
-    # Class that caches every access to a URI (local file name, http, data...).
-    # This ensures just that several files are instantiated just once.
-    # For local files, it takes into account the file modification date/time to know if the Wx::Bitmap file has to be refreshed.
-    class URLCache
+    # Exception for reporting server down errors.
+    class ServerDownError < RuntimeError
+    end
 
-      # Exception for reporting server down errors.
-      class ServerDownError < RuntimeError
-      end
+    module URLCacheInterface
 
       # Constructor
-      def initialize
+      def init_url_cache
         # Map of known contents, interpreted in many flavors
         # map< Integer, [ Integer, Object ] >
         # map< URL's hash, [ CRC, Content ] >
@@ -35,39 +32,39 @@ module RUtilAnts
       # * file:// protocol
       # It also handles redirections or zipped files
       #
-      # Parameters:
+      # Parameters::
       # * *iURL* (_String_): The URL
       # * *iParameters* (<em>map<Symbol,Object></em>): Additional parameters:
-      # ** *:ForceLoad* (_Boolean_): Do we force to refresh the cache ? [optional = false]
-      # ** *:FollowRedirections* (_Boolean_): Do we follow redirections ? [optional = true]
-      # ** *:NbrRedirectionsAllowed* (_Integer_): Number of redirections allowed [optional = 10]
-      # ** *:LocalFileAccess* (_Boolean_): Do we need a local file to read the content from ? If not, the content itslef will be given the code block. [optional = false]
+      #   * *:force_load* (_Boolean_): Do we force to refresh the cache ? [optional = false]
+      #   * *:follow_redirections* (_Boolean_): Do we follow redirections ? [optional = true]
+      #   * *:nbr_redirections_allowed* (_Integer_): Number of redirections allowed [optional = 10]
+      #   * *:local_file_access* (_Boolean_): Do we need a local file to read the content from ? If not, the content itslef will be given the code block. [optional = false]
       # * _CodeBlock_: The code returning the object corresponding to the content:
-      # ** *iContent* (_String_): File content, or file name if :LocalFileAccess was true
-      # ** Returns:
-      # ** _Object_: Object read from the content, or nil in case of error
-      # ** _Exception_: The error encountered, or nil in case of success
-      # Return:
+      #   * *iContent* (_String_): File content, or file name if :local_file_access was true
+      #   * Return::
+      #   * _Object_: Object read from the content, or nil in case of error
+      #   * _Exception_: The error encountered, or nil in case of success
+      # Return::
       # * <em>Object</em>: The corresponding URL content, or nil in case of failure
       # * _Exception_: The error, or nil in case of success
-      def getURLContent(iURL, iParameters = {})
+      def get_url_content(iURL, iParameters = {})
         rObject = nil
         rError = nil
 
         # Parse parameters
-        lForceLoad = iParameters[:ForceLoad]
+        lForceLoad = iParameters[:force_load]
         if (lForceLoad == nil)
           lForceLoad = false
         end
         # Get the URL handler corresponding to this URL
-        lURLHandler = getURLHandler(iURL)
-        lServerID = lURLHandler.getServerID
+        lURLHandler = get_url_handler(iURL)
+        lServerID = lURLHandler.get_server_id
         if (@HostsDown.has_key?(lServerID))
           rError = ServerDownError.new("Server #{iURL} is currently down.")
         else
           lURLHash = iURL.hash
           # Check if it is in the cache, or if we force refresh, or if the URL was invalidated
-          lCurrentCRC = lURLHandler.getCRC
+          lCurrentCRC = lURLHandler.get_crc
           if ((@URLs[lURLHash] == nil) or
               (lForceLoad) or
               (@URLs[lURLHash][0] != lCurrentCRC))
@@ -76,7 +73,7 @@ module RUtilAnts
             @URLs[lURLHash] = nil
             # Get the object
             lObject = nil
-            lAccessError = accessFile(iURL, iParameters.merge(:URLHandler => lURLHandler)) do |iContent, iBaseName|
+            lAccessError = access_file(iURL, iParameters.merge(:url_handler => lURLHandler)) do |iContent, iBaseName|
               lObject, rError = yield(iContent)
             end
             if (lAccessError != nil)
@@ -105,39 +102,25 @@ module RUtilAnts
 
     end
 
-    # Initialize a global cache
-    def self.initializeURLCache
-      $rUtilAnts_URLCache = URLCache.new
-      Object.module_eval('include RUtilAnts::URLCache')
-    end
+    # Class that caches every access to a URI (local file name, http, data...).
+    # This ensures just that several files are instantiated just once.
+    # For local files, it takes into account the file modification date/time to know if the Wx::Bitmap file has to be refreshed.
+    class URLCache
 
-    # Get a content from a URL.
-    # Here are the different formats the URL can have:
-    # * Local file name
-    # * http/https/ftp/ftps:// protocols
-    # * data:image URI
-    # * file:// protocol
-    # It also handles redirections or zipped files
-    #
-    # Parameters:
-    # * *iURL* (_String_): The URL
-    # * *iParameters* (<em>map<Symbol,Object></em>): Additional parameters:
-    # ** *:ForceLoad* (_Boolean_): Do we force to refresh the cache ? [optional = false]
-    # ** *:FollowRedirections* (_Boolean_): Do we follow redirections ? [optional = true]
-    # ** *:NbrRedirectionsAllowed* (_Integer_): Number of redirections allowed [optional = 10]
-    # ** *:LocalFileAccess* (_Boolean_): Do we need a local file to read the content from ? If not, the content itself will be given the code block. [optional = false]
-    # * _CodeBlock_: The code returning the object corresponding to the content:
-    # ** *iContent* (_String_): File content, or file name if :LocalFileAccess was true
-    # ** Returns:
-    # ** _Object_: Object read from the content, or nil in case of error
-    # ** _Exception_: The error encountered, or nil in case of success
-    # Return:
-    # * <em>Object</em>: The corresponding URL content, or nil in case of failure
-    # * _Exception_: The error, or nil in case of success
-    def getURLContent(iURL, iParameters = {})
-      return $rUtilAnts_URLCache.getURLContent(iURL, iParameters) do |iContent|
-        next yield(iContent)
+      include URLCacheInterface
+
+      # Constructor
+      def initialize
+        init_url_cache
       end
+
+    end
+
+    # Initialize a global cache
+    def self.install_url_cache_on_object
+      require 'rUtilAnts/SingletonProxy'
+      RUtilAnts::make_singleton_proxy(RUtilAnts::URLCache::URLCacheInterface, Object)
+      init_url_cache
     end
 
   end

data/lib/rUtilAnts/URLHandlers/DataImage.rb

@@ -1,11 +1,11 @@
 #--
-# Copyright (c) 2009 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 module RUtilAnts
 
-  module URLCache
+  module URLAccess
 
     module URLHandlers
 
@@ -14,9 +14,9 @@ module RUtilAnts
 
         # Get a list of regexps matching the URL to get to this handler
         #
-        # Return:
+        # Return::
         # * <em>list<Regexp></em>: The list of regexps matching URLs from this handler
-        def self.getMatchingRegexps
+        def self.get_matching_regexps
           return [
             /^data:image.*$/
           ]
@@ -24,13 +24,13 @@ module RUtilAnts
 
         # Constructor
         #
-        # Parameters:
+        # Parameters::
         # * *iURL* (_String_): The URL that this handler will manage
         def initialize(iURL)
           @URL = iURL
           lMatchData = @URL.match(/data:image\/(.*);base64,(.*)/)
           if (lMatchData == nil)
-            logBug "URL #{iURL[0..23]}... was identified as a data:image like, but it appears to be false."
+            log_bug "URL #{iURL[0..23]}... was identified as a data:image like, but it appears to be false."
           else
             @Ext = lMatchData[1]
             if (@Ext == 'x-icon')
@@ -42,17 +42,17 @@ module RUtilAnts
 
         # Get the server ID
         #
-        # Return:
+        # Return::
         # * _String_: The server ID
-        def getServerID
+        def get_server_id
           return nil
         end
 
         # Get the current CRC of the URL
         #
-        # Return:
+        # Return::
         # * _Integer_: The CRC
-        def getCRC
+        def get_crc
           # As the content is in the URL, it will be natural to not find it anymore in the cache when it is changed.
           # Therefore there is no need to return a CRC.
           return 0
@@ -61,25 +61,25 @@ module RUtilAnts
         # Get a corresponding file base name.
         # This method has to make sure file extensions are respected, as it can be used for further processing.
         #
-        # Return:
+        # Return::
         # * _String_: The file name
-        def getCorrespondingFileBaseName
+        def get_corresponding_file_base_name
           return "DataImage.#{@Ext}"
         end
 
         # Get the content of the URL
         #
-        # Parameters:
+        # Parameters::
         # * *iFollowRedirections* (_Boolean_): Do we follow redirections while accessing the content ?
-        # Return:
+        # Return::
         # * _Integer_: Type of content returned
         # * _Object_: The content, depending on the type previously returned:
-        # ** _Exception_ if CONTENT_ERROR: The corresponding error
-        # ** _String_ if CONTENT_REDIRECT: The new URL
-        # ** _String_ if CONTENT_STRING: The real content
-        # ** _String_ if CONTENT_LOCALFILENAME: The name of the local file name storing the content
-        # ** _String_ if CONTENT_LOCALFILENAME_TEMPORARY: The name of the temporary local file name storing the content
-        def getContent(iFollowRedirections)
+        #   * _Exception_ if CONTENT_ERROR: The corresponding error
+        #   * _String_ if CONTENT_REDIRECT: The new URL
+        #   * _String_ if CONTENT_STRING: The real content
+        #   * _String_ if CONTENT_LOCALFILENAME: The name of the local file name storing the content
+        #   * _String_ if CONTENT_LOCALFILENAME_TEMPORARY: The name of the temporary local file name storing the content
+        def get_content(iFollowRedirections)
           rContentFormat = nil
           rContent = nil