Changeset 5307

Timestamp:

10/15/06 23:32:31 (2 years ago)

Author:

ulysses

Message:

Add 'unloadable', a method used to mark any constant as requiring an unload after each request.

Files:

• trunk/activesupport/CHANGELOG (modified) (1 diff)
• trunk/activesupport/lib/active_support/dependencies.rb (modified) (7 diffs)
• trunk/activesupport/test/dependencies_test.rb (modified) (2 diffs)

trunk/activesupport/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Add 'unloadable', a method used to mark any constant as requiring an unload after each request. [Nicholas Seckar]
-
-* Make core_ext/string/access.rb multibyte safe. Closes #6388 [Manfred Stienstra]

trunk/activesupport/lib/active_support/dependencies.rb

@@ -39 +39 @@
-  self.autoloaded_constants = []
-  
+  # An array of constant names that need to be unloaded on every request. Used
+  # to allow arbitrary constants to be marked for unloading.
+  mattr_accessor :explicitly_unloadable_constants
+  self.explicitly_unloadable_constants = []
+  
-  # Set to true to enable logging of const_missing and file loads
-  mattr_accessor :log_activity
@@ -61 +66 @@
-    log_call
-    loaded.clear
-autoloaded
+unloadable
-  end
-
@@ -253 +258 @@
-  end
-  
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-  end
-  
@@ -275 +271 @@
-    return false unless qualified_const_defined? name
-    return autoloaded_constants.include?(name)
+  end
+  
+  # Will the provided constant descriptor be unloaded?
+  def will_unload?(const_desc)
+    autoloaded?(desc) ||
+      explicitly_unloadable_constants.include?(to_constant_name(const_desc))
+  end
+  
+  # Mark the provided constant name for unloading. This constant will be
+  # unloaded on each request, not just the next one.
+  def mark_for_unload(const_desc)
+    name = to_constant_name const_desc
+    if explicitly_unloadable_constants.include? name
+      return false
+    else
+      explicitly_unloadable_constants << name
+      return true
+    end
-  end
-  
@@ -296 +310 @@
-      when String then desc.starts_with?('::') ? desc[2..-1] : desc
-      when Symbol then desc.to_s
-
+
+
+
-      else raise TypeError, "Not a valid constant descriptor: #{desc.inspect}"
-    end
+  end
+  
+  def remove_constant(const)
+    return false unless qualified_const_defined? const
+    
+    names = const.split('::')
+    if names.size == 1 || names.first.empty? # It's under Object
+      parent = Object
+    else
+      parent = (names[0..-2] * '::').constantize
+    end
+    
+    log "removing constant #{const}"
+    parent.send :remove_const, names.last
+    return true
-  end
-  
@@ -329 +360 @@
-    Dependencies.load_missing_constant self, class_id
-  end
+  
+  def unloadable(const_desc = self)
+    super(const_desc)
+  end
+  
-end
-
@@ -367 +403 @@
-    raise
-  end
+
+  # Mark the given constant as unloadable. Unloadable constants are removed each
+  # time dependencies are cleared.
+  # 
+  # Note that marking a constant for unloading need only be done once. Setup
+  # or init scripts may list each unloadable constant that may need unloading;
+  # each constant will be removed for every subsequent clear, as opposed to for
+  # the first clear.
+  # 
+  # The provided constant descriptor may be a (non-anonymous) module or class,
+  # or a qualified constant name as a string or symbol.
+  # 
+  # Returns true if the constant was not previously marked for unloading, false
+  # otherwise.
+  def unloadable(const_desc)
+    Dependencies.mark_for_unload const_desc
+  end
+
-end
-

trunk/activesupport/test/dependencies_test.rb

@@ -25 +25 @@
-    Dependencies.load_paths = prior_load_paths
-    Dependencies.mechanism = old_mechanism
+    Dependencies.explicitly_unloadable_constants = []
-  end
-
@@ -454 +455 @@
-  end
-  
+  def test_unloadable
+    with_loading 'autoloading_fixtures' do
+      Object.const_set :M, Module.new
+      M.unloadable
+      
+      Dependencies.clear
+      assert ! defined?(M)
+      
+      Object.const_set :M, Module.new
+      Dependencies.clear
+      assert ! defined?(M), "Dependencies should unload unloadable constants each time"
+    end
+  end
+  
+  def test_unloadable_should_fail_with_anonymous_modules
+    with_loading 'autoloading_fixtures' do
+      m = Module.new
+      assert_raises(ArgumentError) { m.unloadable }
+    end
+  end
+  
+  def test_unloadable_should_return_change_flag
+    with_loading 'autoloading_fixtures' do
+      Object.const_set :M, Module.new
+      assert_equal true, M.unloadable
+      assert_equal false, M.unloadable
+    end
+  end
+  
-end