Class: Alchemy::Page
- Inherits:
-
BaseRecord
- Object
- ActiveRecord::Base
- BaseRecord
- Alchemy::Page
- Includes:
- Hints, Logger, PageElements, PageLayouts, PageNaming, PageNatures, PageScopes, Taggable
- Defined in:
- app/models/alchemy/page/page_scopes.rb,
app/models/alchemy/page.rb,
app/models/alchemy/page/url_path.rb,
app/models/alchemy/page/publisher.rb,
app/models/alchemy/page/page_naming.rb,
app/models/alchemy/page/page_layouts.rb,
app/models/alchemy/page/page_natures.rb,
app/models/alchemy/page/page_elements.rb,
app/models/alchemy/page/fixed_attributes.rb
Overview
ActiveRecord scopes for Alchemy::Page
Defined Under Namespace
Modules: PageElements, PageLayouts, PageNaming, PageNatures, PageScopes Classes: FixedAttributes, Publisher, UrlPath
Constant Summary collapse
- DEFAULT_ATTRIBUTES_FOR_COPY =
{ autogenerate_elements: false, public_on: nil, public_until: nil, locked_at: nil, locked_by: nil }
- SKIPPED_ATTRIBUTES_ON_COPY =
%w[ id updated_at created_at creator_id updater_id lft rgt depth urlname cached_tag_list ]
- PERMITTED_ATTRIBUTES =
[ :meta_description, :meta_keywords, :name, :page_layout, :public_on, :public_until, :restricted, :robot_index, :robot_follow, :searchable, :sitemap, :tag_list, :title, :urlname, :layoutpage, :menu_id ]
Constants included from PageNaming
Constants included from SearchableResource
SearchableResource::SEARCHABLE_COLUMN_TYPES
Class Method Summary collapse
- .alchemy_resource_filters ⇒ Object
- .all_from_clipboard(clipboard) ⇒ Object
- .all_from_clipboard_for_select(clipboard, language_id, layoutpages: false) ⇒ Object
-
.copy(source, differences = {}) ⇒ Alchemy::Page
Creates a copy of given source.
- .copy_and_paste(source, new_parent, new_name) ⇒ Object
-
.current_preview ⇒ Object
Returns the current page id previewed in the edit page template.
-
.current_preview=(page) ⇒ Object
Used to store the current page id previewed in the edit page template.
-
.language_root_for(language_id) ⇒ Object
The language root page for given language id.
- .link_target_options ⇒ Object
- .searchable_alchemy_resource_attributes ⇒ Object
-
.url_path_class ⇒ Object
The url_path class.
-
.url_path_class=(klass) ⇒ Object
Set a custom url path class.
Instance Method Summary collapse
-
#attribute_fixed?(name) ⇒ Boolean
True if given attribute name is defined as fixed.
- #copy_children_to(new_parent) ⇒ Object
-
#creator_name ⇒ Object
Returns the name of the creator of this page.
-
#editable_by?(user) ⇒ Boolean
Checks the current page’s list of editors, if defined.
-
#find_elements(options = {}) ⇒ ActiveRecord::Relation
Returns elements from pages public version.
-
#first_public_child ⇒ Object
Returns the first published child.
-
#fixed_attributes ⇒ Object
Holds an instance of
FixedAttributes
. - #fold!(user_id, status) ⇒ Object
-
#get_language_root ⇒ Object
Gets the language_root page for page.
-
#hint_translation_attribute ⇒ Object
Key hint translations by page layout, rather than the default name.
- #inherit_restricted_status ⇒ Object
-
#lock_to!(user) ⇒ Object
Locks the page to given user.
-
#locker_name ⇒ Object
Returns the name of the user currently editing this page.
-
#menus ⇒ Object
Menus (aka. root nodes) this page is attached to.
-
#next(options = {}) ⇒ Object
(also: #next_page)
Returns the next page on the same level or nil.
-
#previous(options = {}) ⇒ Object
(also: #previous_page)
Returns the previous page on the same level or nil.
-
#public_on ⇒ Object
Returns the value of
public_on
attribute from public version. -
#public_on=(time) ⇒ Object
Sets the public_on date on the published version.
-
#public_until ⇒ Object
Returns the value of
public_until
attribute. -
#publish!(current_time = Time.current) ⇒ Object
Creates a public version of the page in the background.
- #set_restrictions_to_child_pages ⇒ Object
-
#to_partial_path ⇒ Object
The page’s view partial is dependent from its page layout.
-
#unlock! ⇒ Object
Unlocks the page without updating the timestamps.
-
#update_node!(node) ⇒ Object
Updates an Alchemy::Page based on a new ordering to be applied to it.
-
#updater_name ⇒ Object
Returns the name of the last updater of this page.
-
#url_path ⇒ Object
The url_path for this page.
Methods included from PageElements
#available_element_definitions, #available_element_names, #available_elements_within_current_scope, #descendent_element_definitions, #element_definition_names, #element_definitions, #element_definitions_by_name, #richtext_ingredients_ids
Methods included from PageNaming
#renamed?, #slug, #update_urlname!
Methods included from NameConversions
#convert_to_humanized_name, #convert_to_urlname
Methods included from PageNatures
#cache_page?, #cache_version, #definition, #editor_roles, #expiration_time, #folded?, #has_limited_editors?, #layout_display_name, #layout_partial_name, #locked?, #public?, #rootpage?, #status, #status_title
Methods included from Taggable
Methods included from Logger
Methods included from Hints
Methods included from SearchableResource
#ransackable_associations, #ransackable_attributes, #ransortable_attributes
Class Method Details
.alchemy_resource_filters ⇒ Object
184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'app/models/alchemy/page.rb', line 184 def alchemy_resource_filters [ { name: :by_page_layout, values: PageLayout.all.map { |p| [Alchemy.t(p["name"], scope: "page_layout_names"), p["name"]] } }, { name: :status, values: %w[published not_public restricted] } ] end |
.all_from_clipboard(clipboard) ⇒ Object
253 254 255 256 257 |
# File 'app/models/alchemy/page.rb', line 253 def all_from_clipboard(clipboard) return [] if clipboard.blank? where(id: clipboard.collect { |p| p["id"] }) end |
.all_from_clipboard_for_select(clipboard, language_id, layoutpages: false) ⇒ Object
259 260 261 262 263 264 265 266 |
# File 'app/models/alchemy/page.rb', line 259 def all_from_clipboard_for_select(clipboard, language_id, layoutpages: false) return [] if clipboard.blank? clipboard_pages = all_from_clipboard(clipboard) allowed_page_layouts = Alchemy::Page.selectable_layouts(language_id, layoutpages: layoutpages) allowed_page_layout_names = allowed_page_layouts.collect { |p| p["name"] } clipboard_pages.select { |cp| allowed_page_layout_names.include?(cp.page_layout) } end |
.copy(source, differences = {}) ⇒ Alchemy::Page
Creates a copy of given source.
Also copies all elements included in source.
Note:
It prevents the element auto generator from running.
235 236 237 |
# File 'app/models/alchemy/page.rb', line 235 def copy(source, differences = {}) Alchemy::CopyPage.new(page: source).call(changed_attributes: differences) end |
.copy_and_paste(source, new_parent, new_name) ⇒ Object
239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'app/models/alchemy/page.rb', line 239 def copy_and_paste(source, new_parent, new_name) page = Alchemy::CopyPage.new(page: source) .call(changed_attributes: { parent: new_parent, language: new_parent&.language, name: new_name, title: new_name }) if source.children.any? source.copy_children_to(page) end page end |
.current_preview ⇒ Object
Returns the current page id previewed in the edit page template.
209 210 211 |
# File 'app/models/alchemy/page.rb', line 209 def current_preview RequestStore.store[:alchemy_current_preview] end |
.current_preview=(page) ⇒ Object
Used to store the current page id previewed in the edit page template.
203 204 205 |
# File 'app/models/alchemy/page.rb', line 203 def current_preview=(page) RequestStore.store[:alchemy_current_preview] = page&.id end |
.language_root_for(language_id) ⇒ Object
Returns the language root page for given language id.
216 217 218 |
# File 'app/models/alchemy/page.rb', line 216 def language_root_for(language_id) language_roots.find_by_language_id(language_id) end |
.link_target_options ⇒ Object
268 269 270 271 272 273 274 275 276 |
# File 'app/models/alchemy/page.rb', line 268 def = [[Alchemy.t(:default, scope: "link_target_options"), ""]] = Config.get(:link_target_options) .each do |option| << [Alchemy.t(option, scope: "link_target_options", default: option.to_s.humanize), option] end end |
.searchable_alchemy_resource_attributes ⇒ Object
197 198 199 |
# File 'app/models/alchemy/page.rb', line 197 def searchable_alchemy_resource_attributes %w[name urlname title] end |
.url_path_class ⇒ Object
The url_path class
171 172 173 |
# File 'app/models/alchemy/page.rb', line 171 def url_path_class @_url_path_class ||= Alchemy::Page::UrlPath end |
.url_path_class=(klass) ⇒ Object
Set a custom url path class
# config/initializers/alchemy.rb
Alchemy::Page.url_path_class = MyPageUrlPathClass
180 181 182 |
# File 'app/models/alchemy/page.rb', line 180 def url_path_class=(klass) @_url_path_class = klass end |
Instance Method Details
#attribute_fixed?(name) ⇒ Boolean
True if given attribute name is defined as fixed
470 471 472 |
# File 'app/models/alchemy/page.rb', line 470 def attribute_fixed?(name) fixed_attributes.fixed?(name) end |
#copy_children_to(new_parent) ⇒ Object
406 407 408 409 410 411 412 413 414 415 416 417 418 |
# File 'app/models/alchemy/page.rb', line 406 def copy_children_to(new_parent) children.each do |child| next if child == new_parent new_child = Alchemy::CopyPage.new(page: child).call(changed_attributes: { parent_id: new_parent.id, language_id: new_parent.language_id, language_code: new_parent.language_code }) new_child.move_to_child_of(new_parent) child.copy_children_to(new_child) unless child.children.blank? end end |
#creator_name ⇒ Object
Returns the name of the creator of this page.
If no creator could be found or associated user model does not respond to #name
it returns ‘unknown’
506 507 508 |
# File 'app/models/alchemy/page.rb', line 506 def creator_name creator.try(:name) || Alchemy.t("unknown") end |
#editable_by?(user) ⇒ Boolean
Checks the current page’s list of editors, if defined.
This allows us to pass in a user and see if any of their roles are enable them to make edits
479 480 481 482 483 |
# File 'app/models/alchemy/page.rb', line 479 def editable_by?(user) return true unless has_limited_editors? (editor_roles & user.alchemy_roles).any? end |
#find_elements(options = {}) ⇒ ActiveRecord::Relation
Returns elements from pages public version.
You can pass another page_version to load elements from in the options.
308 309 310 311 |
# File 'app/models/alchemy/page.rb', line 308 def find_elements( = {}) finder = [:finder] || Alchemy::ElementsFinder.new() finder.elements(page_version: [:page_version] || public_version) end |
#first_public_child ⇒ Object
Returns the first published child
397 398 399 |
# File 'app/models/alchemy/page.rb', line 397 def first_public_child children.published.first end |
#fixed_attributes ⇒ Object
Holds an instance of FixedAttributes
465 466 467 |
# File 'app/models/alchemy/page.rb', line 465 def fixed_attributes @_fixed_attributes ||= FixedAttributes.new(self) end |
#fold!(user_id, status) ⇒ Object
380 381 382 383 384 |
# File 'app/models/alchemy/page.rb', line 380 def fold!(user_id, status) folded_page = folded_pages.find_or_create_by(user_id: user_id) folded_page.folded = status folded_page.save! end |
#get_language_root ⇒ Object
Gets the language_root page for page
402 403 404 |
# File 'app/models/alchemy/page.rb', line 402 def get_language_root self_and_ancestors.find_by(language_root: true) end |
#hint_translation_attribute ⇒ Object
Key hint translations by page layout, rather than the default name.
530 531 532 |
# File 'app/models/alchemy/page.rb', line 530 def hint_translation_attribute page_layout end |
#inherit_restricted_status ⇒ Object
392 393 394 |
# File 'app/models/alchemy/page.rb', line 392 def inherit_restricted_status self.restricted = parent.restricted? end |
#lock_to!(user) ⇒ Object
Locks the page to given user
368 369 370 |
# File 'app/models/alchemy/page.rb', line 368 def lock_to!(user) update_columns(locked_at: Time.current, locked_by: user.id) end |
#locker_name ⇒ Object
Returns the name of the user currently editing this page.
If no locker could be found or associated user model does not respond to #name
it returns ‘unknown’
524 525 526 |
# File 'app/models/alchemy/page.rb', line 524 def locker_name locker.try(:name) || Alchemy.t("unknown") end |
#menus ⇒ Object
Menus (aka. root nodes) this page is attached to
536 537 538 |
# File 'app/models/alchemy/page.rb', line 536 def @_menus ||= nodes.map(&:root) end |
#next(options = {}) ⇒ Object Also known as: next_page
Returns the next page on the same level or nil.
359 360 361 362 |
# File 'app/models/alchemy/page.rb', line 359 def next( = {}) pages = self_and_siblings.where("lft > ?", lft) select_page(pages, .merge(order: :asc)) end |
#previous(options = {}) ⇒ Object Also known as: previous_page
Returns the previous page on the same level or nil.
345 346 347 348 |
# File 'app/models/alchemy/page.rb', line 345 def previous( = {}) pages = self_and_siblings.where("lft < ?", lft) select_page(pages, .merge(order: :desc)) end |
#public_on ⇒ Object
Returns the value of public_on
attribute from public version
If it’s a fixed attribute then the fixed value is returned instead
489 490 491 |
# File 'app/models/alchemy/page.rb', line 489 def public_on attribute_fixed?(:public_on) ? fixed_attributes[:public_on] : public_version&.public_on end |
#public_on=(time) ⇒ Object
Sets the public_on date on the published version
Builds a new version if none exists yet. Destroys public version if empty time is set
431 432 433 434 435 436 437 438 439 440 441 |
# File 'app/models/alchemy/page.rb', line 431 def public_on=(time) if public_version && time.blank? public_version.destroy! # Need to reset the public version on the instance so we do not need to reload self.public_version = nil elsif public_version public_version.public_on = time elsif time.present? versions.build(public_on: time) end end |
#public_until ⇒ Object
Returns the value of public_until
attribute
If it’s a fixed attribute then the fixed value is returned instead
497 498 499 |
# File 'app/models/alchemy/page.rb', line 497 def public_until attribute_fixed?(:public_until) ? fixed_attributes[:public_until] : public_version&.public_until end |
#publish!(current_time = Time.current) ⇒ Object
Creates a public version of the page in the background.
422 423 424 |
# File 'app/models/alchemy/page.rb', line 422 def publish!(current_time = Time.current) PublishPageJob.perform_later(id, public_on: current_time) end |
#set_restrictions_to_child_pages ⇒ Object
386 387 388 389 390 |
# File 'app/models/alchemy/page.rb', line 386 def set_restrictions_to_child_pages descendants.each do |child| child.update(restricted: restricted?) end end |
#to_partial_path ⇒ Object
The page’s view partial is dependent from its page layout
Define page layouts
Page layouts are defined in the config/alchemy/page_layouts.yml
file
- name: contact
elements: [contactform]
...
Override the view
Page layout partials live in app/views/alchemy/page_layouts
334 335 336 |
# File 'app/models/alchemy/page.rb', line 334 def to_partial_path "alchemy/page_layouts/#{layout_partial_name}" end |
#unlock! ⇒ Object
Unlocks the page without updating the timestamps
374 375 376 377 378 |
# File 'app/models/alchemy/page.rb', line 374 def unlock! if update_columns(locked_at: nil, locked_by: nil) Page.current_preview = nil end end |
#update_node!(node) ⇒ Object
Updates an Alchemy::Page based on a new ordering to be applied to it
Note: Page’s urls should not be updated (and a legacy URL created) if nesting is OFF or if the URL is the same
453 454 455 456 457 458 459 460 461 462 |
# File 'app/models/alchemy/page.rb', line 453 def update_node!(node) hash = {lft: node.left, rgt: node.right, parent_id: node.parent, depth: node.depth, restricted: node.restricted} if urlname != node.url LegacyPageUrl.create(page_id: id, urlname: urlname) hash[:urlname] = node.url end update_columns(hash) end |
#updater_name ⇒ Object
Returns the name of the last updater of this page.
If no updater could be found or associated user model does not respond to #name
it returns ‘unknown’
515 516 517 |
# File 'app/models/alchemy/page.rb', line 515 def updater_name updater.try(:name) || Alchemy.t("unknown") end |
#url_path ⇒ Object
The url_path for this page
316 317 318 |
# File 'app/models/alchemy/page.rb', line 316 def url_path self.class.url_path_class.new(self).call end |