File: module_methods.rb

package info (click to toggle)
ruby-memoizable 0.4.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 192 kB
  • sloc: ruby: 605; makefile: 2
file content (125 lines) | stat: -rw-r--r-- 2,373 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# 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