final 0.1.0

data/CHANGES

@@ -0,0 +1,2 @@
+== 0.1.0 - 8-Apr-2011
+  * Initial release

data/MANIFEST

@@ -0,0 +1,7 @@
+* CHANGES
+* README
+* MANIFEST
+* Rakefile
+* final.gemspec
+* lib/final.rb
+* test/test_final.rb

data/README

@@ -0,0 +1,62 @@
+= Description
+  A Ruby module that can make your classes final. A final class cannot
+  be subclassed, and its instance methods cannot be redefined.
+
+= Synopsis
+  require 'final'
+
+  class Alpha
+    include Final
+
+    def foo
+      puts "Hello"
+    end
+  end
+
+  # Error! You cannot subclass Alpha.
+  class Beta < Alpha; end
+
+  # Error! You cannot redefine an existing method.
+  class Alpha
+    def foo
+      puts "Hi"
+    end
+  end
+
+  # Not an error. You can add new methods to an existing class.
+  class Alpha
+    def bar
+      puts "World"
+    end
+  end
+
+= Developer's Notes
+  This library is merely a proof of concept that was published as the result
+  of a tweet made by James Edward Gray II, where he commented that Ruby core
+  classes should never be subclassed. Knowing that static languages like Java
+  implement the "final" keyword as a way to prevent subclassing, I wanted to
+  see if something similar could be done for Ruby. Turns out it can.
+
+  I do not, however, necessarily advocate actually using this library in
+  production code. Freezing a class this way is contrary to the very nature
+  of Ruby and dynamic languages in general. If you're going to use it, you had
+  better have a very good reason for doing so!
+
+= Caveats
+  Only instance methods are prevented from redefinition. Singleton methods are
+  not final. This change may happen in a future release.
+
+= License
+  Artistic 2.0
+
+= Copyright
+  (C) 2003-2011 Daniel J. Berger
+  All Rights Reserved.`
+
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+= Author
+  Daniel J. Berger

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include('**/*.gem', '**/*.rbc')
+
+namespace :gem do
+  desc 'Build the final gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('final.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc "Install the final gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
+end
+
+Rake::TestTask.new do |t|
+  task :test => :clean
+  t.warning = true
+  t.verbose = true
+end
+
+task :default => :test

data/final.gemspec

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+Gem::Specification.new do |gem|
+  gem.name       = 'final'
+  gem.version    = '0.1.0'
+  gem.license    = 'Artistic 2.0'
+  gem.author     = 'Daniel J. Berger'
+  gem.email      = 'djberg96@gmail.com'
+  gem.homepage   = 'http://www.rubyforge.org/projects/shards'
+  gem.summary    = "An implementation of 'final' for Ruby"
+  gem.test_files = Dir['test/test*']
+  gem.has_rdoc   = true
+  gem.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  gem.rubyforge_project = 'shards'
+  gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+
+  gem.description = <<-EOF
+    The final library enables you to declare your classes as final. This
+    prevents your class from being subclassed or having its methods redefined.
+  EOF
+
+  gem.add_development_dependency('test-unit', '>= 2.2.0')
+end

data/lib/final.rb

@@ -0,0 +1,38 @@
+# Make your class final. Once final'ized, it cannot be subclassed and
+# its methods cannot be redefined.
+#
+module Final
+  # Error raised if any of the Final module's rules are violated.
+  class Error < RuntimeError; end
+
+  # The version of the final library.
+  VERSION = '0.1.0'
+
+  def self.included(mod)
+    # Store already defined methods.
+    mod.instance_eval("@final_methods = []")
+
+    # Internal accessor used in the method_added definition.
+    def mod.final_methods
+      @final_methods
+    end
+
+    # Prevent subclassing, except implicity subclassing from Object.
+    def mod.inherited(sub)
+      raise Error, "cannot subclass final class #{self}" unless self == Object
+    end
+
+    # Prevent methods from being redefined.
+    #--
+    # There's still going to be a method redefinition warning. Gosh, it
+    # sure would be nice if we could disable warnings.
+    #
+    def mod.method_added(sym)
+      if final_methods.include?(sym)
+        raise Error, "method '#{sym}' already defined"
+      else
+        final_methods << sym
+      end
+    end
+  end
+end

data/test/test_final.rb

@@ -0,0 +1,44 @@
+########################################################################
+# test_final.rb
+#
+# Test suite for the final library.
+########################################################################
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'final'
+
+class TC_Final < Test::Unit::TestCase
+  class Foo
+    include Final
+    def bar; end
+  end
+
+  def setup
+    @foo = Foo.new
+  end
+
+  test "version constant returns expected version number" do
+    assert_equal('0.1.0', Final::VERSION)
+  end
+
+  test "final class cannot be subclassed" do
+    assert_raise(Final::Error){ class Bar < Foo; end }
+  end
+
+  test "final class cannot have instance methods redefined" do
+    assert_raise(Final::Error){ class Foo; def bar; end; end }
+  end
+
+  test "adding a new method is not an error" do
+    assert_nothing_raised{ class Foo; def baz; end; end }
+  end
+
+  test "finalized classes do not interfere with each other" do
+    assert_nothing_raised{ class Foo2; include Final; def bar; end; end }
+  end
+
+  def teardown
+    @foo = nil
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: final
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-09 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id001
+description: "    The final library enables you to declare your classes as final. This\n    prevents your class from being subclassed or having its methods redefined.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- CHANGES
+- final.gemspec
+- lib/final.rb
+- MANIFEST
+- Rakefile
+- README
+- test/test_final.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+licenses: 
+- Artistic 2.0
+post_install_message: 
+rdoc_options: []
+
+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: shards
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An implementation of 'final' for Ruby
+test_files: 
+- test/test_final.rb