Class: OpenapiBlocks::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_blocks/configuration.rb,
lib/openapi_blocks/configuration/info_builder.rb,
lib/openapi_blocks/configuration/server_builder.rb,
lib/openapi_blocks/configuration/contact_builder.rb,
lib/openapi_blocks/configuration/license_builder.rb,
lib/openapi_blocks/configuration/servers_builder.rb,
lib/openapi_blocks/configuration/security_builder.rb

Overview

rubocop:disable Style/Documentation

Defined Under Namespace

Classes: ContactBuilder, InfoBuilder, LicenseBuilder, SecurityBuilder, ServerBuilder, ServersBuilder

Constant Summary collapse

SUPPORTED_VERSIONS = 
%w[3.1.0 3.0.3].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



14
15
16
17
18
19
20
21
22
 
# File 'lib/openapi_blocks/configuration.rb', line 14

def initialize
  @openapi_version = "3.1.0"
  @watch           = :development
  @auto_serialize  = false
  @info            = InfoBuilder.new
  @servers         = []
  @security        = nil
  @configured      = false
end

Instance Attribute Details

#auto_serialize ⇒ Object

Returns the value of attribute auto_serialize.



12
13
14
 
# File 'lib/openapi_blocks/configuration.rb', line 12

def auto_serialize
  @auto_serialize
end

#openapi_version ⇒ Object

Returns the value of attribute openapi_version.



11
12
13
 
# File 'lib/openapi_blocks/configuration.rb', line 11

def openapi_version
  @openapi_version
end

#watch ⇒ Object

Returns the value of attribute watch.



12
13
14
 
# File 'lib/openapi_blocks/configuration.rb', line 12

def watch
  @watch
end

Instance Method Details

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/openapi_blocks/configuration.rb', line 24

def configured?
  @configured
end

#info(&block) ⇒ Object 



37
38
39
40
41
 
# File 'lib/openapi_blocks/configuration.rb', line 37

def info(&block)
  @configured = true if block
  @info.instance_eval(&block) if block
  @info
end

#security(&block) ⇒ Object 



49
50
51
52
53
 
# File 'lib/openapi_blocks/configuration.rb', line 49

def security(&block)
  @security ||= SecurityBuilder.new
  @security.instance_eval(&block) if block
  @security
end

#servers(&block) ⇒ Object 



43
44
45
46
47
 
# File 'lib/openapi_blocks/configuration.rb', line 43

def servers(&block)
  builder = ServersBuilder.new
  builder.instance_eval(&block) if block
  @servers = builder.servers
end

#to_h ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/openapi_blocks/configuration.rb', line 55

def to_h
  {
    info:    @info.to_h,
    servers: @servers.map(&:to_h)
  }
end