mirror of
https://github.com/github/rails.git
synced 2026-04-26 03:00:59 -04:00
Move some core extension methods into a module under the ActiveSupport::CoreExtensions namespace, instead of extending core classes directly. This is more friendly for API reference generators.
[#915 state:resolved] Signed-off-by: Jeremy Kemper <jeremy@bitsweat.net>
This commit is contained in:
Hongli Lai (Phusion)
committed by
Jeremy Kemper
Jeremy Kemper
parent
7f179f8540
commit
204a8cce88
@@ -8,6 +8,15 @@ require 'active_support/core_ext/module/loading'
|
||||
require 'active_support/core_ext/module/aliasing'
|
||||
require 'active_support/core_ext/module/model_naming'
|
||||
|
||||
class Module
|
||||
include ActiveSupport::CoreExt::Module::ModelNaming
|
||||
module ActiveSupport
|
||||
module CoreExtensions
|
||||
# Various extensions for the Ruby core Module class.
|
||||
module Module
|
||||
# Nothing here. Only defined for API documentation purposes.
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
class Module
|
||||
include ActiveSupport::CoreExtensions::Module
|
||||
end
|
||||
|
||||
@@ -1,70 +1,74 @@
|
||||
class Module
|
||||
# Encapsulates the common pattern of:
|
||||
#
|
||||
# alias_method :foo_without_feature, :foo
|
||||
# alias_method :foo, :foo_with_feature
|
||||
#
|
||||
# With this, you simply do:
|
||||
#
|
||||
# alias_method_chain :foo, :feature
|
||||
#
|
||||
# And both aliases are set up for you.
|
||||
#
|
||||
# Query and bang methods (foo?, foo!) keep the same punctuation:
|
||||
#
|
||||
# alias_method_chain :foo?, :feature
|
||||
#
|
||||
# is equivalent to
|
||||
#
|
||||
# alias_method :foo_without_feature?, :foo?
|
||||
# alias_method :foo?, :foo_with_feature?
|
||||
#
|
||||
# so you can safely chain foo, foo?, and foo! with the same feature.
|
||||
def alias_method_chain(target, feature)
|
||||
# Strip out punctuation on predicates or bang methods since
|
||||
# e.g. target?_without_feature is not a valid method name.
|
||||
aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
|
||||
yield(aliased_target, punctuation) if block_given?
|
||||
|
||||
with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
|
||||
|
||||
alias_method without_method, target
|
||||
alias_method target, with_method
|
||||
|
||||
case
|
||||
when public_method_defined?(without_method)
|
||||
public target
|
||||
when protected_method_defined?(without_method)
|
||||
protected target
|
||||
when private_method_defined?(without_method)
|
||||
private target
|
||||
module ActiveSupport
|
||||
module CoreExtensions
|
||||
module Module
|
||||
# Encapsulates the common pattern of:
|
||||
#
|
||||
# alias_method :foo_without_feature, :foo
|
||||
# alias_method :foo, :foo_with_feature
|
||||
#
|
||||
# With this, you simply do:
|
||||
#
|
||||
# alias_method_chain :foo, :feature
|
||||
#
|
||||
# And both aliases are set up for you.
|
||||
#
|
||||
# Query and bang methods (foo?, foo!) keep the same punctuation:
|
||||
#
|
||||
# alias_method_chain :foo?, :feature
|
||||
#
|
||||
# is equivalent to
|
||||
#
|
||||
# alias_method :foo_without_feature?, :foo?
|
||||
# alias_method :foo?, :foo_with_feature?
|
||||
#
|
||||
# so you can safely chain foo, foo?, and foo! with the same feature.
|
||||
def alias_method_chain(target, feature)
|
||||
# Strip out punctuation on predicates or bang methods since
|
||||
# e.g. target?_without_feature is not a valid method name.
|
||||
aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
|
||||
yield(aliased_target, punctuation) if block_given?
|
||||
|
||||
with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
|
||||
|
||||
alias_method without_method, target
|
||||
alias_method target, with_method
|
||||
|
||||
case
|
||||
when public_method_defined?(without_method)
|
||||
public target
|
||||
when protected_method_defined?(without_method)
|
||||
protected target
|
||||
when private_method_defined?(without_method)
|
||||
private target
|
||||
end
|
||||
end
|
||||
|
||||
# Allows you to make aliases for attributes, which includes
|
||||
# getter, setter, and query methods.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# class Content < ActiveRecord::Base
|
||||
# # has a title attribute
|
||||
# end
|
||||
#
|
||||
# class Email < Content
|
||||
# alias_attribute :subject, :title
|
||||
# end
|
||||
#
|
||||
# e = Email.find(1)
|
||||
# e.title # => "Superstars"
|
||||
# e.subject # => "Superstars"
|
||||
# e.subject? # => true
|
||||
# e.subject = "Megastars"
|
||||
# e.title # => "Megastars"
|
||||
def alias_attribute(new_name, old_name)
|
||||
module_eval <<-STR, __FILE__, __LINE__+1
|
||||
def #{new_name}; self.#{old_name}; end
|
||||
def #{new_name}?; self.#{old_name}?; end
|
||||
def #{new_name}=(v); self.#{old_name} = v; end
|
||||
STR
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Allows you to make aliases for attributes, which includes
|
||||
# getter, setter, and query methods.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# class Content < ActiveRecord::Base
|
||||
# # has a title attribute
|
||||
# end
|
||||
#
|
||||
# class Email < Content
|
||||
# alias_attribute :subject, :title
|
||||
# end
|
||||
#
|
||||
# e = Email.find(1)
|
||||
# e.title # => "Superstars"
|
||||
# e.subject # => "Superstars"
|
||||
# e.subject? # => true
|
||||
# e.subject = "Megastars"
|
||||
# e.title # => "Megastars"
|
||||
def alias_attribute(new_name, old_name)
|
||||
module_eval <<-STR, __FILE__, __LINE__+1
|
||||
def #{new_name}; self.#{old_name}; end
|
||||
def #{new_name}?; self.#{old_name}?; end
|
||||
def #{new_name}=(v); self.#{old_name} = v; end
|
||||
STR
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,86 +1,90 @@
|
||||
class Module
|
||||
# Returns the name of the module containing this one.
|
||||
#
|
||||
# p M::N.parent_name # => "M"
|
||||
def parent_name
|
||||
unless defined? @parent_name
|
||||
@parent_name = name =~ /::[^:]+\Z/ ? $`.freeze : nil
|
||||
end
|
||||
@parent_name
|
||||
end
|
||||
|
||||
# Returns the module which contains this one according to its name.
|
||||
#
|
||||
# module M
|
||||
# module N
|
||||
# end
|
||||
# end
|
||||
# X = M::N
|
||||
#
|
||||
# p M::N.parent # => M
|
||||
# p X.parent # => M
|
||||
#
|
||||
# The parent of top-level and anonymous modules is Object.
|
||||
#
|
||||
# p M.parent # => Object
|
||||
# p Module.new.parent # => Object
|
||||
#
|
||||
def parent
|
||||
parent_name ? parent_name.constantize : Object
|
||||
end
|
||||
|
||||
# Returns all the parents of this module according to its name, ordered from
|
||||
# nested outwards. The receiver is not contained within the result.
|
||||
#
|
||||
# module M
|
||||
# module N
|
||||
# end
|
||||
# end
|
||||
# X = M::N
|
||||
#
|
||||
# p M.parents # => [Object]
|
||||
# p M::N.parents # => [M, Object]
|
||||
# p X.parents # => [M, Object]
|
||||
#
|
||||
def parents
|
||||
parents = []
|
||||
if parent_name
|
||||
parts = parent_name.split('::')
|
||||
until parts.empty?
|
||||
parents << (parts * '::').constantize
|
||||
parts.pop
|
||||
end
|
||||
end
|
||||
parents << Object unless parents.include? Object
|
||||
parents
|
||||
end
|
||||
|
||||
if RUBY_VERSION < '1.9'
|
||||
# Returns the constants that have been defined locally by this object and
|
||||
# not in an ancestor. This method is exact if running under Ruby 1.9. In
|
||||
# previous versions it may miss some constants if their definition in some
|
||||
# ancestor is identical to their definition in the receiver.
|
||||
def local_constants
|
||||
inherited = {}
|
||||
|
||||
ancestors.each do |anc|
|
||||
next if anc == self
|
||||
anc.constants.each { |const| inherited[const] = anc.const_get(const) }
|
||||
module ActiveSupport
|
||||
module CoreExtensions
|
||||
module Module
|
||||
# Returns the name of the module containing this one.
|
||||
#
|
||||
# p M::N.parent_name # => "M"
|
||||
def parent_name
|
||||
unless defined? @parent_name
|
||||
@parent_name = name =~ /::[^:]+\Z/ ? $`.freeze : nil
|
||||
end
|
||||
@parent_name
|
||||
end
|
||||
|
||||
constants.select do |const|
|
||||
!inherited.key?(const) || inherited[const].object_id != const_get(const).object_id
|
||||
# Returns the module which contains this one according to its name.
|
||||
#
|
||||
# module M
|
||||
# module N
|
||||
# end
|
||||
# end
|
||||
# X = M::N
|
||||
#
|
||||
# p M::N.parent # => M
|
||||
# p X.parent # => M
|
||||
#
|
||||
# The parent of top-level and anonymous modules is Object.
|
||||
#
|
||||
# p M.parent # => Object
|
||||
# p Module.new.parent # => Object
|
||||
#
|
||||
def parent
|
||||
parent_name ? parent_name.constantize : Object
|
||||
end
|
||||
|
||||
# Returns all the parents of this module according to its name, ordered from
|
||||
# nested outwards. The receiver is not contained within the result.
|
||||
#
|
||||
# module M
|
||||
# module N
|
||||
# end
|
||||
# end
|
||||
# X = M::N
|
||||
#
|
||||
# p M.parents # => [Object]
|
||||
# p M::N.parents # => [M, Object]
|
||||
# p X.parents # => [M, Object]
|
||||
#
|
||||
def parents
|
||||
parents = []
|
||||
if parent_name
|
||||
parts = parent_name.split('::')
|
||||
until parts.empty?
|
||||
parents << (parts * '::').constantize
|
||||
parts.pop
|
||||
end
|
||||
end
|
||||
parents << Object unless parents.include? Object
|
||||
parents
|
||||
end
|
||||
|
||||
if RUBY_VERSION < '1.9'
|
||||
# Returns the constants that have been defined locally by this object and
|
||||
# not in an ancestor. This method is exact if running under Ruby 1.9. In
|
||||
# previous versions it may miss some constants if their definition in some
|
||||
# ancestor is identical to their definition in the receiver.
|
||||
def local_constants
|
||||
inherited = {}
|
||||
|
||||
ancestors.each do |anc|
|
||||
next if anc == self
|
||||
anc.constants.each { |const| inherited[const] = anc.const_get(const) }
|
||||
end
|
||||
|
||||
constants.select do |const|
|
||||
!inherited.key?(const) || inherited[const].object_id != const_get(const).object_id
|
||||
end
|
||||
end
|
||||
else
|
||||
def local_constants #:nodoc:
|
||||
constants(false)
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the names of the constants defined locally rather than the
|
||||
# constants themselves. See <tt>local_constants</tt>.
|
||||
def local_constant_names
|
||||
local_constants.map { |c| c.to_s }
|
||||
end
|
||||
end
|
||||
else
|
||||
def local_constants #:nodoc:
|
||||
constants(false)
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the names of the constants defined locally rather than the
|
||||
# constants themselves. See <tt>local_constants</tt>.
|
||||
def local_constant_names
|
||||
local_constants.map { |c| c.to_s }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -11,12 +11,12 @@ module ActiveSupport
|
||||
end
|
||||
end
|
||||
|
||||
module CoreExt
|
||||
module CoreExtensions
|
||||
module Module
|
||||
module ModelNaming
|
||||
def model_name
|
||||
@model_name ||= ModelName.new(name)
|
||||
end
|
||||
# Returns an ActiveSupport::ModelName object for module. It can be
|
||||
# used to retrieve all kinds of naming-related information.
|
||||
def model_name
|
||||
@model_name ||= ModelName.new(name)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user