twitter-status-bot/.gems/gems/memoizable-0.4.2/lib/memoizable/module_methods.rb

126 lines
2.3 KiB
Ruby
Raw Normal View History

2014-09-03 08:49:59 +00:00
# encoding: utf-8
module Memoizable
# Methods mixed in to memoizable singleton classes
module ModuleMethods
# Return default deep freezer
#
# @return [#call]
#
# @api private
def freezer
Freezer
end
# Memoize a list of methods
#
# @example
# memoize :hash
#
# @param [Array<Symbol>] methods
# a list of methods to memoize
#
# @return [self]
#
# @api public
def memoize(*methods)
methods.each(&method(:memoize_method))
self
end
# Test if an instance method is memoized
#
# @example
# class Foo
# include Memoizable
#
# def bar
# end
# memoize :bar
# end
#
# Foo.memoized?(:bar) # true
# Foo.memoized?(:baz) # false
#
# @param [Symbol] name
#
# @return [Boolean]
# true if method is memoized, false if not
#
# @api private
def memoized?(name)
memoized_methods.key?(name)
end
# Return unmemoized instance method
#
# @example
#
# class Foo
# include Memoizable
#
# def bar
# end
# memoize :bar
# end
#
# Foo.unmemoized_instance_method(:bar)
#
# @param [Symbol] name
#
# @return [UnboundMethod]
# the memoized method
#
# @raise [NameError]
# raised if the method is unknown
#
# @api public
def unmemoized_instance_method(name)
memoized_methods[name].original_method
end
private
# Hook called when module is included
#
# @param [Module] descendant
# the module including ModuleMethods
#
# @return [self]
#
# @api private
def included(descendant)
super
descendant.module_eval { include Memoizable }
end
# Memoize the named method
#
# @param [Symbol] method_name
# a method name to memoize
#
# @return [undefined]
#
# @api private
def memoize_method(method_name)
memoized_methods[method_name] = MethodBuilder.new(
self,
method_name,
freezer
).call
end
# Return method builder registry
#
# @return [Hash<Symbol, MethodBuilder>]
#
# @api private
def memoized_methods
@_memoized_methods ||= Memory.new
end
end # ModuleMethods
end # Memoizable