File: null_safe_proxy.rb

package info (click to toggle)
ruby-naught 2.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 180 kB
  • sloc: ruby: 658; makefile: 6
file content (92 lines) | stat: -rw-r--r-- 3,364 bytes parent folder | download
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
require "naught/null_class_builder/command"

module Naught
  class NullClassBuilder
    module Commands
      # Enables null-safe proxy wrapping via the NullSafe() conversion function
      #
      # When enabled, the generated null class gains a NullSafe() function that
      # wraps any value in a proxy. The proxy intercepts all method calls and
      # wraps return values, replacing nil with the null object.
      #
      # @example Enable null-safe proxy
      #   NullObject = Naught.build do |config|
      #     config.null_safe_proxy
      #   end
      #
      #   include NullObject::Conversions
      #
      #   user = nil
      #   NullSafe(user).name.upcase      # => <null>
      #
      #   user = OpenStruct.new(name: nil)
      #   NullSafe(user).name.upcase      # => <null>
      #
      #   user = OpenStruct.new(name: "Bob")
      #   NullSafe(user).name.upcase      # => "BOB"
      #
      # @api private
      class NullSafeProxy < Command
        # Install the NullSafe conversion function
        # @return [void]
        # @api private
        def call
          null_equivs = builder.null_equivalents
          defer_class do |null_class|
            proxy_class = build_proxy_class(null_class, null_equivs)
            null_class.const_set(:NullSafeProxy, proxy_class)
            install_null_safe_conversion(null_class, proxy_class, null_equivs)
          end
        end

        private

        # Build the proxy class that wraps objects for null-safe access
        #
        # @param null_class [Class] the null object class
        # @param null_equivs [Array<Object>] values treated as null-equivalent
        # @return [Class] the proxy class
        # @api private
        def build_proxy_class(null_class, null_equivs)
          Class.new(::Naught::BasicObject) do
            include ::Naught::NullSafeProxyTag

            define_method(:initialize) { |target| @target = target }
            define_method(:__target__) { @target }
            define_method(:respond_to?) { |method_name, include_private = false| @target.respond_to?(method_name, include_private) }
            define_method(:inspect) { "<null-safe-proxy(#{@target.inspect})>" }

            define_method(:method_missing) do |method_name, *args, &block|
              result = @target.__send__(method_name, *args, &block)
              case result
              when ::Naught::NullObjectTag then result
              when *null_equivs then null_class.get
              else self.class.new(result)
              end
            end

            klass = self
            define_method(:class) { klass }
          end
        end

        # Install the NullSafe conversion method on the Conversions module
        #
        # @param null_class [Class] the null object class
        # @param proxy_class [Class] the proxy class
        # @param null_equivs [Array<Object>] values treated as null-equivalent
        # @return [void]
        # @api private
        def install_null_safe_conversion(null_class, proxy_class, null_equivs)
          null_class.const_get(:Conversions).define_method(:NullSafe) do |object|
            case object
            when ::Naught::NullObjectTag then object
            when *null_equivs then null_class.get
            else proxy_class.new(object)
            end
          end
        end
      end
    end
  end
end