Skip to content

Commit

Permalink
adds inline docs for dynamically created methods in Active Support
Browse files Browse the repository at this point in the history
  • Loading branch information
@fxn
fxn committed Dec 27, 2008
1 parent 711512a commit 8cabcbd
Show file tree
Hide file tree
Showing 9 changed files with 157 additions and 157 deletions.
14 changes: 7 additions & 7 deletions activesupport/lib/active_support/buffered_logger.rb
View file
Expand Up @@ -68,13 +68,13 @@ def add(severity, message = nil, progname = nil, &block)


for severity in Severity.constants for severity in Severity.constants
class_eval <<-EOT, __FILE__, __LINE__ class_eval <<-EOT, __FILE__, __LINE__
def #{severity.downcase}(message = nil, progname = nil, &block) def #{severity.downcase}(message = nil, progname = nil, &block) # def debug(message = nil, progname = nil, &block)
add(#{severity}, message, progname, &block) add(#{severity}, message, progname, &block) # add(DEBUG, message, progname, &block)
end end # end
#
def #{severity.downcase}? def #{severity.downcase}? # def debug?
#{severity} >= @level #{severity} >= @level # DEBUG >= @level
end end # end
EOT EOT
end end


Expand Down
28 changes: 14 additions & 14 deletions activesupport/lib/active_support/callbacks.rb
View file
Expand Up @@ -210,20 +210,20 @@ module ClassMethods
def define_callbacks(*callbacks) def define_callbacks(*callbacks)
callbacks.each do |callback| callbacks.each do |callback|
class_eval <<-"end_eval" class_eval <<-"end_eval"
def self.#{callback}(*methods, &block) def self.#{callback}(*methods, &block) # def self.before_save(*methods, &block)
callbacks = CallbackChain.build(:#{callback}, *methods, &block) callbacks = CallbackChain.build(:#{callback}, *methods, &block) # callbacks = CallbackChain.build(:before_save, *methods, &block)
(@#{callback}_callbacks ||= CallbackChain.new).concat callbacks (@#{callback}_callbacks ||= CallbackChain.new).concat callbacks # (@before_save_callbacks ||= CallbackChain.new).concat callbacks
end end # end
#
def self.#{callback}_callback_chain def self.#{callback}_callback_chain # def self.before_save_callback_chain
@#{callback}_callbacks ||= CallbackChain.new @#{callback}_callbacks ||= CallbackChain.new # @before_save_callbacks ||= CallbackChain.new
#
if superclass.respond_to?(:#{callback}_callback_chain) if superclass.respond_to?(:#{callback}_callback_chain) # if superclass.respond_to?(:before_save_callback_chain)
CallbackChain.new(superclass.#{callback}_callback_chain + @#{callback}_callbacks) CallbackChain.new(superclass.#{callback}_callback_chain + @#{callback}_callbacks) # CallbackChain.new(superclass.before_save_callback_chain + @before_save_callbacks)
else else # else
@#{callback}_callbacks @#{callback}_callbacks # @before_save_callbacks
end end # end
end end # end
end_eval end_eval
end end
end end
Expand Down
48 changes: 24 additions & 24 deletions activesupport/lib/active_support/core_ext/class/attribute_accessors.rb
View file
Expand Up @@ -11,17 +11,17 @@ def cattr_reader(*syms)
syms.flatten.each do |sym| syms.flatten.each do |sym|
next if sym.is_a?(Hash) next if sym.is_a?(Hash)
class_eval(<<-EOS, __FILE__, __LINE__) class_eval(<<-EOS, __FILE__, __LINE__)
unless defined? @@#{sym} unless defined? @@#{sym} # unless defined? @@hair_colors
@@#{sym} = nil @@#{sym} = nil # @@hair_colors = nil
end end # end
#
def self.#{sym} def self.#{sym} # def self.hair_colors
@@#{sym} @@#{sym} # @@hair_colors
end end # end
#
def #{sym} def #{sym} # def hair_colors
@@#{sym} @@#{sym} # @@hair_colors
end end # end
EOS EOS
end end
end end
Expand All @@ -30,19 +30,19 @@ def cattr_writer(*syms)
options = syms.extract_options! options = syms.extract_options!
syms.flatten.each do |sym| syms.flatten.each do |sym|
class_eval(<<-EOS, __FILE__, __LINE__) class_eval(<<-EOS, __FILE__, __LINE__)
unless defined? @@#{sym} unless defined? @@#{sym} # unless defined? @@hair_colors
@@#{sym} = nil @@#{sym} = nil # @@hair_colors = nil
end end # end
#
def self.#{sym}=(obj) def self.#{sym}=(obj) # def self.hair_colors=(obj)
@@#{sym} = obj @@#{sym} = obj # @@hair_colors = obj
end end # end
#
#{" #{" #
def #{sym}=(obj) def #{sym}=(obj) # def hair_colors=(obj)
@@#{sym} = obj @@#{sym} = obj # @@hair_colors = obj
end end # end
" unless options[:instance_writer] == false } " unless options[:instance_writer] == false } # # instance writer above is generated unless options[:instance_writer] == false
EOS EOS
end end
end end
Expand Down
38 changes: 19 additions & 19 deletions activesupport/lib/active_support/core_ext/class/delegating_attributes.rb
View file
Expand Up @@ -9,32 +9,32 @@ def superclass_delegating_reader(*names)
class_name_to_stop_searching_on = self.superclass.name.blank? ? "Object" : self.superclass.name class_name_to_stop_searching_on = self.superclass.name.blank? ? "Object" : self.superclass.name
names.each do |name| names.each do |name|
class_eval <<-EOS class_eval <<-EOS
def self.#{name} def self.#{name} # def self.only_reader
if defined?(@#{name}) if defined?(@#{name}) # if defined?(@only_reader)
@#{name} @#{name} # @only_reader
elsif superclass < #{class_name_to_stop_searching_on} && superclass.respond_to?(:#{name}) elsif superclass < #{class_name_to_stop_searching_on} && superclass.respond_to?(:#{name}) # elsif superclass < Object && superclass.respond_to?(:only_reader)
superclass.#{name} superclass.#{name} # superclass.only_reader
end end # end
end end # end
def #{name} def #{name} # def only_reader
self.class.#{name} self.class.#{name} # self.class.only_reader
end end # end
def self.#{name}? def self.#{name}? # def self.only_reader?
!!#{name} !!#{name} # !!only_reader
end end # end
def #{name}? def #{name}? # def only_reader?
!!#{name} !!#{name} # !!only_reader
end end # end
EOS EOS
end end
end end


def superclass_delegating_writer(*names) def superclass_delegating_writer(*names)
names.each do |name| names.each do |name|
class_eval <<-EOS class_eval <<-EOS
def self.#{name}=(value) def self.#{name}=(value) # def self.only_writer=(value)
@#{name} = value @#{name} = value # @only_writer = value
end end # end
EOS EOS
end end
end end
Expand Down
68 changes: 34 additions & 34 deletions activesupport/lib/active_support/core_ext/class/inheritable_attributes.rb
View file
Expand Up @@ -11,13 +11,13 @@ def class_inheritable_reader(*syms)
syms.each do |sym| syms.each do |sym|
next if sym.is_a?(Hash) next if sym.is_a?(Hash)
class_eval <<-EOS class_eval <<-EOS
def self.#{sym} def self.#{sym} # def self.before_add_for_comments
read_inheritable_attribute(:#{sym}) read_inheritable_attribute(:#{sym}) # read_inheritable_attribute(:before_add_for_comments)
end end # end
#
def #{sym} def #{sym} # def before_add_for_comments
self.class.#{sym} self.class.#{sym} # self.class.before_add_for_comments
end end # end
EOS EOS
end end
end end
Expand All @@ -26,15 +26,15 @@ def class_inheritable_writer(*syms)
options = syms.extract_options! options = syms.extract_options!
syms.each do |sym| syms.each do |sym|
class_eval <<-EOS class_eval <<-EOS
def self.#{sym}=(obj) def self.#{sym}=(obj) # def self.color=(obj)
write_inheritable_attribute(:#{sym}, obj) write_inheritable_attribute(:#{sym}, obj) # write_inheritable_attribute(:color, obj)
end end # end
#
#{" #{" #
def #{sym}=(obj) def #{sym}=(obj) # def color=(obj)
self.class.#{sym} = obj self.class.#{sym} = obj # self.class.color = obj
end end # end
" unless options[:instance_writer] == false } " unless options[:instance_writer] == false } # # the writer above is generated unless options[:instance_writer] == false
EOS EOS
end end
end end
Expand All @@ -43,15 +43,15 @@ def class_inheritable_array_writer(*syms)
options = syms.extract_options! options = syms.extract_options!
syms.each do |sym| syms.each do |sym|
class_eval <<-EOS class_eval <<-EOS
def self.#{sym}=(obj) def self.#{sym}=(obj) # def self.levels=(obj)
write_inheritable_array(:#{sym}, obj) write_inheritable_array(:#{sym}, obj) # write_inheritable_array(:levels, obj)
end end # end
#
#{" #{" #
def #{sym}=(obj) def #{sym}=(obj) # def levels=(obj)
self.class.#{sym} = obj self.class.#{sym} = obj # self.class.levels = obj
end end # end
" unless options[:instance_writer] == false } " unless options[:instance_writer] == false } # # the writer above is generated unless options[:instance_writer] == false
EOS EOS
end end
end end
Expand All @@ -60,15 +60,15 @@ def class_inheritable_hash_writer(*syms)
options = syms.extract_options! options = syms.extract_options!
syms.each do |sym| syms.each do |sym|
class_eval <<-EOS class_eval <<-EOS
def self.#{sym}=(obj) def self.#{sym}=(obj) # def self.nicknames=(obj)
write_inheritable_hash(:#{sym}, obj) write_inheritable_hash(:#{sym}, obj) # write_inheritable_hash(:nicknames, obj)
end end # end
#
#{" #{" #
def #{sym}=(obj) def #{sym}=(obj) # def nicknames=(obj)
self.class.#{sym} = obj self.class.#{sym} = obj # self.class.nicknames = obj
end end # end
" unless options[:instance_writer] == false } " unless options[:instance_writer] == false } # # the writer above is generated unless options[:instance_writer] == false
EOS EOS
end end
end end
Expand Down
48 changes: 24 additions & 24 deletions activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
View file
Expand Up @@ -15,17 +15,17 @@ def mattr_reader(*syms)
syms.each do |sym| syms.each do |sym|
next if sym.is_a?(Hash) next if sym.is_a?(Hash)
class_eval(<<-EOS, __FILE__, __LINE__) class_eval(<<-EOS, __FILE__, __LINE__)
unless defined? @@#{sym} unless defined? @@#{sym} # unless defined? @@pagination_options
@@#{sym} = nil @@#{sym} = nil # @@pagination_options = nil
end end # end
#
def self.#{sym} def self.#{sym} # def self.pagination_options
@@#{sym} @@#{sym} # @@pagination_options
end end # end
#
def #{sym} def #{sym} # def pagination_options
@@#{sym} @@#{sym} # @@pagination_options
end end # end
EOS EOS
end end
end end
Expand All @@ -34,19 +34,19 @@ def mattr_writer(*syms)
options = syms.extract_options! options = syms.extract_options!
syms.each do |sym| syms.each do |sym|
class_eval(<<-EOS, __FILE__, __LINE__) class_eval(<<-EOS, __FILE__, __LINE__)
unless defined? @@#{sym} unless defined? @@#{sym} # unless defined? @@pagination_options
@@#{sym} = nil @@#{sym} = nil # @@pagination_options = nil
end end # end
#
def self.#{sym}=(obj) def self.#{sym}=(obj) # def self.pagination_options=(obj)
@@#{sym} = obj @@#{sym} = obj # @@pagination_options = obj
end end # end
#
#{" #{" #
def #{sym}=(obj) def #{sym}=(obj) # def pagination_options=(obj)
@@#{sym} = obj @@#{sym} = obj # @@pagination_options = obj
end end # end
" unless options[:instance_writer] == false } " unless options[:instance_writer] == false } # # instance writer above is generated unless options[:instance_writer] == false
EOS EOS
end end
end end
Expand Down

0 comments on commit 8cabcbd

Please sign in to comment.