impromptu 1.2.1 → 1.3.0

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/impromptu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{impromptu}
-  s.version = "1.2.1"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Cannings"]
-  s.date = %q{2010-11-16}
+  s.date = %q{2011-01-21}
   s.description = %q{Component and dependency manager for Ruby}
   s.email = %q{me@willcannings.com}
   s.extra_rdoc_files = [
@@ -48,6 +48,7 @@ Gem::Specification.new do |s|
     "test/framework/other/ignore.rb",
     "test/framework/other/load.rb",
     "test/framework/other/two.rb",
+    "test/framework/preload/preload.rb",
     "test/framework/private/klass.rb",
     "test/framework/private/other.rb",
     "test/framework/stdlib/string.rb",
@@ -85,6 +86,7 @@ Gem::Specification.new do |s|
     "test/framework/other/ignore.rb",
     "test/framework/other/load.rb",
     "test/framework/other/two.rb",
+    "test/framework/preload/preload.rb",
     "test/framework/private/klass.rb",
     "test/framework/private/other.rb",
     "test/framework/stdlib/string.rb",

data/lib/impromptu/folder.rb

@@ -1,7 +1,7 @@
 module Impromptu
   class Folder
     attr_accessor :folder, :files, :component
-    DEFAULT_OPTIONS   = {nested_namespaces: true, reloadable: true, implicitly_loaded: true, namespace: nil}
+    DEFAULT_OPTIONS   = {nested_namespaces: true, reloadable: true, implicitly_loaded: true, namespace: nil, preload: false}
     SOURCE_EXTENSIONS = %w{rb so bundle}
     
     # Register a new folder containing source files for a
@@ -23,6 +23,9 @@ module Impromptu
     # * namespace: override a component's default namespace with
     #   a namespace specific to this folder. The normal rules
     #   with nested namespaces apply.
+    # * preload: forces the loading of all files within a folder.
+    #   The resources defined can still be reloaded, but loading
+    #   won't wait until the resource is referenced.
     def initialize(path, component, options={}, block)
       @folder     = path.realpath
       @component  = component
@@ -72,6 +75,21 @@ module Impromptu
       @options[:implicitly_loaded]
     end
     
+    # True if the resources of the folder are loaded immediately on
+    # startup, and won't be autoloaded.
+    def preload?
+      @options[:preload]
+    end
+    
+    # Preload the resources defined by this folder. Should only be called
+    # by the Impromptu module, and only once (at app startup).
+    def preload
+      return unless preload?
+      @files.each do |file|
+        file.reload
+      end
+    end
+    
     # A string or symbol for this folder which overrides the components
     # default namespace. Nil if no namespace has been defined.
     def namespace
@@ -160,6 +178,16 @@ module Impromptu
           file.refreeze
         end
       end
+      
+      # ensure all resources defined by this folder
+      # are marked to be preloaded if required
+      if preload?
+        @files.each do |file|
+          file.resources.each do |resource|
+            resource.preload = true
+          end
+        end
+      end
     end
     
     

data/lib/impromptu/impromptu.rb

@@ -60,6 +60,13 @@ module Impromptu
     # modules or classes. we can't catch uses of these resources
     # using const_missing, so we need to load them now.
     @root_resource.load_if_extending_stdlib
+    
+    # load any folders which are to be preloaded
+    components.each do |component|
+      component.folders.each do |folder|
+        folder.preload if folder.preload?
+      end
+    end
   end
 
   # Open and run a file defining components. The folder containing

data/lib/impromptu/resource.rb

@@ -4,7 +4,7 @@ module Impromptu
   # resources yourself - use component definitions to define folders
   # of files which will implement resources.
   class Resource
-    attr_reader :name, :base_symbol, :files, :children, :parent
+    attr_reader :name, :base_symbol, :files, :children, :parent, :preload
     
     def initialize(name, parent)
       @name         = name.to_sym
@@ -15,6 +15,7 @@ module Impromptu
       @reference    = nil
       @namespace    = false
       @dont_undef   = self.loaded?  # existing constants, such as 'String', should never be unloaded
+      @preload      = false # true if any folder defining this resource is marked to be preloaded
       @implicitly_defined = true
     end
     
@@ -32,6 +33,16 @@ module Impromptu
       @name.hash
     end
     
+    # Define this resource as preloaded
+    def preload=(preload)
+      @preload = preload
+    end
+    
+    # True if this resource is defined as preloaded
+    def preload?
+      @preload
+    end
+    
     # Attempts to retrieve a reference to the object represented by
     # this resource. If the resource is unloaded, nil is returned.
     def reference
@@ -48,11 +59,12 @@ module Impromptu
     def reload
       @parent.reload unless @parent.loaded?
       if @implicitly_defined
-        self.unload
+        unload
         Object.module_eval "module #{@name}; end"
       else
         @files.first.reload
       end
+      reload_preloaded_resources
     end
     
     # Unload the resource by undefining the constant representing it.
@@ -203,5 +215,10 @@ module Impromptu
       reload if loaded? && !self.root?
       @children.each_value(&:load_if_extending_stdlib)
     end
+    
+    def reload_preloaded_resources
+      reload if !loaded? && preload?
+      @children.each_value(&:reload_preloaded_resources)
+    end
   end
 end

data/test/framework/preload/preload.rb

@@ -0,0 +1,7 @@
+module Framework
+  module Preload
+    def self.method
+      true
+    end
+  end
+end

data/test/framework/test.components

@@ -2,6 +2,7 @@ component 'framework' do
 	namespace :Framework
 	requires  'mathn'
 	folder    'lib', nested_namespaces: false
+	folder    'preload', preload: true
 end
 
 component 'framework.extensions' do

data/test/test_integration.rb

@@ -17,8 +17,8 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal 5, Impromptu.components.size
     end
     
-    should "02 have a single folder per component" do
-      assert_equal 1, Impromptu.components['framework'].folders.size
+    should "02 have the correct number of folders per component" do
+      assert_equal 2, Impromptu.components['framework'].folders.size
       assert_equal 1, Impromptu.components['framework.extensions'].folders.size
       assert_equal 1, Impromptu.components['other'].folders.size
       assert_equal 1, Impromptu.components['private'].folders.size
@@ -49,6 +49,7 @@ class TestIntegration < Test::Unit::TestCase
       assert Impromptu.root_resource.child(:Framework).child(:Extensions).child?(:Blog)
       assert Impromptu.root_resource.child(:Framework).child?(:Klass)
       assert Impromptu.root_resource.child(:Framework).child?(:Klass2)
+      assert Impromptu.root_resource.child(:Framework).child?(:Preload)
       assert Impromptu.root_resource.child?(:Load)
       assert Impromptu.root_resource.child?(:OtherName)
       assert Impromptu.root_resource.child?(:ModOne)
@@ -70,13 +71,13 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal false, Impromptu.root_resource.child(:ModOne).namespace?
       assert_equal false, Impromptu.root_resource.child(:ModTwo).namespace?
       assert_equal false, Impromptu.root_resource.child(:Another).namespace?
-      assert_equal true, Impromptu.root_resource.child(:Namespace).namespace?
+      assert_equal true,  Impromptu.root_resource.child(:Namespace).namespace?
       assert_equal false, Impromptu.root_resource.child(:Namespace).child(:Stream).namespace?
       assert_equal false, Impromptu.root_resource.child(:Namespace).child(:TwoNames).namespace?
     end
     
-    should "08 keep all resources unloaded to start with" do
-      assert_equal false, Impromptu.root_resource.child(:'Framework').loaded?
+    should "08 keep all non-preloaded resources unloaded to start with, and preload otherwise" do
+      # normal, non preloaded resources
       assert_equal false, Impromptu.root_resource.child(:'Framework::Extensions').loaded?
       assert_equal false, Impromptu.root_resource.child(:'Framework::Extensions::Blog').loaded?
       assert_equal false, Impromptu.root_resource.child(:'Framework::Klass').loaded?
@@ -89,14 +90,19 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal false, Impromptu.root_resource.child(:'Namespace').loaded?
       assert_equal false, Impromptu.root_resource.child(:'Namespace::Stream').loaded?
       assert_equal false, Impromptu.root_resource.child(:'Namespace::TwoNames').loaded?
+      
+      # preloaded resources are the opposite of this
+      assert Impromptu.root_resource.child(:'Framework').loaded?
+      assert Impromptu.root_resource.child(:'Framework::Preload').loaded?
     end
-    
+
     should "09 have all resources specified by the correct number of files" do
       assert_equal 0, Impromptu.root_resource.child(:'Framework').files.size
       assert_equal 1, Impromptu.root_resource.child(:'Framework::Extensions').files.size
       assert_equal 1, Impromptu.root_resource.child(:'Framework::Extensions::Blog').files.size
       assert_equal 2, Impromptu.root_resource.child(:'Framework::Klass').files.size
       assert_equal 1, Impromptu.root_resource.child(:'Framework::Klass2').files.size
+      assert_equal 1, Impromptu.root_resource.child(:'Framework::Preload').files.size
       assert_equal 1, Impromptu.root_resource.child(:'Framework::Klass2').files.size
       assert_equal 1, Impromptu.root_resource.child(:'Load').files.size
       assert_equal 2, Impromptu.root_resource.child(:'OtherName').files.size
@@ -114,7 +120,6 @@ class TestIntegration < Test::Unit::TestCase
     # Loading/unloading
     # ----------------------------------------
     should "10 allow loading the implicitly namespace modules" do
-      assert_equal false, Impromptu.root_resource.child(:'Framework').loaded?
       Impromptu.root_resource.child(:'Framework').reload
       assert_equal true, Impromptu.root_resource.child(:'Framework').loaded?
       assert_nothing_raised do
@@ -130,6 +135,13 @@ class TestIntegration < Test::Unit::TestCase
     end
     
     should "11 load resources using associated files when required" do
+      # preloaded resource
+      assert_nothing_raised do
+        Framework::Preload
+      end
+      assert_respond_to Framework::Preload, :method
+      assert Framework::Preload.method
+      
       # ext
       Impromptu.root_resource.child(:'Framework::Extensions::Blog').reload
       assert_equal true, Impromptu.root_resource.child(:'Framework::Extensions').loaded?
@@ -245,6 +257,23 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal true, Impromptu.root_resource.child(:'Framework::Extensions::Blog').loaded?
     end
     
+    should "15 automatically reload preloaded resources when their parent is reloaded" do
+      # ensure the preloaded resource is in fact preloaded
+      assert Impromptu.root_resource.child(:'Framework').loaded?
+      assert Impromptu.root_resource.child(:'Framework::Preload').loaded?
+      assert_nothing_raised do
+        Framework::Preload
+      end
+      
+      # reload the parent resource and ensure the preloaded resource is still available
+      Impromptu.root_resource.child(:'Framework').reload
+      assert Impromptu.root_resource.child(:'Framework').loaded?
+      assert Impromptu.root_resource.child(:'Framework::Preload').loaded?
+      assert_nothing_raised do
+        Framework::Preload
+      end
+    end
+    
     
     # ----------------------------------------
     # Updating files

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 1
-  version: 1.2.1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Will Cannings
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 +11:00
+date: 2011-01-21 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ files:
 - test/framework/other/ignore.rb
 - test/framework/other/load.rb
 - test/framework/other/two.rb
+- test/framework/preload/preload.rb
 - test/framework/private/klass.rb
 - test/framework/private/other.rb
 - test/framework/stdlib/string.rb
@@ -135,6 +136,7 @@ test_files:
 - test/framework/other/ignore.rb
 - test/framework/other/load.rb
 - test/framework/other/two.rb
+- test/framework/preload/preload.rb
 - test/framework/private/klass.rb
 - test/framework/private/other.rb
 - test/framework/stdlib/string.rb