Class: HaveAPI::ModelAdapters::ActiveRecord::Output

Inherits:
HaveAPI::ModelAdapter::Output show all
Defined in:
lib/haveapi/model_adapters/active_record.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HaveAPI::ModelAdapter::Output

#initialize

Constructor Details

This class inherits a constructor from HaveAPI::ModelAdapter::Output

Class Method Details

.used_by(action) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/haveapi/model_adapters/active_record.rb', line 269

def self.used_by(action)
  action.meta(:object) do
    output do
      custom :path_params,
             label: HaveAPI.message('haveapi.parameters.active_record.path_params.label'),
             desc: HaveAPI.message('haveapi.parameters.active_record.path_params.description')
      bool :resolved,
           label: HaveAPI.message('haveapi.parameters.active_record.resolved.label'),
           desc: HaveAPI.message('haveapi.parameters.active_record.resolved.description')
    end
  end

  return unless %i[object object_list].include?(action.input.layout)

  clean = proc do |raw|
    values = if raw.is_a?(String)
               raw.strip.split(',')
             elsif raw.is_a?(Array)
               raw
             else
               raise HaveAPI::ValidationError,
                     HaveAPI.message('haveapi.validation.includes_string_or_array')
             end

    values.map do |value|
      unless value.is_a?(String)
        raise HaveAPI::ValidationError,
              HaveAPI.message('haveapi.validation.includes_only_strings')
      end

      value.strip
    end
  end

  action.meta(:global) do
    input do
      custom :includes,
             label: HaveAPI.message('haveapi.parameters.active_record.includes.label'),
             desc: HaveAPI.message('haveapi.parameters.active_record.includes.description'),
             &clean
    end
  end

  action.send(:include, Action::InstanceMethods)
end

Instance Method Details

#[](name) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/haveapi/model_adapters/active_record.rb', line 320

def [](name)
  param = @context.action.output[name]
  v = @object.send(param.db_name)

  if v.is_a?(::ActiveRecord::Base)
    resourcify(param, v)
  else
    v
  end
end

#has_param?(name) ⇒ Boolean

Returns:



315
316
317
318
 
# File 'lib/haveapi/model_adapters/active_record.rb', line 315

def has_param?(name)
  param = @context.action.output[name]
  param && @object.respond_to?(param.db_name)
end

#meta ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/haveapi/model_adapters/active_record.rb', line 331

def meta
  res = @context.action.resource

  params = if @context.action.name.demodulize == 'Index' \
     && !@context.action.resolve \
     && res.const_defined?(:Show)
             res::Show.resolve_path_params(@object)

           else
             @context.action.resolve_path_params(@object)
           end

  {
    path_params: params.is_a?(Array) ? params : [params],
    resolved: true
  }
end