Class: Arkaan::Campaign
- Inherits:
-
Object
- Object
- Arkaan::Campaign
- Includes:
- Mongoid::Document, Mongoid::Timestamps
- Defined in:
- lib/arkaan/campaign.rb
Overview
A campaign is a gathering of accounts playing on the same interface, and interacting in a common game.
Instance Attribute Summary collapse
-
#description ⇒ String
A more detailed description, used to give further information about the campaign in general.
-
#files ⇒ Array<Arkaan::Campaigns::File>
The list of files that were uploaded in this campaign.
-
#invitations ⇒ Array<Arkaan::Campaigns::Invitation>
The invitations to players that have been made for this campaign.
-
#is_private ⇒ Boolean
TRUE if the campaign can be joined only by being invited by the creator, FALSE if it’s publicly displayed and accessible.
-
#messages ⇒ Array<Arkaan::Campaigns::Messages::Base>
The messages sent in the chatroom of the campaign.
-
#tags ⇒ Array<String>
An array of tags describing characteristics of this campaign.
-
#title ⇒ String
The title, or name, of the campaign, used to identify it in the list.
Instance Method Summary collapse
-
#creator ⇒ Arkaan::Account
Getter for the creator account of this campaign.
-
#creator=(account) ⇒ Object
Sets the creator of the campaign.
- #max_players_minimum ⇒ Object
- #players_count ⇒ Object
-
#title_unicity ⇒ Object
Adds an error message if the account creating this campaign already has a campaign with the very same name.
Instance Attribute Details
#description ⇒ String
Returns a more detailed description, used to give further information about the campaign in general.
13 |
# File 'lib/arkaan/campaign.rb', line 13 field :description, type: String |
#files ⇒ Array<Arkaan::Campaigns::File>
Returns the list of files that were uploaded in this campaign.
29 |
# File 'lib/arkaan/campaign.rb', line 29 has_many :files, class_name: 'Arkaan::Campaigns::File', inverse_of: :campaign |
#invitations ⇒ Array<Arkaan::Campaigns::Invitation>
Returns the invitations to players that have been made for this campaign.
26 |
# File 'lib/arkaan/campaign.rb', line 26 has_many :invitations, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :campaign |
#is_private ⇒ Boolean
Returns TRUE if the campaign can be joined only by being invited by the creator, FALSE if it’s publicly displayed and accessible.
16 |
# File 'lib/arkaan/campaign.rb', line 16 field :is_private, type: Boolean, default: true |
#messages ⇒ Array<Arkaan::Campaigns::Messages::Base>
Returns the messages sent in the chatroom of the campaign.
33 |
# File 'lib/arkaan/campaign.rb', line 33 :messages, class_name: 'Arkaan::Campaigns::Message', inverse_of: :campaign |
#tags ⇒ Array<String>
Returns an array of tags describing characteristics of this campaign.
19 |
# File 'lib/arkaan/campaign.rb', line 19 field :tags, type: Array, default: [] |
#title ⇒ String
Returns the title, or name, of the campaign, used to identify it in the list.
10 |
# File 'lib/arkaan/campaign.rb', line 10 field :title, type: String |
Instance Method Details
#creator ⇒ Arkaan::Account
Getter for the creator account of this campaign.
56 57 58 |
# File 'lib/arkaan/campaign.rb', line 56 def creator return invitations.where(enum_status: :creator).first.account end |
#creator=(account) ⇒ Object
Sets the creator of the campaign. This method is mainly used for backward-compatibility needs.
48 49 50 51 52 |
# File 'lib/arkaan/campaign.rb', line 48 def creator=(account) if !invitations.where(account: account).exists? Arkaan::Campaigns::Invitation.create(campaign: self, account: account, enum_status: :creator) end end |
#max_players_minimum ⇒ Object
71 72 73 74 75 |
# File 'lib/arkaan/campaign.rb', line 71 def max_players_minimum if max_players? && (max_players < players_count || max_players < 1) errors.add(:max_players, 'minimum') end end |
#players_count ⇒ Object
77 78 79 |
# File 'lib/arkaan/campaign.rb', line 77 def players_count invitations.where(enum_status: :accepted).count end |
#title_unicity ⇒ Object
Adds an error message if the account creating this campaign already has a campaign with the very same name.
61 62 63 64 65 66 67 68 69 |
# File 'lib/arkaan/campaign.rb', line 61 def title_unicity # First we take all the other campaign ids of the user. campaign_ids = creator.invitations.where(:campaign_id.ne => _id).pluck(:campaign_id) # With this list of campaign IDs, we look for a campaign with the same title. same_title_campaign = Arkaan::Campaign.where(:_id.in => campaign_ids, title: title) if !creator.nil? && title? && same_title_campaign.exists? errors.add(:title, 'uniq') end end |