Mention AroundDecorator in README.txt.
[decorate.git] / README.txt
blobced4672c4f2cbbd0b63f13bae1c494d9a93971f5
1 = decorate
3 Homepage:: http://decorate.rubyforge.org/
4 Project page:: http://rubyforge.org/projects/decorate/
5 Git repository:: http://repo.or.cz/w/decorate.git
7 Decorate is written by Stefan Lang, you can contact me directly
8 (langstefan at gmx dot at), or post on ruby-talk and include
9 "decorate" in the subject line.
11 == Description
13 Python style decorators for Ruby, some common decorators like
14 private_method are provided out of the box.
16 Decorators that come with the decorate library:
18 * Decorate::PrivateMethod
19 * Decorate::ProtectedMethod
20 * Decorate::PublicMethod
21 * Decorate::ModuleMethod
22 * Decorate::Memoize
24 Helpers to create your own decorators:
26 * Decorate::AroundDecorator
27 * Decorate::BeforeDecorator
29 == Hygiene issues
31 Decorate hooks into (aka redefines) Module#method_added and
32 Object#singleton_method_added via the classic alias/delegate pattern.
33 If you override these methods in one of your classes that use
34 decorators, make sure to call +super+, otherwise decorate breaks.
36 Also, private_method, protected_method, public_method and
37 module_method are defined as private methods of Module, but only if
38 the respective files are required.
40 == License
42 Decorate is licensed under the same terms as the main Ruby
43 implementation. See http://www.ruby-lang.org/en/LICENSE.txt.