impromptu 1.1.0 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,12 @@
+1.2.0 - New method 'root?' which tests is symbols are prefixed with two colons
+      - New 'namespace' option for folders allows you to override a components
+        namespace with a namespace specific to a folder.
+      - Root symbols (::A) are now respected in provides options on files.
+        This allows files to implement resources which are not relative to the
+        component or folder namespace. For instance a folder with a namespace
+        :A containing a file which provides :B and ::C would create resources
+        for A::B and C.
+
 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

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/impromptu.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{impromptu}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Cannings"]
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
     "test/framework/copies/original_klass.rb",
     "test/framework/ext/extensions.rb",
     "test/framework/ext/extensions/blog.rb",
+    "test/framework/folder_namespace/stream.rb",
     "test/framework/lib/group/klass2.rb",
     "test/framework/lib/klass.rb",
     "test/framework/other/also.rb",
@@ -75,6 +76,7 @@ Gem::Specification.new do |s|
     "test/framework/copies/original_klass.rb",
     "test/framework/ext/extensions.rb",
     "test/framework/ext/extensions/blog.rb",
+    "test/framework/folder_namespace/stream.rb",
     "test/framework/lib/group/klass2.rb",
     "test/framework/lib/klass.rb",
     "test/framework/other/also.rb",

data/lib/impromptu/component.rb

@@ -96,18 +96,19 @@ module Impromptu
     # Mark a component as 'frozen'. Modification of the component
     # requirements or list of folders is not allowed after this.
     def freeze
+      # create a blank namespace module if required
+      unless namespace.nil?
+        Impromptu.root_resource.get_or_create_child(namespace).namespace!
+      end
+      
       # freeze files
       @folders.each do |folder|
+        folder.create_namespace
         folder.files.each do |file|
           file.freeze
         end
       end
       
-      # create a blank namespace module if required
-      unless namespace.nil?
-        Impromptu.root_resource.get_or_create_child(namespace).namespace!
-      end
-      
       @frozen = true
     end
     

data/lib/impromptu/file.rb

@@ -210,11 +210,14 @@ module Impromptu
       end
       
       def combine_symbol_with_namespace(symbol)
-        if @folder.component.namespace
-          "#{@folder.component.namespace}::#{symbol}".to_sym
-        else
-          symbol.to_sym
+        unless symbol.root?
+          if @folder.namespace
+            return "#{@folder.namespace}::#{symbol}".to_sym
+          elsif @folder.component.namespace
+            return "#{@folder.component.namespace}::#{symbol}".to_sym
+          end
         end
+        symbol.without_leading_colons.to_sym
       end
   end
 end

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, implicitly_loaded: true}
+    attr_accessor :folder, :files, :component
+    DEFAULT_OPTIONS   = {nested_namespaces: true, reloadable: true, implicitly_loaded: true, namespace: nil}
     SOURCE_EXTENSIONS = %w{rb so bundle}
     
     # Register a new folder containing source files for a
@@ -20,6 +20,9 @@ module Impromptu
     # * 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.
+    # * namespace: override a component's default namespace with
+    #   a namespace specific to this folder. The normal rules
+    #   with nested namespaces apply.
     def initialize(path, component, options={}, block)
       @folder     = path.realpath
       @component  = component
@@ -69,6 +72,19 @@ module Impromptu
       @options[:implicitly_loaded]
     end
     
+    # A string or symbol for this folder which overrides the components
+    # default namespace. Nil if no namespace has been defined.
+    def namespace
+      @options[:namespace]
+    end
+    
+    # If an overriding namespace has been defined for this folder,
+    # create a resource representing it and define it as a namespace.
+    def create_namespace
+      return if self.namespace.nil?
+      Impromptu.root_resource.get_or_create_child(self.namespace).namespace!
+    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

data/lib/impromptu/symbol.rb

@@ -30,6 +30,11 @@ class Symbol
     self.nested_symbols.first
   end
   
+  # True if the symbol starts with two colons
+  def root?
+    self.to_s.start_with?('::')
+  end
+  
   # Iterate through a namespaced symbol by visiting each
   # name in turn, including its parent names. e.g calling
   # on A::B::C would yield :A, :A::B, and :A::B::C

data/test/framework/folder_namespace/stream.rb

@@ -0,0 +1,4 @@
+module Namespace
+  class Stream
+  end
+end

data/test/framework/private/other.rb

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

data/test/framework/test.components

@@ -20,6 +20,10 @@ end
 component 'private' do
   namespace :Framework
   folder 'private' do
-    file 'other.rb', provides: :Another
+    file 'other.rb', provides: :'::Another'
   end
 end
+
+component 'folder_namespace' do
+  folder 'folder_namespace', namespace: :Namespace
+end

data/test/test_integration.rb

@@ -13,8 +13,8 @@ class TestIntegration < Test::Unit::TestCase
     # ----------------------------------------
     # Loading component definitions
     # ----------------------------------------
-    should "01 create four components" do
-      assert_equal 4, Impromptu.components.size
+    should "01 create five components" do
+      assert_equal 5, Impromptu.components.size
     end
     
     should "02 have a single folder per component" do
@@ -22,6 +22,7 @@ class TestIntegration < Test::Unit::TestCase
       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
+      assert_equal 1, Impromptu.components['folder_namespace'].folders.size
     end
     
     should "03 have a single require in the framework component" do
@@ -34,14 +35,15 @@ class TestIntegration < Test::Unit::TestCase
       assert_equal nil, Impromptu.components['other'].namespace
     end
     
-    should "05 start tracking 8 files" do
+    should "05 start tracking 10 files" do
       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 2, Impromptu.components['private'].folders.first.files.size
+      assert_equal 1, Impromptu.components['folder_namespace'].folders.first.files.size
     end
     
-    should "06 load definitions for 9 resources" do
+    should "06 load definitions for 12 resources" do
       assert Impromptu.root_resource.child?(:Framework)
       assert Impromptu.root_resource.child(:Framework).child?(:Extensions)
       assert Impromptu.root_resource.child(:Framework).child(:Extensions).child?(:Blog)
@@ -51,7 +53,9 @@ 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)
+      assert Impromptu.root_resource.child?(:Another)
+      assert Impromptu.root_resource.child(:Namespace)
+      assert Impromptu.root_resource.child(:Namespace).child?(:Stream)
     end
     
     should "07 correctly mark namespace resources" do
@@ -64,7 +68,9 @@ 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?
+      assert_equal false, Impromptu.root_resource.child(:Another).namespace?
+      assert_equal true, Impromptu.root_resource.child(:Namespace).namespace?
+      assert_equal false, Impromptu.root_resource.child(:Namespace).child(:Stream).namespace?
     end
     
     should "08 keep all resources unloaded to start with" do
@@ -77,7 +83,9 @@ 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?
+      assert_equal false, Impromptu.root_resource.child(:'Another').loaded?
+      assert_equal false, Impromptu.root_resource.child(:'Namespace').loaded?
+      assert_equal false, Impromptu.root_resource.child(:'Namespace::Stream').loaded?
     end
     
     should "09 have all resources specified by the correct number of files" do
@@ -91,21 +99,30 @@ 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 1, Impromptu.root_resource.child(:'Another').files.size
+      assert_equal 1, Impromptu.root_resource.child(:'Namespace::Stream').files.size
       assert_equal true, Impromptu.root_resource.child(:'Framework').implicitly_defined?
+      assert_equal true, Impromptu.root_resource.child(:'Namespace').implicitly_defined?
     end
     
     
     # ----------------------------------------
     # Loading/unloading
     # ----------------------------------------
-    should "10 allow loading the implicitly defined framework module" do
+    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
         Framework
       end
+      
+      assert_equal false, Impromptu.root_resource.child(:'Namespace').loaded?
+      Impromptu.root_resource.child(:'Namespace').reload
+      assert_equal true, Impromptu.root_resource.child(:'Namespace').loaded?
+      assert_nothing_raised do
+        Namespace
+      end
     end
     
     should "11 load resources using associated files when required" do
@@ -155,10 +172,17 @@ class TestIntegration < Test::Unit::TestCase
       end
       
       # private
-      Impromptu.root_resource.child(:Framework).child(:Another).reload
-      assert_equal true, Impromptu.root_resource.child(:Framework).child(:Another).loaded?
+      Impromptu.root_resource.child(:Another).reload
+      assert_equal true, Impromptu.root_resource.child(:Another).loaded?
+      assert_nothing_raised do
+        Another
+      end
+      
+      # folder namespace
+      Impromptu.root_resource.child(:'Namespace::Stream').reload
+      assert_equal true, Impromptu.root_resource.child(:'Namespace::Stream').loaded?
       assert_nothing_raised do
-        Framework::Another
+        Namespace::Stream
       end
     end
     

data/test/test_symbol.rb

@@ -27,6 +27,10 @@ class TestResource < Test::Unit::TestCase
       assert_respond_to @symbol, :root_symbol
     end
     
+    should "respond to root?" do
+      assert_respond_to @symbol, :root?
+    end
+    
     should "respond to each_namespaced_symbol" do
       assert_respond_to @symbol, :each_namespaced_symbol
     end
@@ -56,6 +60,10 @@ class TestResource < Test::Unit::TestCase
       should "return itself for root_symbol" do
         assert_equal @symbol, @symbol.root_symbol
       end
+      
+      should "return false for root?" do
+        assert_equal false, @symbol.root?
+      end
     end
     
     # ----------------------------------------
@@ -82,6 +90,10 @@ class TestResource < Test::Unit::TestCase
         assert_equal :TopLevel, @symbol.root_symbol
       end
       
+      should "return false for root?" do
+        assert_equal false, @symbol.root?
+      end
+      
       should "return the last nested name for base_symbol" do
         assert_equal :BottomLevel, @symbol.base_symbol
       end
@@ -119,6 +131,10 @@ class TestResource < Test::Unit::TestCase
         assert_equal :A, @symbol.base_symbol
       end
       
+      should "return true for root?" do
+        assert_equal true, @symbol.root?
+      end
+      
       should "return itself for root_symbol" do
         assert_equal :A, @symbol.root_symbol
       end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Will Cannings
@@ -63,6 +63,7 @@ files:
 - test/framework/copies/original_klass.rb
 - test/framework/ext/extensions.rb
 - test/framework/ext/extensions/blog.rb
+- test/framework/folder_namespace/stream.rb
 - test/framework/lib/group/klass2.rb
 - test/framework/lib/klass.rb
 - test/framework/other/also.rb
@@ -125,6 +126,7 @@ test_files:
 - test/framework/copies/original_klass.rb
 - test/framework/ext/extensions.rb
 - test/framework/ext/extensions/blog.rb
+- test/framework/folder_namespace/stream.rb
 - test/framework/lib/group/klass2.rb
 - test/framework/lib/klass.rb
 - test/framework/other/also.rb