dyoder-autocode 0.9.7 → 0.9.8

data/lib/autocode.rb

@@ -1,130 +1,103 @@
-module Autocode
-
-  def self.extended( mod )
-    included(mod)
+module AutoCode
+  
+  # always make sure we have a camel-cased symbol
+  def AutoCode.normalize( cname )  
+    return cname unless cname.is_a? String
+    cname.gsub(/(_)(\w)/) { $2.upcase }.gsub(/^([a-z])/) { $1.upcase }.intern
   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, &block )
-        autocreate( key, Class.new( superclass ), &block )
+  
+  class Loader
+    def initialize(options={}); @directories = options[:directories] ; end
+    def call(cname)
+      filename = Loader.snake_case( cname ) << '.rb'
+      if @directories.nil?
+        Kernel.load( filename )
+      else
+        path = @directories.map { |dir| File.join( dir.to_s, filename ) }.find { |path| File.exist?( path ) }
+        Kernel.load( path ) rescue nil unless path.nil?
       end
+    end
+    def Loader.snake_case(cname)
+      cname.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+    end
+  end
+  
+  class Creator
+    def initialize( options, &block )
+      @exemplar = (options[:exemplar]||Module.new).clone; @block = block
+    end
+    def call ; @exemplar.module_eval( &@block ) if @block ; @exemplar ; end
+  end
+  
+  class Initializer
+    def initialize( &block ) ;@block = block ; end
+    def call( mod ) ; mod.module_eval( &@block ) ; end 
+  end
+      
+  def self.extended( mod ) ; included(mod) ; end
 
-      def autocreate_module( key = true, &block )
-        autocreate( key, Module.new, &block )
+  def self.included( mod )
+    
+    mod.instance_eval do
+
+      # Initialize bookkeeping variables needed by AutoCode
+      @initializers ||= Hash.new { |h,k| h[k] = [] }; @reloadable ||= []
+      
+      # Adds an auto_create block for the given key using the given exemplar if provided
+      def auto_create( key = true, options = {}, &block )
+        @initializers[ AutoCode.normalize( key ) ] << Creator.new( options, &block ); self
       end
 
-      def autoinit( key, &block )
-        if match = key.to_s.match(/^([\w\d_]+)::(.*)$/)
-          const, rest = match[1,2]
-          autoinit(const.to_sym) do
-            autoinit(rest, &block)
-          end
-        else
-          @init_blocks ||= Hash.new { |h,k| h[k] = [] }
-          @init_blocks[key.to_sym] << block
-        end
-
-        return self
+      # Adds an auto_load block for the given key and directories
+      def auto_load( key = true, options = {} )
+        @initializers[ AutoCode.normalize( key ) ].unshift( Loader.new( options ) ); 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
+      # Adds an arbitrary initializer block for the given key
+      def auto_eval( key, &block )
+        @initializers[ AutoCode.normalize( key ) ] << Initializer.new( &block ); self
       end
 
-      def autoload_class(key = true, superclass = Class, options = {})
-        options[:exemplar] = Class.new(superclass)
-        autoload key, options
+      # Convenience method for auto_create.
+      def auto_create_class( key = true, superclass = Object, &block )
+        auto_create( key,{ :exemplar => Class.new( superclass ) }, &block )
       end
 
-      def autoload_module(key = true, options = {})
-        options[:exemplar] = Module.new
-        autoload key, options
+      # Convenience method for auto_create.
+      def auto_create_module( key = true, &block )
+        auto_create( key,{ :exemplar => Module.new }, &block )
       end
 
+      # Reloading stuff ...
+      
       # Returns the list of constants that would be reloaded upon a call to reload.
-      def reloadable( *names )
-        ( @reloadable ||= [] ).concat(names)
-        return self
-      end
+      def reloadable( *names ) ; @reloadable + names ; end
 
-      # Reloads all the constants that were loaded via autocode. Technically, all reload
+      # Reloads all the constants that were loaded via auto_code. 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
+      def reload ; @reloadable.each { |name| remove_const( name ) } ; @reloadable = [] ; 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
+      def unload ; reload ; @initializers = Hash.new { |h,k| h[k] = [] } ; 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
+      old = method( :const_missing )
+      (class << self ; self ; end ).instance_eval do
+        define_method :const_missing do | cname |
+          ( @initializers[cname] + @initializers[true] ).each do |initializer|
+            case initializer 
+            when Loader then initializer.call( cname ) unless const_defined?(cname)
+            when Creator then const_set( cname, initializer.call ) unless const_defined?(cname)
+            else
+              return old.call(cname) unless const_defined?( cname )
+              initializer.call( const_get( cname ) ) if const_defined?( cname )
+            end
+          end
+          return old.call(cname) unless const_defined?( cname )
+          @reloadable << cname ; const_get( cname )
         end
-        
-        load(filename) if filename
-        
-        return object
       end
     end
   end

data/test/auto_code.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = %q{auto_code}
+  s.version = "0.9.8"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Yoder"]
+  s.date = %q{2008-05-11}
+  s.files = ["lib/auto_code.rb", "test/auto_create.rb", "test/auto_eval.rb", "test/auto_load", "test/auto_load.rb", "test/helpers.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://dev.zeraweb.com/}
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.6")
+  s.rubygems_version = %q{1.0.1}
+  s.summary = %q{Utility for auto-including, reloading, and generating classes and modules.}
+
+  s.add_dependency(%q<metaid>, [">= 0"])
+end

data/test/auto_create.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+
+describe "auto_create should" do
+
+  before do
+    A.unload if defined? A and A.respond_to? :unload
+    module A
+      include AutoCode
+      auto_create_module :B do
+        include AutoCode
+        auto_create_class
+      end
+    end
+  end
+  
+  specify "allow you create and initialize a given const name" do
+    A::B.class.should == Module
+  end
+  
+  specify "allow you create and initialize const using a wildcard" do
+    A::B::C.class.should === Class
+  end
+  
+  specify "should raise a NameError if a const doesn't match" do
+    lambda{ A::C }.should.raise NameError
+  end
+  
+end

data/test/auto_eval.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+
+describe "auto_eval should" do
+
+  before do
+    A.unload if defined? A and A.respond_to? :unload
+    module A
+      include AutoCode
+      auto_create_module :B
+    end
+    A.auto_eval :B do
+      include AutoCode
+      auto_create_class
+    end
+    A.auto_eval :B do
+      include AutoCode
+      auto_eval :R do
+        def self.foo; end
+      end
+    end
+  end
+  
+  specify "allow you to run blocks after an object is first created" do
+    A::B::C.class.should == Class
+  end
+  
+  specify "work inside an auto_* block" do
+    A::B::R.class.should == Class
+  end
+
+end

data/test/auto_load.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+require 'extensions/io'
+
+
+describe "auto_load should" do
+
+  before do
+    A.unload if defined? A and A.respond_to? :unload
+    FileUtils.mkdir('tmp')
+    @path = File.join( 'tmp', 'b.rb' )
+    content =<<-EOF
+      module A
+        module B
+        end
+      end
+    EOF
+    File.write( @path, content )
+    module A
+      include AutoCode
+      auto_create_class :B
+      auto_load :B, :directories => ['tmp']
+      auto_create_class :B
+    end
+    
+  end
+  
+  after do
+    FileUtils.rm( File.join( @path ) )
+    FileUtils.rmdir( 'tmp' )
+  end
+  
+  specify "allow you to load a file to define a const" do
+    A::B.class.should == Module
+  end
+  
+  specify "should raise a NameError if a const doesn't match" do
+    lambda{ A::C }.should.raise NameError
+  end
+  
+  specify "always take precedence over auto_create" do
+    A::B.class.should == Module
+  end
+  
+  specify "snake case the constant name which is used to map a constant to a filename" do
+    AutoCode::Loader.snake_case(:Post).should == "post"
+    AutoCode::Loader.snake_case(:GitHub).should == "git_hub"
+    AutoCode::Loader.snake_case(:GITRepository).should == "git_repository"
+    AutoCode::Loader.snake_case(:Git42Repository).should == "git42_repository"
+    AutoCode::Loader.snake_case(:GIT42Repository).should == "git42_repository"
+  end
+
+end

data/test/helpers.rb

@@ -1,8 +1,15 @@
 require 'rubygems'
 %w{ bacon metaid }.each { |dep| require dep }
-Bacon.extend Bacon::TestUnitOutput
+# Bacon.extend Bacon::TestUnitOutput
 Bacon.summary_on_exit
 
-$:.unshift File.join(File.dirname(__FILE__) , "../lib")
-require 'autocode'
+module Kernel
+  private
+  def specification(name, &block)  Bacon::Context.new(name, &block) end
+end
 
+Bacon::Context.instance_eval do
+  alias_method :specify, :it
+end
+
+require '../lib/autocode'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dyoder-autocode
 version: !ruby/object:Gem::Version 
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors: 
 - Dan Yoder
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-09 00:00:00 -07:00
+date: 2008-05-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,19 +31,12 @@ extra_rdoc_files: []
 
 files: 
 - lib/autocode.rb
-- test/autocreate.rb
-- test/autoinit.rb
-- test/autoload.rb
+- test/auto_code.gemspec
+- test/auto_create.rb
+- test/auto_eval.rb
+- test/auto_load.rb
+- test/autocode.gemspec
 - test/helpers.rb
-- test/test_lib
-- test/test_lib/answer42_it_is.rb
-- test/test_lib/critter.rb
-- test/test_lib/doo_dad.rb
-- test/test_lib/humbug.rb
-- test/test_lib/the_class42_gang.rb
-- test/test_lib/the_one_and_only_class.rb
-- test/test_lib/the_one_and_only_module.rb
-- test/test_lib/the_pretender.rb
 has_rdoc: true
 homepage: http://dev.zeraweb.com/
 post_install_message: 

data/test/autocreate.rb

@@ -1,60 +0,0 @@
-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
-  
-  it "should be possible to include autocode" do
-    module Waves
-      include Autocode
-      autocreate(:TestLib, Module.new) do
-        include Autocode
-        autocreate_class
-        autoload_class
-      end
-    end
-    Waves::TestLib::TheOneAndOnlyClass.help().should == "class help"
-    Waves::TestLib::AnyThing.name.should == "Waves::TestLib::AnyThing"
-    lambda { Waves::TestLib::TheOneAndOnlyModule }.should.raise TypeError
-    Waves::TestLib::ThePretender.name.should == "Waves::TestLib::ThePretender"
-    lambda { Waves::TestLib::ThePretender.help() }.should.raise NoMethodError
-    Waves.unload
-  end
-  
-end

data/test/autoinit.rb

@@ -1,58 +0,0 @@
-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 "should work with namespaced constants" 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

@@ -1,86 +0,0 @@
-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/test_lib/answer42_it_is.rb

@@ -1,9 +0,0 @@
-module Thingy
-  module Mabob
-    class Answer42ItIs
-      def self.really?
-        true
-      end
-    end
-  end
-end

data/test/test_lib/critter.rb

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

data/test/test_lib/doo_dad.rb

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

data/test/test_lib/humbug.rb

@@ -1,9 +0,0 @@
-module Thingy
-  module Mabob
-    module Humbug
-      def self.full_of_it?
-        true
-      end
-    end
-  end
-end

data/test/test_lib/the_class42_gang.rb

@@ -1,9 +0,0 @@
-module Waves
-  module TestLib
-    class TheClass42Gang < Thingy::Mabob::DooDad
-      def self.party?
-        true
-      end
-    end
-  end
-end

data/test/test_lib/the_one_and_only_class.rb

@@ -1,9 +0,0 @@
-module Waves
-  module TestLib
-    class TheOneAndOnlyClass
-      def self.help()
-        "class help"
-      end
-    end
-  end
-end

data/test/test_lib/the_one_and_only_module.rb

@@ -1,9 +0,0 @@
-module Waves
-  module TestLib
-    module TheOneAndOnlyModule
-      def self.help()
-        "module help"
-      end
-    end
-  end
-end

data/test/test_lib/the_pretender.rb

@@ -1,9 +0,0 @@
-module Haha
-  module TestLib
-    module ThePretender
-      def self.help()
-        "I am not in your waves space"
-      end
-    end
-  end
-end