From 5e85a1c7f835249d276d6868a9520f803be46159 Mon Sep 17 00:00:00 2001
From: Rick Olson <technoweenie@gmail.com>
Date: Sun, 28 Jan 2007 01:18:51 +0000
Subject: Added :instance_writer option to #mattr_writer/accessor,
 #cattr_writer/accessor, and #class_inheritable_writer to skip the creation of
 the instance writer.  [Rick]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6050 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
---
 activesupport/CHANGELOG                            |   2 +
 .../core_ext/class/attribute_accessors.rb          |   4 +
 .../core_ext/class/inheritable_attributes.rb       |  10 +
 .../core_ext/module/attribute_accessors.rb         |   6 +-
 .../test/class_inheritable_attributes_test.rb      | 170 -----------------
 .../test/core_ext/class/attribute_accessor_test.rb |  31 +++
 .../class/class_inheritable_attributes_test.rb     | 208 +++++++++++++++++++++
 .../core_ext/module/attr_accessor_with_default.rb  |  30 +++
 .../core_ext/module/attribute_accessor_test.rb     |  33 ++++
 9 files changed, 323 insertions(+), 171 deletions(-)
 delete mode 100644 activesupport/test/class_inheritable_attributes_test.rb
 create mode 100644 activesupport/test/core_ext/class/attribute_accessor_test.rb
 create mode 100644 activesupport/test/core_ext/class/class_inheritable_attributes_test.rb
 create mode 100644 activesupport/test/core_ext/module/attr_accessor_with_default.rb
 create mode 100644 activesupport/test/core_ext/module/attribute_accessor_test.rb

(limited to 'activesupport')

diff --git a/activesupport/CHANGELOG b/activesupport/CHANGELOG
index 265dd53297..5c0e062403 100644
--- a/activesupport/CHANGELOG
+++ b/activesupport/CHANGELOG
@@ -1,5 +1,7 @@
 *SVN*
 
+* Added :instance_writer option to #mattr_writer/accessor, #cattr_writer/accessor, and #class_inheritable_writer to skip the creation of the instance writer.  [Rick]
+
 * Added Hash#to_query to turn a hash of values into a form-encoded query string [Nicholas Seckar]
 
 * Increase test coverage for subclasses_of. Closes #7335. [Roman2K, Nicholas Seckar]
diff --git a/activesupport/lib/active_support/core_ext/class/attribute_accessors.rb b/activesupport/lib/active_support/core_ext/class/attribute_accessors.rb
index 93a7d48f69..79247e00cb 100644
--- a/activesupport/lib/active_support/core_ext/class/attribute_accessors.rb
+++ b/activesupport/lib/active_support/core_ext/class/attribute_accessors.rb
@@ -3,6 +3,7 @@
 class Class # :nodoc:
   def cattr_reader(*syms)
     syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
       class_eval(<<-EOS, __FILE__, __LINE__)
         unless defined? @@#{sym}
           @@#{sym} = nil
@@ -20,6 +21,7 @@ class Class # :nodoc:
   end
 
   def cattr_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
     syms.flatten.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__)
         unless defined? @@#{sym}
@@ -30,9 +32,11 @@ class Class # :nodoc:
           @@#{sym} = obj
         end
 
+        #{"
         def #{sym}=(obj)
           @@#{sym} = obj
         end
+        " unless options[:instance_writer] == false }
       EOS
     end
   end
diff --git a/activesupport/lib/active_support/core_ext/class/inheritable_attributes.rb b/activesupport/lib/active_support/core_ext/class/inheritable_attributes.rb
index bc8bf09ab2..3c5b2b8340 100644
--- a/activesupport/lib/active_support/core_ext/class/inheritable_attributes.rb
+++ b/activesupport/lib/active_support/core_ext/class/inheritable_attributes.rb
@@ -9,6 +9,7 @@ end
 class Class # :nodoc:
   def class_inheritable_reader(*syms)
     syms.each do |sym|
+      next if sym.is_a?(Hash)
       class_eval <<-EOS
         def self.#{sym}
           read_inheritable_attribute(:#{sym})
@@ -22,43 +23,52 @@ class Class # :nodoc:
   end
 
   def class_inheritable_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
     syms.each do |sym|
       class_eval <<-EOS
         def self.#{sym}=(obj)
           write_inheritable_attribute(:#{sym}, obj)
         end
 
+        #{"
         def #{sym}=(obj)
           self.class.#{sym} = obj
         end
+        " unless options[:instance_writer] == false }
       EOS
     end
   end
 
   def class_inheritable_array_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
     syms.each do |sym|
       class_eval <<-EOS
         def self.#{sym}=(obj)
           write_inheritable_array(:#{sym}, obj)
         end
 
+        #{"
         def #{sym}=(obj)
           self.class.#{sym} = obj
         end
+        " unless options[:instance_writer] == false }
       EOS
     end
   end
 
   def class_inheritable_hash_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
     syms.each do |sym|
       class_eval <<-EOS
         def self.#{sym}=(obj)
           write_inheritable_hash(:#{sym}, obj)
         end
 
+        #{"
         def #{sym}=(obj)
           self.class.#{sym} = obj
         end
+        " unless options[:instance_writer] == false }
       EOS
     end
   end
diff --git a/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb b/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
index fe4f8a4fc0..8127150a96 100644
--- a/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
+++ b/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
@@ -3,6 +3,7 @@
 class Module # :nodoc:
   def mattr_reader(*syms)
     syms.each do |sym|
+      next if sym.is_a?(Hash)
       class_eval(<<-EOS, __FILE__, __LINE__)
         unless defined? @@#{sym}
           @@#{sym} = nil
@@ -20,6 +21,7 @@ class Module # :nodoc:
   end
   
   def mattr_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
     syms.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__)
         unless defined? @@#{sym}
@@ -29,10 +31,12 @@ class Module # :nodoc:
         def self.#{sym}=(obj)
           @@#{sym} = obj
         end
-
+        
+        #{"
         def #{sym}=(obj)
           @@#{sym} = obj
         end
+        " unless options[:instance_writer] == false }
       EOS
     end
   end
diff --git a/activesupport/test/class_inheritable_attributes_test.rb b/activesupport/test/class_inheritable_attributes_test.rb
deleted file mode 100644
index f3c09f0516..0000000000
--- a/activesupport/test/class_inheritable_attributes_test.rb
+++ /dev/null
@@ -1,170 +0,0 @@
-require File.dirname(__FILE__) + '/abstract_unit'
-
-class ClassInheritableAttributesTest < Test::Unit::TestCase
-  def setup
-    @klass = Class.new
-  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_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_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_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_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
-end
diff --git a/activesupport/test/core_ext/class/attribute_accessor_test.rb b/activesupport/test/core_ext/class/attribute_accessor_test.rb
new file mode 100644
index 0000000000..8104c9ce88
--- /dev/null
+++ b/activesupport/test/core_ext/class/attribute_accessor_test.rb
@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../../abstract_unit'
+
+class ClassAttributeAccessorTest < Test::Unit::TestCase
+  def setup
+    @class = Class.new do
+      cattr_accessor :foo
+      cattr_accessor :bar, :instance_writer => false
+    end
+    @object = @class.new
+  end
+  
+  def test_should_use_mattr_default
+    assert_nil @class.foo
+    assert_nil @object.foo
+  end
+  
+  def test_should_set_mattr_value
+    @class.foo = :test
+    assert_equal :test, @object.foo
+  
+    @object.foo = :test2
+    assert_equal :test2, @class.foo
+  end
+  
+  def test_should_not_create_instance_writer
+    assert @class.respond_to?(:foo)
+    assert @class.respond_to?(:foo=)
+    assert @object.respond_to?(:bar)
+    assert !@object.respond_to?(:bar=)
+  end
+end
\ No newline at end of file
diff --git a/activesupport/test/core_ext/class/class_inheritable_attributes_test.rb b/activesupport/test/core_ext/class/class_inheritable_attributes_test.rb
new file mode 100644
index 0000000000..8b11e680af
--- /dev/null
+++ b/activesupport/test/core_ext/class/class_inheritable_attributes_test.rb
@@ -0,0 +1,208 @@
+require File.dirname(__FILE__) + '/../../abstract_unit'
+
+class ClassInheritableAttributesTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new
+  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
+end
diff --git a/activesupport/test/core_ext/module/attr_accessor_with_default.rb b/activesupport/test/core_ext/module/attr_accessor_with_default.rb
new file mode 100644
index 0000000000..8ae52ad17a
--- /dev/null
+++ b/activesupport/test/core_ext/module/attr_accessor_with_default.rb
@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../abstract_unit'
+
+class AttrWithDefaultTest < Test::Unit::TestCase
+  def setup
+    @target = Class.new do
+      def helper
+        'helper'
+      end
+    end  
+    @instance = @target.new
+  end
+  
+  def test_default_arg
+    @target.attr_accessor_with_default :foo, :bar
+    assert_equal(:bar, @instance.foo)
+    @instance.foo = nil
+    assert_nil(@instance.foo)
+  end
+  
+  def test_default_proc
+    @target.attr_accessor_with_default(:foo) {helper.upcase}
+    assert_equal('HELPER', @instance.foo)
+    @instance.foo = nil
+    assert_nil(@instance.foo)
+  end
+  
+  def test_invalid_args
+    assert_raise(RuntimeError) {@target.attr_accessor_with_default :foo}
+  end
+end
\ No newline at end of file
diff --git a/activesupport/test/core_ext/module/attribute_accessor_test.rb b/activesupport/test/core_ext/module/attribute_accessor_test.rb
new file mode 100644
index 0000000000..c3f6575f84
--- /dev/null
+++ b/activesupport/test/core_ext/module/attribute_accessor_test.rb
@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../../abstract_unit'
+
+class ModuleAttributeAccessorTest < Test::Unit::TestCase
+  def setup
+    @module = Module.new do
+      mattr_accessor :foo
+      mattr_accessor :bar, :instance_writer => false
+    end
+    @class = Class.new
+    @class.send :include, @module
+    @object = @class.new
+  end
+  
+  def test_should_use_mattr_default
+    assert_nil @module.foo
+    assert_nil @object.foo
+  end
+  
+  def test_should_set_mattr_value
+    @module.foo = :test
+    assert_equal :test, @object.foo
+  
+    @object.foo = :test2
+    assert_equal :test2, @module.foo
+  end
+  
+  def test_should_not_create_instance_writer
+    assert @module.respond_to?(:foo)
+    assert @module.respond_to?(:foo=)
+    assert @object.respond_to?(:bar)
+    assert !@object.respond_to?(:bar=)
+  end
+end
\ No newline at end of file
-- 
cgit v1.2.3