classy 1.0.2 → 1.0.3

data/README.rdoc

@@ -1,7 +1,7 @@
 = classy
 
-Classy is a collection of meta-programming heavy modules which you can extend
-in order to give various capabilities to your Ruby classes.  For example,
+Classy is a collection of metaprogramming-heavy modules which you can extend in
+order to give various capabilities to your Ruby classes.  For example,
 SubclassAware lets a class know about all of its subclasses (and
 sub-subclasses, etc), and Aliasable lets you refer to classes via symbols
 (useful for creating friendly DSLs).
@@ -27,7 +27,8 @@ sub-subclasses, etc), and Aliasable lets you refer to classes via symbols
   Parent.subclasses   # => [ ChildA, ChildB ]
 
 More extensive documentation and example code can be found in the RDoc for each
-module, or in the spec files.
+module (available online at http://rdoc.info/projects/djspinmonkey/classy) or
+in the spec files.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "classy"
     gem.summary = %Q{A collection of modules to enhance the capabilities of Ruby classes in various ways.}
-    gem.description = %Q{Classy is a collection of meta-programming heavy modules which you can extend in order to give various capabilities to your Ruby classes.  For example, SubclassAware lets a class know about all of its subclasses (and sub-subclasses, etc), and Aliasable lets you refer to classes via symbols (useful for creating friendly DSLs).}
+    gem.description = %Q{Classy is a collection of metaprogramming-heavy modules which you can extend in order to give various capabilities to your Ruby classes.  For example, SubclassAware lets a class know about all of its subclasses (and sub-subclasses, etc), and Aliasable lets you refer to classes via symbols (useful for creating friendly DSLs).}
     gem.email = "github@djspinmonkey.com"
     gem.homepage = "http://github.com/djspinmonkey/classy"
     gem.authors = ["John Hyland"]

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/lib/classy/aliasable.rb

@@ -1,4 +1,4 @@
-# Aliasable allows you to assign aliases to a class (probably symbols, but any
+# Aliasable allows you to assign aliases to a class (usually symbols, but any
 # unique objects would work) and look it up again later with that alias.  This
 # alias-to-class hash is kept in a class variable, so each mapping is unique to
 # a given class hierarchy.  Possible uses for this include friendlier DSLs or
@@ -11,7 +11,7 @@
 # maps as a class variable on the Aliasable module itself, but for reasons of
 # complexity and performance, that has not been done at this time.
 #
-# Example:
+# ==Example
 #
 #   class ParentClass
 #     extend Aliasable

data/lib/classy/subclass_aware.rb

@@ -1,9 +1,9 @@
 require 'set'
 
 # SubclassAware allows a class to know about all of the subclasses that descend
-# from it in the inheritance tree.
+# from it in the inheritance tree.  
 #
-# Example:
+# == Example
 #
 #   class Parent
 #     extend SubclassAware
@@ -20,11 +20,18 @@ require 'set'
 #
 #   Parent.subclasses   # => [ ChildA, ChildB, ChildB1 ]
 #
-# Warning: This module defines an inherited() class method on the extending
-# class to keep track of subclasses.  Unfortunately, if this method is later
-# re-defined, this inherited() method is lost and subclass tracking will break.
-# In order to work around this, constructions like the following might be
-# necessary:
+# == Note
+#
+# SubclassAware sets and maintains the class variable @@classy_subclasses on
+# the extending class, so in the unlikely event that this class variable is
+# already in use, unusual bugs may result.
+#
+# == Warning 
+#
+# This module defines an inherited() class method on the extending class to
+# keep track of subclasses.  Unfortunately, if this method is later re-defined,
+# this inherited() method is lost and subclass tracking will break.  In order
+# to work around this, constructions like the following might be necessary:
 #
 #   class ChildC < Parent
 #
@@ -41,30 +48,35 @@ require 'set'
 #
 module SubclassAware
 
-  def self.extended (klass) #:nodoc:
-    klass.class_exec { class_variable_set(:@@subclasses, Set.new) }
+  # Instantiate a new Set of subclasses.  Not intended to be called directly.
+  #
+  def self.extended(klass)
+    klass.class_exec { class_variable_set(:@@classy_subclasses, Set.new) }
   end
 
+  # Add the inheriting class to the list of subclasses.  Not intended to be
+  # called directly.
+  #
   # TODO: Find a way for self.inherited on the extended class not to blow
   # this away without requiring a bunch of alias chain hoops to be jumped
-  # through.
+  # through, as described above.
   #
-  def inherited(sub) #:nodoc:
-    class_exec { class_variable_get(:@@subclasses).add sub }
+  def inherited(sub)
+    class_exec { class_variable_get(:@@classy_subclasses).add sub }
   end
 
   # Return an array of all known subclasses (and sub-subclasses, etc) of this
   # class.
   #
   def subclasses
-    class_exec { class_variable_get(:@@subclasses).to_a }
+    class_exec { class_variable_get(:@@classy_subclasses).to_a }
   end
 
   # Clear all info about known subclasses.  This method is probably mainly
   # useful for testing.
   #
   def forget_subclasses
-    class_exec { class_variable_get(:@@subclasses).clear }
+    class_exec { class_variable_get(:@@classy_subclasses).clear }
   end
 
 end

data/spec/spec.opts

@@ -1 +1 @@
---color
+-fn --color

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: classy
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - John Hyland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-25 00:00:00 -05:00
+date: 2010-01-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
-description: Classy is a collection of meta-programming heavy modules which you can extend in order to give various capabilities to your Ruby classes.  For example, SubclassAware lets a class know about all of its subclasses (and sub-subclasses, etc), and Aliasable lets you refer to classes via symbols (useful for creating friendly DSLs).
+description: Classy is a collection of metaprogramming-heavy modules which you can extend in order to give various capabilities to your Ruby classes.  For example, SubclassAware lets a class know about all of its subclasses (and sub-subclasses, etc), and Aliasable lets you refer to classes via symbols (useful for creating friendly DSLs).
 email: github@djspinmonkey.com
 executables: []
 
@@ -77,3 +77,4 @@ test_files:
 - spec/aliasable_spec.rb
 - spec/spec_helper.rb
 - spec/subclass_aware_spec.rb
+- spec/templatable_spec.rb