Module: ApipieDSL
- Extended by:
- Utils
- Defined in:
- lib/apipie_dsl/utils.rb,
lib/apipie_dsl.rb,
lib/apipie_dsl/dsl.rb,
lib/apipie_dsl/errors.rb,
lib/apipie_dsl/markup.rb,
lib/apipie_dsl/railtie.rb,
lib/apipie_dsl/routing.rb,
lib/apipie_dsl/version.rb,
lib/apipie_dsl/validator.rb,
lib/apipie_dsl/application.rb,
lib/apipie_dsl/tasks_utils.rb,
lib/apipie_dsl/configuration.rb,
lib/apipie_dsl/see_description.rb,
lib/apipie_dsl/apipie_dsl_module.rb,
lib/apipie_dsl/class_description.rb,
lib/apipie_dsl/static_dispatcher.rb,
lib/apipie_dsl/method_description.rb,
lib/apipie_dsl/return_description.rb,
lib/apipie_dsl/tag_list_description.rb,
lib/apipie_dsl/exception_description.rb,
lib/apipie_dsl/parameter_description.rb,
lib/generators/apipie_dsl/views_generator.rb,
lib/generators/apipie_dsl/install/install_generator.rb
Overview
rubocop:disable Style/FrozenStringLiteralComment
Defined Under Namespace
Modules: Base, Class, Common, Delegatable, Extension, Klass, Markup, Method, Module, Parameter, Routing, TasksUtils, Utils, Validator
Classes: Application, ClassDescription, Configuration, ConfigurationError, Error, ExceptionDescription, FileHandler, InstallGenerator, MethodDescription, MultipleDefinitionError, MultipleReturnsError, ParamError, ParamInvalid, ParamMissing, ParameterDescription, Railtie, ReturnDescription, ReturnsMultipleDefinitionError, SeeDescription, StaticDispatcher, TagListDescription, UnknownParam, ViewsGenerator
Constant Summary
collapse
- VERSION =
'2.5.0'
Instance Attribute Summary
Attributes included from Utils
#url_prefix
Class Method Summary
collapse
Methods included from Utils
full_url, include_javascripts, include_stylesheets, markup_to_html, request_script_name, request_script_name=, superclass_for
Class Method Details
.app_info(version = nil, lang = nil) ⇒ Object
36
37
38
39
40
41
42
43
44
45
46
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 36
def self.app_info(version = nil, lang = nil)
info = if app_info_version_valid?(version)
translate(configuration.app_info[version], lang)
elsif app_info_version_valid?(configuration.default_version)
translate(configuration.app_info[configuration.default_version], lang)
else
'Another DSL description'
end
ApipieDSL.markup_to_html(info)
end
|
.app_info_version_valid?(version) ⇒ Boolean
48
49
50
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 48
def self.app_info_version_valid?(version)
version && configuration.app_info.key?(version)
end
|
.configuration ⇒ Object
17
18
19
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 17
def self.configuration
@configuration ||= Configuration.new
end
|
13
14
15
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 13
def self.configure
yield configuration
end
|
.debug(message) ⇒ Object
27
28
29
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 27
def self.debug(message)
puts message if configuration.debug
end
|
.docs(version = nil, class_name = nil, method_name = nil, lang = nil, section = nil) ⇒ Object
21
22
23
24
25
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 21
def self.docs(version = nil, class_name = nil, method_name = nil, lang = nil, section = nil)
version ||= configuration.default_version
section ||= configuration.default_section
app.docs(version, class_name, method_name, lang, section)
end
|
.method_missing(method, *args, &block) ⇒ Object
All calls delegated to ApipieDSL::Application instance
32
33
34
|
# File 'lib/apipie_dsl/apipie_dsl_module.rb', line 32
def self.method_missing(method, *args, &block)
app.respond_to?(method) ? app.send(method, *args, &block) : super
end
|
.root ⇒ Object
25
26
27
|
# File 'lib/apipie_dsl.rb', line 25
def self.root
File.dirname(__dir__)
end
|