Class: Crm::ArticleRevisionsController

Inherits:
CrmController show all
Defined in:
app/controllers/crm/article_revisions_controller.rb

Overview

Shared review workflow for content revisions of every Article STI subtype.

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#approve ⇒ void

This method returns an undefined value.

Applies a reviewed proposal to its existing Article identity.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 102

def approve
  authorize!(:approve, @article)
  result = ArticleRevision::Approval.call(
    revision: @revision,
    reviewer: current_user,
    review_notes: decision_params[:review_notes]
  )

  if result.success?
    redirect_to polymorphic_path(@article),
                notice: "Revision ##{@revision.revision_number} approved. Article ##{@article.id} was updated in place; its URL is unchanged."
  else
    redirect_to article_revision_path(@article, @revision), alert: result.errors.to_sentence
  end
end

#create ⇒ void

This method returns an undefined value.

Creates the one open proposal for an Article.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 45

def create
  authorize!(:update, @article)
  return redirect_to_open_revision if @article.open_revision
  return redirect_to_article_editor unless @article.revision_proposable?

  @revision = @article.create_revision_draft!(
    author: current_user,
    attributes: revision_params.to_h.symbolize_keys
  )
  redirect_to edit_article_revision_path(@article, @revision),
              notice: 'Revision draft created. The live Article has not changed.'
rescue ActiveRecord::RecordInvalid => e
  @revision = e.record
  render :new, status: :unprocessable_content
end

#destroy ⇒ void

This method returns an undefined value.

Discards an open draft proposal.



78
79
80
81
82
83
84
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 78

def destroy
  authorize!(:update, @article)
  return unless require_draft!

  @revision.destroy!
  redirect_to parent_article_history_path, notice: 'Revision draft discarded.'
end

#edit ⇒ void

This method returns an undefined value.

Displays the shared editor for an open draft proposal.



37
38
39
40
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 37

def edit
  authorize!(:update, @article)
  require_draft!
end

#index ⇒ void

This method returns an undefined value.

Preserves old revision-index URLs while keeping history on the Article.



11
12
13
14
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 11

def index
  authorize!(:read, @article)
  redirect_to parent_article_history_path
end

#new ⇒ void

This method returns an undefined value.

Builds an unsaved proposal from the current live Article.



26
27
28
29
30
31
32
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 26

def new
  authorize!(:update, @article)
  return redirect_to_open_revision if @article.open_revision
  return redirect_to_article_editor unless @article.revision_proposable?

  @revision = @article.build_revision_draft(author: current_user)
end

#preview ⇒ void

This method returns an undefined value.

Opens a secure public preview for a Post revision.



178
179
180
181
182
183
184
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 178

def preview
  authorize!(:read, @article)
  return redirect_to article_revision_path(@article, @revision) unless @article.is_a?(Post)

  token = BlogPreviewTokenService.generate_token(@article.id, current_user&.id, revision_id: @revision.id)
  redirect_to "#{WEB_URL}#{preview_post_path(@article, token:, revision_id: @revision.id)}", allow_other_host: true
end

#rebase ⇒ void

This method returns an undefined value.

Marks a manually reconciled draft as based on the current live content.



147
148
149
150
151
152
153
154
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 147

def rebase
  authorize!(:update, @article)
  return unless require_draft!

  @revision.update!(base_content_digest: @article.revision_content_digest)
  redirect_to edit_article_revision_path(@article, @revision),
              notice: 'Revision marked as reconciled with the current Article. Review the diff before resubmitting.'
end

#reject ⇒ void

This method returns an undefined value.

Rejects a pending proposal without changing the live Article.



134
135
136
137
138
139
140
141
142
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 134

def reject
  authorize!(:approve, @article)
  return unless require_pending_review!

  @revision.reject_by!(reviewer: current_user, notes: decision_params[:review_notes])
  redirect_to article_revision_path(@article, @revision), notice: 'Revision rejected. The live Article was not changed.'
rescue ActiveRecord::RecordInvalid, StateMachines::InvalidTransition => e
  redirect_to article_revision_path(@article, @revision), alert: transition_errors(e)
end

#request_changes ⇒ void

This method returns an undefined value.

Returns a pending proposal to draft with required reviewer feedback.



121
122
123
124
125
126
127
128
129
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 121

def request_changes
  authorize!(:approve, @article)
  return unless require_pending_review!

  @revision.request_changes_by!(reviewer: current_user, notes: decision_params[:review_notes])
  redirect_to article_revision_path(@article, @revision), notice: 'Revision returned to draft with review notes.'
rescue ActiveRecord::RecordInvalid, StateMachines::InvalidTransition => e
  redirect_to article_revision_path(@article, @revision), alert: transition_errors(e)
end

#restore ⇒ void

This method returns an undefined value.

Copies an applied historical revision into a new review draft.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 159

def restore
  authorize!(:update, @article)
  return unless require_restorable!

  draft = @article.create_revision_draft!(author: current_user, source_revision: @revision)
  redirect_to edit_article_revision_path(@article, draft),
              notice: "Revision ##{@revision.revision_number} copied into a new draft. Submit it for review to restore it."
rescue ActiveRecord::RecordInvalid => e
  destination = if e.record.persisted?
                  article_revision_path(@article, e.record)
                else
                  parent_article_history_path
                end
  redirect_to destination, alert: e.record.errors.full_messages.to_sentence
end

#show ⇒ void

This method returns an undefined value.

Displays one revision and its comparison with the live Article.



19
20
21
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 19

def show
  authorize!(:read, @article)
end

#submit ⇒ void

This method returns an undefined value.

Submits a draft proposal to its reviewer.



89
90
91
92
93
94
95
96
97
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 89

def submit
  authorize!(:update, @article)
  return unless require_draft!

  @revision.submit_for_review!
  redirect_to article_revision_path(@article, @revision), notice: 'Revision submitted for review.'
rescue ActiveRecord::RecordInvalid, StateMachines::InvalidTransition => e
  redirect_to edit_article_revision_path(@article, @revision), alert: transition_errors(e)
end

#update ⇒ void

This method returns an undefined value.

Saves changes to an open draft without changing the live Article.



64
65
66
67
68
69
70
71
72
73
 
# File 'app/controllers/crm/article_revisions_controller.rb', line 64

def update
  authorize!(:update, @article)
  return unless require_draft!

  if @revision.update(revision_params)
    redirect_to article_revision_path(@article, @revision), notice: 'Revision draft saved.'
  else
    render :edit, status: :unprocessable_content
  end
end