File: recursion_guard.rb

package info (click to toggle)
ruby-ice-nine 0.11.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 432 kB
  • sloc: ruby: 1,006; makefile: 2
file content (57 lines) | stat: -rw-r--r-- 1,359 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
# encoding: utf-8

module IceNine

  # Protect against infinite recursion
  #
  # @private
  class RecursionGuard

    # Protects against infinite recursion by never yielding with the same
    # object more than once.
    class ObjectSet < self

      # Initialize a recursion guard
      #
      # @return [undefined]
      def initialize
        @object_ids = {}
      end

      # Guard against recursively calling a block with the same object
      #
      # @example
      #   recursion_guard = IceNine::RecursionGuard::ObjectSet.new
      #   recursion_guard.guard(object) do
      #     logic_which_may_be_recursively_called_with_object(recursion_guard)
      #   end
      #
      # @param [Object] object
      #
      # @return [Object]
      def guard(object)
        caller_object_id = object.__id__
        return object if @object_ids.key?(caller_object_id)
        @object_ids[caller_object_id] = nil
        yield
      end

    end # ObjectSet

    # Protects against infinite recursion by not yielding with frozen objects
    class Frozen < self

      # Guard against recursively calling a block with the same frozen object
      #
      # @param [Object] object
      #
      # @return [Object]
      def guard(object)
        return object if object.frozen?
        yield
      end

    end # Frozen

  end # RecursionGuard
end # IceNine