automatthew-autocode 0.9.3

data/lib/autocode.rb

@@ -0,0 +1,120 @@
+require 'reloadable'
+
+module Autocode
+	
+	def self.extended( mod ) #:nodoc:
+
+		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
+			  
+			  keys.each do |k|
+			   	exemplars[k] = exemplar
+          init_blocks[k] << block
+			  end
+
+				return self
+			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 ||= Hash.new { |h,k| h[k] = [] }
+    			@init_blocks[key] << block
+  			end
+  			return self
+  		end
+		  
+		  def autoload( key, options )
+		    # look for load_files in either a specified directory, or in the directory
+		    # with the snakecase name of the enclosing module
+		    directories = [options[:directories] || default_directory(self.name)].flatten
+        # create a lambda that looks for a file to load
+        file_finder = lambda do |cname|
+          filename = default_file_name(cname)
+          dirname = directories.find do |dir|
+  			    File.exist?(File.join(dir.to_s, filename))
+  			  end
+  			  dirname ? File.join(dirname.to_s, filename) : nil
+        end
+        # if no exemplar is given, assume Module.new
+        load_files[key] = [file_finder, options[:exemplar] || Module.new]
+				return self
+		  end
+		  
+		  def autoload_class(key, superclass=nil, options={})
+		    options[:exemplar] = Class.new(superclass)
+		    autoload key, options
+		  end
+		  
+		  
+		  define_method :const_missing do | cname | #:nodoc:
+        cname = cname.to_sym
+        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
+			
+			# helper methods.  May need to make them  private.
+			def exemplars
+			  @exemplars ||= Hash.new
+			end
+			
+			def init_blocks
+			 @init_blocks ||= Hash.new { |h,k| h[k] = [] }
+			end
+		  
+		  def load_files
+			  @load_files ||= Hash.new
+			end
+			
+			def reloadable
+			 @reloadable ||= []
+			end
+			
+			def default_file_name(cname)
+			 ( cname.to_s.gsub(/([a-z\d])([A-Z\d])/){ "#{$1}_#{$2}"} << ".rb" ).downcase
+			end
+			
+			def default_directory(module_name)
+			  m = self.name.match( /^.*::([\w\d_]+)$/)
+			  m[1].snake_case
+			end
+		  
+	  end
+  end
+end

data/lib/reloadable.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'metaid'
+
+# Reloadable simply makes it possible for a module's code to be reloaded. *Important*: Only code loaded via Autoload or Autocreate will be reloaded. Also, the module itself is not reloaded, only the modules and classes within it that were loaded via *Autocode*.
+#
+# To use Reloadable, simply extend a given module with Reloadable. This will add two methods to the module: reloadable and reload. These are described below.
+
+module Reloadable
+	
+	def self.extended( mod ) #:nodoc:
+
+		mod.metaclass.class_eval do
+			
+			# 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 ) }
+				@reloadable = []; return self
+			end
+	
+		end
+		
+	end
+	
+end

data/test/autocreate.rb

@@ -0,0 +1,38 @@
+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
+  
+  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
+  end
+  
+end

data/test/autoinit.rb

@@ -0,0 +1,52 @@
+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 overrides 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
+  
+  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,22 @@
+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 true, :exemplar => Class.new, :directories => [File.join(File.dirname(__FILE__), "test_lib")]
+      end
+    end
+  end
+  
+  it "should autoload where files match" do  
+    Thingy::Mabob::DooDad.should.respond_to :gizmo
+  end
+  
+  it "should not autocreate those unmentioned and fileable" do
+    lambda { Thingy::Mabob::MooCow }.should.raise NameError
+  end
+  
+end

data/test/helpers.rb

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

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,69 @@
+--- !ruby/object:Gem::Specification 
+name: automatthew-autocode
+version: !ruby/object:Gem::Version 
+  version: 0.9.3
+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
+- lib/reloadable.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: []
+