impromptu 1.0.1 → 1.1.0

data/CHANGELOG

@@ -0,0 +1,10 @@
+1.1.0 - Added support for resources which extend stdlib classes and modules
+      - Added the ability to define exceptional files in a folder. Previously
+        folders were either implicitly loaded (all files were loaded), or you
+        could manually define which files to load. Now you can mix the two
+        styles and have some files automatically loaded, and others with
+        custom definitions (useful for files with exceptional names)
+
+1.0.1 - Fix bug where nested resources were not autoloaded
+      
+1.0.0 - Initial Release

data/README.rdoc

@@ -45,7 +45,12 @@ Because the 'private' component shares the same namespace as the 'framework' com
 
 In both these components no file provides the Framework module. In this case, Impromptu will automatically create a blank module. If after an update a file appears which implements the namespace, the blank module will be removed, and the new implementation loaded. Removing this file will cause the blank module to be created again.
 
-Just as a resource may be implemented by multiple files, a file may implement multiple resources. Because Impromptu doesn't scan files before loading them you must manually tell Impromptu which resources a file provides if it provides more than one, or if the name of the resource cannot be inferred from the name of the file. Folder definitions may take a block (as with the 'other' folder from the 'other' component). Calling file within the block informs Impromptu of a file to load, and specifying the :provides option allows you to tell Impromptu the names of the resources implemented in the file.
+Just as a resource may be implemented by multiple files, a file may implement multiple resources. Because Impromptu doesn't scan files before loading them you must manually tell Impromptu which resources a file provides if it provides more than one, or if the name of the resource cannot be inferred from the name of the file. Folder definitions may take a block (as with the 'other' folder from the 'other' component). Calling file within the block informs Impromptu of a file to load, and specifying the :provides option allows you to tell Impromptu the names of the resources implemented in the file. You can set the implicitly_loaded option to false if you would like to restrict the set of files loaded for a folder to the set you define within the passed block.
+
+== Extending the Standard Library
+Impromptu deals with resources that implement extensions to the standard library a little differently. When a resource is declared, if the implementation of the resource already exists, it assumed the resource extends a standard Ruby class or module. For instance, a resource extending String falls in to this category.
+
+These components are automatically loaded at the start of your program since it's impossible for Impromptu to detect when you use them for the first time. If the folder containing their source files is reloadable, any changes to the files will cause the files to be re-required without undefining the module or class. Normally Impromptu undefines a resource before re-requiring the files which define it to ensure the definition doesn't become 'stale'. This isn't possible with preexisting resources, so a side effect of reloading these files is that methods or constants you remove from your extension will remain defined. You will need to restart your program to ensure a clean definition.
 
 == Defining Components
 Before any resources from a component can be loaded, you must define the components of your system in a block provided to define_components. There are two options: you can either define components directly in this block, or you can call the 'parse_file' method to load a file which defines the components instead.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/impromptu.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{impromptu}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Cannings"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "CHANGELOG",
     "LICENSE",
     "README.rdoc",
     "Rakefile",
@@ -46,6 +47,10 @@ Gem::Specification.new do |s|
     "test/framework/other/load.rb",
     "test/framework/other/two.rb",
     "test/framework/private/klass.rb",
+    "test/framework/private/other.rb",
+    "test/framework/stdlib/string.rb",
+    "test/framework/stdlib/timeout.rb",
+    "test/framework/stdlib/timeout/error.rb",
     "test/framework/test.components",
     "test/helper.rb",
     "test/test_autoload.rb",
@@ -56,6 +61,7 @@ Gem::Specification.new do |s|
     "test/test_integration.rb",
     "test/test_ordered_set.rb",
     "test/test_resource.rb",
+    "test/test_stdlib.rb",
     "test/test_symbol.rb"
   ]
   s.homepage = %q{http://github.com/willcannings/impromptu}
@@ -76,6 +82,10 @@ Gem::Specification.new do |s|
     "test/framework/other/load.rb",
     "test/framework/other/two.rb",
     "test/framework/private/klass.rb",
+    "test/framework/private/other.rb",
+    "test/framework/stdlib/string.rb",
+    "test/framework/stdlib/timeout.rb",
+    "test/framework/stdlib/timeout/error.rb",
     "test/helper.rb",
     "test/test_autoload.rb",
     "test/test_component.rb",
@@ -85,6 +95,7 @@ Gem::Specification.new do |s|
     "test/test_integration.rb",
     "test/test_ordered_set.rb",
     "test/test_resource.rb",
+    "test/test_stdlib.rb",
     "test/test_symbol.rb"
   ]
 

data/lib/impromptu/folder.rb

@@ -1,7 +1,7 @@
 module Impromptu
   class Folder
     attr_accessor :folder, :files, :component, :namespace
-    DEFAULT_OPTIONS   = {nested_namespaces: true, reloadable: true}
+    DEFAULT_OPTIONS   = {nested_namespaces: true, reloadable: true, implicitly_loaded: true}
     SOURCE_EXTENSIONS = %w{rb so bundle}
     
     # Register a new folder containing source files for a
@@ -17,13 +17,15 @@ module Impromptu
     #   will be reloaded every time Impromptu.update is
     #   called, and any modified files will be reloaded,
     #   removed files unloaded, and new files tracked.
+    # * implicitly_loaded: true by default. When true, reloads
+    #   and the initial load of this folder will scan for source
+    #   files and automatically infer resource definitions.
     def initialize(path, component, options={}, block)
       @folder     = path.realpath
       @component  = component
       @options    = DEFAULT_OPTIONS.merge(options)
       @block      = block
       @files      = OrderedSet.new
-      @implicitly_load_all_files = true
     end
     
     # Override eql? so two folders with the same path will be
@@ -44,12 +46,11 @@ module Impromptu
     # Otherwise the folder is scanned to produce an initial set of files
     # and resources provided by this folder.
     def load
-      if @block.nil?
-        self.reload_file_set
-      else
+      unless @block.nil?
         instance_eval &@block
         @block = nil # prevent the block from being run twice
       end
+      self.reload_file_set
     end
     
     # True if the folder uses nested namespaces
@@ -62,6 +63,12 @@ module Impromptu
       @options[:reloadable]
     end
     
+    # True if the folder is implicitly loaded (we scan the folder for
+    # source files and automatically infer resources)
+    def implicitly_loaded?
+      @options[:implicitly_loaded]
+    end
+    
     # Return the 'base' folder for a file contained within this
     # folder. For instance, a folder with nested namespaces would
     # return the path to a file from the root folder. Without
@@ -78,17 +85,16 @@ module Impromptu
       end
     end
     
-    # Explicitly include a file from this folder. If you use this
-    # method, only files included by this method will be loaded.
-    # If you do not use this method, all files within this folder
-    # will be accessible. For this reason, you probably want to
-    # separate out files which need to be defined this way into a
-    # folder separate to the majority of your source files. Options
-    # may be:
+    # Explicitly include a file from this folder. Combined with the
+    # implicitly_loaded option set to false, this method allows you
+    # to manually define a set of files to load from a folder. If
+    # implicitly_loaded is true, this method can be used to provide
+    # definitions of exceptional files (for example files which define
+    # multiple resources, or files with exceptional names).
+    # Options may be:
     # * provides (required): an array of symbols, or a symbol
-    #   inidicating the name of the resource(s) provided by the file
+    #   indicating the name of the resource(s) provided by the file
     def file(name, options={})
-      @implicitly_load_all_files = false
       file = Impromptu::File.new(@folder.join(*name).realpath, self, options[:provides])
       @files.push(file).add_resource_definition
     end
@@ -99,7 +105,7 @@ module Impromptu
     # and any previously unseen files loaded, existing files
     # reloaded, and removed files unloaded.
     def reload
-      reload_file_set if @implicitly_load_all_files
+      reload_file_set if implicitly_loaded?
       @files.each {|file| file.reload_if_modified}
     end
     
@@ -110,12 +116,12 @@ module Impromptu
     # as well), and any new files insert their resources in to
     # the known resources tree.
     def reload_file_set
-      return unless @implicitly_load_all_files
+      return unless implicitly_loaded?
       old_file_set = @files.to_a
       new_file_set = []
       changes = false
       
-      # find all current files and add them if necessary
+      # find all source files and add unseen files to the files list
       @folder.find do |path|
         next unless source_file?(path)
         file = Impromptu::File.new(path.realpath, self)

data/lib/impromptu/impromptu.rb

@@ -31,9 +31,7 @@ module Impromptu
   def self.reset
     # unload all resources
     unless @root_resource.nil?
-      @root_resource.children.each_value do |resource|
-        resource.unload
-      end
+      @root_resource.unload
     end
     
     # reset lists to nil
@@ -57,6 +55,11 @@ module Impromptu
     components.each do |component|
       component.freeze
     end
+    
+    # preload any resources which extend existing standard library
+    # 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
   end
 
   # Open and run a file defining components. The folder containing

data/lib/impromptu/resource.rb

@@ -14,6 +14,7 @@ module Impromptu
       @children     = {}
       @reference    = nil
       @namespace    = false
+      @dont_undef   = self.loaded?  # existing constants, such as 'String', should never be unloaded
       @implicitly_defined = true
     end
     
@@ -60,9 +61,11 @@ module Impromptu
     # unloaded. This allows the resource to be garbage collected.
     def unload
       return unless loaded?
-      @children.each_value {|child| child.unload}
-      @parent.reference.send(:remove_const, @base_symbol)
-      @reference = nil
+      @children.each_value(&:unload)
+      unless @dont_undef
+        @parent.reference.send(:remove_const, @base_symbol)
+        @reference = nil
+      end
     end
     
     # Start tracking a file which implements this resource. If the
@@ -192,5 +195,14 @@ module Impromptu
       return false unless @parent && @parent.loaded? && @parent.reference
       parent.reference.constants.include?(@base_symbol)
     end
+    
+    # Loads this resource if it is an extension of an existing class
+    # or module (such as an object in the standard library). Should
+    # only be called on app startup by Impromptu itself. Recurses to
+    # this resource's children as well.
+    def load_if_extending_stdlib
+      reload if loaded? && !self.root?
+      @children.each_value(&:load_if_extending_stdlib)
+    end
   end
 end

data/test/framework/private/other.rb

@@ -0,0 +1,4 @@
+module Framework
+  module Another
+  end
+end

data/test/framework/stdlib/string.rb

@@ -0,0 +1,5 @@
+class String
+  def extra_method
+    true
+  end
+end

data/test/framework/stdlib/timeout/error.rb

@@ -0,0 +1,7 @@
+module Timeout
+  class Error
+    def self.ext_two
+      true
+    end
+  end
+end

data/test/framework/stdlib/timeout.rb

@@ -0,0 +1,5 @@
+module Timeout
+  def self.ext_one
+    true
+  end
+end

data/test/framework/test.components

@@ -10,14 +10,16 @@ component 'framework.extensions' do
 end
 
 component 'other' do
-  folder 'other' do
+  folder 'other', implicitly_loaded: false do
     file 'load.rb'
-    file 'also.rb', :provides => :OtherName
-    file 'two.rb', :provides => [:ModOne, :ModTwo, :OtherName]
+    file 'also.rb', provides: :OtherName
+    file 'two.rb', provides: [:ModOne, :ModTwo, :OtherName]
   end
 end
 
 component 'private' do
   namespace :Framework
-  folder 'private'
+  folder 'private' do
+    file 'other.rb', provides: :Another
+  end
 end

data/test/test_integration.rb

@@ -21,6 +21,7 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal 1, 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
     end
     
     should "03 have a single require in the framework component" do
@@ -37,7 +38,7 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal 2, Impromptu.components['framework'].folders.first.files.size
       assert_equal 2, Impromptu.components['framework.extensions'].folders.first.files.size
       assert_equal 3, Impromptu.components['other'].folders.first.files.size
-      assert_equal 1, Impromptu.components['private'].folders.first.files.size
+      assert_equal 2, Impromptu.components['private'].folders.first.files.size
     end
     
     should "06 load definitions for 9 resources" do
@@ -50,6 +51,7 @@ class TestIntegration < Test::Unit::TestCase
       assert Impromptu.root_resource.child?(:OtherName)
       assert Impromptu.root_resource.child?(:ModOne)
       assert Impromptu.root_resource.child?(:ModTwo)
+      assert Impromptu.root_resource.child(:Framework).child?(:Another)
     end
     
     should "07 correctly mark namespace resources" do
@@ -62,6 +64,7 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal false, Impromptu.root_resource.child(:OtherName).namespace?
       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(:Framework).child(:Another).namespace?
     end
     
     should "08 keep all resources unloaded to start with" do
@@ -74,6 +77,7 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal false, Impromptu.root_resource.child(:'OtherName').loaded?
       assert_equal false, Impromptu.root_resource.child(:'ModOne').loaded?
       assert_equal false, Impromptu.root_resource.child(:'ModTwo').loaded?
+      assert_equal false, Impromptu.root_resource.child(:Framework).child(:'Another').loaded?
     end
     
     should "09 have all resources specified by the correct number of files" do
@@ -87,6 +91,7 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal 2, Impromptu.root_resource.child(:'OtherName').files.size
       assert_equal 1, Impromptu.root_resource.child(:'ModOne').files.size
       assert_equal 1, Impromptu.root_resource.child(:'ModTwo').files.size
+      assert_equal 1, Impromptu.root_resource.child(:Framework).child(:'Another').files.size
       assert_equal true, Impromptu.root_resource.child(:'Framework').implicitly_defined?
     end
     
@@ -148,6 +153,13 @@ class TestIntegration < Test::Unit::TestCase
       assert_nothing_raised do
         ModTwo
       end
+      
+      # private
+      Impromptu.root_resource.child(:Framework).child(:Another).reload
+      assert_equal true, Impromptu.root_resource.child(:Framework).child(:Another).loaded?
+      assert_nothing_raised do
+        Framework::Another
+      end
     end
     
     should "12 load multiple files for a resource when required" do
@@ -253,6 +265,22 @@ class TestIntegration < Test::Unit::TestCase
       end
     end
     
+    context "and adding files to an explicitly defined folder" do
+      setup do
+        FileUtils.mv 'test/framework/copies/new_unseen.rb', 'test/framework/other/unseen.rb'
+      end
+      
+      teardown do
+        FileUtils.mv 'test/framework/other/unseen.rb', 'test/framework/copies/new_unseen.rb'
+      end
+      
+      should "not make add a file definition to the folder" do
+        assert_equal 3, Impromptu.components['other'].folders.first.files.size
+        Impromptu.update
+        assert_equal 3, Impromptu.components['other'].folders.first.files.size
+      end
+    end
+    
     
     # ----------------------------------------
     # Removing files

data/test/test_stdlib.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class TestStdlib < Test::Unit::TestCase
+  context "A component with resources extending the standard library" do
+    setup do
+      Impromptu.reset
+      Impromptu.define_components do
+        component 'stdlib' do
+          folder 'test/framework/stdlib'
+        end
+      end
+    end
+    
+    should "have a single component, and an extension for String" do
+      assert_equal 1, Impromptu.components.size
+      assert_not_nil Impromptu.root_resource.child(:String)
+    end
+    
+    should "automatically load the String resource" do
+      assert_respond_to "string", :extra_method
+      assert "string".extra_method
+    end
+    
+    should "automatically load nested resources" do
+      # timeout
+      assert_respond_to Timeout, :ext_one
+      assert Timeout.ext_one
+      
+      # timeout::error
+      assert_respond_to Timeout::Error, :ext_two
+      assert Timeout::Error.ext_two
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Will Cannings
@@ -41,6 +41,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- CHANGELOG
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -69,6 +70,10 @@ files:
 - test/framework/other/load.rb
 - test/framework/other/two.rb
 - test/framework/private/klass.rb
+- test/framework/private/other.rb
+- test/framework/stdlib/string.rb
+- test/framework/stdlib/timeout.rb
+- test/framework/stdlib/timeout/error.rb
 - test/framework/test.components
 - test/helper.rb
 - test/test_autoload.rb
@@ -79,6 +84,7 @@ files:
 - test/test_integration.rb
 - test/test_ordered_set.rb
 - test/test_resource.rb
+- test/test_stdlib.rb
 - test/test_symbol.rb
 has_rdoc: true
 homepage: http://github.com/willcannings/impromptu
@@ -126,6 +132,10 @@ test_files:
 - test/framework/other/load.rb
 - test/framework/other/two.rb
 - test/framework/private/klass.rb
+- test/framework/private/other.rb
+- test/framework/stdlib/string.rb
+- test/framework/stdlib/timeout.rb
+- test/framework/stdlib/timeout/error.rb
 - test/helper.rb
 - test/test_autoload.rb
 - test/test_component.rb
@@ -135,4 +145,5 @@ test_files:
 - test/test_integration.rb
 - test/test_ordered_set.rb
 - test/test_resource.rb
+- test/test_stdlib.rb
 - test/test_symbol.rb