Module: StructuredParams

Defined in:
lib/structured_params.rb,
lib/structured_params/i18n.rb,
lib/structured_params/errors.rb,
lib/structured_params/params.rb,
lib/structured_params/version.rb,
lib/structured_params/type/array.rb,
lib/structured_params/type/object.rb,
lib/structured_params/validations.rb,
lib/structured_params/attribute_methods.rb,
sig/structured_params.rbs,
sig/structured_params/i18n.rbs,
sig/structured_params/errors.rbs,
sig/structured_params/params.rbs,
sig/structured_params/version.rbs,
sig/structured_params/type/array.rbs,
sig/structured_params/type/object.rbs,
sig/structured_params/validations.rbs,
sig/structured_params/attribute_methods.rbs

Overview

rubocop:disable Style/OptionalBooleanParameter

Defined Under Namespace

Modules: AttributeMethods, I18n, Type, Validations Classes: Configuration, Errors, Params

Constant Summary collapse

VERSION =

: string

Returns:

  • (string) 
'0.9.5'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

: () -> Configuration

Returns:



69
70
71
 
# File 'lib/structured_params.rb', line 69

def configuration
  @configuration ||= Configuration.new
end

.configure {|arg0| ... } ⇒ void

This method returns an undefined value.

: () { (Configuration) -> void } -> void

Yields:

Yield Parameters:

Yield Returns:

  • (void) 


74
75
76
 
# File 'lib/structured_params.rb', line 74

def configure
  yield configuration
end

.register_types ⇒ void

This method returns an undefined value.

Helper method to register types : () -> void



85
86
87
88
 
# File 'lib/structured_params.rb', line 85

def register_types
  ActiveModel::Type.register(:object, StructuredParams::Type::Object)
  ActiveModel::Type.register(:array, StructuredParams::Type::Array)
end

.register_types_as(object_name:, array_name:) ⇒ void

This method returns an undefined value.

Helper method to register types with custom names : (object_name: Symbol, array_name: Symbol) -> void

Parameters:

  • object_name: (Symbol)
  • array_name: (Symbol) 


92
93
94
95
 
# File 'lib/structured_params.rb', line 92

def register_types_as(object_name:, array_name:)
  ActiveModel::Type.register(object_name, StructuredParams::Type::Object)
  ActiveModel::Type.register(array_name, StructuredParams::Type::Array)
end

.reset_configuration! ⇒ void

This method returns an undefined value.

: () -> void



79
80
81
 
# File 'lib/structured_params.rb', line 79

def reset_configuration!
  @configuration = Configuration.new
end