Class: Alchemy::Page

Inherits:
BaseRecord
  • Object
show all
Includes:
Logger, Definitions, PageElements, 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/definitions.rb,
app/models/alchemy/page/page_naming.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: Definitions, PageElements, 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

PageNaming::RESERVED_URLNAMES

Constants included from SearchableResource

SearchableResource::SEARCHABLE_COLUMN_TYPES

Class Method Summary collapse

Instance Method Summary collapse

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?, #last_modified_at, #layout_display_name, #layout_partial_name, #locked?, #public?, #rootpage?, #status, #status_message, #status_title

Methods included from Taggable

included, #tag_list=

Methods included from Logger

#log_warning, warn

Methods included from ConfigMissing

#const_missing

Methods included from SearchableResource

#ransackable_associations, #ransackable_attributes, #ransackable_scopes, #ransortable_attributes

Class Method Details

.all_from_clipboard(clipboard) ⇒ Object 



230
231
232
233
234
 
# File 'app/models/alchemy/page.rb', line 230

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 



236
237
238
239
240
241
242
243
 
# File 'app/models/alchemy/page.rb', line 236

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(&: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.

Parameters:

  • source (Alchemy::Page) —

    The source page the copy is taken from

  • differences (Hash) (defaults to: {}) —

    A optional hash with attributes that take precedence over the source attributes

Returns:



212
213
214
 
# File 'app/models/alchemy/page.rb', line 212

def copy(source, differences = {})
  Alchemy::CopyPage.new(page: source).call(changed_attributes: differences)
end

.copy_and_paste(source, new_parent, new_name) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'app/models/alchemy/page.rb', line 216

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

.language_root_for(language_id) ⇒ Object

Returns the language root page for given language id.

Parameters:

  • language_id (Fixnum)

Returns:

  • the language root page for given language id.



193
194
195
 
# File 'app/models/alchemy/page.rb', line 193

def language_root_for(language_id)
  language_roots.find_by_language_id(language_id)
end

.link_target_options ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
 
# File 'app/models/alchemy/page.rb', line 245

def link_target_options
  options = [[Alchemy.t(:default, scope: "link_target_options"), ""]]
  link_target_options = Alchemy.config.link_target_options
  link_target_options.each do |option|
    # add an underscore to the options to provide the default syntax
    # @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target
    options << [Alchemy.t(option, scope: "link_target_options",
      default: option.to_s.humanize), "_#{option}"]
  end
  options
end

.ransackable_attributes(_auth_object = nil) ⇒ Object

Allow all string and text attributes to be searchable by Ransack.



258
259
260
 
# File 'app/models/alchemy/page.rb', line 258

def ransackable_attributes(_auth_object = nil)
  searchable_alchemy_resource_attributes + ["updated_at"]
end

.searchable_alchemy_resource_attributes ⇒ Object 



186
187
188
 
# File 'app/models/alchemy/page.rb', line 186

def searchable_alchemy_resource_attributes
  %w[name urlname title]
end

.url_path_class ⇒ Object

The url_path class

See Also:



173
174
175
 
# File 'app/models/alchemy/page.rb', line 173

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



182
183
184
 
# File 'app/models/alchemy/page.rb', line 182

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

Returns:

  • (Boolean) 


435
436
437
 
# File 'app/models/alchemy/page.rb', line 435

def attribute_fixed?(name)
  fixed_attributes.fixed?(name)
end

#copy_children_to(new_parent) ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'app/models/alchemy/page.rb', line 390

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’



471
472
473
 
# File 'app/models/alchemy/page.rb', line 471

def creator_name
  creator.try(:alchemy_display_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

Returns:

  • (Boolean) 


444
445
446
447
448
 
# File 'app/models/alchemy/page.rb', line 444

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.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :only (Array<String>|String) —

    Returns only elements with given names

  • :except (Array<String>|String) —

    Returns all elements except the ones with given names

  • :count (Integer) —

    Limit the count of returned elements

  • :offset (Integer) —

    Starts with an offset while returning elements

  • :include_hidden (Boolean) — default: false —

    Return hidden elements as well

  • :random (Boolean) — default: false —

    Return elements randomly shuffled

  • :reverse (Boolean) — default: false —

    Reverse the load order

  • :finder (Class) — default: Alchemy::ElementsFinder —

    A class that will return elements from page. Use this for your custom element loading logic.

  • :page_version (Alchemy::PageVersion) —

    A page version to load elements from. Uses the pages public_version by default.

Returns:

  • (ActiveRecord::Relation) 


292
293
294
295
 
# File 'app/models/alchemy/page.rb', line 292

def find_elements(options = {})
  finder = options[:finder] || Alchemy::ElementsFinder.new(options)
  finder.elements(page_version: options[:page_version] || public_version)
end

#first_public_child ⇒ Object

Returns the first published child



381
382
383
 
# File 'app/models/alchemy/page.rb', line 381

def first_public_child
  children.published.first
end

#fixed_attributes ⇒ Object

Holds an instance of FixedAttributes



430
431
432
 
# File 'app/models/alchemy/page.rb', line 430

def fixed_attributes
  @_fixed_attributes ||= FixedAttributes.new(self)
end

#fold!(user_id, status) ⇒ Object 



364
365
366
367
368
 
# File 'app/models/alchemy/page.rb', line 364

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



386
387
388
 
# File 'app/models/alchemy/page.rb', line 386

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.



495
496
497
 
# File 'app/models/alchemy/page.rb', line 495

def hint_translation_attribute
  page_layout
end

#inherit_restricted_status ⇒ Object 



376
377
378
 
# File 'app/models/alchemy/page.rb', line 376

def inherit_restricted_status
  self.restricted = parent.restricted?
end

#lock_to!(user) ⇒ Object

Locks the page to given user



352
353
354
 
# File 'app/models/alchemy/page.rb', line 352

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’



489
490
491
 
# File 'app/models/alchemy/page.rb', line 489

def locker_name
  locker.try(:alchemy_display_name) || Alchemy.t("unknown")
end

#menus ⇒ Object

Menus (aka. root nodes) this page is attached to



501
502
503
 
# File 'app/models/alchemy/page.rb', line 501

def menus
  @_menus ||= nodes.map(&:root)
end

#next(options = {}) ⇒ Object Also known as: next_page

Returns the next page on the same level or nil.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :restricted (Boolean) — default: false —

    only restricted pages (true), skip restricted pages (false)

  • :public (Boolean) — default: true —

    only public pages (true), skip public pages (false)



343
344
345
346
 
# File 'app/models/alchemy/page.rb', line 343

def next(options = {})
  pages = self_and_siblings.where("lft > ?", lft)
  select_page(pages, options.merge(order: :asc))
end

#previous(options = {}) ⇒ Object Also known as: previous_page

Returns the previous page on the same level or nil.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :restricted (Boolean) — default: false —

    only restricted pages (true), skip restricted pages (false)

  • :public (Boolean) — default: true —

    only public pages (true), skip public pages (false)



329
330
331
332
 
# File 'app/models/alchemy/page.rb', line 329

def previous(options = {})
  pages = self_and_siblings.where("lft < ?", lft)
  select_page(pages, options.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



454
455
456
 
# File 'app/models/alchemy/page.rb', line 454

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



415
416
417
418
419
420
421
422
423
424
425
 
# File 'app/models/alchemy/page.rb', line 415

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



462
463
464
 
# File 'app/models/alchemy/page.rb', line 462

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.



406
407
408
 
# File 'app/models/alchemy/page.rb', line 406

def publish!(current_time = Time.current)
  PublishPageJob.perform_later(id, public_on: current_time)
end

#set_restrictions_to_child_pages ⇒ Object 



370
371
372
373
374
 
# File 'app/models/alchemy/page.rb', line 370

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



318
319
320
 
# File 'app/models/alchemy/page.rb', line 318

def to_partial_path
  "alchemy/page_layouts/#{layout_partial_name}"
end

#unlock! ⇒ Object

Unlocks the page without updating the timestamps



358
359
360
361
362
 
# File 'app/models/alchemy/page.rb', line 358

def unlock!
  if update_columns(locked_at: nil, locked_by: nil)
    Current.preview_page = nil
  end
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’



480
481
482
 
# File 'app/models/alchemy/page.rb', line 480

def updater_name
  updater.try(:alchemy_display_name) || Alchemy.t("unknown")
end

#url_path ⇒ Object

The url_path for this page

See Also:



300
301
302
 
# File 'app/models/alchemy/page.rb', line 300

def url_path
  self.class.url_path_class.new(self).call
end