module_creation_helper 0.0.4 → 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,22 @@
+== master
+
+== 0.1.0 / 2008-07-06
+
+* Add support for specifying the parent class/module in the name of the class/module being created
+* Don't depend on active_support
+
+== 0.0.4 / 2008-05-05
+
+* Updated documentation
+
+== 0.0.3 / 2007-09-18
+
+* Convert dos newlines to unix newlines
+
+== 0.0.2 / 2007-02-02
+
+* Released as a gem
+
+== 0.0.1 / 2007-01-04
+
+* Initial release

data/{README → README.rdoc}

@@ -5,21 +5,21 @@ at runtime.
 
 == Resources
 
-Wiki
-
-* http://wiki.pluginaweek.org/Module_creation_helper
-
 API
 
 * http://api.pluginaweek.org/module_creation_helper
 
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13281-module_creation_helper
+
 Development
 
-* http://dev.pluginaweek.org/browser/trunk/module_creation_helper
+* http://github.com/pluginaweek/module_creation_helper
 
 Source
 
-* http://svn.pluginaweek.org/trunk/module_creation_helper
+* git://github.com/pluginaweek/module_creation_helper.git
 
 == Description
 
@@ -29,10 +29,8 @@ you will want to associate a runtime class with an actual name.
 
 Traditionally, you would create new classes like so:
 
-  >> c = Class.new
-  => #<Class:0x480e388>
-  >> Object.const_set('Foo', c)
-  => Foo
+  c = Class.new               # => #<Class:0x480e388>
+  Object.const_set('Foo', c)  # => Foo
 
 Although this isn't very hard, there are two problems:
 (1) It's a repetitive process that should be DRYed.
@@ -50,9 +48,9 @@ To understand the second problem, consider the following:
 When a class inherits from Foo, Ruby will invoke the +inherited+ callback.  For
 example,
 
-  >> c = Class.new(Foo)
-  inherited class: #<Class:0x47fb92c>, name:
-  => #<Class:0x47fb92c>
+  c = Class.new(Foo)
+  # inherited class: #<Class:0x47fb92c>, name:
+  # => #<Class:0x47fb92c>
 
 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.
@@ -67,9 +65,9 @@ Class since Class inherits from Module.
 
 Using the same example as before,
 
-  >> c = Class.create('Bar', :superclass => Foo)
-  inherited class: Bar, name: Bar
-  => Bar
+  c = Class.create('Bar', :superclass => Foo)
+  # inherited class: Bar, name: Bar
+  # => 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.
@@ -79,24 +77,24 @@ callback and is automatically assigned to the 'Bar' constant in Object.
 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
+  c = Class.create('Bar', :superclass => Foo, :parent => MyModule)
+  # inherited class: MyModule::Bar, name: MyModule::Bar
+  # => MyModule::Bar
 
 === 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
-  ?>     'hello'
-  ?>   end
-  ?> end
-  inherited class: MyModule::Bar, name: MyModule::Bar
-  => Bar
-  >> Bar.new.say_hello
-  => "hello"
+  c = Class.create('Bar', :superclass => Foo, :parent => MyModule) do
+    def say_hello
+      'hello'
+    end
+  end
+  # inherited class: MyModule::Bar, name: MyModule::Bar
+  # => Bar
+  Bar.new.say_hello
+  # => "hello"
 
 == Dependencies
 

data/Rakefile

@@ -3,45 +3,54 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
-PKG_NAME           = 'module_creation_helper'
-PKG_VERSION        = '0.0.4'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'pluginaweek'
-
-desc 'Default: run unit tests.'
+spec = Gem::Specification.new do |s|
+  s.name              = 'module_creation_helper'
+  s.version           = '0.1.0'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Adds a helper method for creating new modules and classes at runtime.'
+  
+  s.files             = FileList['{lib,test}/**/*'].to_a + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc)
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
 task :default => :test
 
-desc 'Test the module_creation_helper plugin.'
+desc "Test the #{spec.name} plugin."
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = spec.test_files
   t.verbose = true
 end
 
-desc 'Generate documentation for the module_creation_helper plugin.'
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ModuleCreationHelper'
+  rdoc.title    = spec.name
+  rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = PKG_NAME
-  s.version         = PKG_VERSION
-  s.platform        = Gem::Platform::RUBY
-  s.summary         = 'Adds a helper method for creating new modules and classes at runtime.'
-  
-  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'
-  s.email           = 'aaron@pluginaweek.org'
-  s.homepage        = 'http://www.pluginaweek.org'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
 end
   
 Rake::GemPackageTask.new(spec) do |p|
@@ -50,30 +59,30 @@ Rake::GemPackageTask.new(spec) do |p|
   p.need_zip = true
 end
 
-desc 'Publish the beta gem'
+desc 'Publish the beta gem.'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
 end
 
-desc 'Publish the API documentation'
+desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
-task :publish => [:pdoc, :release]
+task :publish => [:pgem, :pdoc, :release]
 
 desc 'Publish the release files to RubyForge.'
 task :release => [:gem, :package] do
   require 'rubyforge'
   
-  ruby_forge = RubyForge.new
+  ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
-  %w( gem tgz zip ).each do |ext|
-    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
     puts "Releasing #{File.basename(file)}..."
     
-    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
   end
 end

data/lib/module_creation_helper.rb

@@ -1,60 +1 @@
-module PluginAWeek #: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
-
-Module.class_eval do
-  extend PluginAWeek::ModuleCreationHelper
-end
+require 'module_creation_helper/extensions/module'

data/lib/module_creation_helper/extensions/module.rb

@@ -0,0 +1,63 @@
+module PluginAWeek #:nodoc:
+  module ModuleCreationHelper
+    module Extensions #:nodoc:
+      # Adds helper methods for easily generating new modules/classes
+      module Module
+        # 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:
+        # * +superclass+ - The class to inherit from.  This only applies when using Class#create.  Default is Object.
+        # * +parent+ - 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)
+          # Validate the provided options
+          invalid_options = options.keys - [:superclass, :parent]
+          raise ArgumentError, "Unknown key(s): #{invalid_options.join(", ")}" unless invalid_options.empty?
+          
+          # Validate usage of :superclass option
+          raise ArgumentError, 'Modules cannot have superclasses' if options[:superclass] && self.to_s == 'Module'
+          
+          options = {:superclass => Object, :parent => Object}.merge(options)
+          parent = options[:parent]
+          superclass = options[:superclass]
+          
+          if superclass != Object
+            superclass = " < ::#{superclass}"
+          else
+            superclass = ''
+          end
+          
+          mod = parent.class_eval <<-end_eval
+            #{self.to_s.downcase} #{name}#{superclass}
+              self
+            end
+          end_eval
+          
+          mod.class_eval(&block) if block_given?
+          mod
+        end
+      end
+    end
+  end
+end
+
+Module.class_eval do
+  extend PluginAWeek::ModuleCreationHelper::Extensions::Module
+end

data/test/module_creation_helper_test.rb

@@ -4,9 +4,11 @@ module Ford
 end
 
 class Vehicle
-  cattr_accessor :test_name
-  cattr_accessor :test_inspect
-  cattr_accessor :test_to_s
+  class << self
+    attr_accessor :test_name
+    attr_accessor :test_inspect
+    attr_accessor :test_to_s
+  end
   
   def self.inherited(base)
     self.test_name = base.name
@@ -21,7 +23,7 @@ class ModuleCreationHelperTest < Test::Unit::TestCase
   end
 end
 
-class ModuleCreationHelperForClassTest < Test::Unit::TestCase
+class ClassTest < Test::Unit::TestCase
   def setup
     @car = Class.create('Car')
   end
@@ -31,7 +33,6 @@ class ModuleCreationHelperForClassTest < Test::Unit::TestCase
   end
   
   def test_should_have_object_as_parent
-    assert_equal Object, @car.parent
     assert Object.const_defined?('Car')
   end
   
@@ -40,7 +41,7 @@ class ModuleCreationHelperForClassTest < Test::Unit::TestCase
   end
 end
 
-class ModuleCreationHelperForClassWithSuperclassTest < Test::Unit::TestCase
+class ClassWithSuperclassTest < Test::Unit::TestCase
   def setup
     @car = Class.create('Car', :superclass => Vehicle)
   end
@@ -50,7 +51,6 @@ class ModuleCreationHelperForClassWithSuperclassTest < Test::Unit::TestCase
   end
   
   def test_should_have_object_as_parent
-    assert_equal Object, @car.parent
     assert Object.const_defined?('Car')
   end
   
@@ -71,7 +71,7 @@ class ModuleCreationHelperForClassWithSuperclassTest < Test::Unit::TestCase
   end
 end
 
-class ModuleCreationHelperForClassWithParentTest < Test::Unit::TestCase
+class ClassWithParentTest < Test::Unit::TestCase
   def setup
     @car = Class.create('Car', :parent => Ford)
   end
@@ -81,7 +81,6 @@ class ModuleCreationHelperForClassWithParentTest < Test::Unit::TestCase
   end
   
   def test_should_be_nested_within_parent
-    assert_equal Ford, @car.parent
     assert Ford.const_defined?('Car')
   end
   
@@ -90,7 +89,45 @@ class ModuleCreationHelperForClassWithParentTest < Test::Unit::TestCase
   end
 end
 
-class ModuleCreationHelperForClassWithSuperclassAndParentTest < Test::Unit::TestCase
+class ClassWithInferredParentTest < Test::Unit::TestCase
+  def setup
+    @car = Class.create('Ford::Car')
+  end
+  
+  def test_should_have_object_as_superclass
+    assert_equal Object, @car.superclass
+  end
+  
+  def test_should_be_nested_within_parent
+    assert Ford.const_defined?('Car')
+  end
+  
+  def teardown
+    Ford.send(:remove_const, 'Car')
+  end
+end
+
+class ClassWithInferredParentAndConfiguredParenTest < Test::Unit::TestCase
+  def setup
+    Module.create('Car', :parent => Ford)
+    @part = Class.create('Car::Part', :parent => Ford)
+  end
+  
+  def test_should_have_object_as_superclass
+    assert_equal Object, @part.superclass
+  end
+  
+  def test_should_be_nested_within_parent
+    assert Ford::Car.const_defined?('Part')
+  end
+  
+  def teardown
+    Ford::Car.send(:remove_const, 'Part')
+    Ford.send(:remove_const, 'Car')
+  end
+end
+
+class ClassWithSuperclassAndParentTest < Test::Unit::TestCase
   def setup
     Vehicle.test_name = nil
     Vehicle.test_inspect = nil
@@ -104,7 +141,6 @@ class ModuleCreationHelperForClassWithSuperclassAndParentTest < Test::Unit::Test
   end
   
   def test_should_be_nested_within_parent
-    assert_equal Ford, @car.parent
     assert Ford.const_defined?('Car')
   end
   
@@ -125,7 +161,7 @@ class ModuleCreationHelperForClassWithSuperclassAndParentTest < Test::Unit::Test
   end
 end
 
-class ModuleCreationHelperForClassWithDynamicSuperclassTest < Test::Unit::TestCase
+class ClassWithDynamicSuperclassTest < Test::Unit::TestCase
   def setup
     @car = Class.create('Car')
     @convertible = Class.create('Convertible', :superclass => @car)
@@ -141,7 +177,7 @@ class ModuleCreationHelperForClassWithDynamicSuperclassTest < Test::Unit::TestCa
   end
 end
 
-class ModuleCreationHelperForClassWithCustomMethods < Test::Unit::TestCase
+class ClassWithCustomMethodsTest < Test::Unit::TestCase
   def setup
     @car = Class.create('Car', :superclass => Vehicle) do
       def self.color
@@ -159,13 +195,12 @@ class ModuleCreationHelperForClassWithCustomMethods < Test::Unit::TestCase
   end
 end
 
-class ModuleCreationHelperForModuleTest < Test::Unit::TestCase
+class ModuleTest < 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
   
@@ -174,19 +209,18 @@ class ModuleCreationHelperForModuleTest < Test::Unit::TestCase
   end
 end
 
-class ModuleCreationHelperForModuleWithSuperclassTest < Test::Unit::TestCase
+class ModuleWithSuperclassTest < Test::Unit::TestCase
   def test_should_raise_an_exception
     assert_raise(ArgumentError) {Module.create(nil, :superclass => Object)}
   end
 end
 
-class ModuleCreationHelperForModuleWithParentTest < Test::Unit::TestCase
+class ModuleWithParentTest < 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
   

data/test/test_helper.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: module_creation_helper
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
-autorequire: module_creation_helper
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-05-05 00:00:00 -04:00
+date: 2008-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -22,14 +22,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/module_creation_helper
+- lib/module_creation_helper/extensions
+- lib/module_creation_helper/extensions/module.rb
 - lib/module_creation_helper.rb
 - test/test_helper.rb
 - test/module_creation_helper_test.rb
-- CHANGELOG
+- CHANGELOG.rdoc
 - init.rb
-- MIT-LICENSE
+- LICENSE
 - Rakefile
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
 post_install_message: 
@@ -51,8 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.1.0
+rubyforge_project: pluginaweek
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: Adds a helper method for creating new modules and classes at runtime.

data/CHANGELOG

@@ -1,17 +0,0 @@
-*SVN*
-
-*0.0.4* (May 5th, 2008)
-
-* Updated documentation
-
-*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