Module: Verquest::HelperMethods::RequiredProperties

Included in:
Properties::Base, Version
Defined in:
lib/verquest/helper_methods/required_properties.rb

Overview

Module that provides methods for working with required properties in schemas

This module offers functionality to identify and categorize properties based on their required status within schema definitions. It distinguishes between unconditionally required properties (those marked with ‘required: true`) and conditionally required properties (those with dependencies expressed as arrays).

When included in classes that manage properties (like Version or Base property classes), it provides methods to extract both types of required properties which can be used for schema validation, documentation generation, or UI rendering.

Instance Method Summary collapse

Instance Method Details

#dependent_required_properties ⇒ Hash<String, Array<String>>

Returns properties that are conditionally required based on other properties

This method identifies properties that are required only when certain other properties are present. These are properties where the required attribute is an array of dependency names rather than a boolean. Results are memoized to avoid recalculating on subsequent calls.

Examples:

Return value format:

{
  "property_name1": ["dependency1", "dependency2"],
  "property_name2": ["dependency3"]
}

Returns:

  • (Hash<String, Array<String>>) —

    Hash mapping property names to their dependency arrays



41
42
43
44
45
 
# File 'lib/verquest/helper_methods/required_properties.rb', line 41

def dependent_required_properties
  @_dependent_required_properties ||= properties.values.select { _1.required.is_a?(Array) }.each_with_object({}) do |property, hash|
    hash[property.name] = property.required.map(&:to_s)
  end
end

#required_properties ⇒ Array<Symbol>

Returns all properties that are unconditionally required

This method identifies properties that must always be present in valid data, by selecting those with their required attribute set to true (boolean). Results are memoized to avoid recalculating on subsequent calls.

Returns:

  • (Array<Symbol>) —

    Names of properties marked as unconditionally required (required == true)



24
25
26
 
# File 'lib/verquest/helper_methods/required_properties.rb', line 24

def required_properties
  @_required_properties ||= properties.values.select { _1.required == true }.map(&:name)
end