autocode 0.9.3 → 0.9.9

data/lib/autocode.rb

@@ -1,3 +1,92 @@
-require 'autocreate'
-require 'autoload'
-require 'reloadable'
+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 AutoCode.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
+        
+  def self.extended( mod ) ; included( mod ) ; end
+
+  def self.included( mod )
+    
+    mod.instance_eval do
+
+      # First make sure we haven't already done this once
+      return unless @autocode.nil?
+      
+      # Initialize bookkeeping variables needed by AutoCode
+      @autocode = { 
+        :constructors => Hash.new { |h,k| h[k] = [] },
+        :initializers => Hash.new { |h,k| h[k] = [] },
+        :loaded => []
+      }
+      
+      # Adds an auto_create block for the given key using the given exemplar if provided
+      def auto_create( key = true, options = {}, &block )
+        @autocode[:constructors][ AutoCode.normalize( key ) ] << lambda do | cname |
+          exemplar = ( options[:exemplar] || Module.new ).clone
+          exemplar.module_eval( &block ) if block
+          const_set( cname, exemplar )
+        end
+      end
+
+      # Adds an auto_load block for the given key and directories
+      def auto_load( key = true, options = {} )
+        @autocode[:constructors][ AutoCode.normalize( key ) ] << lambda do | cname |
+          filename = AutoCode.snake_case( cname ) << '.rb'
+          if options[:directories].nil?
+            Kernel.load( filename ) if File.exist?( filename )
+          else
+            path = options[:directories].
+              map { |dir| File.join( dir.to_s, filename ) }.
+              find { |path| File.exist?( path ) }
+            Kernel.load( path ) unless path.nil?
+          end
+        end
+      end
+
+      # Adds an arbitrary initializer block for the given key
+      def auto_eval( key, &block )
+        @autocode[:initializers][ AutoCode.normalize( key ) ] << lambda do | mod |
+          mod.module_eval( &block )
+        end
+      end
+
+      # Convenience method for auto_create.
+      def auto_create_class( key = true, superclass = Object, &block )
+        auto_create( key,{ :exemplar => Class.new( superclass ) }, &block )
+      end
+
+      # Convenience method for auto_create.
+      def auto_create_module( key = true, &block )
+        auto_create( key,{ :exemplar => Module.new }, &block )
+      end
+
+      # Returns the list of constants that would be reloaded upon a call to reload.
+      def reloadable ; @autocode[:loaded] ; end
+
+      # Reloads (via #remove_const) all the constants that were loaded via auto_code.
+      def reload ; @autocode[:loaded].each { |name| remove_const( name ) } ; @autocode[:loaded] = [] ; end
+
+      private
+
+      old = method( :const_missing )
+      (class << self ; self ; end ).instance_eval do
+        define_method( :const_missing ) do | cname |
+          constructors = @autocode[:constructors][true] + @autocode[:constructors][cname]
+          constructors.pop.call( cname ) until ( const_defined?( cname ) or constructors.empty? )
+          return old.call( cname ) unless const_defined?( cname )
+          initializers = @autocode[:initializers][true] + @autocode[:initializers][cname]
+          mod = const_get( cname ) ; initializers.pop.call( mod ) until initializers.empty?
+          @autocode[:loaded] << cname ; const_get( cname )
+        end
+      end
+    end
+  end
+end
+Autocode = AutoCode

data/test/auto_create.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+
+describe "auto_create should" do
+
+  before do
+    Object.instance_eval { remove_const(:A) if const_defined?(:A) }
+    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
+    Object.instance_eval { remove_const(:A) if const_defined?(:A) }
+    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 :C do
+        self::D = true
+      end
+    end
+  end
+  
+  specify "allow you to run blocks after an object is first created" do
+    A::B::C.class.should == Class
+  end
+  
+  specify "allow you to define nested auto_eval declarations" do
+    A::B::C::D.should == true
+  end
+
+end

data/test/auto_load.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(__FILE__), 'helpers.rb')
+require 'extensions/io'
+
+
+describe "auto_load should" do
+
+  before do
+    Object.instance_eval { remove_const(:A) if const_defined?(:A) }
+    FileUtils.mkdir('tmp') rescue nil
+    @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']
+    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 implement LIFO semantics" 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 "snake case the constant name which is used to map a constant to a filename" do
+    AutoCode.snake_case(:Post).should == "post"
+    AutoCode.snake_case(:GitHub).should == "git_hub"
+    AutoCode.snake_case(:GITRepository).should == "git_repository"
+    AutoCode.snake_case(:Git42Repository).should == "git42_repository"
+    AutoCode.snake_case(:GIT42Repository).should == "git42_repository"
+  end
+
+end

data/test/helpers.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+%w{ bacon metaid }.each { |dep| require dep }
+# Bacon.extend Bacon::TestUnitOutput
+Bacon.summary_on_exit
+
+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,85 +1,65 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: autocode
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
-date: 2008-01-26 00:00:00 -08:00
-summary: Utility for auto-including, reloading, and generating classes and modules.
-require_paths: 
-- lib
-email: 
-homepage: http://dev.zeraweb.com/
-rubyforge_project: 
-description: 
+  version: 0.9.9
+platform: ruby
+authors: 
+- Dan Yoder
 autorequire: 
-default_executable: 
 bindir: bin
+cert_chain: []
+
+date: 2008-05-18 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: dan@zeraweb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/autocode.rb
+- test/auto_create.rb
+- test/auto_eval.rb
+- test/auto_load.rb
+- test/helpers.rb
 has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
+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: 
-platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
-authors: []
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
 
-files: 
-- doc/rdoc
-- doc/rdoc/classes
-- doc/rdoc/classes/Autocreate.html
-- doc/rdoc/classes/Autocreate.src
-- doc/rdoc/classes/Autocreate.src/M000004.html
-- doc/rdoc/classes/Autoload.html
-- doc/rdoc/classes/Autoload.src
-- doc/rdoc/classes/Autoload.src/M000001.html
-- doc/rdoc/classes/Autoload.src/M000002.html
-- doc/rdoc/classes/Autoload.src/M000003.html
-- doc/rdoc/classes/Reloadable.html
-- doc/rdoc/classes/Reloadable.src
-- doc/rdoc/classes/Reloadable.src/M000005.html
-- doc/rdoc/classes/Reloadable.src/M000006.html
-- doc/rdoc/created.rid
-- doc/rdoc/files
-- doc/rdoc/files/HISTORY.html
-- doc/rdoc/files/lib
-- doc/rdoc/files/lib/autocode_rb.html
-- doc/rdoc/files/lib/autocreate_rb.html
-- doc/rdoc/files/lib/autoload_rb.html
-- doc/rdoc/files/lib/reloadable_rb.html
-- doc/rdoc/files/README.html
-- doc/rdoc/fr_class_index.html
-- doc/rdoc/fr_file_index.html
-- doc/rdoc/fr_method_index.html
-- doc/rdoc/index.html
-- doc/rdoc/rdoc-style.css
-- lib/autocode.rb
-- lib/autocreate.rb
-- lib/autoload.rb
-- lib/reloadable.rb
+rubyforge_project: autocode
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Utility for auto-including, reloading, and generating classes and modules.
 test_files: []
 
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
-
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: metaid
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 

data/doc/rdoc/classes/Autocreate.html

@@ -1,158 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: Autocreate</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Autocreate</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/autocreate_rb.html">
-                lib/autocreate.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-Extending a module with <a href="Autocreate.html">Autocreate</a> allows you
-to specify <a href="Autocreate.html#M000004">autocreate</a> rules for that
-module.
-</p>
-<p>
-<a href="Autocreate.html">Autocreate</a> allows you to automatically
-created classes or modules based on a given exemplar at the time they are
-referenced.
-</p>
-<p>
-To use <a href="Autocreate.html">Autocreate</a>, mix it via <tt>extend</tt>
-into the class or module within which you want to <a
-href="Autocreate.html#M000004">autocreate</a> referenced constants.
-</p>
-<p>
-See the README for an example of how to use <a
-href="Autocreate.html">Autocreate</a>.
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000004">autocreate</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
-
-        <div class="method-heading">
-          <a href="Autocreate.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('Autocreate.src/M000004.html');return false;">
-          <span class="method-name">autocreate</span><span class="method-args">( key, exemplar, &amp;block )</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Specifies that the constant specified by key should be autocreated using
-the exemplar. If a block is given, the block is further used to initialize
-the block once it has been cloned.
-</p>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>