module_creation_helper 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,5 +1,9 @@
 *SVN*
 
+*0.0.4* (May 5th, 2008)
+
+* Updated documentation
+
 *0.0.3* (September 18th, 2007)
 
 * Convert dos newlines to unix newlines

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2007 Aaron Pfeifer & Neil Abraham
+Copyright (c) 2006-2008 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -5,25 +5,21 @@ at runtime.
 
 == Resources
 
-API
-
-* http://api.pluginaweek.org/module_creation_helper
-
 Wiki
 
 * http://wiki.pluginaweek.org/Module_creation_helper
 
-Announcement
+API
 
-* http://www.pluginaweek.org/2007/01/04/10-from-anonymous-to-named-and-back-again-a-tale-of-modules-and-classes
+* http://api.pluginaweek.org/module_creation_helper
 
-Source
+Development
 
-* http://svn.pluginaweek.org/trunk/plugins/ruby/module/module_creation_helper
+* http://dev.pluginaweek.org/browser/trunk/module_creation_helper
 
-Development
+Source
 
-* http://dev.pluginaweek.org/browser/trunk/plugins/ruby/module/module_creation_helper
+* http://svn.pluginaweek.org/trunk/module_creation_helper
 
 == Description
 
@@ -104,4 +100,4 @@ block that defines the body of the class.  For example,
 
 == Dependencies
 
-This plugin does not depend on the presence of any other plugins.
+None.

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'module_creation_helper'
-PKG_VERSION        = '0.0.3'
+PKG_VERSION        = '0.0.4'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 
@@ -39,8 +39,8 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc        = true
   s.test_files      = Dir['test/**/*_test.rb']
   
-  s.author          = 'Aaron Pfeifer, Neil Abraham'
-  s.email           = 'info@pluginaweek.org'
+  s.author          = 'Aaron Pfeifer'
+  s.email           = 'aaron@pluginaweek.org'
   s.homepage        = 'http://www.pluginaweek.org'
 end
   
@@ -52,12 +52,12 @@ end
 
 desc 'Publish the beta gem'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('pluginaweek@pluginaweek.org', '/home/pluginaweek/gems.pluginaweek.org/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
 end
 
 desc 'Publish the API documentation'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'

data/lib/module_creation_helper.rb

@@ -1,64 +1,60 @@
 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
+  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
 
-::Module.class_eval do
-  extend PluginAWeek::CoreExtensions::Module::ModuleCreationHelper
+Module.class_eval do
+  extend PluginAWeek::ModuleCreationHelper
 end

data/test/module_creation_helper_test.rb

@@ -1,9 +1,9 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-module TestParent
+module Ford
 end
 
-class TestSuperclass
+class Vehicle
   cattr_accessor :test_name
   cattr_accessor :test_inspect
   cattr_accessor :test_to_s
@@ -16,117 +16,181 @@ class TestSuperclass
 end
 
 class ModuleCreationHelperTest < Test::Unit::TestCase
+  def test_should_raise_exception_if_invalid_option_specified
+    assert_raise(ArgumentError) {Class.create(nil, :invalid => true)}
+  end
+end
+
+class ModuleCreationHelperForClassTest < Test::Unit::TestCase
   def setup
-    TestSuperclass.test_name = nil
-    TestSuperclass.test_inspect = nil
-    TestSuperclass.test_to_s = nil
+    @car = Class.create('Car')
   end
   
-  def test_no_options_for_class
-    klass = Class.create('Foo')
-    assert_equal Object, klass.superclass
-    assert_equal Object, klass.parent
-    assert Object.const_defined?('Foo')
+  def test_should_have_object_as_superclass
+    assert_equal Object, @car.superclass
   end
   
-  def test_no_options_for_module
-    mod = Module.create('FooMod')
-    assert_equal Object, mod.parent
-    assert Object.const_defined?('FooMod')
+  def test_should_have_object_as_parent
+    assert_equal Object, @car.parent
+    assert Object.const_defined?('Car')
   end
   
-  def test_invalid_option
-    assert_raise(ArgumentError) {Class.create(nil, :invalid => true)}
+  def teardown
+    Object.send(:remove_const, 'Car')
+  end
+end
+
+class ModuleCreationHelperForClassWithSuperclassTest < Test::Unit::TestCase
+  def setup
+    @car = Class.create('Car', :superclass => Vehicle)
   end
   
-  def test_superclass_for_module
-    assert_raise(ArgumentError) {Module.create(nil, :superclass => Object)}
+  def test_should_inherit_from_superclass
+    assert_equal Vehicle, @car.superclass
+  end
+  
+  def test_should_have_object_as_parent
+    assert_equal Object, @car.parent
+    assert Object.const_defined?('Car')
+  end
+  
+  def test_should_evaluate_name_as_name
+    assert_equal 'Car', Vehicle.test_name
   end
   
-  def test_superclass
-    klass = Class.create('Bar', :superclass => TestSuperclass)
-    assert_equal TestSuperclass, klass.superclass
-    assert_equal Object, klass.parent
-    assert Object.const_defined?('Bar')
+  def test_should_evaluate_inspect_as_name
+    assert_equal 'Car', Vehicle.test_inspect
   end
   
-  def test_parent_for_class
-    klass = Class.create('Baz', :parent => TestParent)
-    assert_equal Object, klass.superclass
-    assert_equal TestParent, klass.parent
-    assert TestParent.const_defined?('Baz')
+  def test_should_evaluate_to_s_as_name
+    assert_equal 'Car', Vehicle.test_to_s
   end
   
-  def test_parent_for_module
-    mod = Module.create('BazMod', :parent => TestParent)
-    assert_equal TestParent, mod.parent
-    assert TestParent.const_defined?('BazMod')
+  def teardown
+    Object.send(:remove_const, 'Car')
+  end
+end
+
+class ModuleCreationHelperForClassWithParentTest < Test::Unit::TestCase
+  def setup
+    @car = Class.create('Car', :parent => Ford)
   end
   
-  def test_superclass_and_parent
-    klass = Class.create('Biz', :superclass => TestSuperclass, :parent => TestParent)
-    assert_equal TestSuperclass, klass.superclass
-    assert_equal TestParent, klass.parent
-    assert TestParent.const_defined?('Biz')
+  def test_should_have_object_as_superclass
+    assert_equal Object, @car.superclass
   end
   
-  def test_name_before_evaluated
-    klass = Class.create('Waddle', :superclass => TestSuperclass)
-    assert_equal 'Waddle', TestSuperclass.test_name
+  def test_should_be_nested_within_parent
+    assert_equal Ford, @car.parent
+    assert Ford.const_defined?('Car')
+  end
+  
+  def teardown
+    Ford.send(:remove_const, 'Car')
+  end
+end
+
+class ModuleCreationHelperForClassWithSuperclassAndParentTest < Test::Unit::TestCase
+  def setup
+    Vehicle.test_name = nil
+    Vehicle.test_inspect = nil
+    Vehicle.test_to_s = nil
+    
+    @car = Class.create('Car', :superclass => Vehicle, :parent => Ford)
   end
   
-  def test_inspect_before_evaluated
-    klass = Class.create('Widdle', :superclass => TestSuperclass)
-    assert_equal 'Widdle', TestSuperclass.test_inspect
+  def test_should_inherit_from_superclass
+    assert_equal Vehicle, @car.superclass
   end
   
-  def test_to_s_before_evaluated
-    klass = Class.create('Wuddle', :superclass => TestSuperclass)
-    assert_equal 'Wuddle', TestSuperclass.test_to_s
+  def test_should_be_nested_within_parent
+    assert_equal Ford, @car.parent
+    assert Ford.const_defined?('Car')
   end
   
-  def test_name_before_evaluated_with_parent
-    klass = Class.create('Waddle', :superclass => TestSuperclass, :parent => TestParent)
-    assert_equal 'TestParent::Waddle', TestSuperclass.test_name
+  def test_should_evaluate_name_as_name
+    assert_equal 'Ford::Car', Vehicle.test_name
   end
   
-  def test_inspect_before_evaluated_with_parent
-    klass = Class.create('Widdle', :superclass => TestSuperclass, :parent => TestParent)
-    assert_equal 'TestParent::Widdle', TestSuperclass.test_inspect
+  def test_should_evaluate_inspect_as_name
+    assert_equal 'Ford::Car', Vehicle.test_inspect
   end
   
-  def test_to_s_before_evaluated_with_parent
-    klass = klass = Class.create('Wuddle', :superclass => TestSuperclass, :parent => TestParent)
-    assert_equal 'TestParent::Wuddle', TestSuperclass.test_to_s
+  def test_should_evaluate_to_s_as_name
+    assert_equal 'Ford::Car', Vehicle.test_to_s
   end
   
-  def test_subclass_of_dynamic_class
-    klass = Class.create('Foobar')
-    subclass = Class.create('Foobaz', :superclass => klass)
-    
-    assert_equal klass, subclass.superclass
-    assert_equal 'Foobaz', subclass.name
-    assert_equal 'Foobaz', subclass.inspect
-    assert_equal 'Foobaz', subclass.to_s
+  def teardown
+    Ford.send(:remove_const, 'Car')
+  end
+end
+
+class ModuleCreationHelperForClassWithDynamicSuperclassTest < Test::Unit::TestCase
+  def setup
+    @car = Class.create('Car')
+    @convertible = Class.create('Convertible', :superclass => @car)
+  end
+  
+  def test_should_inherit_from_superclass
+    assert_equal @car, @convertible.superclass
   end
   
-  def test_with_block
-    klass = Class.create('ClassWithBlock', :superclass => TestSuperclass) do
-      def self.say_hello
-        'hello'
+  def teardown
+    Object.send(:remove_const, 'Convertible')
+    Object.send(:remove_const, 'Car')
+  end
+end
+
+class ModuleCreationHelperForClassWithCustomMethods < Test::Unit::TestCase
+  def setup
+    @car = Class.create('Car', :superclass => Vehicle) do
+      def self.color
+        'red'
       end
     end
-    assert_equal 'hello', ClassWithBlock.say_hello
   end
   
-  def test_nested_class_with_superclass_with_same_name
-    klass = Class.create('Employee')
-    nested_class = Class.create('Employee', :superclass => klass, :parent => TestParent)
-    assert_equal klass, nested_class.superclass
+  def test_should_evaluate_methods
+    assert_equal 'red', Car.color
+  end
+  
+  def teardown
+    Object.send(:remove_const, 'Car')
+  end
+end
+
+class ModuleCreationHelperForModuleTest < Test::Unit::TestCase
+  def setup
+    @autopilot = Module.create('Autopilot')
+  end
+  
+  def test_should_have_object_as_parent
+    assert_equal Object, @autopilot.parent
+    assert Object.const_defined?('Autopilot')
+  end
+  
+  def teardown
+    Object.send(:remove_const, 'Autopilot')
+  end
+end
+
+class ModuleCreationHelperForModuleWithSuperclassTest < Test::Unit::TestCase
+  def test_should_raise_an_exception
+    assert_raise(ArgumentError) {Module.create(nil, :superclass => Object)}
+  end
+end
+
+class ModuleCreationHelperForModuleWithParentTest < Test::Unit::TestCase
+  def setup
+    @autopilot = Module.create('Autopilot', :parent => Ford)
+  end
+  
+  def test_should_be_nested_within_parent
+    assert_equal Ford, @autopilot.parent
+    assert Ford.const_defined?('Autopilot')
   end
   
-  private
-  def klass_with_id(klass)
-    "#<Class:0x#{(klass.object_id * 2).to_s(16)}>"
+  def teardown
+    Ford.send(:remove_const, 'Autopilot')
   end
 end

metadata

@@ -1,33 +1,26 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: module_creation_helper
 version: !ruby/object:Gem::Version 
-  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
-email: info@pluginaweek.org
-homepage: http://www.pluginaweek.org
-rubyforge_project: 
-description: 
-autorequire: module_creation_helper
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.0.4
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
-- Aaron Pfeifer, Neil Abraham
+- Aaron Pfeifer
+autorequire: module_creation_helper
+bindir: bin
+cert_chain: []
+
+date: 2008-05-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - lib/module_creation_helper.rb
 - test/test_helper.rb
@@ -37,17 +30,31 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README
-test_files: 
-- test/module_creation_helper_test.rb
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: Adds a helper method for creating new modules and classes at runtime.
+test_files: 
+- test/module_creation_helper_test.rb