Class: HaveAPI::Parameters::Resource

Inherits:
Object
  • Object
show all
Includes:
MetadataI18n
Defined in:
lib/haveapi/parameters/resource.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MetadataI18n

#metadata_i18n_catalog_items

Constructor Details

#initialize(resource, name: nil, label: nil, desc: nil, choices: nil, value_id: :id, value_label: :label, required: nil, db_name: nil, fetch: nil, nullable: nil, label_key: nil, desc_key: nil) ⇒ Resource

Returns a new instance of Resource.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/haveapi/parameters/resource.rb', line 10

def initialize(resource, name: nil, label: nil, desc: nil,
               choices: nil, value_id: :id, value_label: :label, required: nil,
               db_name: nil, fetch: nil, nullable: nil, label_key: nil,
               desc_key: nil)
  @resource = resource
  @resource_path = build_resource_path(resource)
  @name = name || resource.resource_name.underscore.to_sym
  @label = label || (name && name.to_s.capitalize) || resource.resource_name
  @desc = desc
  @label_key = label_key
  @desc_key = desc_key
  @choices = choices || @resource::Index
  @value_id = value_id
  @value_label = value_label
  @required = required
  @nullable = nullable
  @db_name = db_name
  @extra = {
      fetch:
  }
end

Instance Attribute Details

#choices ⇒ Object (readonly)

Returns the value of attribute choices.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def choices
  @choices
end

#desc ⇒ Object (readonly)

Returns the value of attribute desc.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def desc
  @desc
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def label
  @label
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def name
  @name
end

#resource ⇒ Object (readonly)

Returns the value of attribute resource.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def resource
  @resource
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def type
  @type
end

#value_id ⇒ Object (readonly)

Returns the value of attribute value_id.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def value_id
  @value_id
end

#value_label ⇒ Object (readonly)

Returns the value of attribute value_label.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def value_label
  @value_label
end

#value_params ⇒ Object (readonly)

Returns the value of attribute value_params.



7
8
9
 
# File 'lib/haveapi/parameters/resource.rb', line 7

def value_params
  @value_params
end

Instance Method Details

#clean(raw, context = nil) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/haveapi/parameters/resource.rb', line 107

def clean(raw, context = nil)
  if raw.nil?
    return nil if nullable?

    raise validation_error('haveapi.validation.cannot_be_null')
  end

  if raw.is_a?(String)
    stripped = strip_string(raw)
    return nil if stripped.empty? && nullable?
  end

  extra = @extra.merge(optional: optional?, nullable: nullable?)

  ret = ::HaveAPI::ModelAdapter.for(
    show_action.input.layout, @resource.model
  ).input_clean(@resource.model, raw, extra)

  authorize_record!(ret, context)

  ret
end

#db_name ⇒ Object 



32
33
34
 
# File 'lib/haveapi/parameters/resource.rb', line 32

def db_name
  @db_name || @name
end

#describe(context, i18n_path: nil) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/haveapi/parameters/resource.rb', line 56

def describe(context, i18n_path: nil)
  val_path = context.path_for(
    @resource::Show,
    context.endpoint && context.action_prepare && context.layout == :object && context.call_path_params(context.action, context.action_prepare)
  )
  val_method = @resource::Index.http_method.to_s.upcase

  choices_path = context.path_for(
    @choices,
    context.endpoint && context.layout == :object && context.call_path_params(context.action, context.action_prepare)
  )
  choices_method = @choices.http_method.to_s.upcase

  {
    required: required?,
    nullable: nullable?,
    label: localized_label(context, i18n_path),
    description: localized_description(context, i18n_path),
    type: 'Resource',
    resource: @resource_path,
    value_id: @value_id,
    value_label: @value_label,
    value: context.action_prepare && {
      path: val_path,
      method: val_method,
      help: "#{val_path}?method=#{val_method}"
    },
    choices: {
      path: choices_path,
      method: choices_method,
      help: "#{choices_path}?method=#{choices_method}"
    }
  }
end

#format_output(v) ⇒ Object 



134
135
136
 
# File 'lib/haveapi/parameters/resource.rb', line 134

def format_output(v)
  v
end

#nullable? ⇒ Boolean

Returns:



44
45
46
 
# File 'lib/haveapi/parameters/resource.rb', line 44

def nullable?
  @nullable == true && optional?
end

#optional? ⇒ Boolean

Returns:



40
41
42
 
# File 'lib/haveapi/parameters/resource.rb', line 40

def optional?
  !@required
end

#patch(attrs) ⇒ Object 



103
104
105
 
# File 'lib/haveapi/parameters/resource.rb', line 103

def patch(attrs)
  attrs.each { |k, v| instance_variable_set("@#{k}", v) }
end

#required? ⇒ Boolean

Returns:



36
37
38
 
# File 'lib/haveapi/parameters/resource.rb', line 36

def required?
  @required
end

#show_action ⇒ Object 



48
49
50
 
# File 'lib/haveapi/parameters/resource.rb', line 48

def show_action
  @resource::Show
end

#show_index ⇒ Object 



52
53
54
 
# File 'lib/haveapi/parameters/resource.rb', line 52

def show_index
  @resource::Index
end

#validate(v, params) ⇒ Object 



130
131
132
 
# File 'lib/haveapi/parameters/resource.rb', line 130

def validate(v, params)
  true
end

#validate_build_output ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/haveapi/parameters/resource.rb', line 91

def validate_build_output
  %i[value_id value_label].each do |name|
    v = instance_variable_get("@#{name}")

    [show_action, show_index].each do |klass|
      next unless klass.instance_variable_get('@output')[v].nil?

      raise "association to '#{@resource}': value_label '#{v}' is not an output parameter of '#{klass}'"
    end
  end
end