classy 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Hyland
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,20 @@
+= 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,
+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).
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 John Hyland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  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.email = "github@djspinmonkey.com"
+    gem.homepage = "http://github.com/djspinmonkey/classy"
+    gem.authors = ["John Hyland"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "classy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/classy/aliasable.rb

@@ -0,0 +1,50 @@
+module Aliasable
+  def self.extended (klass) #nodoc;
+    klass.class_exec do
+      class_variable_set(:@@aliases, {})
+    end
+  end
+
+  ##
+  # When passed a class, just returns it.  When passed a symbol that is an
+  # alias for a class, returns that class.
+  #
+  #   Testify::Framework::Base.find(:rspec)  # => Testify::Framework::RSpec
+  #
+  def find (klass)
+    return klass if klass.kind_of? Class
+    class_variable_get(:@@aliases)[klass] or raise ArgumentError, "Could not find alias #{klass}"
+  end
+
+  ##
+  # Forget all known aliases.
+  #
+  def forget_aliases
+    class_variable_get(:@@aliases).clear
+  end
+
+  ##
+  # Specifies a symbol (or several) that a given framework might be known
+  # by.  For example, if you wanted to refer to RSpec by :rspec or :spec,
+  # you might do this:
+  #
+  #   class RSpec
+  #     aka :rspec, spec
+  #     ...
+  #   end
+  #
+  def aka (*names)
+    names.each do |name| 
+      raise ArgumentError, "Called aka with an alias that is already taken." if class_variable_get(:@@aliases).include? name
+      class_variable_get(:@@aliases)[name] = self
+    end
+  end
+
+  ##
+  # Return a hash of known aliases to Class objects
+  #
+  def aliases
+    class_variable_get(:@@aliases).dup
+  end
+
+end

data/lib/classy/subclass_aware.rb

@@ -0,0 +1,32 @@
+require 'set'
+
+module SubclassAware
+
+  def self.extended (klass) #nodoc;
+    klass.class_exec { class_variable_set(:@@subclasses, Set.new) }
+  end
+
+  # 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.
+  def inherited(sub) #nodoc;
+    class_exec { class_variable_get(:@@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 }
+  end
+
+  ##
+  # Clear all info about known subclasses.  Usefull for testing, but it is
+  # unlikely you would use it for much else.
+  #
+  def forget_subclasses
+    class_exec { class_variable_get(:@@subclasses).clear }
+  end
+
+end

data/lib/classy.rb

@@ -0,0 +1,3 @@
+Dir.foreach( File.join( File.dirname(__FILE__), 'classy' ) ) do |entry|
+  require "classy/#{entry}" if entry =~ /\.rb$/
+end

data/spec/aliasable_spec.rb

@@ -0,0 +1,81 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Aliasable" do
+
+  # TODO: It would be better to tear these down and rebuild them before each
+  # test, since some of the tests add or remove aliases.
+  before :all do
+    class Base
+      extend Aliasable
+      aka :base
+    end
+
+    class ChildA < Base
+      aka :childA, :first_child
+    end
+
+    class ChildB < Base
+      aka :childB
+    end
+
+  end
+
+  describe ".aliases" do
+    it "should return all known aliases" do
+      Base.aliases.should eql({
+        :base => Base,
+        :childA => ChildA,
+        :first_child => ChildA,
+        :childB => ChildB
+      })
+    end
+  end
+
+  describe ".aka" do
+    it "should allow an alias to be set" do
+      lambda {
+        class ChildC < Base
+          aka :childC
+        end
+      }.should_not raise_error
+    end
+  end
+
+  describe '.find' do
+    it "should allow you to look up a class via its alias" do
+      Base.find(:first_child).should equal ChildA
+      Base.find(:childB).should equal ChildB
+    end
+  end
+
+  it "should keep aliases of different class hierarchies separate" do
+    class AnotherBase
+      extend Aliasable
+    end
+
+    lambda {
+      class AnotherChildA < AnotherBase
+        aka :first_child
+      end
+    }.should_not raise_error
+
+    AnotherBase.find(:first_child).should equal AnotherChildA
+    Base.find(:first_child).should equal ChildA
+  end
+
+  it "shouldn't allow the same alias to be used more than once in the same hierarchy" do
+    lambda {
+      class BogusDuplicateChildA < Base
+        aka :childA
+      end
+    }.should raise_error( ArgumentError, /already taken/ )
+  end
+
+  describe '.forget_aliases' do
+    it "should clear all aliases for this hierarchy" do
+      Base.forget_aliases
+      Base.aliases.should be_empty
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'classy'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/subclass_aware_spec.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "SubclassAware" do
+
+  before :all do
+    # TODO: It would be nicer if this were torn down and re-built between each test.
+    
+    class ParentA
+      extend SubclassAware
+
+      # This is kind of a pain in the butt, but it's what you need to do if you
+      # define your own self.inherited to keep from blowing away the one
+      # SubclassAware sets up.  There's a todo in subclass_aware.rb about this.
+      class << self; alias :old_inherited :inherited end
+      def self.inherited(sub)
+        old_inherited(sub)
+        # do your stuff here
+      end
+    end
+
+    class ParentB
+      extend SubclassAware
+    end
+
+    class SubclassA1 < ParentA; end
+    class SubclassA2 < ParentA; end
+    class SubclassA3 < ParentA; end
+
+    class SubclassB1 < ParentB; end
+    class SubclassB2 < ParentB; end
+    class SubclassB3 < ParentB; end
+  end
+
+  it "should keep track of all subclasses (and sub-sub, etc. classes) of a module which extends it" do
+    ParentA::subclasses.should include(SubclassA1, SubclassA2, SubclassA3)
+    ParentB::subclasses.should include(SubclassB1, SubclassB2, SubclassB3)
+    ParentA::subclasses.should have(3).subclasses
+    ParentB::subclasses.should have(3).subclasses
+  end
+
+  it "should not confuse the subclasses of two different extending classes" do
+    ParentA.subclasses.should_not include(SubclassB1, SubclassB2, SubclassB3)
+    ParentB.subclasses.should_not include(SubclassA1, SubclassA2, SubclassA3)
+  end
+
+  it "should forget all subclasses when forget_subclasses() is called" do
+    ParentA.forget_subclasses
+    ParentA.subclasses.should be_empty
+
+    ParentB::subclasses.should include(SubclassB1, SubclassB2, SubclassB3)
+    ParentB.subclasses.should have(3).subclasses
+  end
+
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: classy
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- John Hyland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-24 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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).
+email: github@djspinmonkey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/classy.rb
+- lib/classy/aliasable.rb
+- lib/classy/subclass_aware.rb
+- spec/aliasable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/subclass_aware_spec.rb
+has_rdoc: true
+homepage: http://github.com/djspinmonkey/classy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A collection of modules to enhance the capabilities of Ruby classes in various ways.
+test_files: 
+- spec/aliasable_spec.rb
+- spec/spec_helper.rb
+- spec/subclass_aware_spec.rb