Class: Rswag::Specs::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/rswag/specs/configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(rspec_config) ⇒ Configuration

Returns a new instance of Configuration.



6
7
8
 
# File 'lib/rswag/specs/configuration.rb', line 6

def initialize(rspec_config)
  @rspec_config = rspec_config
end

Instance Method Details

#get_swagger_doc(name) ⇒ Object

Raises:



42
43
44
45
46
 
# File 'lib/rswag/specs/configuration.rb', line 42

def get_swagger_doc(name)
  return swagger_docs.values.first if name.nil?
  raise ConfigurationError, "Unknown swagger_doc '#{name}'" unless swagger_docs[name]
  swagger_docs[name]
end

#swagger_docs ⇒ Object 



19
20
21
22
23
24
25
26
 
# File 'lib/rswag/specs/configuration.rb', line 19

def swagger_docs
  @swagger_docs ||= begin
    if @rspec_config.swagger_docs.nil? || @rspec_config.swagger_docs.empty?
      raise ConfigurationError, 'No swagger_docs defined. See swagger_helper.rb'
    end
    @rspec_config.swagger_docs
  end
end

#swagger_dry_run ⇒ Object 



28
29
30
31
32
 
# File 'lib/rswag/specs/configuration.rb', line 28

def swagger_dry_run
  @swagger_dry_run ||= begin
    @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
  end
end

#swagger_format ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/rswag/specs/configuration.rb', line 34

def swagger_format
  @swagger_format ||= begin
    @rspec_config.swagger_format = :json if @rspec_config.swagger_format.nil? || @rspec_config.swagger_format.empty?
    raise ConfigurationError, "Unknown swagger_format '#{@rspec_config.swagger_format}'" unless [:json, :yaml].include?(@rspec_config.swagger_format)
    @rspec_config.swagger_format
  end
end

#swagger_root ⇒ Object 



10
11
12
13
14
15
16
17
 
# File 'lib/rswag/specs/configuration.rb', line 10

def swagger_root
  @swagger_root ||= begin
    if @rspec_config.swagger_root.nil?
      raise ConfigurationError, 'No swagger_root provided. See swagger_helper.rb'
    end
    @rspec_config.swagger_root
  end
end