Class: Refinery::Page

Inherits:
Core::BaseModel
  • Object
show all
Extended by:
FriendlyId
Defined in:
app/models/refinery/page.rb

Defined Under Namespace

Classes: FriendlyIdOptions, FriendlyIdPath, Translation

Class Method Summary collapse

Instance Method Summary collapse

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.



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

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.



115
116
117
 
# File 'app/models/refinery/page.rb', line 115

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

.fast_menu ⇒ Object

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



136
137
138
 
# File 'app/models/refinery/page.rb', line 136

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



87
88
89
 
# File 'app/models/refinery/page.rb', line 87

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.



94
95
96
 
# File 'app/models/refinery/page.rb', line 94

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) 


103
104
105
106
107
108
109
 
# File 'app/models/refinery/page.rb', line 103

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

  raise ActiveRecord::RecordNotFound unless page

  page
end

.in_menu ⇒ Object

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.



131
132
133
 
# File 'app/models/refinery/page.rb', line 131

def in_menu
  where(:show_in_menu => true).with_globalize
end

.live ⇒ Object

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’.



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

def live
  where(:draft => false)
end

.per_page(dialog = false) ⇒ Object

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



146
147
148
 
# File 'app/models/refinery/page.rb', line 146

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

.rebuild! ⇒ Object 



150
151
152
153
 
# File 'app/models/refinery/page.rb', line 150

def rebuild!
  super
  nullify_duplicate_slugs_under_the_same_parent!
end

.with_globalize(conditions = {}) ⇒ Object

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



141
142
143
 
# File 'app/models/refinery/page.rb', line 141

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

Instance Method Details

#canonical ⇒ Object

The canonical page for this particular page. Consists of:

* The current locale's translated slug



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

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

#canonical_slug ⇒ Object

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



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

def canonical_slug
  Globalize.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.



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

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) 


314
315
316
 
# File 'app/models/refinery/page.rb', line 314

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

#custom_slug_or_title ⇒ Object

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



188
189
190
191
 
# File 'app/models/refinery/page.rb', line 188

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) 


196
197
198
 
# File 'app/models/refinery/page.rb', line 196

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

#destroy ⇒ Object

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



210
211
212
213
214
215
216
 
# File 'app/models/refinery/page.rb', line 210

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.



219
220
221
222
223
 
# File 'app/models/refinery/page.rb', line 219

def destroy!
  self.update_attributes(: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) 


270
271
272
 
# File 'app/models/refinery/page.rb', line 270

def in_menu?
  live? && show_in_menu?
end

#live? ⇒ Boolean

Returns true if this page is “published”

Returns:

  • (Boolean) 


264
265
266
 
# File 'app/models/refinery/page.rb', line 264

def live?
  !draft?
end

#nested_path ⇒ Object

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



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

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

#nested_url ⇒ Object Also known as: uncached_nested_url 



239
240
241
242
243
244
245
246
247
 
# File 'app/models/refinery/page.rb', line 239

def nested_url
  Globalize.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



338
339
340
 
# File 'app/models/refinery/page.rb', line 338

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

#not_in_menu? ⇒ Boolean

Returns:

  • (Boolean) 


274
275
276
 
# File 'app/models/refinery/page.rb', line 274

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.



324
325
326
327
328
329
330
 
# File 'app/models/refinery/page.rb', line 324

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.



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

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.



202
203
204
205
206
 
# File 'app/models/refinery/page.rb', line 202

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) 


45
46
47
 
# File 'app/models/refinery/page.rb', line 45

def should_generate_new_friendly_id?
  changes.keys.include?("title") || changes.keys.include?("custom_slug")
end

#shown_siblings ⇒ Object

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



279
280
281
 
# File 'app/models/refinery/page.rb', line 279

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

#to_refinery_menu_item ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'app/models/refinery/page.rb', line 283

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) 


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

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

#url ⇒ Object 



235
236
237
 
# File 'app/models/refinery/page.rb', line 235

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