Roman2K-class-inheritable-attributes 0.1.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2008-2009 Roman Le Négrate
+
+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.mdown

@@ -0,0 +1,56 @@
+# Thread-safe class inheritable attributes
+
+[GitHub repository](https://github.com/Roman2K/class-inheritable-attributes).
+
+## Installation
+
+    $ gem install Roman2K-class-inheritable-attributes -s http://gems.github.com/
+
+## Features
+
+Allows for defining class-level attributes whose values are:
+
+* inherited by subclasses,
+* stored in a thread safe manner,
+* accessible via calls to `super`,
+* stored in a memory efficient manner (the registry shrinks itself on `nil` values).
+
+## Example usage
+
+    require 'class_inheritable_attributes'
+    
+    class Resource
+      class_inheritable_attr_accessor :site, :timeout
+    
+      def self.timeout
+        super || 10
+      end
+    
+      def self.timeout=(seconds)
+        super(seconds.to_i)
+      end
+    end
+  
+    Resource.timeout  # => 10
+    Resource.timeout = "5"
+    Resource.timeout  # => 5
+  
+    class AccountingResource < Resource
+      self.site = "http://account.example.com"
+    end
+  
+    class Balance < AccountingResource
+    end
+  
+    # Child's value defaults to parent's
+    AccountingResource.site   # => "http://account.example.com"
+    Balance.site              # => "http://account.example.com"
+  
+    # Child can set its own value
+    Balance.site = "http://balance.account.example.com"
+    AccountingResource.site   # => "http://account.example.com"
+    Balance.site              # => "http://balance.account.example.com"
+
+## Credits
+
+Written by [Roman Le Négrate](http://roman.flucti.com) ([contact](mailto:roman.lenegrate@gmail.com)). Released under the MIT license: see the `LICENSE` file.

data/Rakefile

@@ -0,0 +1,11 @@
+require "echoe"
+
+Echoe.new('class-inheritable-attributes', '0.1.1') do |p|
+  p.description     = "Thread-safe class inheritable attributes"
+  p.url             = "https://github.com/Roman2K/class-inheritable-attributes"
+  p.author          = "Roman Le Négrate"
+  p.email           = "roman.lenegrate@gmail.com"
+  p.ignore_pattern  = "*.gemspec"
+  p.development_dependencies = ["mocha"]
+  p.rdoc_options    = %w(--main README.mdown --inline-source --line-numbers --charset UTF-8)
+end

data/class-inheritable-attributes.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{class-inheritable-attributes}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Le N\303\251grate"]
+  s.date = %q{2009-03-17}
+  s.description = %q{Thread-safe class inheritable attributes}
+  s.email = %q{roman.lenegrate@gmail.com}
+  s.extra_rdoc_files = ["lib/class_inheritable_attributes.rb", "LICENSE", "README.mdown"]
+  s.files = ["lib/class_inheritable_attributes.rb", "LICENSE", "Manifest", "Rakefile", "README.mdown", "test/class_inheritable_attributes_test.rb", "class-inheritable-attributes.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{https://github.com/Roman2K/class-inheritable-attributes}
+  s.rdoc_options = ["--main", "README.mdown", "--inline-source", "--line-numbers", "--charset", "UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{class-inheritable-attributes}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Thread-safe class inheritable attributes}
+  s.test_files = ["test/class_inheritable_attributes_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/lib/class_inheritable_attributes.rb

@@ -0,0 +1,82 @@
+module ClassInheritableAttributes
+  class << self
+    def eval_in_accessor_module(klass, code)
+      mod = klass.instance_eval { @_inheritable_attribute_accessors ||= Module.new }
+      klass.extend(mod)
+      mod.module_eval(code)
+    end
+    
+    def fetch_value(klass, attribute)
+      each_parent(klass) do |parent|
+        if values = registry[parent] and values.key?(attribute)
+          return values[attribute]
+        elsif parent.instance_variable_defined?("@#{attribute}")
+          return parent.instance_variable_get("@#{attribute}")
+        end
+      end
+      return nil
+    end
+    
+    def store_value(klass, attribute, value)
+      if Thread.current == Thread.main
+        if value.nil?
+          klass.instance_eval do
+            remove_instance_variable("@#{attribute}") if instance_variable_defined?("@#{attribute}")
+          end
+        else
+          klass.instance_variable_set("@#{attribute}", value)
+        end
+      else
+        registry[klass] ||= {}
+        if value.nil?
+          registry[klass].delete(attribute)
+          registry.delete(klass) if registry[klass].empty?
+        else
+          registry[klass][attribute] = value
+        end
+      end
+    end
+    
+  private
+    
+    def each_parent(klass)
+      while klass < Object
+        yield klass
+        klass = klass.superclass
+      end
+    end
+    
+    def registry
+      Thread.current[ClassInheritableAttributes.name] ||= {}
+    end
+  end
+  
+  def class_inheritable_attr_reader(*attributes)
+    attributes.each do |attribute|
+      ClassInheritableAttributes.eval_in_accessor_module(self, <<-EOS)
+        def #{attribute}
+          #{ClassInheritableAttributes}.fetch_value(self, :#{attribute})
+        end
+      EOS
+    end
+  end
+  
+  def class_inheritable_attr_writer(*attributes)
+    attributes.each do |attribute|
+      ClassInheritableAttributes.eval_in_accessor_module(self, <<-EOS)
+        def #{attribute}=(value)
+          #{ClassInheritableAttributes}.store_value(self, :#{attribute}, value)
+        end
+      EOS
+    end
+  end
+  
+  def class_inheritable_attr_accessor(*attributes)
+    class_inheritable_attr_reader(*attributes)
+    class_inheritable_attr_writer(*attributes)
+  end
+end
+
+Class.class_eval do
+  include ClassInheritableAttributes
+end

data/test/class_inheritable_attributes_test.rb

@@ -0,0 +1,85 @@
+require 'test/unit'
+require 'mocha'
+
+require 'class_inheritable_attributes'
+
+class ClassInheritableAttributesTest < Test::Unit::TestCase
+  def setup
+    @class = Class.new { class_inheritable_attr_accessor :foo }
+  end
+  
+  def test_initial_value
+    assert_equal nil, @class.foo
+  end
+  
+  def test_thread_overrideability
+    @class.foo = :bar
+    assert_equal :over, Thread.new { @class.foo = :over; @class.foo }.value
+    assert_equal :bar, @class.foo
+  end
+  
+  def test_inheritability
+    child = Class.new(@class)
+    
+    @class.foo = :bar
+    assert_equal :bar, child.foo
+    
+    @class.foo = :bar
+    child.foo = :other
+    assert_equal :other, child.foo
+    assert_equal :bar, @class.foo
+    
+    # Setting a value to nil, in the main thread
+    @class.foo = :bar
+    child.foo = nil
+    assert_equal :bar, child.foo
+    assert_equal :bar, @class.foo
+    
+    # Setting a value that wasn't previously assigned to nil, in the main thread
+    @class.foo = :bar
+    other_child = Class.new(@class)
+    other_child.foo = nil
+    assert_equal :bar, other_child.foo
+    
+    # Setting a value to nil, in a separate thread
+    @class.foo = :bar
+    result = Thread.new { child.foo = nil; child.foo }.value
+    assert_equal :bar, result
+    
+    @class.foo = :bar
+    child.foo = :other
+    assert_equal :in_thread, Thread.new { child.foo = :in_thread; child.foo }.value
+    assert_equal :other, child.foo
+    assert_equal :bar, @class.foo
+    
+    @class.foo = :bar
+    child.foo = :other
+    @class.foo = :changed
+    assert_equal :other, child.foo
+    assert_equal :changed, @class.foo
+  end
+  
+  def test_housekeeping
+    Thread.new do
+      assert_equal 0, ClassInheritableAttributes.instance_eval { registry }.size
+      @class.foo = nil
+      assert_equal 0, ClassInheritableAttributes.instance_eval { registry }.size
+      @class.foo = :bar
+      assert_equal 1, ClassInheritableAttributes.instance_eval { registry }.size
+      @class.foo = nil
+      assert_equal 0, ClassInheritableAttributes.instance_eval { registry }.size
+    end.join
+  end
+  
+  def test_attribute_methods_are_defined_in_ancestors
+    c = @class
+    def c.foo
+      super || :default
+    end
+    
+    assert_equal :default, c.foo
+    
+    c.foo = :explicit
+    assert_equal :explicit, c.foo
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: Roman2K-class-inheritable-attributes
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Roman Le N\xC3\xA9grate"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Thread-safe class inheritable attributes
+email: roman.lenegrate@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/class_inheritable_attributes.rb
+- LICENSE
+- README.mdown
+files: 
+- lib/class_inheritable_attributes.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.mdown
+- test/class_inheritable_attributes_test.rb
+- class-inheritable-attributes.gemspec
+has_rdoc: true
+homepage: https://github.com/Roman2K/class-inheritable-attributes
+post_install_message: 
+rdoc_options: 
+- --main
+- README.mdown
+- --inline-source
+- --line-numbers
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: class-inheritable-attributes
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Thread-safe class inheritable attributes
+test_files: 
+- test/class_inheritable_attributes_test.rb