Class: RESTFramework::Config

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

Overview

Global configuration should be kept minimal, as controller-level configurations allows multiple APIs to be defined to behave differently.

Constant Summary collapse

DEFAULT_LABEL_FIELDS = 
%w[name label login title email username url].freeze
DEFAULT_SEARCH_COLUMNS = 
DEFAULT_LABEL_FIELDS + %w[description note].freeze
DEFAULT_EXCLUDE_BODY_FIELDS = 
%w[
  created_at
  created_by
  created_by_id
  updated_at
  updated_by
  updated_by_id
  _method
  utf8
  authenticity_token
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/rest_framework.rb', line 182

def initialize
  self.register_api_renderer = true
  self.auto_finalize = true

  self.show_backtrace = Rails.env.development?

  self.label_fields = DEFAULT_LABEL_FIELDS
  self.search_columns = DEFAULT_SEARCH_COLUMNS
  self.exclude_body_fields = DEFAULT_EXCLUDE_BODY_FIELDS
end

Instance Attribute Details

#auto_finalize ⇒ Object

Run ‘rrf_finalize` on controllers automatically using a `TracePoint` hook. This is `true` by default, and can be disabled for performance, and must be global because we have to determine this before any controller-specific configuration is set. If this is set to `false`, then you must manually call `rrf_finalize` after any configuration on each controller that needs to participate in:

- Model delegation, for the helper methods to be defined dynamically.
- Websockets, for `::Channel` class to be defined dynamically.
- Controller configuration freezing.



154
155
156
 
# File 'lib/rest_framework.rb', line 154

def auto_finalize
  @auto_finalize
end

#disable_rescue_from ⇒ Object

Disable ‘rescue_from` on the controller mixins.



167
168
169
 
# File 'lib/rest_framework.rb', line 167

def disable_rescue_from
  @disable_rescue_from
end

#exclude_body_fields ⇒ Object

The default list of fields to exclude from the body of the request.



176
177
178
 
# File 'lib/rest_framework.rb', line 176

def exclude_body_fields
  @exclude_body_fields
end

#freeze_config ⇒ Object

Freeze configuration attributes during finalization to prevent accidental mutation.



157
158
159
 
# File 'lib/rest_framework.rb', line 157

def freeze_config
  @freeze_config
end

#label_fields ⇒ Object

The default label fields to use when generating labels for ‘has_many` associations.



170
171
172
 
# File 'lib/rest_framework.rb', line 170

def label_fields
  @label_fields
end

#large_reverse_association_tables ⇒ Object

Specify reverse association tables that are typically very large, and therefore should not be added to fields by default.



161
162
163
 
# File 'lib/rest_framework.rb', line 161

def large_reverse_association_tables
  @large_reverse_association_tables
end

#register_api_renderer ⇒ Object

Permits use of ‘render(api: obj)` syntax over `render_api(obj)`; `true` by default.



144
145
146
 
# File 'lib/rest_framework.rb', line 144

def register_api_renderer
  @register_api_renderer
end

#search_columns ⇒ Object

The default search columns to use when generating search filters.



173
174
175
 
# File 'lib/rest_framework.rb', line 173

def search_columns
  @search_columns
end

#show_backtrace ⇒ Object

Whether the backtrace should be shown in rescued errors.



164
165
166
 
# File 'lib/rest_framework.rb', line 164

def show_backtrace
  @show_backtrace
end

#use_vendored_assets ⇒ Object

Option to use vendored assets (requires sprockets or propshaft) rather than linking to external assets (the default).



180
181
182
 
# File 'lib/rest_framework.rb', line 180

def use_vendored_assets
  @use_vendored_assets
end