Class: Page

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Annotatable, DeprecatedTags, StandardTags, TrustyCms::Taggable
Defined in:
app/models/page.rb

Direct Known Subclasses

FileNotFoundPage

Defined Under Namespace

Classes: MissingRootPageError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Annotatable

included

Methods included from TrustyCms::Taggable

included, #render_tag, #tag_descriptions, #tags, #warn_of_tag_deprecation

Methods included from LocalTime

#adjust_time

Instance Attribute Details

#pagination_parameters ⇒ Object

Returns the value of attribute pagination_parameters.



41
42
43
 
# File 'app/models/page.rb', line 41

def pagination_parameters
  @pagination_parameters
end

#request ⇒ Object

Returns the value of attribute request.



41
42
43
 
# File 'app/models/page.rb', line 41

def request
  @request
end

#response ⇒ Object

Returns the value of attribute response.



41
42
43
 
# File 'app/models/page.rb', line 41

def response
  @response
end

Class Method Details

.date_column_names ⇒ Object 



246
247
248
 
# File 'app/models/page.rb', line 246

def date_column_names
  self.columns.collect{|c| c.name if c.sql_type =~ /(date|time)/}.compact
end

.descendant_class(class_name) ⇒ Object

Raises:

  • (ArgumentError) 


299
300
301
302
303
304
305
306
 
# File 'app/models/page.rb', line 299

def descendant_class(class_name)
  raise ArgumentError.new("argument must be a valid descendant of Page") unless is_descendant_class_name?(class_name)
  if ["", nil, "Page"].include?(class_name)
    Page
  else
    class_name.constantize
  end
end

.display_name(string = nil) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'app/models/page.rb', line 250

def display_name(string = nil)
  if string
    @display_name = string
  else
    @display_name ||= begin
      n = name.to_s
      n.sub!(/^(.+?)Page$/, '\1')
      n.gsub!(/([A-Z])/, ' \1')
      n.strip
    end
  end
  @display_name = @display_name + " - not installed" if missing? && @display_name !~ /not installed/
  @display_name
end

.display_name=(string) ⇒ Object 



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

def display_name=(string)
  display_name(string)
end

.find_by_path(path, live = true) ⇒ Object

Raises:



237
238
239
240
 
# File 'app/models/page.rb', line 237

def find_by_path(path, live = true)
  raise MissingRootPageError unless root
  root.find_by_path(path, live)
end

.find_by_url(*args) ⇒ Object 



241
242
243
244
 
# File 'app/models/page.rb', line 241

def find_by_url(*args)
  ActiveSupport::Deprecation.warn("`find_by_url' has been deprecated; use `find_by_path' instead.", caller)
  find_by_path(*args)
end

.is_descendant_class_name?(class_name) ⇒ Boolean

Returns:

  • (Boolean) 


295
296
297
 
# File 'app/models/page.rb', line 295

def is_descendant_class_name?(class_name)
  (Page.descendants.map(&:to_s) + [nil, "", "Page"]).include?(class_name)
end

.load_subclasses ⇒ Object 



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

def load_subclasses
  ([TRUSTY_CMS_ROOT] + TrustyCms::Extension.descendants.map(&:root)).each do |path|
    Dir["#{path}/app/models/*_page.rb"].each do |page|
      $1.camelize.constantize if page =~ %r{/([^/]+)\.rb}
    end
  end
  if ActiveRecord::Base.connection.tables.include?('pages') && Page.column_names.include?('class_name') # Assume that we have bootstrapped
    Page.connection.select_values("SELECT DISTINCT class_name FROM pages WHERE class_name <> '' AND class_name IS NOT NULL").each do |p|
      begin
        p.constantize
      rescue NameError, LoadError
        eval(%Q{class #{p} < Page; acts_as_tree; def self.missing?; true end end}, TOPLEVEL_BINDING)
      end
    end
  end
end

.missing? ⇒ Boolean

Returns:

  • (Boolean) 


308
309
310
 
# File 'app/models/page.rb', line 308

def missing?
  false
end

.new_with_defaults(config = TrustyCms::Config) ⇒ Object 



286
287
288
289
290
291
292
293
 
# File 'app/models/page.rb', line 286

def new_with_defaults(config = TrustyCms::Config)
  page = new
  page.parts.concat default_page_parts(config)
  page.fields.concat default_page_fields(config)
  default_status = config['defaults.page.status']
  page.status = Status[default_status] if default_status
  page
end

.root ⇒ Object 



233
234
235
 
# File 'app/models/page.rb', line 233

def root
  find_by_parent_id(nil)
end

Instance Method Details

#allowed_children_lookup ⇒ Object 



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

def allowed_children_lookup
  [default_child, *Page.descendants.sort_by(&:name)].uniq
end

#cache? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'app/models/page.rb', line 64

def cache?
  true
end

#child_path(child) ⇒ Object Also known as: child_url 



68
69
70
 
# File 'app/models/page.rb', line 68

def child_path(child)
  clean_path(path + '/' + child.slug)
end

#default_child ⇒ Object 



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

def default_child
  self.class.default_child
end

#description ⇒ Object 



56
57
58
 
# File 'app/models/page.rb', line 56

def description
  self["description"]
end

#description=(value) ⇒ Object 



60
61
62
 
# File 'app/models/page.rb', line 60

def description=(value)
  self["description"] = value
end

#field(name) ⇒ Object 



93
94
95
96
97
98
99
 
# File 'app/models/page.rb', line 93

def field(name)
  if new_record? or fields.any?(&:new_record?)
    fields.detect { |f| f.name.downcase == name.to_s.downcase }
  else
    fields.find_by_name name.to_s
  end
end

#find_by_path(path, live = true, clean = true) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'app/models/page.rb', line 179

def find_by_path(path, live = true, clean = true)
  return nil if virtual?
  path = clean_path(path) if clean
  my_path = self.path
  if (my_path == path) && (not live or published?)
    self
  elsif (path =~ /^#{Regexp.quote(my_path)}([^\/]*)/)
    slug_child = children.find_by_slug($1)
    if slug_child
      found = slug_child.find_by_url(path, live, clean) # TODO: set to find_by_path after deprecation
      return found if found
    end
    children.each do |child|
      found = child.find_by_url(path, live, clean) # TODO: set to find_by_path after deprecation
      return found if found
    end
    file_not_found_types = ([FileNotFoundPage] + FileNotFoundPage.descendants)
    file_not_found_names = file_not_found_types.collect { |x| x.name }
    condition = (['class_name = ?'] * file_not_found_names.length).join(' or ')
    condition = "status_id = #{Status[:published].id} and (#{condition})" if live
    children.where([condition] + file_not_found_names).first
  end
end

#find_by_url ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'app/models/page.rb', line 202

def find_by_path(path, live = true, clean = true)
  return nil if virtual?
  path = clean_path(path) if clean
  my_path = self.path
  if (my_path == path) && (not live or published?)
    self
  elsif (path =~ /^#{Regexp.quote(my_path)}([^\/]*)/)
    slug_child = children.find_by_slug($1)
    if slug_child
      found = slug_child.find_by_url(path, live, clean) # TODO: set to find_by_path after deprecation
      return found if found
    end
    children.each do |child|
      found = child.find_by_url(path, live, clean) # TODO: set to find_by_path after deprecation
      return found if found
    end
    file_not_found_types = ([FileNotFoundPage] + FileNotFoundPage.descendants)
    file_not_found_names = file_not_found_types.collect { |x| x.name }
    condition = (['class_name = ?'] * file_not_found_names.length).join(' or ')
    condition = "status_id = #{Status[:published].id} and (#{condition})" if live
    children.where([condition] + file_not_found_names).first
  end
end

#has_or_inherits_part?(name) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'app/models/page.rb', line 85

def has_or_inherits_part?(name)
  has_part?(name) || inherits_part?(name)
end

#has_part?(name) ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_part?(name)
  !part(name).nil?
end

#headers ⇒ Object 



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

def headers
  # Return a blank hash that child classes can override or merge
  { }
end

#inherits_part?(name) ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'app/models/page.rb', line 89

def inherits_part?(name)
  !has_part?(name) && self.ancestors.any? { |page| page.has_part?(name) }
end

#layout_with_inheritance ⇒ Object 



47
48
49
50
51
52
53
 
# File 'app/models/page.rb', line 47

def layout_with_inheritance
  unless layout_without_inheritance
    parent.layout if parent?
  else
    layout_without_inheritance
  end
end

#part(name) ⇒ Object 



73
74
75
76
77
78
79
 
# File 'app/models/page.rb', line 73

def part(name)
  if new_record? or parts.to_a.any?(&:new_record?)
    parts.to_a.find {|p| p.name == name.to_s }
  else
    parts.find_by_name name.to_s
  end
end

#path ⇒ Object Also known as: url 



117
118
119
120
121
122
123
 
# File 'app/models/page.rb', line 117

def path
  if parent?
    parent.child_path(self)
  else
    clean_path(slug)
  end
end

#process(request, response) ⇒ Object 



126
127
128
129
130
131
 
# File 'app/models/page.rb', line 126

def process(request, response)
  @request, @response = request, response
  set_response_headers(@response)
  @response.body = render
  @response.status = response_code
end

#published? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'app/models/page.rb', line 101

def published?
  status == Status[:published]
end

#render ⇒ Object 



158
159
160
161
162
163
164
 
# File 'app/models/page.rb', line 158

def render
  if layout
    parse_object(layout)
  else
    render_part(:body)
  end
end

#render_part(part_name) ⇒ Object 



166
167
168
169
170
171
172
173
 
# File 'app/models/page.rb', line 166

def render_part(part_name)
  part = part(part_name)
  if part
    parse_object(part)
  else
    ''
  end
end

#render_snippet(snippet) ⇒ Object 



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

def render_snippet(snippet)
  parse_object(snippet)
end

#response_code ⇒ Object 



154
155
156
 
# File 'app/models/page.rb', line 154

def response_code
  200
end

#scheduled? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'app/models/page.rb', line 105

def scheduled?
  status == Status[:scheduled]
end

#set_allowed_children_cache ⇒ Object 



227
228
229
 
# File 'app/models/page.rb', line 227

def set_allowed_children_cache
  self.allowed_children_cache = allowed_children_lookup.collect(&:name).join(',')
end

#status ⇒ Object 



109
110
111
 
# File 'app/models/page.rb', line 109

def status
 Status.find(self.status_id)
end

#status=(value) ⇒ Object 



113
114
115
 
# File 'app/models/page.rb', line 113

def status=(value)
  self.status_id = value.id
end

#to_xml(options = {}, &block) ⇒ Object 



215
216
217
 
# File 'app/models/page.rb', line 215

def to_xml(options={}, &block)
  super(options.reverse_merge(:include => :parts), &block)
end

#update_status ⇒ Object 



204
205
206
207
208
209
210
211
212
213
 
# File 'app/models/page.rb', line 204

def update_status
  self.published_at = Time.zone.now if published? && self.published_at == nil

  if self.published_at != nil && (published? || scheduled?)
    self[:status_id] = Status[:scheduled].id if self.published_at  > Time.zone.now
    self[:status_id] = Status[:published].id if self.published_at <= Time.zone.now
  end

  true
end