wrap_in_module 0.0.2 → 0.0.3

data/lib/wrap_in_module.rb

@@ -13,96 +13,53 @@ module WrapInModule
   #
   # See intro.txt[link:files/intro_txt.html] for an overview.
 
-  class Script < Module
-    # The file with which the Script was instantiated.
-    attr_reader :__main_file
-
-    # The directory in which main_file is located, and relative to which
-    # #load searches for files before falling back to Kernel#load.
-    attr_reader :__dir
-    
-    # A hash that maps <tt>filename=>true</tt> for each file that has been
-    # required locally by the script. This has the same semantics as <tt>$"</tt>,
-    # alias <tt>$LOADED_FEATURES</tt>, except that it is local to this script.
-    attr_reader :__loaded_features
-
-    class << self
-      alias load new
-    end
-    
+  class Script
     # Creates new Script, and loads _main_file_ in the scope of the Script. If a
     # block is given, the script is passed to it before loading from the file, and
     # constants can be defined as inputs to the script.
     
-    def initialize(main_file)   # :yields: self
-      extend ScriptModuleMethods
-      @__main_file = File.expand_path(main_file)
-      @__dir = File.dirname(@__main_file)
-      @__loaded_features = {}
+    def initialize(_module, main_file)   # :yields: self
+      @__module = _module
+      @__module.extend LoadInModuleMethods
+      @__module.extend ScriptModuleMethods
       
       yield self if block_given?
-      load_in_module(main_file)
-    end
-    
-    # Loads _file_ into this Script. Searches relative to the local dir, that is,
-    # the dir of the file given in the original call to
-    # <tt>Script.load(file)</tt>, loads the file, if found, into this Script's
-    # scope, and returns true. If the file is not found, falls back to
-    # <tt>Kernel.load</tt>, which searches on <tt>$LOAD_PATH</tt>, loads the file,
-    # if found, into global scope, and returns true. Otherwise, raises
-    # <tt>LoadError</tt>.
-    #
-    # The _wrap_ argument is passed to <tt>Kernel.load</tt> in the fallback case,
-    # when the file is not found locally.
-    #
-    # Typically called from within the main file to load additional sub files, or
-    # from those sub files.
-    
-    def load(file, wrap = false)
-      load_in_module(File.join(@__dir, file))
-      true
-    rescue MissingFile
-      super
-    end
 
-    # Analogous to <tt>Kernel#require</tt>. First tries the local dir, then falls
-    # back to <tt>Kernel#require</tt>. Will load a given _feature_ only once.
-    #
-    # Note that extensions (*.so, *.dll) can be required in the global scope, as
-    # usual, but not in the local scope. (This is not much of a limitation in
-    # practice--you wouldn't want to load an extension more than once.) This
-    # implementation falls back to <tt>Kernel#require</tt> when the argument is an
-    # extension or is not found locally.
-    
-    def require(feature)
-      unless @__loaded_features[feature]
-        @__loaded_features[feature] = true
-        file = File.join(@__dir, feature)
-        file += ".rb" unless /\.rb$/ =~ file
-        load_in_module(file)
+      @__module.module_eval do
+        # The file with which the Script was instantiated.
+        attr_reader :__main_file
+
+        # The directory in which main_file is located, and relative to which
+        # #load searches for files before falling back to Kernel#load.
+        attr_reader :__dir
+        
+        # A hash that maps <tt>filename=>true</tt> for each file that has been
+        # required locally by the script. This has the same semantics as <tt>$"</tt>,
+        # alias <tt>$LOADED_FEATURES</tt>, except that it is local to this script.
+        attr_reader :__loaded_features
+
+        @__main_file = File.expand_path(main_file)
+        @__dir = File.dirname(@__main_file)
+        @__loaded_features = {}
+        load_in_module(main_file)
       end
-    rescue MissingFile
-      @__loaded_features[feature] = false
-      super
     end
-    
-    # Raised by #load_in_module, caught by #load and #require.
-    class MissingFile < LoadError; end
-    
-    # Loads _file_ in this module's context. Note that <tt>\_\_FILE\_\_</tt> and
-    # <tt>\_\_LINE\_\_</tt> work correctly in _file_.
-    # Called by #load and #require; not normally called directly.
-    
-    def load_in_module(__file__)
-      module_eval("@__script_scope ||= binding\n" + IO.read(__file__),
-        File.expand_path(__file__), 0)
-        # start numbering at 0 because of the extra line.
-        # The extra line does nothing in sub-script files.
-    rescue Errno::ENOENT
-      if /#{__file__}$/ =~ $!.message # No extra locals in this scope.
-        raise MissingFile, $!.message
-      else
-        raise
+
+    module LoadInModuleMethods
+      # Loads _file_ in this module's context. Note that <tt>\_\_FILE\_\_</tt> and
+      # <tt>\_\_LINE\_\_</tt> work correctly in _file_.
+      # Called by #load and #require; not normally called directly.
+      def load_in_module(__file__)
+        module_eval("@__script_scope ||= binding\n" + IO.read(__file__),
+          File.expand_path(__file__), 0)
+          # start numbering at 0 because of the extra line.
+          # The extra line does nothing in sub-script files.
+      rescue Errno::ENOENT
+        if /#{__file__}$/ =~ $!.message # No extra locals in this scope.
+          raise MissingFile, $!.message
+        else
+          raise
+        end
       end
     end
     
@@ -131,6 +88,51 @@ module WrapInModule
       def __local_variable_get(name)
         eval(name.to_s, __script_scope)
       end
+
+      # Raised by #load_in_module, caught by #load and #require.
+      class MissingFile < LoadError; end
+
+      # Loads _file_ into this Script. Searches relative to the local dir, that is,
+      # the dir of the file given in the original call to
+      # <tt>Script.load(file)</tt>, loads the file, if found, into this Script's
+      # scope, and returns true. If the file is not found, falls back to
+      # <tt>Kernel.load</tt>, which searches on <tt>$LOAD_PATH</tt>, loads the file,
+      # if found, into global scope, and returns true. Otherwise, raises
+      # <tt>LoadError</tt>.
+      #
+      # The _wrap_ argument is passed to <tt>Kernel.load</tt> in the fallback case,
+      # when the file is not found locally.
+      #
+      # Typically called from within the main file to load additional sub files, or
+      # from those sub files.
+      
+      def load(file, wrap = false)
+        load_in_module(File.join(@__dir, file))
+        true
+      rescue MissingFile
+        super
+      end
+
+      # Analogous to <tt>Kernel#require</tt>. First tries the local dir, then falls
+      # back to <tt>Kernel#require</tt>. Will load a given _feature_ only once.
+      #
+      # Note that extensions (*.so, *.dll) can be required in the global scope, as
+      # usual, but not in the local scope. (This is not much of a limitation in
+      # practice--you wouldn't want to load an extension more than once.) This
+      # implementation falls back to <tt>Kernel#require</tt> when the argument is an
+      # extension or is not found locally.
+      
+      def require(feature)
+        unless @__loaded_features[feature]
+          @__loaded_features[feature] = true
+          file = File.join(@__dir, feature)
+          file += ".rb" unless /\.rb$/ =~ file
+          load_in_module(file)
+        end
+      rescue MissingFile
+        @__loaded_features[feature] = false
+        super
+      end
     end
   end
 end

data/lib/wrap_in_module/version.rb

@@ -1,3 +1,3 @@
 module WrapInModule
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/example_data/single_top_level_class.rb

@@ -0,0 +1,2 @@
+class Hoopty
+end

data/spec/example_data/top_level_class_requires_another_file.rb

@@ -0,0 +1,7 @@
+require 'single_top_level_class'
+
+class Doopty
+  def test_hoopty
+    Hoopty.new
+  end
+end

data/spec/lib/wrap_in_module_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "WrapInModule" do
+  it "loads a file with a single top level class" do
+    module FooMod; end
+    WrapInModule::Script.new(FooMod, File.dirname(__FILE__) + '/../example_data/single_top_level_class.rb')
+    FooMod::Hoopty.new
+  end
+
+  it "loads a file without overwriting existing module definition" do
+    module FooMod; BOB="hello there I am bob"; end
+    WrapInModule::Script.new(FooMod, File.dirname(__FILE__) + '/../example_data/single_top_level_class.rb')
+    FooMod::BOB
+  end
+
+  it "loads a file with a top level class that requires another file with a top level class" do
+    module FooMod; end
+    WrapInModule::Script.new(FooMod, File.dirname(__FILE__) + '/../example_data/top_level_class_requires_another_file.rb')
+    FooMod::Doopty.new
+    FooMod::Hoopty.new
+  end
+
+  it "verify that classes required inside of the top level loaded file are accesible in the non namespaces scope" do
+    module FooMod; end
+    WrapInModule::Script.new(FooMod, File.dirname(__FILE__) + '/../example_data/top_level_class_requires_another_file.rb')
+    a = FooMod::Doopty.new
+    a.test_hoopty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'wrap_in_module'

data/wrap_in_module.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = "wrap_in_module"
   gem.require_paths = ["lib"]
   gem.version       = WrapInModule::VERSION
+
+  gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrap_in_module
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
-dependencies: []
+date: 2012-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby gem that allows you to load a ruby file into a module. Think scoping
   bunch of code inside a module.
 email:
@@ -27,6 +43,10 @@ files:
 - Rakefile
 - lib/wrap_in_module.rb
 - lib/wrap_in_module/version.rb
+- spec/example_data/single_top_level_class.rb
+- spec/example_data/top_level_class_requires_another_file.rb
+- spec/lib/wrap_in_module_spec.rb
+- spec/spec_helper.rb
 - wrap_in_module.gemspec
 homepage: http://github.com/realpractice/wrap_in_module
 licenses: []
@@ -53,4 +73,8 @@ signing_key:
 specification_version: 3
 summary: Ruby gem that allows you to load a ruby file into a module. Think scoping
   bunch of code inside a module.
-test_files: []
+test_files:
+- spec/example_data/single_top_level_class.rb
+- spec/example_data/top_level_class_requires_another_file.rb
+- spec/lib/wrap_in_module_spec.rb
+- spec/spec_helper.rb