Class: Decidim::Debates::Debate
- Inherits:
-
Debates::ApplicationRecord
- Object
- Debates::ApplicationRecord
- Decidim::Debates::Debate
- Includes:
- Authorable, Comments::CommentableWithComponent, Comments::HasAvailabilityAttributes, Decidim::DownloadYourData, Endorsable, FilterableResource, Followable, HasCategory, HasComponent, HasReference, Loggable, NewsletterParticipant, Randomable, Reportable, Resourceable, ScopableResource, Searchable, Traceable, TranslatableAttributes, TranslatableResource
- Defined in:
- app/models/decidim/debates/debate.rb
Overview
The data store for a Debate in the Decidim::Debates component. It stores a title, description and any other useful information to render a custom debate.
Class Method Summary collapse
- .export_serializer ⇒ Object
- .log_presenter_class_for(_log) ⇒ Object
- .newsletter_participant_ids(component) ⇒ Object
- .ransack(params = {}, options = {}) ⇒ Object
- .ransackable_scopes(_auth_object = nil) ⇒ Object
Instance Method Summary collapse
-
#accepts_new_comments? ⇒ Boolean
Public: Overrides the ‘accepts_new_comments?` CommentableWithComponent concern method.
-
#allow_resource_permissions? ⇒ Boolean
Public: Overrides the ‘allow_resource_permissions?` Resourceable concern method.
-
#ama? ⇒ Boolean
Public: Calculates whether the current debate is an AMA-styled one or not.
-
#closeable_by?(user) ⇒ Boolean
Checks whether the user can edit the debate.
-
#closed? ⇒ Boolean
Checks whether the debate is closed or not.
-
#commentable_type ⇒ Object
Public: Identifies the commentable type in the API.
- #comments_end_time ⇒ Object
-
#comments_have_alignment? ⇒ Boolean
Public: Overrides the ‘comments_have_alignment?` Commentable concern method.
-
#comments_have_votes? ⇒ Boolean
Public: Overrides the ‘comments_have_votes?` Commentable concern method.
- #comments_start_time ⇒ Object
-
#editable_by?(user) ⇒ Boolean
Checks whether the user can edit the debate.
-
#open? ⇒ Boolean
Public: Checks if the debate is open or not.
-
#open_ama? ⇒ Boolean
Public: Checks whether the debate is an AMA-styled one and is open.
-
#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.
-
#update_comments_count ⇒ Object
Public: Updates the comments counter cache.
-
#users_to_notify_on_comment_created ⇒ Object
Public: Override Commentable concern method ‘users_to_notify_on_comment_created`.
Class Method Details
.export_serializer ⇒ Object
152 153 154 |
# File 'app/models/decidim/debates/debate.rb', line 152 def self.export_serializer Decidim::Debates::DownloadYourDataDebateSerializer end |
.log_presenter_class_for(_log) ⇒ Object
66 67 68 |
# File 'app/models/decidim/debates/debate.rb', line 66 def self.log_presenter_class_for(_log) Decidim::Debates::AdminLog::DebatePresenter end |
.newsletter_participant_ids(component) ⇒ Object
156 157 158 159 160 161 162 163 164 |
# File 'app/models/decidim/debates/debate.rb', line 156 def self.(component) = Decidim::Debates::Debate.where(component: component) .where(decidim_author_type: Decidim::UserBaseEntity.name) .where.not(author: nil) .group(:decidim_author_id) .pluck(:decidim_author_id).flatten.compact commentators_ids = Decidim::Comments::Comment.user_commentators_ids_in(Decidim::Debates::Debate.where(component: component)) ( + commentators_ids).flatten.compact.uniq end |
.ransack(params = {}, options = {}) ⇒ Object
215 216 217 |
# File 'app/models/decidim/debates/debate.rb', line 215 def self.ransack(params = {}, = {}) DebateSearch.new(self, params, ) end |
.ransackable_scopes(_auth_object = nil) ⇒ Object
211 212 213 |
# File 'app/models/decidim/debates/debate.rb', line 211 def self.ransackable_scopes(_auth_object = nil) [:with_any_state, :with_any_origin, :with_any_category, :with_any_scope] end |
Instance Method Details
#accepts_new_comments? ⇒ Boolean
Public: Overrides the ‘accepts_new_comments?` CommentableWithComponent concern method.
118 119 120 121 122 123 |
# File 'app/models/decidim/debates/debate.rb', line 118 def accepts_new_comments? return false unless open? return false if closed? commentable? && !comments_blocked? && comments_allowed? end |
#allow_resource_permissions? ⇒ Boolean
Public: Overrides the ‘allow_resource_permissions?` Resourceable concern method.
148 149 150 |
# File 'app/models/decidim/debates/debate.rb', line 148 def true end |
#ama? ⇒ Boolean
Public: Calculates whether the current debate is an AMA-styled one or not. AMA-styled debates are those that have a start and end time set, and comments are only open during that timelapse. AMA stands for Ask Me Anything, a type of debate inspired by Reddit.
Returns a Boolean.
99 100 101 |
# File 'app/models/decidim/debates/debate.rb', line 99 def ama? start_time.present? && end_time.present? end |
#closeable_by?(user) ⇒ Boolean
Checks whether the user can edit the debate.
user - the user to check for authorship
182 183 184 |
# File 'app/models/decidim/debates/debate.rb', line 182 def closeable_by?(user) (user) end |
#closed? ⇒ Boolean
Checks whether the debate is closed or not.
175 176 177 |
# File 'app/models/decidim/debates/debate.rb', line 175 def closed? closed_at.present? && conclusions.present? end |
#commentable_type ⇒ Object
Public: Identifies the commentable type in the API.
136 137 138 |
# File 'app/models/decidim/debates/debate.rb', line 136 def commentable_type self.class.name end |
#comments_end_time ⇒ Object
74 75 76 |
# File 'app/models/decidim/debates/debate.rb', line 74 def comments_end_time end_time end |
#comments_have_alignment? ⇒ Boolean
Public: Overrides the ‘comments_have_alignment?` Commentable concern method.
126 127 128 |
# File 'app/models/decidim/debates/debate.rb', line 126 def comments_have_alignment? true end |
#comments_have_votes? ⇒ Boolean
Public: Overrides the ‘comments_have_votes?` Commentable concern method.
131 132 133 |
# File 'app/models/decidim/debates/debate.rb', line 131 def comments_have_votes? true end |
#comments_start_time ⇒ Object
70 71 72 |
# File 'app/models/decidim/debates/debate.rb', line 70 def comments_start_time start_time end |
#editable_by?(user) ⇒ Boolean
Checks whether the user can edit the debate.
user - the user to check for authorship
169 170 171 |
# File 'app/models/decidim/debates/debate.rb', line 169 def editable_by?(user) !closed? && (user) end |
#open? ⇒ Boolean
Public: Checks if the debate is open or not.
Returns a boolean.
113 114 115 |
# File 'app/models/decidim/debates/debate.rb', line 113 def open? (ama? && open_ama?) || !ama? end |
#open_ama? ⇒ Boolean
Public: Checks whether the debate is an AMA-styled one and is open.
Returns a boolean.
106 107 108 |
# File 'app/models/decidim/debates/debate.rb', line 106 def open_ama? ama? && Time.current.between?(start_time, end_time) end |
#reported_attributes ⇒ Object
Public: Overrides the ‘reported_attributes` Reportable concern method.
84 85 86 |
# File 'app/models/decidim/debates/debate.rb', line 84 def reported_attributes [:title, :description] end |
#reported_content_url ⇒ Object
Public: Overrides the ‘reported_content_url` Reportable concern method.
79 80 81 |
# File 'app/models/decidim/debates/debate.rb', line 79 def reported_content_url ResourceLocatorPresenter.new(self).url end |
#reported_searchable_content_extras ⇒ Object
Public: Overrides the ‘reported_searchable_content_extras` Reportable concern method.
89 90 91 |
# File 'app/models/decidim/debates/debate.rb', line 89 def reported_searchable_content_extras [.name] end |
#update_comments_count ⇒ Object
Public: Updates the comments counter cache. We have to do it these way in order to properly calculate the counter with hidden comments.
rubocop:disable Rails/SkipsModelValidations
191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'app/models/decidim/debates/debate.rb', line 191 def update_comments_count comments_count = comments.not_hidden.not_deleted.count last_comment = comments.not_hidden.not_deleted.order("created_at DESC").first update_columns( last_comment_at: last_comment&.created_at, last_comment_by_id: last_comment&.decidim_user_group_id || last_comment&., last_comment_by_type: last_comment&., comments_count: comments_count, updated_at: Time.current ) end |
#users_to_notify_on_comment_created ⇒ Object
Public: Override Commentable concern method ‘users_to_notify_on_comment_created`
141 142 143 144 145 |
# File 'app/models/decidim/debates/debate.rb', line 141 def users_to_notify_on_comment_created return Decidim::User.where(id: followers).or(Decidim::User.where(id: component.participatory_space.admins)).distinct if official? followers end |