Class: Apipie::Generator::Swagger::TypeExtractor

Inherits:
Object
  • Object
show all
Defined in:
lib/apipie/generator/swagger/type_extractor.rb

Constant Summary collapse

TYPES = 
{
  numeric: 'number',
  hash: 'object',
  array: 'array',
  enum: 'enum',

  # see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
  integer: Apipie::Generator::Swagger::Type.new('integer', 'int32'),
  long: Apipie::Generator::Swagger::Type.new('integer', 'int64'),
  number: Apipie::Generator::Swagger::Type.new('number'),
  float: Apipie::Generator::Swagger::Type.new('number', 'float'),
  double: Apipie::Generator::Swagger::Type.new('number', 'double'),
  string: Apipie::Generator::Swagger::Type.new('string'),
  byte: Apipie::Generator::Swagger::Type.new('string', 'byte'),
  binary: Apipie::Generator::Swagger::Type.new('string', 'binary'),
  boolean: Apipie::Generator::Swagger::Type.new('boolean'),
  date: Apipie::Generator::Swagger::Type.new('string', 'date'),
  dateTime: Apipie::Generator::Swagger::Type.new('string', 'date-time'),
  password: Apipie::Generator::Swagger::Type.new('string', 'password')
}

Instance Method Summary collapse

Constructor Details

#initialize(validator) ⇒ TypeExtractor

Returns a new instance of TypeExtractor.

Parameters:



24
25
26
 
# File 'lib/apipie/generator/swagger/type_extractor.rb', line 24

def initialize(validator)
  @validator = validator
end

Instance Method Details

#extract ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/apipie/generator/swagger/type_extractor.rb', line 37

def extract
  expected_type =
    if string?
      :string
    elsif boolean?
      :boolean
    elsif enum?
      :enum
    else
      @validator.expected_type.to_sym
    end

  TYPES[expected_type] || @validator.expected_type
end

#extract_with_warnings(warnings = {}) ⇒ Object

Parameters:



29
30
31
32
33
34
35
 
# File 'lib/apipie/generator/swagger/type_extractor.rb', line 29

def extract_with_warnings(warnings = {})
  if boolean? && warnings[:boolean].present?
    Apipie::Generator::Swagger::WarningWriter.instance.warn(warnings[:boolean])
  end

  extract
end