lib/ronin/platform/extension_cache.rb in ronin-0.2.4 vs lib/ronin/platform/extension_cache.rb in ronin-0.3.0

@@ -1,9 +1,7 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,24 +14,29 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
 #
 
 require 'ronin/platform/extension'
 require 'ronin/platform/exceptions/extension_not_found'
 
 module Ronin
   module Platform
     class ExtensionCache < Hash
 
       #
-      # Creates a new empty ExtensionCache object. If a _block_ is given
-      # it will be passed the newly created ExtensionCache object.
+      # Creates a new empty ExtensionCache object.
       #
+      # @yield [cache]
+      #   If a block is given, it will be passed the newly created
+      #   extension cache.
+      #
+      # @yieldparam [ExtensionCache] cache
+      #   The newly created extension cache.
+      #
       def initialize(&block)
         super() do |hash,key|
           name = key.to_s
 
           hash[name] = load_extension(name)
@@ -45,11 +48,12 @@
 
         block.call(self) if block
       end
 
       #
-      # Returns the sorted names of the extensions within the cache.
+      # @return [Array]
+      #   The sorted names of the extensions within the cache.
       #
       def names
         keys.sort
       end
 
@@ -58,49 +62,81 @@
 
       #
       # Selects the extensions within the cache that match the specified
       # _block_.
       #
-      def extensions_with(&block)
+      # @yield [ext]
+      #   The block will be passed each extension, and the extension will
+      #   be selected based on the return value of the block.
+      #
+      # @yieldparam [Extension] ext
+      #   An extension from the cache.
+      #
+      # @return [Array]
+      #   The selected extensions.
+      #
+      def with(&block)
         values.select(&block)
       end
 
       #
-      # Returns +true+ if the cache contains the extension with the
-      # specified _name_, returns +false+ otherwise.
+      # Searches within the cache for the extension with the specified
+      # _name_.
       #
-      def has_extension?(name)
+      # @return [Boolean]
+      #   Specifies whether the cache contains the extension with the
+      #   specified _name_.
+      #
+      def has?(name)
         has_key?(name.to_s)
       end
 
       #
-      # Loads the extension with the specified _name_. If no such extension
-      # exists an ExtensionNotFound exception will be raised. If a _block_
-      # is given, it will be passed the loaded extension.
+      # Loads the extension with the specified _name_.
       #
-      def load_extension(name,&block)
+      # @param [String, Symbol] name
+      #   The name of the extension to load.
+      #
+      # @raise [ExtensionNotFound]
+      #   The extension with the specified _name_ could not be found in
+      #   the extension cache.
+      #
+      def load_extension(name)
         name = name.to_s
 
         unless Platform.overlays.has_extension?(name)
           raise(ExtensionNotFound,"extension #{name.dump} does not eixst",caller)
         end
 
-        return Extension.load(name) do |ext|
-          ext.setup!
-
-          block.call(ext) if block
+        return Extension.new(name) do |ext|
+          include(self.name)
+          setup!
         end
       end
 
       #
-      # Reloads the extensions within the extension cache.
+      # Reloads one or all extensions within the extension cache.
       #
-      def reload!
-        each do |name,ext|
-          ext.teardown!
+      # @param [String, Symbol] name
+      #   The specific extension to reload.
+      #
+      # @return [true]
+      #   Specifies the reload was successful.
+      #
+      def reload!(name=nil)
+        reloader = lambda { |ext_name|
+          self[ext_name].teardown! if has?(ext_name)
 
-          self[name] = load_extension(name)
+          self[ext_name] = load_extension(ext_name)
+        }
+
+        if name
+          reloader.call(name)
+        else
+          each_key(&reloader)
         end
+
+        return true
       end
 
     end
   end
 end