Class: Pageflow::Entry

Inherits:
ApplicationRecord show all
Extended by:
FriendlyId
Includes:
EntryPublicationStates, FeatureTarget, Permalinkable, SerializationBlacklist, Translatable
Defined in:
app/models/pageflow/entry.rb

Overview

rubocop:todo Style/Documentation

Defined Under Namespace

Classes: PasswordMissingError

Constant Summary

Constants included from FeatureTarget

FeatureTarget::STATE_MAPPING

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Translatable

#default_translation?, #mark_as_default_translation, #mark_as_translation_of, #remove_from_translation_group

Methods included from SerializationBlacklist

#serializable_hash

Methods included from EntryPublicationStates

#last_published_with_noindex?, #publication_state, #published?, #published_at, #published_until, #published_with_password_protection?, #published_without_password_protection?

Methods included from FeatureTarget

#enabled_feature_names, #feature_state, #feature_states=, #features_configuration, #own_feature_state

Instance Attribute Details

#skip_draft_creation ⇒ Object

Returns the value of attribute skip_draft_creation.



57
58
59
 
# File 'app/models/pageflow/entry.rb', line 57

def skip_draft_creation
  @skip_draft_creation
end

Class Method Details

.ransackable_associations(_auth_object = nil) ⇒ Object 



150
151
152
 
# File 'app/models/pageflow/entry.rb', line 150

def self.ransackable_associations(_auth_object = nil)
  %w[account published_revision]
end

.ransackable_attributes(_auth_object = nil) ⇒ Object 



146
147
148
 
# File 'app/models/pageflow/entry.rb', line 146

def self.ransackable_attributes(_auth_object = nil)
  %w[title type_name created_at edited_at first_published_at]
end

.ransackable_scopes(_auth_object = nil) ⇒ Object 



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

def self.ransackable_scopes(_auth_object = nil)
  [:with_publication_state, :published]
end

Instance Method Details

#blacklist_for_serialization ⇒ Object 



158
159
160
 
# File 'app/models/pageflow/entry.rb', line 158

def blacklist_for_serialization
  [:password_digest, :features_configuration]
end

#default_permalink_slug ⇒ Object 



142
143
144
 
# File 'app/models/pageflow/entry.rb', line 142

def default_permalink_slug
  title.to_s.parameterize
end

#duplicate ⇒ Object 



130
131
132
 
# File 'app/models/pageflow/entry.rb', line 130

def duplicate
  EntryDuplicate.of(self).create!
end

#edit_lock ⇒ Object 



75
76
77
 
# File 'app/models/pageflow/entry.rb', line 75

def edit_lock
  super || EditLock::Null.new(self)
end

#entry_template ⇒ Object 



65
66
67
68
69
 
# File 'app/models/pageflow/entry.rb', line 65

def entry_template
  @entry_template ||= site.entry_templates.find_or_initialize_by(
    entry_type_name: type_name
  )
end

#entry_type ⇒ Object 



71
72
73
 
# File 'app/models/pageflow/entry.rb', line 71

def entry_type
  Pageflow.config.entry_types.find_by_name!(type_name)
end

#inherited_feature_state(name) ⇒ Object 



79
80
81
 
# File 'app/models/pageflow/entry.rb', line 79

def inherited_feature_state(name)
  .feature_state(name)
end

#publish(options = {}) ⇒ Object

rubocop:todo Metrics/AbcSize



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/models/pageflow/entry.rb', line 83

def publish(options = {}) # rubocop:todo Metrics/AbcSize
  transaction do
    self.first_published_at ||= Time.now
    update_password!(options.slice(:password, :password_protected))

    revisions.depublish_all
    association(:published_revision).reset

    draft.copy do |revision|
      revision.creator = options[:creator]
      revision.frozen_at = Time.now
      revision.published_at = Time.now
      revision.published_until = options[:published_until]
      revision.password_protected = options[:password_protected]
      revision.noindex = !!options[:noindex]
    end
  end
end

#restore(options) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'app/models/pageflow/entry.rb', line 112

def restore(options)
  transaction do
    restored_revision = options.fetch(:revision)
    draft.update!(frozen_at: Time.now, creator: options[:creator],
                  snapshot_type: 'before_restore')

    restored_revision.copy do |revision|
      revision.restored_from = restored_revision
      revision.frozen_at = nil
      revision.snapshot_type = nil
      revision.published_at = nil
      revision.published_until = nil
      revision.password_protected = nil
      revision.noindex = nil
    end
  end
end

#should_generate_new_friendly_id? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'app/models/pageflow/entry.rb', line 134

def should_generate_new_friendly_id?
  slug.blank? || title_changed?
end

#slug_candidates ⇒ Object 



138
139
140
 
# File 'app/models/pageflow/entry.rb', line 138

def slug_candidates
  [:title, [:title, :id]]
end

#snapshot(options) ⇒ Object 



102
103
104
105
106
107
108
109
110
 
# File 'app/models/pageflow/entry.rb', line 102

def snapshot(options)
  transaction do
    draft.copy do |revision|
      revision.creator = options[:creator]
      revision.frozen_at = Time.now
      revision.snapshot_type = options.fetch(:type, 'auto')
    end
  end
end