Class: Decidim::Proposals::Proposal
- Inherits:
-
ApplicationRecord
- Object
- ActiveRecord::Base
- ApplicationRecord
- Decidim::Proposals::Proposal
- Includes:
- Amendable, Coauthorable, DownloadYourData, Endorsable, FilterableResource, Fingerprintable, Followable, HasAttachments, HasCategory, HasComponent, HasReference, Loggable, NewsletterParticipant, CommentableProposal, ParticipatoryTextSection, Valuatable, Randomable, Reportable, Resourceable, ScopableResource, Searchable, Traceable, TranslatableAttributes, TranslatableResource
- Defined in:
- decidim-proposals/app/models/decidim/proposals/proposal.rb
Overview
The data store for a Proposal in the Decidim::Proposals component.
Constant Summary collapse
- STATES =
{ not_answered: 0, evaluating: 10, accepted: 20, rejected: -10, withdrawn: -20 }.freeze
Constants included from ParticipatoryTextSection
Decidim::Proposals::ParticipatoryTextSection::LEVELS
Class Method Summary collapse
- .download_your_data_images(user) ⇒ Object
- .export_serializer ⇒ Object
- .log_presenter_class_for(_log) ⇒ Object
- .newsletter_participant_ids(component) ⇒ Object
- .ransack(params = {}, options = {}) ⇒ Object
- .ransackable_scopes(auth_object = nil) ⇒ Object
- .retrieve_proposals_for(component) ⇒ Object
- .sort_by_translated_title_asc ⇒ Object
- .sort_by_translated_title_desc ⇒ Object
-
.sort_by_valuation_assignments_count_nulls_last_query ⇒ Object
Defines the base query so that ransack can actually sort by this value.
-
.user_collection(author) ⇒ Object
Returns a collection scoped by an author.
-
.valuator_role_ids_has(value) ⇒ Object
method to filter by assigned valuator role ID.
- .with_valuation_assigned_to(user, space) ⇒ Object
Instance Method Summary collapse
-
#accepted? ⇒ Boolean
Public: Checks if the organization has accepted a proposal.
-
#allow_resource_permissions? ⇒ Boolean
Public: Overrides the ‘allow_resource_permissions?` Resourceable concern method.
-
#answered? ⇒ Boolean
Public: Checks if the organization has given an answer for the proposal.
-
#can_accumulate_supports_beyond_threshold ⇒ Object
Public: Can accumulate more votres than maximum for this proposal.
-
#draft? ⇒ Boolean
Public: Whether the proposal is a draft or not.
-
#editable_by?(user) ⇒ Boolean
Checks whether the user can edit the given proposal.
-
#evaluating? ⇒ Boolean
Public: Checks if the organization has marked the proposal as evaluating it.
-
#internal_state ⇒ Object
Public: Returns the internal state of the proposal.
-
#maximum_votes ⇒ Object
Public: The maximum amount of votes allowed for this proposal.
-
#maximum_votes_reached? ⇒ Boolean
Public: The maximum amount of votes allowed for this proposal.
-
#official? ⇒ Boolean
Public: Whether the proposal is official or not.
-
#official_meeting? ⇒ Boolean
Public: Whether the proposal is created in a meeting or not.
-
#presenter ⇒ Object
Returns the presenter for this author, to be used in the views.
- #process_amendment_state_change! ⇒ Object
-
#published? ⇒ Boolean
Public: Checks if the proposal has been published or not.
-
#published_state? ⇒ Boolean
Public: Checks if the organization has published the state for the proposal.
-
#rejected? ⇒ Boolean
Public: Checks if the organization has rejected a proposal.
-
#reported_attributes ⇒ Object
Public: Overrides the ‘reported_attributes` Reportable concern method.
-
#reported_content_url ⇒ Object
Public: Overrides the ‘reported_content_url` Reportable concern method.
-
#reported_searchable_content_extras ⇒ Object
Public: Overrides the ‘reported_searchable_content_extras` Reportable concern method.
-
#state ⇒ Object
Public: Returns the published state of the proposal.
-
#update_votes_count ⇒ Object
Public: Updates the vote count of this proposal.
-
#voted_by?(user) ⇒ Boolean
Public: Check if the user has voted the proposal.
-
#withdrawable_by?(user) ⇒ Boolean
Checks whether the user can withdraw the given proposal.
-
#withdrawn? ⇒ Boolean
Public: Checks if the author has withdrawn the proposal.
-
#within_edit_time_limit? ⇒ Boolean
Checks whether the proposal is inside the time window to be editable or not once published.
Methods included from TranslatableAttributes
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
Methods included from Searchable
searchable_resources, searchable_resources_by_type, 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
Methods included from HasAttachments
Class Method Details
.download_your_data_images(user) ⇒ Object
426 427 428 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 426 def self.download_your_data_images(user) user_collection(user).map { |p| p..collect(&:file) } end |
.export_serializer ⇒ Object
422 423 424 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 422 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.(component) proposals = retrieve_proposals_for(component).uniq = 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 + + commentators_ids).flatten.compact.uniq end |
.ransack(params = {}, options = {}) ⇒ Object
333 334 335 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 333 def self.ransack(params = {}, = {}) ProposalSearch.new(self, params, ) end |
.ransackable_scopes(auth_object = nil) ⇒ Object
362 363 364 365 366 367 368 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 362 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:).joins(:coauthorships) .includes(:votes, :endorsements) .where(decidim_coauthorships: { decidim_author_type: "Decidim::UserBaseEntity" }) .not_hidden .published .except_withdrawn end |
.sort_by_translated_title_asc ⇒ Object
387 388 389 390 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 387 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_desc ⇒ Object
392 393 394 395 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 392 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_query ⇒ Object
Defines the base query so that ransack can actually sort by this value
338 339 340 341 342 343 344 345 346 347 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 338 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() return unless .is_a?(Decidim::User) joins(:coauthorships) .where(decidim_coauthorships: { coauthorable_type: name }) .where("decidim_coauthorships.decidim_author_id = ? AND decidim_coauthorships.decidim_author_type = ? ", .id, .class.base_class.name) end |
.valuator_role_ids_has(value) ⇒ Object
method to filter by assigned valuator role ID
350 351 352 353 354 355 356 357 358 359 360 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 350 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:) 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:) 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.
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.
431 432 433 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 431 def component.settings. end |
#answered? ⇒ Boolean
Public: Checks if the organization has given an answer for the proposal.
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_threshold ⇒ Object
Public: Can accumulate more votres than maximum for this proposal.
Returns true if can accumulate, false otherwise
308 309 310 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 308 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.
329 330 331 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 329 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
315 316 317 318 319 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 315 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.
250 251 252 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 250 def evaluating? state == "evaluating" end |
#internal_state ⇒ Object
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_votes ⇒ Object
Public: The maximum amount of votes allowed for this proposal.
Returns an Integer with the maximum amount of votes, nil otherwise.
289 290 291 292 293 294 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 289 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.
299 300 301 302 303 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 299 def maximum_votes_reached? return false unless maximum_votes votes.count >= maximum_votes end |
#official? ⇒ Boolean
Public: Whether the proposal is official or not.
277 278 279 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 277 def official? .first.is_a?(Decidim::Organization) end |
#official_meeting? ⇒ Boolean
Public: Whether the proposal is created in a meeting or not.
282 283 284 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 282 def official_meeting? .first.instance_of?(Decidim::Meetings::Meeting) end |
#presenter ⇒ Object
Returns the presenter for this author, to be used in the views. Required by ResourceRenderer.
261 262 263 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 261 def presenter Decidim::Proposals::ProposalPresenter.new(self) end |
#process_amendment_state_change! ⇒ Object
444 445 446 447 448 449 450 451 452 453 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 444 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.
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.
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.
243 244 245 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 243 def rejected? state == "rejected" end |
#reported_attributes ⇒ Object
Public: Overrides the ‘reported_attributes` Reportable concern method.
266 267 268 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 266 def reported_attributes [:title, :body] end |
#reported_content_url ⇒ Object
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_extras ⇒ Object
Public: Overrides the ‘reported_searchable_content_extras` Reportable concern method. Returns authors name or title in case it is a meeting
272 273 274 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 272 def reported_searchable_content_extras [.map { |p| p.respond_to?(:name) ? p.name : p.title }.join("\n")] end |
#state ⇒ Object
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_count ⇒ Object
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.
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.
324 325 326 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 324 def withdrawable_by?(user) user && !withdrawn? && (user) && !copied_from_other_component? end |
#withdrawn? ⇒ Boolean
Public: Checks if the author has withdrawn the proposal.
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.
436 437 438 439 440 441 442 |
# File 'decidim-proposals/app/models/decidim/proposals/proposal.rb', line 436 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 |