The Aspect helper allows you to execute hooks before or after a number of actions.
See {Innate::Helper::Aspect::SingletonMethods} for more details on the various hooks available.
@example Querying a database before a number of actions.
class Posts include Innate::Node map '/' helper :aspect before(:index, :other) do @posts = Post.all end def index return @posts end def other return @posts[0] end end
This helper is essential for proper working of {Action#render}.
Hash containing the various hooks to call for certain actions.
Consider objects that have Aspect included
# File lib/innate/helper/aspect.rb, line 49 def self.ancestral_aop(from) aop = {} from.ancestors.reverse.each do |anc| aop.merge!(AOP[anc]) if anc < Aspect end aop end
Calls the aspect for a given position and name.
@param [to_sym] position The position of the hook, e.g. :before_all. @param [to_sym] name The name of the method for which to call the hook.
# File lib/innate/helper/aspect.rb, line 65 def aspect_call(position, name) return unless aop = Aspect.ancestral_aop(self.class) return unless block = at_position = aop[position] block = at_position[name.to_sym] unless at_position.is_a?(Proc) instance_eval(&block) if block end
Wraps the specified action between various hooks.
@param [Innate::Action] action The action to wrap.
# File lib/innate/helper/aspect.rb, line 79 def aspect_wrap(action) return yield unless method = action.name aspect_call(:before_all, method) aspect_call(:before, method) result = yield aspect_call(:after, method) aspect_call(:after_all, method) result end
This awesome piece of hackery implements action AOP.
The so-called aspects are simply methods that may yield the next aspect in the chain, this is similar to racks concept of middleware, but instead of initializing with an app we simply pass a block that may be yielded with the action being processed.
This gives us things like logging, caching, aspects, authentication, etc.
Add the name of your method to the trait to add your own method to the wrap_action_call chain.
@example adding your method
class MyNode Innate.node '/' private def wrap_logging(action) Innate::Log.info("Executing #{action.name}") yield end trait[:wrap] end
methods may register themself in the trait and will be called in left-to-right order, each being passed the action instance and a block that they have to yield to continue the chain.
@param [Action] action instance that is being passed to every registered
method
@param [Proc] block contains the instructions to call the action method
if any
@see Action#render @author manveru
# File lib/innate/helper/aspect.rb, line 131 def wrap_action_call(action, &block) return yield if action.options[:is_layout] wrap = SortedSet.new action.node.ancestral_trait_values(:wrap).each{|sset| wrap.merge(sset) } head, *tail = wrap.map{|k,v| v } tail.reverse! combined = tail.inject(block){|s,v| lambda{ __send__(v, action, &s) } } __send__(head, action, &combined) end
Generated with the Darkfish Rdoc Generator 2.