abstract_class 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sean Huber - shuber@huberry.com
+
+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,65 @@
+= abstract_class
+
+Abstract classes in ruby
+
+
+== Installation
+
+  gem install abstract_class
+
+
+== Usage
+
+  class ActiveRecord::Base
+    abstract
+  end
+
+  class User < ActiveRecord::Base
+  end
+
+  # RuntimeError: abstract class ActiveRecord::Base can't be instantiated/allocated
+  ActiveRecord::Base.new
+  ActiveRecord::Base.allocate
+
+  # instantiates/allocates like normal
+  User.new
+  User.allocate
+
+  # returns true or false
+  ActiveRecord::Base.abstract?
+  User.abstract?
+
+
+== Testing abstract classes
+
+Include <tt>AbstractClass::TestHelper</tt> in your test framework
+
+  Test::Unit::TestCase.send(:include, AbstractClass::TestHelper)
+
+Then you can use <tt>assert_abstract_class</tt> or <tt>assert_not_abstract_class</tt>) in your tests
+
+  class AbstractClass
+    abstract
+  end
+
+  class NormalClass < AbstractClass
+  end
+
+  class AbstractClassTest < Test::Unit::TestCase
+    def test_should_be_abstract_class
+      assert_abstract_class AbstractClass
+    end
+
+    def test_should_not_be_abstract_class
+      assert_not_abstract_class NormalClass
+    end
+  end
+
+
+== Patches and 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.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the abstract_class gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs += ['lib', 'test']
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the abstract_class gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'abstract_class'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/abstract_class.rb

@@ -0,0 +1,38 @@
+# Adds the ability to declare classes as abstract so that they can't be instantiated or allocated
+module AbstractClass
+  autoload :TestHelper, 'abstract_class/test_helper'
+  autoload :Version,    'abstract_class/version'
+
+  # When included, it will <tt>alias_method_chain</tt> <tt>allocate</tt> and <tt>new</tt> methods with <tt>:abstract_class</tt> in <tt>klass</tt>
+  def self.included(klass)
+    klass.class_eval do
+      alias_method :allocate_without_abstract_class, :allocate
+      alias_method :allocate, :allocate_with_abstract_class
+
+      alias_method :new_without_abstract_class, :new
+      alias_method :new, :new_with_abstract_class
+    end
+  end
+
+  # Declares this class as abstract and prevents it from being instantiated or allocated
+  def abstract
+    @abstract = true
+  end
+
+  # Checks if this class has been declared as abstract
+  def abstract?
+    @abstract ||= false
+  end
+
+  # Raises RuntimeError if class is abstract, otherwise returns <tt>allocate_without_abstract_class</tt>
+  def allocate_with_abstract_class
+    abstract? ? raise("abstract class #{self} can't be allocated") : allocate_without_abstract_class
+  end
+
+  # Raises RuntimeError if class is abstract, otherwise returns <tt>new_without_abstract_class</tt>
+  def new_with_abstract_class(*args, &block)
+    abstract? ? raise("abstract class #{self} can't be instantiated") : new_without_abstract_class(*args, &block)
+  end
+end
+
+Class.send(:include, AbstractClass)

data/lib/abstract_class/test_helper.rb

@@ -0,0 +1,14 @@
+module AbstractClass
+  # Contains abstract class testing assertions to include in your test framework
+  module TestHelper
+    # Asserts that the specified <tt>klass</tt> has been declared as abstract
+    def assert_abstract_class(klass)
+      assert klass.abstract?, "#{klass} was expected to be abstract"
+    end
+
+    # Asserts that the specified <tt>klass</tt> has not been declared as abstract
+    def assert_not_abstract_class(klass)
+      assert !klass.abstract?, "#{klass} was not expected to be abstract"
+    end
+  end
+end

data/lib/abstract_class/version.rb

@@ -0,0 +1,17 @@
+module AbstractClass
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
+    #
+    # Example
+    #
+    #   Version.string # '1.0.2'
+    def self.string
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/test/abstract_class_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class BaseClass
+  abstract
+end
+
+class DerivedClass
+end
+
+class AbstractClassTest < Test::Unit::TestCase
+  def test_should_not_allow_abstract_class_to_be_initialized
+    assert_raises(RuntimeError) { BaseClass.new }
+  end
+
+  def test_should_not_allow_abstract_class_to_be_allocated
+    assert_raises(RuntimeError) { BaseClass.allocate }
+  end
+
+  def test_should_allow_derived_class_to_be_initialized
+    assert DerivedClass.new.is_a?(DerivedClass)
+  end
+
+  def test_should_allow_derived_class_to_be_allocated
+    assert DerivedClass.allocate.is_a?(DerivedClass)
+  end
+
+  def test_should_check_if_a_class_is_abstract
+    assert BaseClass.abstract?
+    assert !DerivedClass.abstract?
+  end
+
+  def test_should_bypass_instantiation_restrictions
+    assert DerivedClass.new_without_abstract_class.is_a?(DerivedClass)
+  end
+
+  def test_should_bypass_allocation_restrictions
+    assert DerivedClass.allocate_without_abstract_class.is_a?(DerivedClass)
+  end
+
+  def test_should_assert_class_is_abstract
+    assert_abstract_class BaseClass
+    assert_raises(Test::Unit::AssertionFailedError) { assert_abstract_class DerivedClass }
+  end
+
+  def test_should_assert_class_is_not_abstract
+    assert_not_abstract_class DerivedClass
+    assert_raises(Test::Unit::AssertionFailedError) { assert_not_abstract_class BaseClass }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'abstract_class'
+
+Test::Unit::TestCase.send(:include, AbstractClass::TestHelper)

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: abstract_class
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Abstract classes in ruby
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/abstract_class.rb
+- lib/abstract_class/test_helper.rb
+- lib/abstract_class/version.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/abstract_class_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/shuber/abstract_class
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Abstract classes in ruby
+test_files: 
+- test/abstract_class_test.rb
+- test/test_helper.rb