module_creation_helper 0.0.2 → 0.0.3

data/CHANGELOG

@@ -0,0 +1,13 @@
+*SVN*
+
+*0.0.3* (September 18th, 2007)
+
+* Convert dos newlines to unix newlines
+
+*0.0.2* (February 2nd, 2007)
+
+* Released as a gem
+
+*0.0.1* (January 4th, 2007)
+
+* Initial release

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2006 Aaron Pfeifer & Neil Abraham
+Copyright (c) 2006-2007 Aaron Pfeifer & Neil Abraham
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -1,17 +1,21 @@
 = module_creation_helper
 
-module_creation_helper adds a helper method for creating new modules and classes
++module_creation_helper+ adds a helper method for creating new modules and classes
 at runtime.
 
 == Resources
 
+API
+
+* http://api.pluginaweek.org/module_creation_helper
+
 Wiki
 
 * http://wiki.pluginaweek.org/Module_creation_helper
 
 Announcement
 
-* http://www.pluginaweek.org/2007/01/04/10-from-anonymous-to-named-and-back-again-a-tale-of-modules-and-classes/
+* http://www.pluginaweek.org/2007/01/04/10-from-anonymous-to-named-and-back-again-a-tale-of-modules-and-classes
 
 Source
 
@@ -24,11 +28,10 @@ Development
 == Description
 
 Creating modules and classes at runtime isn't the easiest and most intuitive
-process that Ruby could have provided.  Although often used for anonymous
-classes, there are many times where you will want to associate a runtime class
-with an actual name.
+process.  Although often used for anonymous classes, there are many times where
+you will want to associate a runtime class with an actual name.
 
-Normally, you would create new classes and associate them with a name like so:
+Traditionally, you would create new classes like so:
 
   >> c = Class.new
   => #<Class:0x480e388>
@@ -36,10 +39,9 @@ Normally, you would create new classes and associate them with a name like so:
   => Foo
 
 Although this isn't very hard, there are two problems:
-(1) It's a repetitive process that should be DRYed in the same way that chaining
-methods has been dried.
-(2) Callbacks that are invoked while the class is being created do not have
-access to the name of the class.
+(1) It's a repetitive process that should be DRYed.
+(2) Callbacks that are invoked while the class is being created do not know the
+name of the class.
 
 To understand the second problem, consider the following:
 
@@ -59,14 +61,13 @@ example,
 As you can see from output in this example, since the class has not yet been
 assigned to a constant, it is anonymous and does not yet have a name.
 
-To address these two issues, the functionality is encapsulated into a new method,
-Module#create.  Since the method is defined in Module, it is also available to
+To address these issues, the functionality is encapsulated into a new method,
+<tt>Module#create</tt>.  Since the method is defined in Module, it is also available to
 Class since Class inherits from Module.
 
-Rather than defining new modules/classes using Module#new/Class#new, this plugin
-uses class_eval on the object's parent.  This allows names to be immediately
-associated with the class/module regardless of whether it is currently being
-evaluated or has already been evaluated.
+== Usage
+
+=== Creating new classes/modules
 
 Using the same example as before,
 
@@ -75,16 +76,21 @@ Using the same example as before,
   => Bar
 
 As you can see, the name of the class is now available during the +inherited+
-callback and is automatically assigned to the 'Bar' constant in Object.  In
-addition to specifying the superclass, you can also specify the parent
+callback and is automatically assigned to the 'Bar' constant in Object.
+
+=== Specifying the parent class/module
+
+In addition to specifying the superclass, you can also specify the parent
 module/class like so:
 
   >> c = Class.create('Bar', :superclass => Foo, :parent => MyModule)
   inherited class: MyModule::Bar, name: MyModule::Bar
   => MyModule::Bar
 
-Finally, as you normally could when creating a new class, you can provide an
-additional block that defines the body of the class.  For example,
+=== Defining class/module methods
+
+As you normally could when creating a new class, you can provide an additional
+block that defines the body of the class.  For example,
 
   >> c = Class.create('Bar', :superclass => Foo, :parent => MyModule) do
   ?>   def say_hello
@@ -94,4 +100,8 @@ additional block that defines the body of the class.  For example,
   inherited class: MyModule::Bar, name: MyModule::Bar
   => Bar
   >> Bar.new.say_hello
-  => "hello"
+  => "hello"
+
+== Dependencies
+
+This plugin does not depend on the presence of any other plugins.

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'module_creation_helper'
-PKG_VERSION        = '0.0.2'
+PKG_VERSION        = '0.0.3'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 
@@ -33,13 +33,13 @@ spec = Gem::Specification.new do |s|
   s.platform        = Gem::Platform::RUBY
   s.summary         = 'Adds a helper method for creating new modules and classes at runtime.'
   
-  s.files           = FileList['{lib,tasks,test}/**/*'].to_a + %w(init.rb MIT-LICENSE Rakefile README)
+  s.files           = FileList['{lib,test}/**/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
   s.require_path    = 'lib'
   s.autorequire     = 'module_creation_helper'
   s.has_rdoc        = true
   s.test_files      = Dir['test/**/*_test.rb']
   
-  s.author          = 'Aaron Pfeifer and Neil Abraham'
+  s.author          = 'Aaron Pfeifer, Neil Abraham'
   s.email           = 'info@pluginaweek.org'
   s.homepage        = 'http://www.pluginaweek.org'
 end
@@ -76,4 +76,4 @@ task :release => [:gem, :package] do
     
     ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
   end
-end
+end

data/lib/module_creation_helper.rb

@@ -1,64 +1,64 @@
-module PluginAWeek #:nodoc:
-  module CoreExtensions #:nodoc:
-    module Module #:nodoc:
-      module ModuleCreationHelper
-        # Creates a new module with the specified name.  This is essentially the
-        # same as actually defining the module like so:
-        # 
-        #   module NewModule
-        #   end
-        # 
-        # or as a class:
-        # 
-        #   class NewClass < SuperKlass
-        #   end
-        # 
-        # Configuration options:
-        # <tt>superclass</tt> - The class to inherit from.  This only applies when using Class#create.  Default is Object.
-        # <tt>parent</tt> - The class/module that contains this module.  Default is Object.
-        # 
-        # Examples:
-        # 
-        #   Module.create('Foo')                                                      # => Foo
-        #   Module.create('Bar', :parent => Foo)                                      # => Foo::Bar
-        #   Class.create('Waddle')                                                    # => Waddle
-        #   Class.create('Widdle', :parent => Waddle)                                 # => Waddle::Widdle
-        #   Class.create('Woddle', :superclass => Waddle::Widdle, :parent => Waddle)  # => Waddle::Woddle
-        #   Waddle::Woddle.superclass                                                 # => Waddle::Widdle
-        def create(name, options = {}, &block)
-          options.assert_valid_keys(
-            :superclass,
-            :parent
-          )
-          raise ArgumentError, 'Modules cannot have superclasses' if options[:superclass] && self.to_s == 'Module'
-          
-          options.reverse_merge!(
-            :superclass => ::Object,
-            :parent => ::Object
-          )
-          parent = options[:parent]
-          superclass = options[:superclass]
-          
-          if superclass != ::Object
-            superclass = " < ::#{superclass}"
-          else
-            superclass = ''
-          end
-          
-          parent.class_eval <<-end_eval
-            #{self.to_s.downcase} #{name}#{superclass}
-            end
-          end_eval
-          
-          mod = parent.const_get(name)
-          mod.class_eval(&block) if block_given?
-          mod
-        end
-      end
-    end
-  end
-end
-
-class ::Module #:nodoc:
-  extend PluginAWeek::CoreExtensions::Module::ModuleCreationHelper
-end
+module PluginAWeek #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Module #:nodoc:
+      module ModuleCreationHelper
+        # Creates a new module with the specified name.  This is essentially the
+        # same as actually defining the module like so:
+        # 
+        #   module NewModule
+        #   end
+        # 
+        # or as a class:
+        # 
+        #   class NewClass < SuperKlass
+        #   end
+        # 
+        # Configuration options:
+        # <tt>superclass</tt> - The class to inherit from.  This only applies when using Class#create.  Default is Object.
+        # <tt>parent</tt> - The class/module that contains this module.  Default is Object.
+        # 
+        # Examples:
+        # 
+        #   Module.create('Foo')                                                      # => Foo
+        #   Module.create('Bar', :parent => Foo)                                      # => Foo::Bar
+        #   Class.create('Waddle')                                                    # => Waddle
+        #   Class.create('Widdle', :parent => Waddle)                                 # => Waddle::Widdle
+        #   Class.create('Woddle', :superclass => Waddle::Widdle, :parent => Waddle)  # => Waddle::Woddle
+        #   Waddle::Woddle.superclass                                                 # => Waddle::Widdle
+        def create(name, options = {}, &block)
+          options.assert_valid_keys(
+            :superclass,
+            :parent
+          )
+          raise ArgumentError, 'Modules cannot have superclasses' if options[:superclass] && self.to_s == 'Module'
+          
+          options.reverse_merge!(
+            :superclass => ::Object,
+            :parent => ::Object
+          )
+          parent = options[:parent]
+          superclass = options[:superclass]
+          
+          if superclass != ::Object
+            superclass = " < ::#{superclass}"
+          else
+            superclass = ''
+          end
+          
+          parent.class_eval <<-end_eval
+            #{self.to_s.downcase} #{name}#{superclass}
+            end
+          end_eval
+          
+          mod = parent.const_get(name)
+          mod.class_eval(&block) if block_given?
+          mod
+        end
+      end
+    end
+  end
+end
+
+::Module.class_eval do
+  extend PluginAWeek::CoreExtensions::Module::ModuleCreationHelper
+end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
-require 'test/unit'
-require 'rubygems'
-require 'active_support'
-
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 require File.dirname(__FILE__) + '/../init'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: module_creation_helper
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-02-02 00:00:00 -05:00
+  version: 0.0.3
+date: 2007-09-18 00:00:00 -04:00
 summary: Adds a helper method for creating new modules and classes at runtime.
 require_paths: 
 - lib
@@ -27,11 +27,12 @@ signing_key:
 cert_chain: 
 post_install_message: 
 authors: 
-- Aaron Pfeifer and Neil Abraham
+- Aaron Pfeifer, Neil Abraham
 files: 
 - lib/module_creation_helper.rb
 - test/test_helper.rb
 - test/module_creation_helper_test.rb
+- CHANGELOG
 - init.rb
 - MIT-LICENSE
 - Rakefile