aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib
diff options
context:
space:
mode:
authorNeeraj Singh <neerajdotname@gmail.com>2010-08-04 17:02:38 -0400
committerNeeraj Singh <neerajdotname@gmail.com>2010-08-04 17:03:03 -0400
commit589e6977d72b232b6e1af5ef508beddffbcd5f4c (patch)
tree5e72068d4e0d9c7330d87c564625ea2f7b13614f /activesupport/lib
parent7745f716a175b680f140c7b735261e5a3064e7e9 (diff)
downloadrails-589e6977d72b232b6e1af5ef508beddffbcd5f4c.tar.gz
rails-589e6977d72b232b6e1af5ef508beddffbcd5f4c.tar.bz2
rails-589e6977d72b232b6e1af5ef508beddffbcd5f4c.zip
adding documentation to ActiveSupport::Concern ht:strictly typed for an awesome example
some minor documentation changes
Diffstat (limited to 'activesupport/lib')
-rw-r--r--activesupport/lib/active_support/callbacks.rb4
-rw-r--r--activesupport/lib/active_support/concern.rb35
2 files changed, 38 insertions, 1 deletions
diff --git a/activesupport/lib/active_support/callbacks.rb b/activesupport/lib/active_support/callbacks.rb
index 1c7802f7de..adabdd3388 100644
--- a/activesupport/lib/active_support/callbacks.rb
+++ b/activesupport/lib/active_support/callbacks.rb
@@ -568,7 +568,9 @@ module ActiveSupport
#
# would trigger <tt>Audit#before_save</tt> instead. That's constructed by calling
# <tt>"#{kind}_#{name}"</tt> on the given instance. In this case "kind" is "before" and
- # "name" is "save".
+ # "name" is "save". In this context treat ":kind" and ":name" as special thing where
+ # ":kind" refers to "callback type(before/after)" and ":name" refers to the method on
+ # which callbacks are being defined.
#
# A declaration like
#
diff --git a/activesupport/lib/active_support/concern.rb b/activesupport/lib/active_support/concern.rb
index eb31f7cad4..408d327dd7 100644
--- a/activesupport/lib/active_support/concern.rb
+++ b/activesupport/lib/active_support/concern.rb
@@ -1,3 +1,38 @@
+# A typical module looks like this
+#
+# module M
+# def self.included(base)
+# base.send(:extend, ClassMethods)
+# base.send(:include, InstanceMethods)
+# scope :foo, :conditions => {:created_at => nil}
+# end
+#
+# module ClassMethods
+# def cm; puts 'I am class method'; end
+# end
+#
+# module InstanceMethods
+# def im; puts 'I am instance method'; end
+# end
+# end
+#
+# By using <tt>ActiveSupport::Concern</tt> above module could be written as:
+#
+# module M
+# extend ActiveSupport::Concern
+#
+# included do
+# scope :foo, :conditions => {:created_at => nil}
+# end
+#
+# module ClassMethods
+# def cm; puts 'I am class method'; end
+# end
+#
+# module InstanceMethods
+# def im; puts 'I am instance method'; end
+# end
+# end
module ActiveSupport
module Concern
def self.extended(base)