Class: Pageflow::Configuration
- Inherits:
-
Object
- Object
- Pageflow::Configuration
- Defined in:
- lib/pageflow/configuration.rb
Overview
Options to be defined in the pageflow initializer of the main app.
Instance Attribute Summary collapse
-
#confirm_encoding_jobs ⇒ Object
Submit video/audio encoding jobs only after the user has explicitly confirmed in the editor.
-
#editor_route_constraint ⇒ Object
A constraint used by the pageflow engine to restrict access to the editor related HTTP end points.
-
#editor_routing_constraint ⇒ Object
Either a lambda or an object with a ‘match?` method, to restrict access to the editor routes defined by Pageflow.
-
#hooks ⇒ Object
readonly
Subscribe to hooks in order to be notified of events.
-
#mailer_sender ⇒ Object
The email address to use as from header in invitation mails to new users.
-
#paperclip_attachments_version ⇒ Object
String to interpolate into paths of files generated by paperclip preprocessors.
-
#paperclip_filesystem_default_options ⇒ Object
Default options for paperclip attachments which are supposed to use filesystem storage.
-
#paperclip_filesystem_root ⇒ Object
Path to the location in the filesystem where attachments shall be stored.
-
#paperclip_s3_default_options ⇒ Object
Default options for paperclip attachments which are supposed to use s3 storage.
-
#public_entry_request_scope ⇒ Object
Either a lambda or an object with a ‘call` method taking two parameters: An `ActiveRecord` scope of `Pageflow::Entry` records and an `ActionDispatch::Request` object.
-
#public_entry_url_options ⇒ Object
Either a lambda or an object with a ‘call` method taking a Theming as paramater and returing a hash of options used to construct the url of a published entry.
-
#quotas ⇒ Object
Limit the use of certain resources.
-
#themes ⇒ Themes
readonly
Additional themes can be registered to use custom css.
-
#theming_request_scope ⇒ Object
Either a lambda or an object with a ‘call` method taking two parameters: An `ActiveRecord` scope of Theming records and an ActionDispatch::Request object.
-
#zencoder_options ⇒ Object
Refer to the pageflow initializer template for a list of supported options.
Instance Method Summary collapse
-
#initialize ⇒ Configuration
constructor
A new instance of Configuration.
- #lookup_page_type(name) ⇒ Object
- #page_type_names ⇒ Object
- #page_types ⇒ Object
-
#register_page_type(page_type) ⇒ Object
Make a page type available for use in the system.
- #revision_components ⇒ Object
- #theming_url_options(theming) ⇒ Object private
Constructor Details
#initialize ⇒ Configuration
Returns a new instance of Configuration.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/pageflow/configuration.rb', line 125 def initialize @paperclip_filesystem_default_options = {} @paperclip_s3_default_options = {} @zencoder_options = {} @mailer_sender = '[email protected]' @hooks = Hooks.new @quotas = Quotas.new @themes = Themes.new @theming_request_scope = CnameThemingRequestScope.new @public_entry_request_scope = lambda { |entries, request| entries } @public_entry_url_options = Pageflow::ThemingsHelper::DEFAULT_PUBLIC_ENTRY_OPTIONS @confirm_encoding_jobs = false end |
Instance Attribute Details
#confirm_encoding_jobs ⇒ Object
Submit video/audio encoding jobs only after the user has explicitly confirmed in the editor. Defaults to false.
123 124 125 |
# File 'lib/pageflow/configuration.rb', line 123 def confirm_encoding_jobs @confirm_encoding_jobs end |
#editor_route_constraint ⇒ Object
A constraint used by the pageflow engine to restrict access to the editor related HTTP end points. This can be used to ensure the editor is only accessable via a certain host when different CNAMES are used to access the public end points of pageflow.
30 31 32 |
# File 'lib/pageflow/configuration.rb', line 30 def editor_route_constraint @editor_route_constraint end |
#editor_routing_constraint ⇒ Object
Either a lambda or an object with a ‘match?` method, to restrict access to the editor routes defined by Pageflow.
This can be used if published entries shall be available under different CNAMES but the admin and the editor shall only be accessible via one official url.
69 70 71 |
# File 'lib/pageflow/configuration.rb', line 69 def editor_routing_constraint @editor_routing_constraint end |
#hooks ⇒ Object (readonly)
Subscribe to hooks in order to be notified of events. Any object with a call method can be a subscriber
Example:
config.hooks.subscribe(:submit_file, -> { do_something })
43 44 45 |
# File 'lib/pageflow/configuration.rb', line 43 def hooks @hooks end |
#mailer_sender ⇒ Object
The email address to use as from header in invitation mails to new users
34 35 36 |
# File 'lib/pageflow/configuration.rb', line 34 def mailer_sender @mailer_sender end |
#paperclip_attachments_version ⇒ Object
String to interpolate into paths of files generated by paperclip preprocessors. This allows to refresh cdn caches after reprocessing attachments.
15 16 17 |
# File 'lib/pageflow/configuration.rb', line 15 def @paperclip_attachments_version end |
#paperclip_filesystem_default_options ⇒ Object
Default options for paperclip attachments which are supposed to use filesystem storage.
6 7 8 |
# File 'lib/pageflow/configuration.rb', line 6 def @paperclip_filesystem_default_options end |
#paperclip_filesystem_root ⇒ Object
Path to the location in the filesystem where attachments shall be stored. The value of this option is available via the pageflow_filesystem_root paperclip interpolation.
20 21 22 |
# File 'lib/pageflow/configuration.rb', line 20 def paperclip_filesystem_root @paperclip_filesystem_root end |
#paperclip_s3_default_options ⇒ Object
Default options for paperclip attachments which are supposed to use s3 storage.
10 11 12 |
# File 'lib/pageflow/configuration.rb', line 10 def @paperclip_s3_default_options end |
#public_entry_request_scope ⇒ Object
Either a lambda or an object with a ‘call` method taking two parameters: An `ActiveRecord` scope of `Pageflow::Entry` records and an `ActionDispatch::Request` object. Has to return the scope in which to find entries.
Used by all public actions that display entries to restrict the available entries by hostname or other request attributes.
Use #public_entry_url_options to make sure urls of published entries conform twith the restrictions.
Example:
# Only make entries of one account available under <account.name>.example.com
config.public_entry_request_scope = lambda do |entries, request|
entries.includes(:account).where(pageflow_accounts: {name: request.subdomain})
end
105 106 107 |
# File 'lib/pageflow/configuration.rb', line 105 def public_entry_request_scope @public_entry_request_scope end |
#public_entry_url_options ⇒ Object
Either a lambda or an object with a ‘call` method taking a Theming as paramater and returing a hash of options used to construct the url of a published entry.
Can be used to change the host of the url under which entries are available.
Example:
config. = lambda do |theming|
{host: "#{theming.account.name}.example.com"}
end
119 120 121 |
# File 'lib/pageflow/configuration.rb', line 119 def @public_entry_url_options end |
#quotas ⇒ Object
Limit the use of certain resources. Any object implementing the interface of Pageflow::Quota can be registered.
Example:
config.quotas.register(:users, UserQuota)
52 53 54 |
# File 'lib/pageflow/configuration.rb', line 52 def quotas @quotas end |
#themes ⇒ Themes (readonly)
Additional themes can be registered to use custom css.
Example:
config.themes.register(:custom)
61 62 63 |
# File 'lib/pageflow/configuration.rb', line 61 def themes @themes end |
#theming_request_scope ⇒ Object
Either a lambda or an object with a ‘call` method taking two parameters: An `ActiveRecord` scope of Theming records and an ActionDispatch::Request object. Has to return the scope in which to find themings.
Defaults to Pageflow::CnameThemingRequestScope which finds themings based on the request subdomain. Can be used to alter the logic of finding a theming whose home_url to redirect to when visiting the public root path.
Example:
config.theming_request_scope = lambda do |themings, request|
themings.where(id: Pageflow::Account.find_by_name!(request.subdomain).default_theming_id)
end
86 87 88 |
# File 'lib/pageflow/configuration.rb', line 86 def theming_request_scope @theming_request_scope end |
#zencoder_options ⇒ Object
Refer to the pageflow initializer template for a list of supported options.
24 25 26 |
# File 'lib/pageflow/configuration.rb', line 24 def @zencoder_options end |
Instance Method Details
#lookup_page_type(name) ⇒ Object
152 153 154 |
# File 'lib/pageflow/configuration.rb', line 152 def lookup_page_type(name) @page_types_by_name.fetch(name) end |
#page_type_names ⇒ Object
160 161 162 |
# File 'lib/pageflow/configuration.rb', line 160 def page_type_names page_types.map(&:name) end |
#page_types ⇒ Object
156 157 158 |
# File 'lib/pageflow/configuration.rb', line 156 def page_types @page_types ||= [] end |
#register_page_type(page_type) ⇒ Object
Make a page type available for use in the system.
145 146 147 148 149 150 |
# File 'lib/pageflow/configuration.rb', line 145 def register_page_type(page_type) page_types << page_type @page_types_by_name ||= {} @page_types_by_name[page_type.name] = page_type end |
#revision_components ⇒ Object
164 165 166 |
# File 'lib/pageflow/configuration.rb', line 164 def revision_components page_types.map(&:revision_components).flatten.uniq end |
#theming_url_options(theming) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
169 170 171 172 |
# File 'lib/pageflow/configuration.rb', line 169 def (theming) = .respond_to?(:call) ? .call(theming) : end |