Namespace Extlib versions of class_inheritable_accessor methods with extlib_prefix, as done in Wycats' Rails fork, so that their inclusion won't overwrite existing ActiveSupport implementations, if present. Check for existence of Class extensions on a per-method basis.
This commit is contained in:
parent
de0476b083
commit
a1a4985149
|
@ -5,10 +5,10 @@ module CouchRest
|
||||||
include CouchRest::Mixins::Attachments
|
include CouchRest::Mixins::Attachments
|
||||||
|
|
||||||
# def self.inherited(subklass)
|
# def self.inherited(subklass)
|
||||||
# subklass.send(:class_inheritable_accessor, :database)
|
# subklass.send(:extlib_inheritable_accessor, :database)
|
||||||
# end
|
# end
|
||||||
|
|
||||||
class_inheritable_accessor :database
|
extlib_inheritable_accessor :database
|
||||||
attr_accessor :database
|
attr_accessor :database
|
||||||
|
|
||||||
# override the CouchRest::Model-wide default_database
|
# override the CouchRest::Model-wide default_database
|
||||||
|
|
|
@ -426,10 +426,10 @@ module CouchRest
|
||||||
def define_callbacks(*symbols)
|
def define_callbacks(*symbols)
|
||||||
terminator = symbols.pop if symbols.last.is_a?(String)
|
terminator = symbols.pop if symbols.last.is_a?(String)
|
||||||
symbols.each do |symbol|
|
symbols.each do |symbol|
|
||||||
self.class_inheritable_accessor("_#{symbol}_terminator")
|
self.extlib_inheritable_accessor("_#{symbol}_terminator")
|
||||||
self.send("_#{symbol}_terminator=", terminator)
|
self.send("_#{symbol}_terminator=", terminator)
|
||||||
self.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
|
self.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
|
||||||
class_inheritable_accessor :_#{symbol}_callbacks
|
extlib_inheritable_accessor :_#{symbol}_callbacks
|
||||||
self._#{symbol}_callbacks = CallbackChain.new(:#{symbol})
|
self._#{symbol}_callbacks = CallbackChain.new(:#{symbol})
|
||||||
|
|
||||||
def self.#{symbol}_callback(*filters, &blk)
|
def self.#{symbol}_callback(*filters, &blk)
|
||||||
|
|
|
@ -4,9 +4,9 @@ module CouchRest
|
||||||
|
|
||||||
def self.included(base)
|
def self.included(base)
|
||||||
base.extend(ClassMethods)
|
base.extend(ClassMethods)
|
||||||
base.send(:class_inheritable_accessor, :design_doc)
|
base.send(:extlib_inheritable_accessor, :design_doc)
|
||||||
base.send(:class_inheritable_accessor, :design_doc_slug_cache)
|
base.send(:extlib_inheritable_accessor, :design_doc_slug_cache)
|
||||||
base.send(:class_inheritable_accessor, :design_doc_fresh)
|
base.send(:extlib_inheritable_accessor, :design_doc_fresh)
|
||||||
end
|
end
|
||||||
|
|
||||||
module ClassMethods
|
module ClassMethods
|
||||||
|
|
|
@ -25,19 +25,7 @@
|
||||||
# example, an array without those additions being shared with either their
|
# example, an array without those additions being shared with either their
|
||||||
# parent, siblings, or children, which is unlike the regular class-level
|
# parent, siblings, or children, which is unlike the regular class-level
|
||||||
# attributes that are shared across the entire hierarchy.
|
# attributes that are shared across the entire hierarchy.
|
||||||
module CouchRest
|
class Class
|
||||||
module ClassExtension
|
|
||||||
def self.included(base)
|
|
||||||
if CouchRest::ClassExtension::InstanceMethods.instance_methods.all? {|m| base.respond_to?(m)}
|
|
||||||
# do nothing
|
|
||||||
elsif CouchRest::ClassExtension::InstanceMethods.instance_methods.any? {|m| base.respond_to?(m)}
|
|
||||||
raise RuntimeError, "Conflicting extentions to Class, work it out"
|
|
||||||
else
|
|
||||||
base.send(:include, CouchRest::ClassExtension::InstanceMethods)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
module InstanceMethods
|
|
||||||
# Defines class-level and instance-level attribute reader.
|
# Defines class-level and instance-level attribute reader.
|
||||||
#
|
#
|
||||||
# @param *syms<Array> Array of attributes to define reader for.
|
# @param *syms<Array> Array of attributes to define reader for.
|
||||||
|
@ -64,7 +52,7 @@ module CouchRest
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
end
|
end
|
||||||
end
|
end unless Class.respond_to?(:cattr_reader)
|
||||||
|
|
||||||
# Defines class-level (and optionally instance-level) attribute writer.
|
# Defines class-level (and optionally instance-level) attribute writer.
|
||||||
#
|
#
|
||||||
|
@ -94,7 +82,7 @@ module CouchRest
|
||||||
RUBY
|
RUBY
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end unless Class.respond_to?(:cattr_writer)
|
||||||
|
|
||||||
# Defines class-level (and optionally instance-level) attribute accessor.
|
# Defines class-level (and optionally instance-level) attribute accessor.
|
||||||
#
|
#
|
||||||
|
@ -106,7 +94,7 @@ module CouchRest
|
||||||
def cattr_accessor(*syms)
|
def cattr_accessor(*syms)
|
||||||
cattr_reader(*syms)
|
cattr_reader(*syms)
|
||||||
cattr_writer(*syms)
|
cattr_writer(*syms)
|
||||||
end
|
end unless Class.respond_to?(:cattr_accessor)
|
||||||
|
|
||||||
# Defines class-level inheritable attribute reader. Attributes are available to subclasses,
|
# Defines class-level inheritable attribute reader. Attributes are available to subclasses,
|
||||||
# each subclass has a copy of parent's attribute.
|
# each subclass has a copy of parent's attribute.
|
||||||
|
@ -121,7 +109,7 @@ module CouchRest
|
||||||
# (error out or do the same as other methods above) instead of silently
|
# (error out or do the same as other methods above) instead of silently
|
||||||
# moving on). In particular, this makes the return value of this function
|
# moving on). In particular, this makes the return value of this function
|
||||||
# less useful.
|
# less useful.
|
||||||
def class_inheritable_reader(*ivars)
|
def extlib_inheritable_reader(*ivars)
|
||||||
instance_reader = ivars.pop[:reader] if ivars.last.is_a?(Hash)
|
instance_reader = ivars.pop[:reader] if ivars.last.is_a?(Hash)
|
||||||
|
|
||||||
ivars.each do |ivar|
|
ivars.each do |ivar|
|
||||||
|
@ -130,7 +118,7 @@ module CouchRest
|
||||||
return @#{ivar} if self.object_id == #{self.object_id} || defined?(@#{ivar})
|
return @#{ivar} if self.object_id == #{self.object_id} || defined?(@#{ivar})
|
||||||
ivar = superclass.#{ivar}
|
ivar = superclass.#{ivar}
|
||||||
return nil if ivar.nil? && !#{self}.instance_variable_defined?("@#{ivar}")
|
return nil if ivar.nil? && !#{self}.instance_variable_defined?("@#{ivar}")
|
||||||
@#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) && !ivar.is_a?(TrueClass) && !ivar.is_a?(FalseClass) && !ivar.is_a?(Symbol) ? ivar.dup : ivar
|
@#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) && !ivar.is_a?(TrueClass) && !ivar.is_a?(FalseClass) ? ivar.dup : ivar
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
unless instance_reader == false
|
unless instance_reader == false
|
||||||
|
@ -141,7 +129,7 @@ module CouchRest
|
||||||
RUBY
|
RUBY
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end unless Class.respond_to?(:extlib_inheritable_reader)
|
||||||
|
|
||||||
# Defines class-level inheritable attribute writer. Attributes are available to subclasses,
|
# Defines class-level inheritable attribute writer. Attributes are available to subclasses,
|
||||||
# each subclass has a copy of parent's attribute.
|
# each subclass has a copy of parent's attribute.
|
||||||
|
@ -155,8 +143,8 @@ module CouchRest
|
||||||
#
|
#
|
||||||
# @todo We need a style for class_eval <<-HEREDOC. I'd like to make it
|
# @todo We need a style for class_eval <<-HEREDOC. I'd like to make it
|
||||||
# class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.
|
# class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.
|
||||||
def class_inheritable_writer(*ivars)
|
def extlib_inheritable_writer(*ivars)
|
||||||
instance_writer = ivars.pop[:instance_writer] if ivars.last.is_a?(Hash)
|
instance_writer = ivars.pop[:writer] if ivars.last.is_a?(Hash)
|
||||||
ivars.each do |ivar|
|
ivars.each do |ivar|
|
||||||
self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
|
self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
|
||||||
def self.#{ivar}=(obj)
|
def self.#{ivar}=(obj)
|
||||||
|
@ -169,7 +157,7 @@ module CouchRest
|
||||||
RUBY
|
RUBY
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end unless Class.respond_to?(:extlib_inheritable_writer)
|
||||||
|
|
||||||
# Defines class-level inheritable attribute accessor. Attributes are available to subclasses,
|
# Defines class-level inheritable attribute accessor. Attributes are available to subclasses,
|
||||||
# each subclass has a copy of parent's attribute.
|
# each subclass has a copy of parent's attribute.
|
||||||
|
@ -180,12 +168,9 @@ module CouchRest
|
||||||
# @return <Array[#to_s]> An Array of attributes turned into inheritable accessors.
|
# @return <Array[#to_s]> An Array of attributes turned into inheritable accessors.
|
||||||
#
|
#
|
||||||
# @api public
|
# @api public
|
||||||
def class_inheritable_accessor(*syms)
|
def extlib_inheritable_accessor(*syms)
|
||||||
class_inheritable_reader(*syms)
|
extlib_inheritable_reader(*syms)
|
||||||
class_inheritable_writer(*syms)
|
extlib_inheritable_writer(*syms)
|
||||||
end
|
end unless Class.respond_to?(:extlib_inheritable_accessor)
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
Class.send(:include, CouchRest::ClassExtension)
|
|
||||||
|
|
|
@ -1,59 +0,0 @@
|
||||||
require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
|
|
||||||
require File.join(File.dirname(__FILE__), '..', '..', '..', 'lib', 'couchrest', 'support', 'class')
|
|
||||||
|
|
||||||
describe CouchRest::ClassExtension do
|
|
||||||
|
|
||||||
before :all do
|
|
||||||
class FullyDefinedClassExtensions
|
|
||||||
def self.respond_to?(method)
|
|
||||||
if CouchRest::ClassExtension::InstanceMethods.instance_methods.include?(method)
|
|
||||||
true
|
|
||||||
else
|
|
||||||
super
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
class PartDefinedClassExtensions
|
|
||||||
def self.respond_to?(method)
|
|
||||||
methods = CouchRest::ClassExtension::InstanceMethods.instance_methods
|
|
||||||
methods.delete('cattr_reader')
|
|
||||||
|
|
||||||
if methods.include?(method)
|
|
||||||
false
|
|
||||||
else
|
|
||||||
super
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
class NoClassExtensions
|
|
||||||
def self.respond_to?(method)
|
|
||||||
if CouchRest::ClassExtension::InstanceMethods.instance_methods.include?(method)
|
|
||||||
false
|
|
||||||
else
|
|
||||||
super
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
it "should not include InstanceMethods if the class extensions are already defined" do
|
|
||||||
FullyDefinedClassExtensions.send(:include, CouchRest::ClassExtension)
|
|
||||||
FullyDefinedClassExtensions.ancestors.should_not include(CouchRest::ClassExtension::InstanceMethods)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "should raise RuntimeError if the class extensions are only partially defined" do
|
|
||||||
lambda {
|
|
||||||
PartDefinedClassExtensions.send(:include, CouchRest::ClassExtension)
|
|
||||||
}.should raise_error(RuntimeError)
|
|
||||||
end
|
|
||||||
|
|
||||||
it "should include class extensions if they are not already defined" do
|
|
||||||
NoClassExtensions.send(:include, CouchRest::ClassExtension)
|
|
||||||
NoClassExtensions.ancestors.should include(CouchRest::ClassExtension::InstanceMethods)
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
Loading…
Reference in a new issue