class_inheritable_attributes 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in class_inheritable_attributes.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Burke Libbey
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# ClassInheritableAttributes
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'class_inheritable_attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install class_inheritable_attributes
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/class_inheritable_attributes.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/class_inheritable_attributes/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Burke Libbey"]
+  gem.email         = ["burke@burkelibbey.org"]
+  gem.description   = %q{Forward-port of deprectaed ClassInheritableAttributes functionality removed in rails 3.2}
+  gem.summary       = %q{Forward-port of deprectaed ClassInheritableAttributes functionality removed in rails 3.2.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "class_inheritable_attributes"
+  gem.require_paths = ["lib"]
+  gem.version       = ClassInheritableAttributes::VERSION
+end

data/lib/class_inheritable_attributes/version.rb

@@ -0,0 +1,3 @@
+module ClassInheritableAttributes
+  VERSION = "0.0.1"
+end

data/lib/class_inheritable_attributes.rb

@@ -0,0 +1,180 @@
+require "class_inheritable_attributes/version"
+
+require 'active_support/core_ext/object/duplicable'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/deprecation'
+
+# Retained for backward compatibility. Methods are now included in Class.
+module ClassInheritableAttributes # :nodoc:
+  DEPRECATION_WARNING_MESSAGE = "class_inheritable_attribute is deprecated, please use class_attribute method instead. Notice their behavior are slightly different, so refer to class_attribute documentation first"
+end
+
+# It is recommended to use <tt>class_attribute</tt> over methods defined in this file. Please
+# refer to documentation for <tt>class_attribute</tt> for more information. Officially it is not
+# deprecated but <tt>class_attribute</tt> is faster.
+#
+# Allows attributes to be shared within an inheritance hierarchy. Each descendant gets a copy of
+# their parents' attributes, instead of just a pointer to the same. This means that the child can add elements
+# to, for example, an array without those additions being shared with either their parent, siblings, or
+# children. This is unlike the regular class-level attributes that are shared across the entire hierarchy.
+#
+# The copies of inheritable parent attributes are added to subclasses when they are created, via the
+# +inherited+ hook.
+#
+#  class Person
+#    class_inheritable_accessor :hair_colors
+#  end
+#
+#  Person.hair_colors = [:brown, :black, :blonde, :red]
+#  Person.hair_colors     # => [:brown, :black, :blonde, :red]
+#  Person.new.hair_colors # => [:brown, :black, :blonde, :red]
+#
+# To opt out of the instance writer method, pass :instance_writer => false.
+# To opt out of the instance reader method, pass :instance_reader => false.
+#
+#   class Person
+#     class_inheritable_accessor :hair_colors :instance_writer => false, :instance_reader => false
+#   end
+#
+#   Person.new.hair_colors = [:brown]  # => NoMethodError
+#   Person.new.hair_colors             # => NoMethodError
+class Class # :nodoc:
+  def class_inheritable_reader(*syms)
+    ActiveSupport::Deprecation.warn ClassInheritableAttributes::DEPRECATION_WARNING_MESSAGE
+    options = syms.extract_options!
+    syms.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}                                # def self.after_add
+          read_inheritable_attribute(:#{sym})          #   read_inheritable_attribute(:after_add)
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}                                     # def after_add
+          self.class.#{sym}                            #   self.class.after_add
+        end                                            # end
+        " unless options[:instance_reader] == false }  # # the reader above is generated unless options[:instance_reader] == false
+      EOS
+    end
+  end
+
+  def class_inheritable_writer(*syms)
+    ActiveSupport::Deprecation.warn ClassInheritableAttributes::DEPRECATION_WARNING_MESSAGE
+    options = syms.extract_options!
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}=(obj)                          # def self.color=(obj)
+          write_inheritable_attribute(:#{sym}, obj)    #   write_inheritable_attribute(:color, obj)
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}=(obj)                               # def color=(obj)
+          self.class.#{sym} = obj                      #   self.class.color = obj
+        end                                            # end
+        " unless options[:instance_writer] == false }  # # the writer above is generated unless options[:instance_writer] == false
+      EOS
+    end
+  end
+
+  def class_inheritable_array_writer(*syms)
+    ActiveSupport::Deprecation.warn ClassInheritableAttributes::DEPRECATION_WARNING_MESSAGE
+    options = syms.extract_options!
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}=(obj)                          # def self.levels=(obj)
+          write_inheritable_array(:#{sym}, obj)        #   write_inheritable_array(:levels, obj)
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}=(obj)                               # def levels=(obj)
+          self.class.#{sym} = obj                      #   self.class.levels = obj
+        end                                            # end
+        " unless options[:instance_writer] == false }  # # the writer above is generated unless options[:instance_writer] == false
+      EOS
+    end
+  end
+
+  def class_inheritable_hash_writer(*syms)
+    ActiveSupport::Deprecation.warn ClassInheritableAttributes::DEPRECATION_WARNING_MESSAGE
+    options = syms.extract_options!
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}=(obj)                          # def self.nicknames=(obj)
+          write_inheritable_hash(:#{sym}, obj)         #   write_inheritable_hash(:nicknames, obj)
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}=(obj)                               # def nicknames=(obj)
+          self.class.#{sym} = obj                      #   self.class.nicknames = obj
+        end                                            # end
+        " unless options[:instance_writer] == false }  # # the writer above is generated unless options[:instance_writer] == false
+      EOS
+    end
+  end
+
+  def class_inheritable_accessor(*syms)
+    class_inheritable_reader(*syms)
+    class_inheritable_writer(*syms)
+  end
+
+  def class_inheritable_array(*syms)
+    class_inheritable_reader(*syms)
+    class_inheritable_array_writer(*syms)
+  end
+
+  def class_inheritable_hash(*syms)
+    class_inheritable_reader(*syms)
+    class_inheritable_hash_writer(*syms)
+  end
+
+  def inheritable_attributes
+    @inheritable_attributes ||= EMPTY_INHERITABLE_ATTRIBUTES
+  end
+
+  def write_inheritable_attribute(key, value)
+    if inheritable_attributes.equal?(EMPTY_INHERITABLE_ATTRIBUTES)
+      @inheritable_attributes = {}
+    end
+    inheritable_attributes[key] = value
+  end
+
+  def write_inheritable_array(key, elements)
+    write_inheritable_attribute(key, []) if read_inheritable_attribute(key).nil?
+    write_inheritable_attribute(key, read_inheritable_attribute(key) + elements)
+  end
+
+  def write_inheritable_hash(key, hash)
+    write_inheritable_attribute(key, {}) if read_inheritable_attribute(key).nil?
+    write_inheritable_attribute(key, read_inheritable_attribute(key).merge(hash))
+  end
+
+  def read_inheritable_attribute(key)
+    inheritable_attributes[key]
+  end
+
+  def reset_inheritable_attributes
+    ActiveSupport::Deprecation.warn ClassInheritableAttributes::DEPRECATION_WARNING_MESSAGE
+    @inheritable_attributes = EMPTY_INHERITABLE_ATTRIBUTES
+  end
+
+  private
+    # Prevent this constant from being created multiple times
+    EMPTY_INHERITABLE_ATTRIBUTES = {}.freeze
+
+    def inherited_with_inheritable_attributes(child)
+      inherited_without_inheritable_attributes(child) if respond_to?(:inherited_without_inheritable_attributes)
+
+      if inheritable_attributes.equal?(EMPTY_INHERITABLE_ATTRIBUTES)
+        new_inheritable_attributes = EMPTY_INHERITABLE_ATTRIBUTES
+      else
+        new_inheritable_attributes = Hash[inheritable_attributes.map do |(key, value)|
+          [key, value.duplicable? ? value.dup : value]
+        end]
+      end
+
+      child.instance_variable_set('@inheritable_attributes', new_inheritable_attributes)
+    end
+
+    alias inherited_without_inheritable_attributes inherited
+    alias inherited inherited_with_inheritable_attributes
+end

data/test/abstract_unit.rb

@@ -0,0 +1,64 @@
+ORIG_ARGV = ARGV.dup
+
+begin
+  old, $VERBOSE = $VERBOSE, nil
+  # require File.expand_path('../../../load_paths', __FILE__)
+ensure
+  $VERBOSE = old
+end
+
+lib = File.expand_path("#{File.dirname(__FILE__)}/../lib")
+$:.unshift(lib) unless $:.include?('lib') || $:.include?(lib)
+
+require 'active_support/core_ext/kernel/reporting'
+
+require 'active_support/core_ext/string/encoding'
+if "ruby".encoding_aware?
+  # These are the normal settings that will be set up by Railties
+  # TODO: Have these tests support other combinations of these values
+  silence_warnings do
+    Encoding.default_internal = "UTF-8"
+    Encoding.default_external = "UTF-8"
+  end
+end
+
+require 'test/unit'
+# require 'empty_bool'
+
+silence_warnings { require 'mocha' }
+
+ENV['NO_RELOAD'] = '1'
+require 'active_support'
+
+# Include shims until we get off 1.8.6
+require 'active_support/ruby/shim' if RUBY_VERSION < '1.8.7'
+
+def uses_memcached(test_name)
+  require 'memcache'
+  begin
+    MemCache.new('localhost:11211').stats
+    yield
+  rescue MemCache::MemCacheError
+    $stderr.puts "Skipping #{test_name} tests. Start memcached and try again."
+  end
+end
+
+def with_kcode(code)
+  if RUBY_VERSION < '1.9'
+    begin
+      old_kcode, $KCODE = $KCODE, code
+      yield
+    ensure
+      $KCODE = old_kcode
+    end
+  else
+    yield
+  end
+end
+
+# Show backtraces for deprecated behavior for quicker cleanup.
+ActiveSupport::Deprecation.debug = true
+
+if RUBY_VERSION < '1.9'
+  $KCODE = 'UTF8'
+end

data/test/class_inheritable_attributes_test.rb

@@ -0,0 +1,230 @@
+require './test/abstract_unit'
+require './lib/class_inheritable_attributes'
+
+class ClassInheritableAttributesTest < Test::Unit::TestCase
+  def setup
+    ActiveSupport::Deprecation.silenced = true
+    @klass = Class.new
+  end
+
+  def teardown
+    ActiveSupport::Deprecation.silenced = false
+  end
+
+  def test_reader_declaration
+    assert_nothing_raised do
+      @klass.class_inheritable_reader :a
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+    end
+  end
+
+  def test_writer_declaration
+    assert_nothing_raised do
+      @klass.class_inheritable_writer :a
+      assert_respond_to @klass, :a=
+      assert_respond_to @klass.new, :a=
+    end
+  end
+
+  def test_writer_declaration_without_instance_writer
+    assert_nothing_raised do
+      @klass.class_inheritable_writer :a, :instance_writer => false
+      assert_respond_to @klass, :a=
+      assert !@klass.new.respond_to?(:a=)
+    end
+  end
+
+  def test_accessor_declaration
+    assert_nothing_raised do
+      @klass.class_inheritable_accessor :a
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+      assert_respond_to @klass, :a=
+      assert_respond_to @klass.new, :a=
+    end
+  end
+
+  def test_accessor_declaration_without_instance_writer
+    assert_nothing_raised do
+      @klass.class_inheritable_accessor :a, :instance_writer => false
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+      assert_respond_to @klass, :a=
+      assert !@klass.new.respond_to?(:a=)
+    end
+  end
+
+  def test_array_declaration
+    assert_nothing_raised do
+      @klass.class_inheritable_array :a
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+      assert_respond_to @klass, :a=
+      assert_respond_to @klass.new, :a=
+    end
+  end
+
+  def test_array_declaration_without_instance_writer
+    assert_nothing_raised do
+      @klass.class_inheritable_array :a, :instance_writer => false
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+      assert_respond_to @klass, :a=
+      assert !@klass.new.respond_to?(:a=)
+    end
+  end
+
+  def test_hash_declaration
+    assert_nothing_raised do
+      @klass.class_inheritable_hash :a
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+      assert_respond_to @klass, :a=
+      assert_respond_to @klass.new, :a=
+    end
+  end
+
+  def test_hash_declaration_without_instance_writer
+    assert_nothing_raised do
+      @klass.class_inheritable_hash :a, :instance_writer => false
+      assert_respond_to @klass, :a
+      assert_respond_to @klass.new, :a
+      assert_respond_to @klass, :a=
+      assert !@klass.new.respond_to?(:a=)
+    end
+  end
+
+  def test_reader
+    @klass.class_inheritable_reader :a
+    assert_nil @klass.a
+    assert_nil @klass.new.a
+
+    @klass.send(:write_inheritable_attribute, :a, 'a')
+
+    assert_equal 'a', @klass.a
+    assert_equal 'a', @klass.new.a
+    assert_equal @klass.a, @klass.new.a
+    assert_equal @klass.a.object_id, @klass.new.a.object_id
+  end
+
+  def test_writer
+    @klass.class_inheritable_reader :a
+    @klass.class_inheritable_writer :a
+
+    assert_nil @klass.a
+    assert_nil @klass.new.a
+
+    @klass.a = 'a'
+    assert_equal 'a', @klass.a
+    @klass.new.a = 'A'
+    assert_equal 'A', @klass.a
+  end
+
+  def test_array
+    @klass.class_inheritable_array :a
+
+    assert_nil @klass.a
+    assert_nil @klass.new.a
+
+    @klass.a = %w(a b c)
+    assert_equal %w(a b c), @klass.a
+    assert_equal %w(a b c), @klass.new.a
+
+    @klass.new.a = %w(A B C)
+    assert_equal %w(a b c A B C), @klass.a
+    assert_equal %w(a b c A B C), @klass.new.a
+  end
+
+  def test_hash
+    @klass.class_inheritable_hash :a
+
+    assert_nil @klass.a
+    assert_nil @klass.new.a
+
+    @klass.a = { :a => 'a' }
+    assert_equal({ :a => 'a' }, @klass.a)
+    assert_equal({ :a => 'a' }, @klass.new.a)
+
+    @klass.new.a = { :b => 'b' }
+    assert_equal({ :a => 'a', :b => 'b' }, @klass.a)
+    assert_equal({ :a => 'a', :b => 'b' }, @klass.new.a)
+  end
+
+  def test_inheritance
+    @klass.class_inheritable_accessor :a
+    @klass.a = 'a'
+
+    @sub = eval("class FlogMe < @klass; end; FlogMe")
+
+    @klass.class_inheritable_accessor :b
+
+    assert_respond_to @sub, :a
+    assert_respond_to @sub, :b
+    assert_equal @klass.a, @sub.a
+    assert_equal @klass.b, @sub.b
+    assert_equal 'a', @sub.a
+    assert_nil @sub.b
+
+    @klass.b = 'b'
+    assert_not_equal @klass.b, @sub.b
+    assert_equal 'b', @klass.b
+    assert_nil @sub.b
+
+    @sub.a = 'A'
+    assert_not_equal @klass.a, @sub.a
+    assert_equal 'a', @klass.a
+    assert_equal 'A', @sub.a
+
+    @sub.b = 'B'
+    assert_not_equal @klass.b, @sub.b
+    assert_equal 'b', @klass.b
+    assert_equal 'B', @sub.b
+  end
+
+  def test_array_inheritance
+    @klass.class_inheritable_accessor :a
+    @klass.a = []
+
+    @sub = eval("class SubbyArray < @klass; end; SubbyArray")
+
+    assert_equal [], @klass.a
+    assert_equal [], @sub.a
+
+    @sub.a << :first
+
+    assert_equal [:first], @sub.a
+    assert_equal [], @klass.a
+  end
+
+  def test_array_inheritance_
+    @klass.class_inheritable_accessor :a
+    @klass.a = {}
+
+    @sub = eval("class SubbyHash < @klass; end; SubbyHash")
+
+    assert_equal Hash.new, @klass.a
+    assert_equal Hash.new, @sub.a
+
+    @sub.a[:first] = :first
+
+    assert_equal 1, @sub.a.keys.size
+    assert_equal 0, @klass.a.keys.size
+  end
+
+  def test_reset_inheritable_attributes
+    @klass.class_inheritable_accessor :a
+    @klass.a = 'a'
+
+    @sub = eval("class Inheriting < @klass; end; Inheriting")
+
+    assert_equal 'a', @klass.a
+    assert_equal 'a', @sub.a
+
+    @klass.reset_inheritable_attributes
+    @sub = eval("class NotInheriting < @klass; end; NotInheriting")
+
+    assert_nil @klass.a
+    assert_nil @sub.a
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: class_inheritable_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Burke Libbey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies: []
+description: Forward-port of deprectaed ClassInheritableAttributes functionality removed
+  in rails 3.2
+email:
+- burke@burkelibbey.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- class_inheritable_attributes.gemspec
+- lib/class_inheritable_attributes.rb
+- lib/class_inheritable_attributes/version.rb
+- test/abstract_unit.rb
+- test/class_inheritable_attributes_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Forward-port of deprectaed ClassInheritableAttributes functionality removed
+  in rails 3.2.
+test_files:
+- test/abstract_unit.rb
+- test/class_inheritable_attributes_test.rb