File: naught.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 (37 lines) | stat: -rw-r--r-- 989 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
require "naught/version"
require "naught/caller_info"
require "naught/null_class_builder"
require "naught/null_class_builder/commands"

# Top-level namespace for Naught null object helpers
#
# @example Create a basic null object class
#   NullObject = Naught.build
#   null = NullObject.new
#   null.foo  #=> nil
#
# @example Create a black hole null object
#   BlackHole = Naught.build(&:black_hole)
#   BlackHole.new.foo.bar.baz  #=> <null>
#
# @api public
module Naught
  # Build a null object class using the builder DSL
  #
  # @example
  #   NullObject = Naught.build { |b| b.black_hole }
  #
  # @yieldparam builder [Naught::NullClassBuilder] builder DSL instance
  # @return [Class] generated null class
  def self.build(&)
    builder = NullClassBuilder.new
    builder.customize(&)
    builder.generate_class
  end

  # Marker module mixed into generated null objects
  module NullObjectTag; end

  # Marker module for null-safe proxy wrappers
  module NullSafeProxyTag; end
end