Class: Decidim::Initiative

Inherits:
ApplicationRecord
  • Object
show all
Includes:
ActiveModel::Dirty, Authorable, Comments::Commentable, Followable, HasAttachmentCollections, HasAttachments, HasReference, HasResourcePermission, Decidim::Initiatives::HasArea, Decidim::Initiatives::InitiativeSlug, Loggable, Participable, Publicable, Randomable, Resourceable, ScopableParticipatorySpace, Searchable, Traceable, TranslatableResource
Defined in:
app/models/decidim/initiative.rb

Overview

The data store for a Initiative in the Decidim::Initiatives component.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Decidim::Initiatives::InitiativeSlug

#id_from_slug, #slug_from_id

Class Method Details

.log_presenter_class_for(_log) ⇒ Object 



123
124
125
 
# File 'app/models/decidim/initiative.rb', line 123

def self.log_presenter_class_for(_log)
  Decidim::Initiatives::AdminLog::InitiativePresenter
end

Instance Method Details

#accepts_offline_votes? ⇒ Boolean

Returns:

  • (Boolean) 


374
375
376
 
# File 'app/models/decidim/initiative.rb', line 374

def accepts_offline_votes?
  published? && (offline_signature_type? || any_signature_type?)
end

#accepts_online_unvotes? ⇒ Boolean

Returns:

  • (Boolean) 


382
383
384
 
# File 'app/models/decidim/initiative.rb', line 382

def accepts_online_unvotes?
  accepts_online_votes? && type.undo_online_signatures_enabled?
end

#accepts_online_votes? ⇒ Boolean

Returns:

  • (Boolean) 


378
379
380
 
# File 'app/models/decidim/initiative.rb', line 378

def accepts_online_votes?
  votes_enabled? && (online_signature_type? || any_signature_type?)
end

#allow_resource_permissions? ⇒ Boolean

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

Returns:

  • (Boolean) 


415
416
417
 
# File 'app/models/decidim/initiative.rb', line 415

def allow_resource_permissions?
  true
end

#answered? ⇒ Boolean

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

Returns a Boolean.

Returns:

  • (Boolean) 


190
191
192
 
# File 'app/models/decidim/initiative.rb', line 190

def answered?
  answered_at.present?
end

#author_name ⇒ Object

Public: Returns the author name. If it has been created by an organization it will return the organization’s name. Otherwise it will return author’s name.

Returns a string



170
171
172
 
# File 'app/models/decidim/initiative.rb', line 170

def author_name
  user_group&.name || author.name
end

#author_users ⇒ Object 



370
371
372
 
# File 'app/models/decidim/initiative.rb', line 370

def author_users
  [author].concat(committee_members.excluding_author.map(&:user))
end

Public: Overrides participatory space’s banner image with the banner image defined for the initiative type.

Returns Decidim::BannerImageUploader



134
135
136
 
# File 'app/models/decidim/initiative.rb', line 134

def banner_image
  type.attached_uploader(:banner_image)
end

#closed? ⇒ Boolean

Public: Checks if an initiative is closed. An initiative is closed when at least one of the following conditions is true:

  • It has been discarded.

  • It has been rejected.

  • It has been accepted.

  • Signature collection period has finished.

Returns a Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'app/models/decidim/initiative.rb', line 162

def closed?
  discarded? || rejected? || accepted? || !votes_enabled?
end

#comments_have_alignment? ⇒ Boolean

Public: Overrides the ‘comments_have_alignment?` Commentable concern method.

Returns:

  • (Boolean) 


351
352
353
 
# File 'app/models/decidim/initiative.rb', line 351

def comments_have_alignment?
  true
end

#comments_have_votes? ⇒ Boolean

Public: Overrides the ‘comments_have_votes?` Commentable concern method.

Returns:

  • (Boolean) 


356
357
358
 
# File 'app/models/decidim/initiative.rb', line 356

def comments_have_votes?
  true
end

#component ⇒ Object 



394
395
396
 
# File 'app/models/decidim/initiative.rb', line 394

def component
  nil
end

#created_by_individual? ⇒ Boolean

Public: Check if an initiative has been created by an individual person. If it’s false, then it has been created by an authorized organization.

Returns a Boolean

Returns:

  • (Boolean) 


142
143
144
 
# File 'app/models/decidim/initiative.rb', line 142

def created_by_individual?
  decidim_user_group_id.nil?
end

#enough_committee_members? ⇒ Boolean

Returns:

  • (Boolean) 


390
391
392
 
# File 'app/models/decidim/initiative.rb', line 390

def enough_committee_members?
  committee_members.approved.count >= minimum_committee_members
end

#has_authorship?(user) ⇒ Boolean

Public: Checks if user is the author or is part of the promotal committee of the initiative.

Returns a Boolean.

Returns:

  • (Boolean) 


364
365
366
367
368
 
# File 'app/models/decidim/initiative.rb', line 364

def has_authorship?(user)
  return true if author.id == user.id

  committee_members.approved.where(decidim_users_id: user.id).any?
end

#has_signature_interval_defined? ⇒ Boolean

Public: Returns wether the signature interval is already defined or not.

Returns:

  • (Boolean) 


232
233
234
 
# File 'app/models/decidim/initiative.rb', line 232

def has_signature_interval_defined?
  signature_end_date.present? && signature_start_date.present?
end

#hashtag ⇒ Object

Public: Returns the hashtag for the initiative.



237
238
239
 
# File 'app/models/decidim/initiative.rb', line 237

def hashtag
  attributes["hashtag"].to_s.delete("#")
end

#minimum_committee_members ⇒ Object 



386
387
388
 
# File 'app/models/decidim/initiative.rb', line 386

def minimum_committee_members
  type.minimum_committee_members || Decidim::Initiatives.minimum_committee_members
end

#offline_votes_count ⇒ Object 



286
287
288
289
290
 
# File 'app/models/decidim/initiative.rb', line 286

def offline_votes_count
  return 0 if online_signature_type?

  offline_votes["total"].to_i
end

#offline_votes_count_for(scope) ⇒ Object 



300
301
302
303
304
305
306
 
# File 'app/models/decidim/initiative.rb', line 300

def offline_votes_count_for(scope)
  return 0 if online_signature_type?

  scope_key = (scope&.id || "global").to_s

  (offline_votes || {}).fetch(scope_key, 0).to_i
end

#online_votes_count ⇒ Object

Public: Calculates all the votes across all the scopes.

Returns an Integer.



280
281
282
283
284
 
# File 'app/models/decidim/initiative.rb', line 280

def online_votes_count
  return 0 if offline_signature_type?

  online_votes["total"].to_i
end

#online_votes_count_for(scope) ⇒ Object 



292
293
294
295
296
297
298
 
# File 'app/models/decidim/initiative.rb', line 292

def online_votes_count_for(scope)
  return 0 if offline_signature_type?

  scope_key = (scope&.id || "global").to_s

  (online_votes || {}).fetch(scope_key, 0).to_i
end

#open? ⇒ Boolean

Public: check if an initiative is open

Returns a Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'app/models/decidim/initiative.rb', line 149

def open?
  !closed?
end

#percentage ⇒ Object

Public: Returns the percentage of required supports reached



263
264
265
 
# File 'app/models/decidim/initiative.rb', line 263

def percentage
  [supports_count * 100 / supports_required, 100].min
end

#publish! ⇒ Object

Public: Publishes this initiative

Returns true if the record was properly saved, false otherwise.



211
212
213
214
215
216
217
218
219
220
 
# File 'app/models/decidim/initiative.rb', line 211

def publish!
  return false if published?

  update(
    published_at: Time.current,
    state: "published",
    signature_start_date: Date.current,
    signature_end_date: signature_end_date || Date.current + Decidim::Initiatives.default_signature_time_period_length
  )
end

#scopes_enabled ⇒ Object

Public: Overrides scopes enabled attribute value. For initiatives it won’t be directly managed by the user and it will be enabled by default.



204
205
206
 
# File 'app/models/decidim/initiative.rb', line 204

def scopes_enabled
  true
end

#scopes_enabled? ⇒ Boolean

Public: Overrides scopes enabled flag available in other models like participatory space or assemblies. For initiatives it won’t be directly managed by the user and it will be enabled by default.

Returns:

  • (Boolean) 


197
198
199
 
# File 'app/models/decidim/initiative.rb', line 197

def scopes_enabled?
  true
end

#set_offline_votes_total ⇒ Object 



320
321
322
323
324
 
# File 'app/models/decidim/initiative.rb', line 320

def set_offline_votes_total
  return if offline_votes.blank?

  offline_votes["total"] = offline_votes[scope&.id.to_s] || offline_votes["global"]
end

#slug ⇒ Object

Public: Overrides slug attribute from participatory processes.



341
342
343
 
# File 'app/models/decidim/initiative.rb', line 341

def slug
  slug_from_id(id)
end

#supports_count ⇒ Object

Public: Calculates the number of total current supports.

Returns an Integer.



244
245
246
 
# File 'app/models/decidim/initiative.rb', line 244

def supports_count
  online_votes_count + offline_votes_count
end

#supports_count_for(scope) ⇒ Object

Public: Calculates the number of current supports for a scope.

Returns an Integer.



251
252
253
 
# File 'app/models/decidim/initiative.rb', line 251

def supports_count_for(scope)
  online_votes_count_for(scope) + offline_votes_count_for(scope)
end

#supports_goal_reached? ⇒ Boolean

Public: Whether the supports required objective has been reached

Returns:

  • (Boolean) 


268
269
270
 
# File 'app/models/decidim/initiative.rb', line 268

def supports_goal_reached?
  votable_initiative_type_scopes.map(&:scope).all? { |scope| supports_goal_reached_for?(scope) }
end

#supports_goal_reached_for?(scope) ⇒ Boolean

Public: Whether the supports required objective has been reached for a scope

Returns:

  • (Boolean) 


273
274
275
 
# File 'app/models/decidim/initiative.rb', line 273

def supports_goal_reached_for?(scope)
  supports_count_for(scope) >= supports_required_for(scope)
end

#supports_required_for(scope) ⇒ Object

Public: Calculates the number of supports required to accept the initiative for a scope.

Returns an Integer.



258
259
260
 
# File 'app/models/decidim/initiative.rb', line 258

def supports_required_for(scope)
  initiative_type_scopes.find_by(decidim_scopes_id: scope&.id).supports_required
end

#to_param ⇒ Object 



345
346
347
 
# File 'app/models/decidim/initiative.rb', line 345

def to_param
  slug
end

#unpublish! ⇒ Object

Public: Unpublishes this initiative

Returns true if the record was properly saved, false otherwise.



225
226
227
228
229
 
# File 'app/models/decidim/initiative.rb', line 225

def unpublish!
  return false unless published?

  update(published_at: nil, state: "discarded")
end

#update_online_votes_counters ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
 
# File 'app/models/decidim/initiative.rb', line 308

def update_online_votes_counters
  online_votes = votes.group(:scope).count.each_with_object({}) do |(scope, count), counters|
    counters[scope&.id || "global"] = count
    counters["total"] ||= 0
    counters["total"] += count
  end

  # rubocop:disable Rails/SkipsModelValidations
  update_column("online_votes", online_votes)
  # rubocop:enable Rails/SkipsModelValidations
end

#user_allowed_to_comment?(user) ⇒ Boolean

Returns:

  • (Boolean) 


419
420
421
 
# File 'app/models/decidim/initiative.rb', line 419

def user_allowed_to_comment?(user)
  ActionAuthorizer.new(user, "comment", self, nil).authorize.ok?
end

#user_role_config_for(_user, _role_name) ⇒ Object

Public: Returns an empty object. This method should be implemented by ‘ParticipatorySpaceResourceable`, but for some reason this model does not implement this interface.



410
411
412
 
# File 'app/models/decidim/initiative.rb', line 410

def user_role_config_for(_user, _role_name)
  Decidim::ParticipatorySpaceRoleConfig::Base.new(:empty_role_name)
end

#validate_sms_code_on_votes? ⇒ Boolean

Public: Checks if the type the initiative belongs to enables SMS code verification step. Tis configuration is ignored if the organization doesn’t have the sms authorization available

Returns a Boolean

Returns:

  • (Boolean) 


403
404
405
 
# File 'app/models/decidim/initiative.rb', line 403

def validate_sms_code_on_votes?
  organization.available_authorizations.include?("sms") && type.validate_sms_code_on_votes?
end

#votable_initiative_type_scopes ⇒ Object

Public: Finds all the InitiativeTypeScopes that are eligible to be voted by a user. Usually this is only the ‘scoped_type` but voting on children of the scoped type is enabled we have to filter all the available scopes in the initiative type to select the ones that are a descendant of the initiative type.

Returns an Array of Decidim::InitiativesScopeType.



332
333
334
335
336
337
338
 
# File 'app/models/decidim/initiative.rb', line 332

def votable_initiative_type_scopes
  return Array(scoped_type) unless type.child_scope_threshold_enabled?

  initiative_type_scopes.select do |initiative_type_scope|
    initiative_type_scope.scope.present? && (scoped_type.global_scope? || scoped_type.scope.ancestor_of?(initiative_type_scope.scope))
  end.prepend(scoped_type).uniq
end

#voted_by?(user) ⇒ Boolean

Public: Check if the user has voted the question.

Returns Boolean.

Returns:

  • (Boolean) 


183
184
185
 
# File 'app/models/decidim/initiative.rb', line 183

def voted_by?(user)
  votes.where(author: user).any?
end

#votes_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
177
178
 
# File 'app/models/decidim/initiative.rb', line 174

def votes_enabled?
  published? &&
    signature_start_date <= Date.current &&
    signature_end_date >= Date.current
end