Skip to content

Commit

Permalink
here's a proper readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan-allen committed Jun 11, 2010
1 parent 9ad561b commit 514fcb2
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
1 change: 0 additions & 1 deletion README

This file was deleted.

36 changes: 36 additions & 0 deletions README.md
@@ -0,0 +1,36 @@
# Interceptor

## Overview:

Interceptor allows you to wrap other objects, and intercept method calls, without changing the target objects code, or performing any hairy metaprogramming. You may use this library to perform these kinds of tasks:

* Modifying method arguments as they come in.
* Modify return values as they go out.
* Perform other tasks (such as logging) without sprinkling the code throughout the objects (typically unrelated) implementation.
* Call completely different methods depending on anything you want, I suppose.

You can think of this as a more explicit form of AOP, but unlike AOP, instead of being picked off by a sniper from 3000m away (and being very surprised about the whole thing), it's like the sniper has arrived at your house with your birthday cake and birthday present in order to convey his birthday wishes.

## Example:

Let's say as a Ruby programmer you picked up some Lua and decided that Lua's idea of starting an Array at 1 is _way_ better than starting an Array at 0, in a fit of blinding genius you decide to make a Ruby Array behave like a Lua one.

lucky_numbers = [42, 666, 2012]

lucky_numbers[0] # => 42
lucky_numbers[1] # => 666
lucky_numbers[2] # => 2012

even_luckier_numbers = Interceptor.new(lucky_numbers)

# intercept the [] method, and take 1 off the index passed in
# so that our arrays become like lua arrays, kinda
even_luckier_numbers.intercept(:[]) do |receiver, target, index|
receiver[index-1]
end

even_luckier_numbers[1] # => 42
even_luckier_numbers[2] # => 666
even_luckier_numbers[3] # => 2012

The first two arguments to the block is a reference to the object passed to the Interceptor (in this case, a reference to ``lucky_numbers``), the second is a symbol of the method call (in this case, it is ``:[]``), and the remaining arguments are the arguments passed to the method call (in this case, ``1`` and ``2`` and ``3``).

0 comments on commit 514fcb2

Please sign in to comment.