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, #api!, #def_param_group, #example, #resource_description, #see

Methods included from Common

#_apipie_define_validators, #_apipie_get_method_params, #_apipie_save_method_params, #api_versions, #desc, #document, #error, #formats, #header, #meta

Instance Method Details

#_apipie_concern_data ⇒ Object 



425
426
427
 
# File 'lib/apipie/dsl_definition.rb', line 425

def _apipie_concern_data
  @_apipie_concern_data ||= []
end

#apipie_concern? ⇒ Boolean

Returns:

  • (Boolean) 


429
430
431
 
# File 'lib/apipie/dsl_definition.rb', line 429

def apipie_concern?
  true
end

#included(controller) ⇒ Object

the concern was included into a controller



416
417
418
419
420
421
422
423
 
# File 'lib/apipie/dsl_definition.rb', line 416

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



434
435
436
437
438
439
440
441
442
 
# File 'lib/apipie/dsl_definition.rb', line 434

def method_added(method_name) #:doc:
  super

  return if ! Apipie.active_dsl? || !_apipie_dsl_data[:api]

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