lawrencepit-autocode 0.9.5

data/lib/autocode.rb

@@ -0,0 +1,135 @@
+module Autocode
+
+  def self.extended( mod )
+    included(mod)
+  end
+
+  def self.included( mod )
+
+    old = mod.method( :const_missing )
+    mod.metaclass.class_eval do
+
+      def autocreate( key, exemplar, &block )
+        keys = case key
+        when true, Symbol then [key]
+        when Array then key
+        end
+
+        @exemplars ||= Hash.new
+        @init_blocks ||= Hash.new { |h,k| h[k] = [] }
+        keys.each do |k|
+          @exemplars[k] = exemplar
+          @init_blocks[k] << block
+        end
+
+        return self
+      end
+
+      def autocreate_class( key = true, superclass = Class )
+        autocreate key, Class.new( superclass )
+      end
+
+      def autocreate_module( key = true )
+        autocreate key, Module.new
+      end
+
+      def autoinit( key, &block )
+        # See whether we're dealing with a namespaced constant,
+        # The match groupings for,  e.g. "X::Y::Z", would be
+        # ["X::Y", "Z"]
+        match = key.to_s.match(/^(.*)::([\w\d_]+)$/)
+        if match
+          namespace, cname = match[1,2]
+          const = module_eval(namespace)
+          const.module_eval do
+            @init_blocks ||= Hash.new { |h,k| h[k] = [] }
+            @init_blocks[cname.to_sym] << block
+          end
+        else
+          @init_blocks[key] << block
+        end
+        return self
+      end
+
+      def autoload(key = true, options = {})
+        snake_case = lambda {|name| name.gsub(/([a-z\d])([A-Z])/){"#{$1}_#{$2}"}.tr("-", "_").downcase }
+        # look for load_files in either a specified directory, or in the directory
+        # with the snakecase name of the enclosing module
+        directories = [options[:directories] || snake_case.call(self.name.match( /^.*::([\w\d_]+)$/)[1])].flatten
+        # create a lambda that looks for a file to load
+        file_finder = lambda do |cname|
+          filename = snake_case.call(cname.to_s << ".rb")
+          path = directories.map { |dir| File.join(dir.to_s, filename) }.find { |path| File.exist?( path ) }
+        end
+        # if no exemplar is given, assume Module.new
+        @load_files ||= Hash.new
+        @load_files[key] = [file_finder, options[:exemplar] || Module.new]
+        return self
+      end
+
+      def autoload_class(key = true, superclass = Class, options = {})
+        options[:exemplar] = Class.new(superclass)
+        autoload key, options
+      end
+
+      def autoload_module(key = true, options = {})
+        options[:exemplar] = Module.new
+        autoload key, options
+      end
+
+      # Returns the list of constants that would be reloaded upon a call to reload.
+      def reloadable( *names )
+        ( @reloadable ||= [] ).concat(names)
+        return self
+      end
+
+      # Reloads all the constants that were loaded via autocode. Technically, all reload
+      # is doing is undefining them (by calling +remove_const+ on each in turn); they won't get
+      # reloaded until they are referenced.
+      def reload
+        @reloadable.each { |name| remove_const( name ) } if @reloadable
+        @reloadable = nil
+        return self
+      end
+
+      # Unloads all the constants that were loaded and removes all auto* definitions.
+      def unload
+        reload
+        @exemplars = @init_blocks = @load_files = nil
+        return self
+      end
+
+      private
+
+      define_method :const_missing do | cname | #:nodoc:
+        cname = cname.to_sym
+        @exemplars ||= Hash.new
+        @init_blocks ||= Hash.new { |h,k| h[k] = [] }
+        @load_files ||= Hash.new
+        exemplar = @exemplars[cname] || @exemplars[true]
+        blocks = @init_blocks[cname]
+        blocks = @init_blocks[true] + blocks if @exemplars[cname].nil? && @init_blocks[true]
+        load_file_finder, load_class = @load_files[cname] || @load_files[true]
+
+        if load_file_finder && filename = load_file_finder.call(cname)
+          object = load_class.clone
+        elsif exemplar
+          object = exemplar.clone
+        else
+          return old.call(cname)
+        end
+
+        (@reloadable ||= []) << cname;
+        const_set( cname, object )
+
+        blocks.each do |block|
+          object.module_eval( &block) if block
+        end
+        
+        load(filename) if filename
+        
+        return object
+      end
+    end
+  end
+end

data/test/autocreate.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+
+describe "A module where autocreate has been called" do
+  before do
+    module Thingy
+      extend Autocode
+      autocreate :Tom, Module.new do
+        def self.peeps; true; end 
+      end
+      
+      autocreate [:Dick, :Harry], Class.new do
+        def self.peeps; false; end
+      end
+    end
+  end
+  
+  after do
+    Thingy.unload
+  end
+
+  it "should autocreate some constants" do
+    Thingy::Tom.peeps.should == true
+    Thingy::Dick.peeps.should == false
+    Thingy::Harry.peeps.should == false
+  end
+  
+  it "should not autocreate unregistered constants" do
+    lambda { Thingy::Mabob::MooCow }.should.raise NameError
+  end
+  
+  it "unless autocreate was called with key of true" do
+    module Duffel
+      extend Autocode
+      autocreate true, Class.new do
+        def self.universal; true; end
+      end
+    end
+    
+    Duffel::AnyThing.universal.should == true
+    Duffel.unload
+  end
+  
+end

data/test/autoinit.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+
+describe "thingy" do
+  before do
+    module Thingy
+      extend Autocode
+      autocreate(:Whatsit, Module.new) do
+        extend Autocode
+        autoload :Critter, :exemplar => Class.new, :directories => File.join(File.dirname(__FILE__), "test_lib")
+      end
+      
+      autoinit(:Whatsit) do
+        def self.in_scope; true; end
+      end
+      
+      autoinit('Whatsit::Critter') do
+        def self.outside_scope; true; end
+        def instance; true; end
+        # this definition is overridden by the one in the file
+        def self.gizmo; 2; end
+      end
+      
+      autocreate :Big, Module.new do
+        extend Autocode
+        autocreate :Bad, Module.new do
+          extend Autocode
+          autocreate :John, Class.new do
+            def self.stinks?; true; end
+          end
+        end
+      end
+      
+      autoinit('Big::Bad::John') do
+        def self.stinks?; false; end
+      end
+      
+    end
+  end
+  
+  after do
+    Thingy::Whatsit.unload    
+    Thingy::Big::Bad.unload
+    Thingy::Big.unload
+    Thingy.unload    
+  end  
+  
+  it "fdfdsf" do
+    Thingy::Whatsit.in_scope.should.be.true
+    Thingy::Whatsit::Critter.outside_scope.should.be.true
+    Thingy::Whatsit::Critter.new.instance.should.be.true
+    Thingy::Big::Bad::John.stinks?.should.be.false
+  end
+  
+  it "should run autoinit blocks before the file loading" do
+     Thingy::Whatsit::Critter.gizmo.should == 1
+  end
+
+end

data/test/autoload.rb

@@ -0,0 +1,86 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+
+describe "A module where autoload has been called" do
+  
+  before do
+    module Thingy
+      module Mabob
+        extend Autocode
+        autoload_class :DooDad, Class, :directories => [File.join(File.dirname(__FILE__), "test_lib")]
+        autoload_module :Humbug, :directories => [File.join(File.dirname(__FILE__), "test_lib")]
+      end
+    end
+  end
+  
+  after do
+    Thingy::Mabob.unload
+  end
+
+  it "should autoload where files match" do  
+    Thingy::Mabob::DooDad.should.respond_to :gizmo
+    Thingy::Mabob::Humbug.should.respond_to :full_of_it?
+  end
+  
+  it "should not autoload where it matches a file but is out of scope" do
+    lambda { Thingy::Mabob::Answer42ItIs }.should.raise NameError
+    lambda { Thingy::Whatsit::Critter }.should.raise NameError
+  end
+  
+  it "should not autocreate those unmentioned and fileable" do
+    lambda { Thingy::Mabob::MooCow }.should.raise NameError
+  end
+  
+  it "should autoload using super class" do
+    module Waves
+      module TestLib
+        extend Autocode
+        autoload_class true, Thingy::Mabob::DooDad
+      end
+    end
+    Waves::TestLib::TheClass42Gang.party?.should == true
+    Waves::TestLib::TheClass42Gang.gizmo.should == 1
+    Waves::TestLib.unload
+  end
+
+  it "should autoload using defaults" do
+    module Waves
+      module TestLib
+        extend Autocode
+        autoload
+      end
+    end    
+    Waves::TestLib::TheOneAndOnlyModule.help().should == "module help"
+    lambda { Waves::TestLib::TheOneAndOnlyClass }.should.raise TypeError
+    Waves::TestLib::ThePretender.name.should == "Waves::TestLib::ThePretender"
+    lambda { Waves::TestLib::ThePretender.help() }.should.raise NoMethodError
+    Waves::TestLib.unload
+  end
+  
+  it "should autoload class using defaults" do
+    module Waves
+      module TestLib
+        extend Autocode
+        autoload_class
+      end
+    end
+    Waves::TestLib::TheOneAndOnlyClass.help().should == "class help"
+    lambda { Waves::TestLib::TheOneAndOnlyModule }.should.raise TypeError
+    Waves::TestLib::ThePretender.name.should == "Waves::TestLib::ThePretender"
+    lambda { Waves::TestLib::ThePretender.help() }.should.raise NoMethodError
+    Waves::TestLib.unload
+  end
+
+  it "should autoload module using defaults" do
+    module Waves
+      module TestLib
+        extend Autocode
+        autoload_module
+      end
+    end
+    Waves::TestLib::TheOneAndOnlyModule.help().should == "module help"
+    lambda { Waves::TestLib::TheOneAndOnlyClass }.should.raise TypeError
+    Waves::TestLib::ThePretender.name.should == "Waves::TestLib::ThePretender"
+    lambda { Waves::TestLib::ThePretender.help() }.should.raise NoMethodError
+    Waves::TestLib.unload
+  end
+end

data/test/helpers.rb

@@ -0,0 +1,7 @@
+%w{ rubygems bacon metaid }.each { |dep| require dep }
+Bacon.extend Bacon::TestUnitOutput
+Bacon.summary_on_exit
+
+$:.unshift File.join(File.dirname(__FILE__) , "../lib")
+require 'autocode'
+

data/test/test_lib/critter.rb

@@ -0,0 +1,9 @@
+module Thingy
+  module Whatsit
+    class Critter
+      def self.gizmo
+        1
+      end
+    end
+  end
+end

data/test/test_lib/doo_dad.rb

@@ -0,0 +1,9 @@
+module Thingy
+  module Mabob
+    class DooDad
+      def self.gizmo
+        1
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: lawrencepit-autocode
+version: !ruby/object:Gem::Version 
+  version: 0.9.5
+platform: ruby
+authors: 
+- Dan Yoder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: metaid
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/autocode.rb
+- test/autocreate.rb
+- test/autoinit.rb
+- test/autoload.rb
+- test/helpers.rb
+- test/test_lib
+- test/test_lib/critter.rb
+- test/test_lib/doo_dad.rb
+has_rdoc: true
+homepage: http://dev.zeraweb.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Utility for auto-including, reloading, and generating classes and modules.
+test_files: []
+