Class: Apiwork::API::EnumRegistry::Definition

Inherits:
Object
  • Object
show all
Defined in:
lib/apiwork/api/enum_registry/definition.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, scope: nil, deprecated: false, description: nil, example: nil, values: nil) ⇒ Definition

Returns a new instance of Definition.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 13

def initialize(
  name,
  scope: nil,
  deprecated: false,
  description: nil,
  example: nil,
  values: nil
)
  @name = name
  @scope = scope
  @deprecated = deprecated
  @description = description
  @example = example
  @values = values
end

Instance Attribute Details

#description ⇒ Object (readonly) 



7
8
9
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 7

def description
  @description
end

#example ⇒ Object (readonly) 



7
8
9
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 7

def example
  @example
end

#name ⇒ Object (readonly) 



7
8
9
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 7

def name
  @name
end

#scope ⇒ Object (readonly) 



7
8
9
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 7

def scope
  @scope
end

#values ⇒ Object (readonly) 



7
8
9
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 7

def values
  @values
end

Instance Method Details

#deprecated? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 29

def deprecated?
  @deprecated == true
end

#merge(deprecated:, description:, example:, values:) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/apiwork/api/enum_registry/definition.rb', line 33

def merge(
  deprecated:,
  description:,
  example:,
  values:
)
  Definition.new(
    @name,
    deprecated: deprecated || @deprecated,
    description: description || @description,
    example: example || @example,
    scope: @scope,
    values: values || @values,
  )
end