typecollection 0.0.2

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 James Petty
+
+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/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "typecollection"
+  gem.homepage = "http://github.com/pettyjamesm/TypeCollection"
+  gem.license = "MIT"
+  gem.summary = %Q{TypeCollection maintains a record of sub-types for a given
+    class based on a common suffix.}
+  gem.description = %Q{Easily map subtypes into their parent type for later retrieval}
+  gem.email = "jp@jibe.com"
+  gem.authors = ["James Petty"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "typecollection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/typecollection.rb

@@ -0,0 +1,11 @@
+require 'typecollection'
+require 'typecollection/class+inferred_type'
+require 'typecollection/class_methods'
+
+module TypeCollection
+  # The intended means to use a TypeCollection is to include TypeCollection
+  # in your class definition.
+  def self.included(base)
+    base.extend(TypeCollection::ClassMethods)
+  end
+end

data/lib/typecollection/class+inferred_type.rb

@@ -0,0 +1,14 @@
+class Class
+  def inferred_type()
+    klass_name   = self.name.split("::").last
+    parent_klass = self.superclass
+    while(parent_klass != nil)
+      check = parent_klass.name.split("::").last
+      if (klass_name.end_with?(check))
+        return klass_name.gsub(/#{check}\z/, "")
+      end
+      parent_klass = parent_klass.superclass
+    end
+    return nil
+  end
+end

data/lib/typecollection/class_methods.rb

@@ -0,0 +1,43 @@
+module TypeCollection
+  # Indicates that a TypeCollection has been extended by a base class that
+  # fails to comply with the correct naming convention for TypeCollection
+  # to function properly
+  class InvalidChildType < StandardError; end
+  
+  # Indicates that a request has been made to retrieve a child type that
+  # is not currently registered with the type collection
+  class UnknownChildType < StandardError; end
+  
+  # Extended by TypeCollections to provide class level functionality (almost
+  # all functionality is class level as of the current design)
+  module ClassMethods
+    # Contains the Members mapped by type
+    def __tc_members(); @_members ||= { }; end
+    
+    # Returns all of the known subclasses for this collection
+    def all_types()
+      return __tc_members().values()
+    end
+    
+    # Gets the type associated with the provided value (Class or Otherwise)
+    def get_type(type)
+      type = type.inferred_type() if (type.kind_of?(Class))
+      mems = __tc_members()
+      raise TypeCollection::UnknownChildType.new() unless (mems.has_key?(type))
+      return mems[type]
+    end
+    
+    # Overrides the default behavior when being extended by a child class.
+    # It ensures the child is mapped for future retrieval and checks the
+    # subclass name to ensure it is a valid one
+    def inherited(child)
+      super if (defined?(super))
+      type = child.inferred_type()
+      if (type.nil?)
+        error = "Invalid Name: #{child.name}! Child class names must end with \"#{self.name}\"."
+        raise TypeCollection::InvalidChildType.new(error)
+      end
+      __tc_members()[type] = child
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'typecollection'
+
+class Test::Unit::TestCase
+end

data/test/test_typecollection.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestTypecollection < Test::Unit::TestCase
+  should "Actually Function" do
+    require 'typecollection'
+    # => Define a Type Collection
+    class SomeType
+      include TypeCollection
+    end
+    # => Extend that Type Collection
+    class ExtendedSomeType < SomeType
+      
+    end
+    # => Ensure it can be retrieved
+    unless (SomeType.all_types().length == 1 and SomeType.get_type("Extended") == ExtendedSomeType)
+      flunk "Failed to Register Extended with SomeType!" 
+    end
+  end
+end

data/typecollection.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "typecollection"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Petty"]
+  s.date = "2012-01-10"
+  s.description = "Easily map subtypes into their parent type for later retrieval"
+  s.email = "jp@jibe.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/typecollection.rb",
+    "lib/typecollection/class+inferred_type.rb",
+    "lib/typecollection/class_methods.rb",
+    "test/helper.rb",
+    "test/test_typecollection.rb",
+    "typecollection.gemspec"
+  ]
+  s.homepage = "http://github.com/pettyjamesm/TypeCollection"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "TypeCollection maintains a record of sub-types for a given class based on a common suffix."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: typecollection
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- James Petty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70319050220100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319050220100
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70319050215500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70319050215500
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70319050210820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70319050210820
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70319050200520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319050200520
+description: Easily map subtypes into their parent type for later retrieval
+email: jp@jibe.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/typecollection.rb
+- lib/typecollection/class+inferred_type.rb
+- lib/typecollection/class_methods.rb
+- test/helper.rb
+- test/test_typecollection.rb
+- typecollection.gemspec
+homepage: http://github.com/pettyjamesm/TypeCollection
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -698932350453145529
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: TypeCollection maintains a record of sub-types for a given class based on
+  a common suffix.
+test_files: []