Module: Apipie::DSL::Concern

Includes:
Action, Base, Common, Param
Defined in:
lib/apipie/dsl_definition.rb

Instance Attribute Summary

Attributes included from Base

#api_params, #apipie_resource_descriptions

Instance Method Summary collapse

Methods included from Param

#_default_param_group_scope, #param, #param_group

Methods included from Action

#api, #def_param_group, #example, #resource_description, #see

Methods included from Common

#_apipie_define_validators, #api_versions, #desc, #document, #error, #formats, #meta

Instance Method Details

#_apipie_concern_data ⇒ Object 



372
373
374
 
# File 'lib/apipie/dsl_definition.rb', line 372

def _apipie_concern_data
  @_apipie_concern_data ||= []
end

#apipie_concern? ⇒ Boolean

Returns:

  • (Boolean) 


376
377
378
 
# File 'lib/apipie/dsl_definition.rb', line 376

def apipie_concern?
  true
end

#included(controller) ⇒ Object

the concern was included into a controller



363
364
365
366
367
368
369
370
 
# File 'lib/apipie/dsl_definition.rb', line 363

def included(controller)
  super
  _apipie_concern_data.each do |method_name, _apipie_dsl_data|
    # remove method description if exists and create new one
    description = Apipie.define_method_description(controller, method_name, _apipie_dsl_data)
    controller._apipie_define_validators(description)
  end
end

#method_added(method_name) ⇒ Object

create method api and redefine newly added method



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/apipie/dsl_definition.rb', line 381

def method_added(method_name) #:doc:
  super

  if ! Apipie.active_dsl? || _apipie_dsl_data[:api_args].blank?
    _apipie_dsl_data_clear
    return
  end

  begin
    _apipie_concern_data << [method_name, _apipie_dsl_data.merge(:from_concern => true)]
  ensure
    _apipie_dsl_data_clear
  end

end