Class: Apipie::Configuration

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/apipie/configuration.rb', line 122

def initialize
  @markup = Apipie::Markup::RDoc.new
  @app_name = "Another API"
  @app_info = HashWithIndifferentAccess.new
  @copyright = nil
  @validate = true
  @validate_value = true
  @validate_presence = true
  @required_by_default = false
  @api_base_url = HashWithIndifferentAccess.new
  @doc_base_url = "/apipie"
  @layout = "apipie/apipie"
  @disqus_shortname = nil
  @default_version = "1.0"
  @debug = false
  @version_in_url = true
  @namespaced_resources = false
  @doc_path = "doc"
  @process_params = false
  @checksum_path = [@doc_base_url, '/api/']
  @update_checksum = false
  @link_extension = ".html"
end

Instance Attribute Details

#api_base_url ⇒ Object

Returns the value of attribute api_base_url.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def api_base_url
  @api_base_url
end

#api_controllers_matcher ⇒ Object

matcher to be used in Dir.glob to find controllers to be reloaded e.g.

"#{Rails.root}/app/controllers/api/*.rb"



18
19
20
 
# File 'lib/apipie/configuration.rb', line 18

def api_controllers_matcher
  @api_controllers_matcher
end

#api_routes ⇒ Object

specify routes if used router differ from default e.g.

Api::Engine.routes



28
29
30
 
# File 'lib/apipie/configuration.rb', line 28

def api_routes
  @api_routes
end

#app_info ⇒ Object

Returns the value of attribute app_info.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def app_info
  @app_info
end

#app_name ⇒ Object

Returns the value of attribute app_name.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def app_name
  @app_name
end

#authenticate ⇒ Object

Returns the value of attribute authenticate.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def authenticate
  @authenticate
end

#cache_dir ⇒ Object 



58
59
60
 
# File 'lib/apipie/configuration.rb', line 58

def cache_dir
  @cache_dir ||= File.join(Rails.root, "public", "apipie-cache")
end

#checksum_path ⇒ Object

Returns the value of attribute checksum_path.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def checksum_path
  @checksum_path
end

#copyright ⇒ Object

Returns the value of attribute copyright.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def copyright
  @copyright
end

#debug ⇒ Object

Returns the value of attribute debug.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def debug
  @debug
end

#default_version ⇒ Object

Returns the value of attribute default_version.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def default_version
  @default_version
end

#disqus_shortname ⇒ Object

Returns the value of attribute disqus_shortname.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def disqus_shortname
  @disqus_shortname
end

#doc_base_url ⇒ Object

Returns the value of attribute doc_base_url.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def doc_base_url
  @doc_base_url
end

#doc_path ⇒ Object

Returns the value of attribute doc_path.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def doc_path
  @doc_path
end

#force_dsl=(value) ⇒ Object (writeonly)

if there is not obvious reason why the DSL should be turned on (no validations, cache turned on etc.), it’s disabled to avoid unneeded allocation. It you need the DSL for other reasons, you can force the activation.



66
67
68
 
# File 'lib/apipie/configuration.rb', line 66

def force_dsl=(value)
  @force_dsl = value
end

#generated_doc_disclaimer ⇒ Object 



94
95
96
 
# File 'lib/apipie/configuration.rb', line 94

def generated_doc_disclaimer
  @generated_doc_disclaimer ||= "# DOC GENERATED AUTOMATICALLY: REMOVE THIS LINE TO PREVENT REGENARATING NEXT TIME"
end

#ignored ⇒ Object 



84
85
86
87
 
# File 'lib/apipie/configuration.rb', line 84

def ignored
  @ignored ||= []
  @ignored.map(&:to_s)
end

#ignored_by_recorder ⇒ Object 



75
76
77
78
 
# File 'lib/apipie/configuration.rb', line 75

def ignored_by_recorder
  @ignored_by_recorder ||= []
  @ignored_by_recorder.map(&:to_s)
end

#layout ⇒ Object

Returns the value of attribute layout.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def layout
  @layout
end

#link_extension ⇒ Object

Returns the value of attribute link_extension.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def link_extension
  @link_extension
end

#markup ⇒ Object

Returns the value of attribute markup.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def markup
  @markup
end

#namespaced_resources ⇒ Object Also known as: namespaced_resources?

Returns the value of attribute namespaced_resources.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def namespaced_resources
  @namespaced_resources
end

#process_params ⇒ Object

Returns the value of attribute process_params.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def process_params
  @process_params
end

#reload_controllers=(value) ⇒ Object (writeonly)

set to true if you want to reload the controllers at each refresh of the documentation. It requires :api_controllers_matcher to be set to work properly.



23
24
25
 
# File 'lib/apipie/configuration.rb', line 23

def reload_controllers=(value)
  @reload_controllers = value
end

#required_by_default ⇒ Object Also known as: required_by_default?

Returns the value of attribute required_by_default.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def required_by_default
  @required_by_default
end

#show_all_examples ⇒ Object

Returns the value of attribute show_all_examples.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def show_all_examples
  @show_all_examples
end

#update_checksum ⇒ Object

Returns the value of attribute update_checksum.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def update_checksum
  @update_checksum
end

#use_cache ⇒ Object Also known as: use_cache?

set to true if you want to use pregenerated documentation cache and avoid generating the documentation on runtime (usefull for production environment). You can generate the cache by running

rake apipie:cache



54
55
56
 
# File 'lib/apipie/configuration.rb', line 54

def use_cache
  @use_cache
end

#validate ⇒ Object Also known as: validate?

Returns the value of attribute validate.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def validate
  @validate
end

#validate_presence ⇒ Object Also known as: validate_presence?

Returns the value of attribute validate_presence.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def validate_presence
  @validate_presence
end

#validate_value ⇒ Object Also known as: validate_value?

Returns the value of attribute validate_value.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def validate_value
  @validate_value
end

#version_in_url ⇒ Object

Returns the value of attribute version_in_url.



4
5
6
 
# File 'lib/apipie/configuration.rb', line 4

def version_in_url
  @version_in_url
end

Instance Method Details

#force_dsl? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/apipie/configuration.rb', line 67

def force_dsl?
  @force_dsl
end

#process_value? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/apipie/configuration.rb', line 45

def process_value?
  @process_params
end

#reload_controllers? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
 
# File 'lib/apipie/configuration.rb', line 30

def reload_controllers?
  @reload_controllers = Rails.env.development? unless defined? @reload_controllers
  return @reload_controllers && @api_controllers_matcher
end

#use_disqus? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/apipie/configuration.rb', line 98

def use_disqus?
  !@disqus_shortname.blank?
end