class ApipieDSL::Configuration
Attributes
app_info[RW]
app_name[RW]
authenticate[RW]
autoload_methods[RW]
autoload_methods?[RW]
cache_dir[W]
class_full_names[RW]
class_full_names?[RW]
copyright[RW]
debug[RW]
default_locale[RW]
default_section[W]
default_version[RW]
doc_base_url[RW]
doc_path[RW]
dsl_classes_matcher[RW]
dsl_classes_matchers[W]
help_layout[RW]
ignored[W]
languages[RW]
layout[RW]
link_extension[RW]
locale[RW]
markup[RW]
rails[RW]
rails?[RW]
reload_dsl[W]
sections[RW]
translate[RW]
use_cache[RW]
use_cache?[RW]
validate[RW]
validate?[RW]
validate_value[W]
version_in_url[RW]
Public Class Methods
new()
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 64 def initialize @markup = ApipieDSL::Markup::RDoc.new @app_name = 'Another DOC' @app_info = {} @copyright = nil @validate = false @validate_value = true @doc_base_url = '/apipie-dsl' @layout = 'apipie_dsl/apipie_dsl' @default_version = '1.0' @debug = false @version_in_url = true @doc_path = 'doc' @link_extension = '.html' @languages = [] @default_locale = 'en' @locale = lambda { |_locale| @default_locale } @translate = lambda { |str, _locale| str } @class_full_names = true @autoload_methods = false @dsl_classes_matcher = '' @dsl_classes_matchers = [] @sections = ['all'] @default_section = nil @rails = true end
Public Instance Methods
app_info=(description)
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 39 def app_info=(description) version = ApipieDSL.configuration.default_version @app_info[version] = description end
cache_dir()
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 19 def cache_dir return @cache_dir if @cache_dir raise ConfigurationError.new('Please specify cache_dir to be able to use caching.') unless rails? @cache_dir = File.join(Rails.root, 'public', 'apipie-dsl-cache') end
default_section()
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 60 def default_section @default_section || @sections.first end
dsl_classes_matchers()
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 44 def dsl_classes_matchers unless @dsl_classes_matcher.empty? @dsl_classes_matchers << @dsl_classes_matcher end @dsl_classes_matchers = @dsl_classes_matchers.uniq end
ignored()
click to toggle source
array of class names (strings) (might include methods as well) to be ignored when generationg the documentation e.g. %w[DSL::MyClass DSL::IO#puts]
# File lib/apipie_dsl/configuration.rb, line 34 def ignored @ignored ||= [] @ignored.map(&:to_s) end
reload_dsl?()
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 51 def reload_dsl? @reload_dsl = if rails? Rails.env.development? else @reload_dsl end @reload_dsl && !dsl_classes_matchers.empty? end
validate_value()
click to toggle source
# File lib/apipie_dsl/configuration.rb, line 26 def validate_value (validate? && @validate_value) end
Also aliased as: validate_value?