Class: Decidim::Proposals::Proposal

Overview

The data store for a Proposal in the Decidim::Proposals component.

Constant Summary collapse

POSSIBLE_STATES =
%w(not_answered evaluating accepted rejected withdrawn).freeze

Constants included from ParticipatoryTextSection

Decidim::Proposals::ParticipatoryTextSection::LEVELS

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TranslatableAttributes

#default_locale?

Methods included from Amendable

#add_author, #amendable?, #amendable_fields, #amendable_form, #amendment, #emendation?, #linked_promoted_resource, #notifiable_identities, #visible_amendments_for, #visible_emendations_for

Methods included from Fingerprintable

#fingerprint

Methods included from Searchable

searchable_resources, searchable_resources_of_type_comment, searchable_resources_of_type_component, searchable_resources_of_type_participant, searchable_resources_of_type_participatory_space

Methods included from Followable

#followers

Methods included from HasAttachments

#attachment_context

Class Method Details

.download_your_data_images(user) ⇒ Object


416
417
418
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 416

def self.download_your_data_images(user)
  user_collection(user).map { |p| p.attachments.collect(&:file) }
end

.export_serializerObject


412
413
414
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 412

def self.export_serializer
  Decidim::Proposals::ProposalSerializer
end

.log_presenter_class_for(_log) ⇒ Object


128
129
130
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 128

def self.log_presenter_class_for(_log)
  Decidim::Proposals::AdminLog::ProposalPresenter
end

.newsletter_participant_ids(component) ⇒ Object


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 151

def self.newsletter_participant_ids(component)
  proposals = retrieve_proposals_for(component).uniq

  coauthors_recipients_ids = proposals.map { |p| p.notifiable_identities.pluck(:id) }.flatten.compact.uniq

  participants_has_voted_ids = Decidim::Proposals::ProposalVote.joins(:proposal).where(proposal: proposals).joins(:author).map(&:decidim_author_id).flatten.compact.uniq

  endorsements_participants_ids = Decidim::Endorsement.where(resource: proposals)
                                                      .where(decidim_author_type: "Decidim::UserBaseEntity")
                                                      .pluck(:decidim_author_id).to_a.compact.uniq

  commentators_ids = Decidim::Comments::Comment.user_commentators_ids_in(proposals)

  (endorsements_participants_ids + participants_has_voted_ids + coauthors_recipients_ids + commentators_ids).flatten.compact.uniq
end

.ransack(params = {}, options = {}) ⇒ Object


327
328
329
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 327

def self.ransack(params = {}, options = {})
  ProposalSearch.new(self, params, options)
end

.ransackable_scopes(auth_object = nil) ⇒ Object


356
357
358
359
360
361
362
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 356

def self.ransackable_scopes(auth_object = nil)
  base = [:with_any_origin, :with_any_state, :voted_by, :coauthored_by, :related_to, :with_any_scope, :with_any_category]
  return base unless auth_object&.admin?

  # Add extra scopes for admins for the admin panel searches
  base + [:valuator_role_ids_has]
end

.retrieve_proposals_for(component) ⇒ Object


142
143
144
145
146
147
148
149
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 142

def self.retrieve_proposals_for(component)
  Decidim::Proposals::Proposal.where(component: component).joins(:coauthorships)
                              .includes(:votes, :endorsements)
                              .where(decidim_coauthorships: { decidim_author_type: "Decidim::UserBaseEntity" })
                              .not_hidden
                              .published
                              .except_withdrawn
end

.sort_by_translated_title_ascObject


381
382
383
384
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 381

def self.sort_by_translated_title_asc
  field = Arel::Nodes::InfixOperation.new("->>", arel_table[:title], Arel::Nodes.build_quoted(I18n.locale))
  order(Arel::Nodes::InfixOperation.new("", field, Arel.sql("ASC")))
end

.sort_by_translated_title_descObject


386
387
388
389
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 386

def self.sort_by_translated_title_desc
  field = Arel::Nodes::InfixOperation.new("->>", arel_table[:title], Arel::Nodes.build_quoted(I18n.locale))
  order(Arel::Nodes::InfixOperation.new("", field, Arel.sql("DESC")))
end

.sort_by_valuation_assignments_count_nulls_last_queryObject

Defines the base query so that ransack can actually sort by this value


332
333
334
335
336
337
338
339
340
341
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 332

def self.sort_by_valuation_assignments_count_nulls_last_query
  <<-SQL.squish
  (
    SELECT COUNT(decidim_proposals_valuation_assignments.id)
    FROM decidim_proposals_valuation_assignments
    WHERE decidim_proposals_valuation_assignments.decidim_proposal_id = decidim_proposals_proposals.id
    GROUP BY decidim_proposals_valuation_assignments.decidim_proposal_id
  )
  SQL
end

.user_collection(author) ⇒ Object

Returns a collection scoped by an author. Overrides this method in DownloadYourData to support Coauthorable.


134
135
136
137
138
139
140
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 134

def self.user_collection(author)
  return unless author.is_a?(Decidim::User)

  joins(:coauthorships)
    .where(decidim_coauthorships: { coauthorable_type: name })
    .where("decidim_coauthorships.decidim_author_id = ? AND decidim_coauthorships.decidim_author_type = ? ", author.id, author.class.base_class.name)
end

.valuator_role_ids_has(value) ⇒ Object

method to filter by assigned valuator role ID


344
345
346
347
348
349
350
351
352
353
354
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 344

def self.valuator_role_ids_has(value)
  query = <<-SQL.squish
  :value = any(
    (SELECT decidim_proposals_valuation_assignments.valuator_role_id
    FROM decidim_proposals_valuation_assignments
    WHERE decidim_proposals_valuation_assignments.decidim_proposal_id = decidim_proposals_proposals.id
    )
  )
  SQL
  where(query, value: value)
end

.with_valuation_assigned_to(user, space) ⇒ Object


109
110
111
112
113
114
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 109

def self.with_valuation_assigned_to(user, space)
  valuator_roles = space.user_roles(:valuator).where(user: user)

  includes(:valuation_assignments)
    .where(decidim_proposals_valuation_assignments: { valuator_role_id: valuator_roles })
end

Instance Method Details

#accepted?Boolean

Public: Checks if the organization has accepted a proposal.

Returns Boolean.

Returns:

  • (Boolean)

236
237
238
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 236

def accepted?
  state == "accepted"
end

#allow_resource_permissions?Boolean

Public: Overrides the `allow_resource_permissions?` Resourceable concern method.

Returns:

  • (Boolean)

421
422
423
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 421

def allow_resource_permissions?
  component.settings.resources_permissions_enabled
end

#answered?Boolean

Public: Checks if the organization has given an answer for the proposal.

Returns Boolean.

Returns:

  • (Boolean)

222
223
224
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 222

def answered?
  answered_at.present?
end

#can_accumulate_supports_beyond_thresholdObject

Public: Can accumulate more votres than maximum for this proposal.

Returns true if can accumulate, false otherwise


302
303
304
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 302

def can_accumulate_supports_beyond_threshold
  component.settings.can_accumulate_supports_beyond_threshold
end

#draft?Boolean

Public: Whether the proposal is a draft or not.

Returns:

  • (Boolean)

323
324
325
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 323

def draft?
  published_at.nil?
end

#editable_by?(user) ⇒ Boolean

Checks whether the user can edit the given proposal.

user - the user to check for authorship

Returns:

  • (Boolean)

309
310
311
312
313
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 309

def editable_by?(user)
  return true if draft? && created_by?(user)

  !published_state? && within_edit_time_limit? && !copied_from_other_component? && created_by?(user)
end

#evaluating?Boolean

Public: Checks if the organization has marked the proposal as evaluating it.

Returns Boolean.

Returns:

  • (Boolean)

250
251
252
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 250

def evaluating?
  state == "evaluating"
end

#internal_stateObject

Public: Returns the internal state of the proposal.

Returns Boolean.


206
207
208
209
210
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 206

def internal_state
  return amendment.state if emendation?

  self[:state]
end

#maximum_votesObject

Public: The maximum amount of votes allowed for this proposal.

Returns an Integer with the maximum amount of votes, nil otherwise.


283
284
285
286
287
288
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 283

def maximum_votes
  maximum_votes = component.settings.threshold_per_proposal
  return nil if maximum_votes.zero?

  maximum_votes
end

#maximum_votes_reached?Boolean

Public: The maximum amount of votes allowed for this proposal. 0 means infinite.

Returns true if reached, false otherwise.

Returns:

  • (Boolean)

293
294
295
296
297
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 293

def maximum_votes_reached?
  return false unless maximum_votes

  votes.count >= maximum_votes
end

#official?Boolean

Public: Whether the proposal is official or not.

Returns:

  • (Boolean)

271
272
273
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 271

def official?
  authors.first.is_a?(Decidim::Organization)
end

#official_meeting?Boolean

Public: Whether the proposal is created in a meeting or not.

Returns:

  • (Boolean)

276
277
278
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 276

def official_meeting?
  authors.first.instance_of?(Decidim::Meetings::Meeting)
end

#process_amendment_state_change!Object


434
435
436
437
438
439
440
441
442
443
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 434

def process_amendment_state_change!
  return unless %w(accepted rejected evaluating withdrawn).member?(amendment.state)

  PaperTrail.request(enabled: false) do
    update!(
      state: amendment.state,
      state_published_at: Time.current
    )
  end
end

#published?Boolean

Public: Checks if the proposal has been published or not.

Returns Boolean.

Returns:

  • (Boolean)

186
187
188
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 186

def published?
  published_at.present?
end

#published_state?Boolean

Public: Checks if the organization has published the state for the proposal.

Returns Boolean.

Returns:

  • (Boolean)

215
216
217
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 215

def published_state?
  emendation? || state_published_at.present?
end

#rejected?Boolean

Public: Checks if the organization has rejected a proposal.

Returns Boolean.

Returns:

  • (Boolean)

243
244
245
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 243

def rejected?
  state == "rejected"
end

#reported_attributesObject

Public: Overrides the `reported_attributes` Reportable concern method.


260
261
262
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 260

def reported_attributes
  [:title, :body]
end

#reported_content_urlObject

Public: Overrides the `reported_content_url` Reportable concern method.


255
256
257
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 255

def reported_content_url
  ResourceLocatorPresenter.new(self).url
end

#reported_searchable_content_extrasObject

Public: Overrides the `reported_searchable_content_extras` Reportable concern method. Returns authors name or title in case it's a meeting


266
267
268
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 266

def reported_searchable_content_extras
  [authors.map { |p| p.respond_to?(:name) ? p.name : p.title }.join("\n")]
end

#stateObject

Public: Returns the published state of the proposal.

Returns Boolean.


193
194
195
196
197
198
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 193

def state
  return amendment.state if emendation?
  return nil unless published_state? || withdrawn?

  super
end

#update_votes_countObject

Public: Updates the vote count of this proposal.

Returns nothing. rubocop:disable Rails/SkipsModelValidations


171
172
173
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 171

def update_votes_count
  update_columns(proposal_votes_count: votes.count)
end

#voted_by?(user) ⇒ Boolean

Public: Check if the user has voted the proposal.

Returns Boolean.

Returns:

  • (Boolean)

179
180
181
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 179

def voted_by?(user)
  ProposalVote.where(proposal: self, author: user).any?
end

#withdrawable_by?(user) ⇒ Boolean

Checks whether the user can withdraw the given proposal.

user - the user to check for withdrawability.

Returns:

  • (Boolean)

318
319
320
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 318

def withdrawable_by?(user)
  user && !withdrawn? && authored_by?(user) && !copied_from_other_component?
end

#withdrawn?Boolean

Public: Checks if the author has withdrawn the proposal.

Returns Boolean.

Returns:

  • (Boolean)

229
230
231
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 229

def withdrawn?
  internal_state == "withdrawn"
end

#within_edit_time_limit?Boolean

Checks whether the proposal is inside the time window to be editable or not once published.

Returns:

  • (Boolean)

426
427
428
429
430
431
432
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 426

def within_edit_time_limit?
  return true if draft?
  return true if component.settings.proposal_edit_time == "infinite"

  limit = updated_at + component.settings.proposal_edit_before_minutes.minutes
  Time.current < limit
end