Module: RSpec::SleepingKingStudios::Concerns::ExampleConstants

Defined in:
lib/rspec/sleeping_king_studios/concerns/example_constants.rb

Overview

Methods for defining example-scoped classes and constants.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.define_class(class_name:, example:, base_class: nil, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rspec/sleeping_king_studios/concerns/example_constants.rb', line 13

def define_class(class_name:, example:, base_class: nil, &block)
  klass = Class.new(resolve_base_class(base_class))

  klass.define_singleton_method(:name) { class_name }
  klass.singleton_class.send(:alias_method, :inspect, :name)
  klass.singleton_class.send(:alias_method, :to_s,    :name)

  example.instance_exec(klass, &block) if block_given?

  klass
end

.with_constant(constant_name:, constant_value:, namespace:, force: false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rspec/sleeping_king_studios/concerns/example_constants.rb', line 26

def with_constant( # rubocop:disable Metrics/MethodLength
  constant_name:,
  constant_value:,
  namespace:,
  force: false
)
  guard_existing_constant!(namespace, constant_name) unless force

  prior_value = DEFAULT_VALUE

  if namespace.const_defined?(constant_name)
    prior_value = namespace.const_get(constant_name)
  end

  namespace.const_set(constant_name, constant_value)

  yield
ensure
  if prior_value == DEFAULT_VALUE
    namespace.send :remove_const, constant_name
  else
    namespace.const_set(constant_name, prior_value)
  end
end

.with_namespace(module_names) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rspec/sleeping_king_studios/concerns/example_constants.rb', line 52

def with_namespace(module_names) # rubocop:disable Metrics/MethodLength
  last_defined = nil

  resolved =
    module_names.reduce(Object) do |namespace, module_name|
      if namespace.const_defined?(module_name)
        next namespace.const_get(module_name)
      end

      last_defined ||= { namespace:, module_name: }

      namespace.const_set(module_name, Module.new)
    end

  yield resolved
ensure
  if last_defined
    last_defined[:namespace]
      .send(:remove_const, last_defined[:module_name])
  end
end

Instance Method Details

#example_class(class_name, base_class = nil, &block) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/rspec/sleeping_king_studios/concerns/example_constants.rb', line 97

def example_class(class_name, base_class = nil, &block)
  class_name = class_name.to_s if class_name.is_a?(Symbol)

  example_constant(class_name) do
    ExampleConstants.define_class(
      base_class:,
      class_name:,
      example:    self,
      &block
    )
  end
end

#example_constant(qualified_name, constant_value = DEFAULT_VALUE, force: false, &block) ⇒ Object

rubocop:disable Metrics/MethodLength



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/rspec/sleeping_king_studios/concerns/example_constants.rb', line 110

def example_constant( # rubocop:disable Metrics/MethodLength
  qualified_name,
  constant_value = DEFAULT_VALUE,
  force: false,
  &block
)
  around(:example) do |wrapped_example|
    resolved_value =
      if constant_value == DEFAULT_VALUE && block_given?
        wrapped_example.example.instance_exec(&block)
      else
        constant_value
      end

    *module_names, constant_name = qualified_name.to_s.split('::')

    ExampleConstants.with_namespace(module_names) do |namespace|
      ExampleConstants.with_constant(
        constant_name:,
        constant_value: resolved_value,
        namespace:,
        force:
      ) \
      do
        wrapped_example.call
      end
    end
  end
end