Module: SwaggerDocsGenerator

Defined in:
lib/swagger_docs_generator/info.rb,
lib/swagger_docs_generator/methods.rb,
lib/swagger_docs_generator/railtie.rb,
lib/swagger_docs_generator/extractor.rb,
lib/swagger_docs_generator/generator.rb,
lib/swagger_docs_generator/models/mongo.rb,
lib/swagger_docs_generator/parser/model.rb,
lib/swagger_docs_generator/metadata/info.rb,
lib/swagger_docs_generator/parser/action.rb,
lib/swagger_docs_generator/parser/parser.rb,
lib/swagger_docs_generator/metadata/jsons.rb,
lib/swagger_docs_generator/metadata/metadata.rb,
lib/swagger_docs_generator/parser/controller.rb,
lib/swagger_docs_generator/parser/definition.rb,
lib/swagger_docs_generator/metadata/controller.rb,
lib/swagger_docs_generator/metadata/definition.rb,
lib/swagger_docs_generator/models/active_record.rb,
lib/swagger_docs_generator/parser/actions/schema.rb,
lib/swagger_docs_generator/metadata/configuration.rb,
lib/swagger_docs_generator/parser/actions/actions.rb,
lib/swagger_docs_generator/parser/actions/response.rb,
lib/swagger_docs_generator/parser/actions/parameters.rb,
lib/swagger_docs_generator/configuration/configuration.rb,
lib/swagger_docs_generator/parser/actions/parameters/body.rb,
lib/swagger_docs_generator/parser/actions/parameters/form.rb,
lib/swagger_docs_generator/parser/actions/parameters/path.rb,
lib/swagger_docs_generator/parser/actions/parameters/query.rb,
lib/generators/swagger_docs_generator/environment_generator.rb,
lib/generators/swagger_docs_generator/initializer_generator.rb,
lib/swagger_docs_generator/configuration/configuration_info.rb,
lib/swagger_docs_generator/parser/actions/parameters/header.rb

Overview

:reek:InstanceVariableAssumption :reek:NilCheck

Defined Under Namespace

Modules: Actions, Methods Classes: Configuration, ConfigurationInfo, EnvironmentGenerator, Extractor, Generator, InitializerGenerator, Metadata, MetadataConfiguration, MetadataController, MetadataDefinition, MetadataInfo, MetadataJsons, Model, ModelActiveRecord, ModelMongo, Parser, ParserAction, ParserController, ParserDefinition, Railtie

Constant Summary collapse

GEM =

Name to gem

'swagger_docs_generator'
VERSION =

Version to gem

'0.3.1'
AUTHORS =

Authors contributed to gem

['VAILLANT Jeremy'].freeze
EMAILS =

Email to ahuthors

['[email protected]'].freeze
SUMMARY =

Short description

'Swagger UI json file'
DESCRIPTION =

Describe gem

'Generates swagger-ui json file for rails-api'
HOMEPAGE =

Homepage

'https://github.com/Dev-Crea/swagger-docs-generator'
LICENSE =

License

'MIT'
POST_INSTALL =

Define a post install message

"# ====================================================== #\n" \
"# Thanks for installing SwaggerDocsGenerator !           #\n" \
"# #{HOMEPAGE}.    #\n" \
"# ;;;;;;;;;;;:.                                          #\n" \
"# ;;;;;;;;;;;;;;;;;;                                     #\n" \
"# ;;;;;;;;;;;:;;;;;;;;                                   #\n" \
"# ;;;;;;;;;;` ;;;;;;;;                                   #\n" \
"# ;;;;;;;;;  :;;;;;;;;.                                  #\n" \
"# ;;;;;;;;   :::::;;;;;                                  #\n" \
"# ;;;;;;,       ,;;;;;;                                  #\n" \
"# ;;;;;        ;;;;;;;;                                  #\n" \
"# ;;;;;;;;;   ;;;;;;;;,                                  #\n" \
"# ;;;;;;;;; `;;;;;;;;;     A    ZZZZZZZ ZZZZZZZ LL       #\n" \
"# ;;;;;;;;.:;;;;;;;;;;    A A      ZZZ     ZZZ  LL       #\n" \
"# ;;;;;;;;;;;;;;;;;      AAAAA   ZZ      ZZ     LL       #\n" \
"# ;;;;;;;;;;;;;,        A     A ZZZZZZZ ZZZZZZZ LLLLLLL  #\n" \
'# ====================================================== #'

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



40
41
42
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 40

def config
  @config ||= Configuration.new
end

.configure ⇒ Object 



36
37
38
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 36

def configure
  block_given? ? yield(config) : config
end

.configure_info ⇒ Object 



22
23
24
 
# File 'lib/swagger_docs_generator/configuration/configuration_info.rb', line 22

def configure_info
  block_given? ? yield(info) : info
end

.file_base ⇒ Object 



44
45
46
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 44

def file_base
  File.join(@config.doc_folder, @config.doc_class)
end

.file_docs ⇒ Object 



48
49
50
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 48

def file_docs
  Dir[File.join(@config.doc_folder, '*.rb')]
end

.info ⇒ Object 



26
27
28
 
# File 'lib/swagger_docs_generator/configuration/configuration_info.rb', line 26

def info
  @info ||= ConfigurationInfo.new
end

.temporary_folder ⇒ Object 



52
53
54
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 52

def temporary_folder
  Rails.root.join('tmp', SwaggerDocsGenerator::GEM)
end

.version_ruby ⇒ Object 



30
31
32
 
# File 'lib/swagger_docs_generator/configuration/configuration_info.rb', line 30

def version_ruby
  @info.version.humanize
end