Class: Refinery::Page

Inherits:
Core::BaseModel show all
Extended by:
FriendlyId, Mobility
Defined in:
pages/app/models/refinery/page.rb

Defined Under Namespace

Classes: FriendlyIdOptions, FriendlyIdPath, Translation

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Core::BaseModel

#users_manager

Class Method Details

.by_slug(slug, conditions = {}) ⇒ Object

Finds pages by their slug. This method is necessary because pages are translated which means the slug attribute does not exist on the pages table thus requiring us to find the attribute on the translations table and then join to the pages table again to return the associated record.


111
112
113
# File 'pages/app/models/refinery/page.rb', line 111

def by_slug(slug, conditions = {})
  Pages::Finder.by_slug(slug, conditions)
end

.by_title(title) ⇒ Object

Finds pages by their title. This method is necessary because pages are translated which means the title attribute does not exist on the pages table thus requiring us to find the attribute on the translations table and then join to the pages table again to return the associated record.


103
104
105
# File 'pages/app/models/refinery/page.rb', line 103

def by_title(title)
  Pages::Finder.by_title(title)
end

.fast_menuObject

An optimised scope containing only live pages ordered for display in a menu.


124
125
126
# File 'pages/app/models/refinery/page.rb', line 124

def fast_menu
  live.in_menu.order(arel_table[:lft]).includes(:parent, :translations)
end

.find_by_path(path) ⇒ Object

Find page by path, checking for scoping rules


75
76
77
# File 'pages/app/models/refinery/page.rb', line 75

def find_by_path(path)
  Pages::Finder.by_path(path)
end

.find_by_path_or_id(path, id) ⇒ Object

Helps to resolve the situation where you have a path and an id and if the path is unfriendly then a different finder method is required than find_by_path.


82
83
84
# File 'pages/app/models/refinery/page.rb', line 82

def find_by_path_or_id(path, id)
  Pages::Finder.by_path_or_id(path, id)
end

.find_by_path_or_id!(path, id) ⇒ Object

Helps to resolve the situation where you have a path and an id and if the path is unfriendly then a different finder method is required than find_by_path.

raise ActiveRecord::RecordNotFound if not found.

Raises:

  • (::ActiveRecord::RecordNotFound)

91
92
93
94
95
96
97
# File 'pages/app/models/refinery/page.rb', line 91

def find_by_path_or_id!(path, id)
  page = find_by_path_or_id(path, id)

  raise ::ActiveRecord::RecordNotFound unless page

  page
end

.in_menuObject

Shows all pages with :show_in_menu set to true, but it also rejects any page that has not been translated to the current locale. This works using a query against the translated content first and then using all of the page_ids we further filter against this model's table.


119
120
121
# File 'pages/app/models/refinery/page.rb', line 119

def in_menu
  where(show_in_menu: true).with_mobility
end

.liveObject

Live pages are 'allowed' to be shown in the frontend of your website. By default, this is all pages that are not set as 'draft'.


70
71
72
# File 'pages/app/models/refinery/page.rb', line 70

def live
  where(:draft => false)
end

.per_page(dialog = false) ⇒ Object

Returns how many pages per page should there be when paginating pages


134
135
136
# File 'pages/app/models/refinery/page.rb', line 134

def per_page(dialog = false)
  dialog ? Pages.pages_per_dialog : Pages.pages_per_admin_index
end

.rebuild!Object


138
139
140
141
# File 'pages/app/models/refinery/page.rb', line 138

def rebuild!
  super
  nullify_duplicate_slugs_under_the_same_parent!
end

.with_mobility(conditions = {}) ⇒ Object

Wrap up the logic of finding the pages based on the translations table.


129
130
131
# File 'pages/app/models/refinery/page.rb', line 129

def with_mobility(conditions = {})
  Pages::Finder.with_mobility(conditions)
end

Instance Method Details

#canonicalObject

The canonical page for this particular page. Consists of:

* The current locale's translated slug

164
165
166
# File 'pages/app/models/refinery/page.rb', line 164

def canonical
  Mobility.with_locale(::Refinery::I18n.current_frontend_locale) { url }
end

#canonical_slugObject

The canonical slug for this particular page. This is the slug for the current frontend locale.


170
171
172
# File 'pages/app/models/refinery/page.rb', line 170

def canonical_slug
  Mobility.with_locale(::Refinery::I18n.current_frontend_locale) { slug }
end

#content_for(part_slug) ⇒ Object

Accessor method to get a page part from a page. Example:

::Refinery::Page.first.content_for(:body)

Will return the body page part of the first page.


291
292
293
# File 'pages/app/models/refinery/page.rb', line 291

def content_for(part_slug)
  part_with_slug(part_slug).try(:body)
end

#content_for?(part_slug) ⇒ Boolean

Accessor method to test whether a page part exists and has content for this page. Example:

::Refinery::Page.first.content_for?(:body)

Will return true if the page has a body page part and it is not blank.

Returns:

  • (Boolean)

302
303
304
# File 'pages/app/models/refinery/page.rb', line 302

def content_for?(part_slug)
  content_for(part_slug).present?
end

#custom_slug_or_titleObject

Returns in cascading order: custom_slug or menu_title or title depending on which attribute is first found to be present for this page.


176
177
178
179
# File 'pages/app/models/refinery/page.rb', line 176

def custom_slug_or_title
  (Refinery::Pages.use_custom_slugs && custom_slug.presence) ||
    menu_title.presence || title.presence
end

#deletable?Boolean

Am I allowed to delete this page? If a link_url is set we don't want to break the link so we don't allow them to delete If deletable is set to false then we don't allow this page to be deleted. These are often Refinery system pages

Returns:

  • (Boolean)

184
185
186
# File 'pages/app/models/refinery/page.rb', line 184

def deletable?
  deletable && link_url.blank? && menu_match.blank?
end

#destroyObject

Before destroying a page we check to see if it's a deletable page or not Refinery system pages are not deletable.


198
199
200
201
202
203
204
# File 'pages/app/models/refinery/page.rb', line 198

def destroy
  return super if deletable?

  puts_destroy_help

  false
end

#destroy!Object

If you want to destroy a page that is set to be not deletable this is the way to do it.


207
208
209
210
211
# File 'pages/app/models/refinery/page.rb', line 207

def destroy!
  self.update(:menu_match => nil, :link_url => nil, :deletable => true)

  self.destroy
end

#in_menu?Boolean

Return true if this page can be shown in the navigation. If it's a draft or is set to not show in the menu it will return false.

Returns:

  • (Boolean)

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

def in_menu?
  live? && show_in_menu?
end

#live?Boolean

Returns true if this page is “published”

Returns:

  • (Boolean)

252
253
254
# File 'pages/app/models/refinery/page.rb', line 252

def live?
  !draft?
end

#nested_pathObject

Returns the string version of nested_url, i.e., the path that should be generated by the router


247
248
249
# File 'pages/app/models/refinery/page.rb', line 247

def nested_path
  ['', nested_url].join('/')
end

#nested_urlObject Also known as: uncached_nested_url


227
228
229
230
231
232
233
234
235
# File 'pages/app/models/refinery/page.rb', line 227

def nested_url
  Mobility.with_locale(slug_locale) do
    if ::Refinery::Pages.scope_slug_by_parent && !root?
      self_and_ancestors.includes(:translations).map(&:to_param)
    else
      [to_param.to_s]
    end
  end
end

#normalize_friendly_id(slug_string) ⇒ Object

Protects generated slugs from title if they are in the list of reserved words This applies mostly to plugin-generated pages. This only kicks in when Refinery::Pages.marketable_urls is enabled. Also check for global scoping, and if enabled, allow slashes in slug.

Returns the sluggified string


326
327
328
# File 'pages/app/models/refinery/page.rb', line 326

def normalize_friendly_id(slug_string)
  FriendlyIdPath.normalize_friendly_id(slug_string)
end

#not_in_menu?Boolean

Returns:

  • (Boolean)

262
263
264
# File 'pages/app/models/refinery/page.rb', line 262

def not_in_menu?
  !in_menu?
end

#part_with_slug(part_slug) ⇒ Object

Accessor method to get a page part object from a page. Example:

::Refinery::Page.first.part_with_slug(:body)

Will return the Refinery::PagePart object with that slug using the first page.


312
313
314
315
316
317
318
# File 'pages/app/models/refinery/page.rb', line 312

def part_with_slug(part_slug)
  # self.parts is usually already eager loaded so we can now just grab
  # the first element matching the title we specified.
  self.parts.detect do |part|
    part.slug_matches?(part_slug)
  end
end

#path(path_separator: ' - ', ancestors_first: true) ⇒ Object

Returns the full path to this page. This automatically prints out this page title and all parent page titles. The result is joined by the path_separator argument.


216
217
218
219
220
221
# File 'pages/app/models/refinery/page.rb', line 216

def path(path_separator: ' - ', ancestors_first: true)
  return title if root?

  chain = ancestors_first ? self_and_ancestors : self_and_ancestors.reverse
  chain.map(&:title).join(path_separator)
end

#reposition_parts!Object

Repositions the child page_parts that belong to this page. This ensures that they are in the correct 0,1,2,3,4… etc order.


190
191
192
193
194
# File 'pages/app/models/refinery/page.rb', line 190

def reposition_parts!
  reload.parts.each_with_index do |part, index|
    part.update_columns position: index
  end
end

#should_generate_new_friendly_id?Boolean

If title changes tell friendly_id to regenerate slug when saving record

Returns:

  • (Boolean)

54
55
56
# File 'pages/app/models/refinery/page.rb', line 54

def should_generate_new_friendly_id?
  title_changed? || custom_slug_changed?
end

#shown_siblingsObject

Returns all visible sibling pages that can be rendered for the menu


267
268
269
# File 'pages/app/models/refinery/page.rb', line 267

def shown_siblings
  siblings.reject(&:not_in_menu?)
end

#to_refinery_menu_itemObject


271
272
273
274
275
276
277
278
279
280
281
282
283
# File 'pages/app/models/refinery/page.rb', line 271

def to_refinery_menu_item
  {
    :id => id,
    :lft => lft,
    :depth => depth,
    :menu_match => menu_match,
    :parent_id => parent_id,
    :rgt => rgt,
    :title => menu_title.presence || title.presence,
    :type => self.class.name,
    :url => url
  }
end

#translated_to_default_locale?Boolean

Returns:

  • (Boolean)

157
158
159
# File 'pages/app/models/refinery/page.rb', line 157

def translated_to_default_locale?
  persisted? && translations.any?{ |t| t.locale.to_sym == Refinery::I18n.default_frontend_locale}
end

#urlObject


223
224
225
# File 'pages/app/models/refinery/page.rb', line 223

def url
  Pages::Url.build(self)
end