arkaan 2.7.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6071d575435983f455e7d27bc319a2ae2b0e41c0af841de7cc1d913b9de361cc
-  data.tar.gz: 80679ea438105b33983fd988e9983d93b5f5ec9fd62814f559790105b3838029
+  metadata.gz: 99aa03dc8a6f14cf981a81b89ab54adf9450c7bf2646a8231883ec71673d5695
+  data.tar.gz: 1e852dcc77ae4418286c94b7390888b3f8e71c57770852548cdf585ec300cea8
 SHA512:
-  metadata.gz: bbbb37a386bad165d89dbfcd9e21c6b1a3d6b05897c32b0f35ff1fc337c140aa62c65f87908cf9d78e3929022c92e83279ace0c74b09d498601a190401752b90
-  data.tar.gz: dad545ddc2fba3fbc89c08492c2a8ebaf854d87d44511fbedb2fc6595cb2d715705c2a31d4bf48cc9e4802aa35863eaf210f7f19d17fde054b07e1a8e5046295
+  metadata.gz: 7fb7d81811559f1daff3971c65b80d323ad9c29705e96b5cc3d6ba2729234498b094955e76478148c3876b2aeb62f6dad5806d34f6fae6761d0fecb86d495917
+  data.tar.gz: 4d2398bdc636a6b2307d4d4c101cf7f75e0e74b958f13e1d37d7e22addbbbfaec96022565737212c9f7b4beacd8f94e4f956f73a43203ca057612c8f50b33683

data/lib/arkaan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 require 'active_model'
 require 'active_support'
@@ -6,20 +8,20 @@ require 'dotenv/load'
 # Main module of the application, holding all the subsequent classes.
 # @author Vincent Courtois <courtois.vincent@outlook.com>
 module Arkaan
-  autoload :Account       , 'arkaan/account'
+  autoload :Account, 'arkaan/account'
   autoload :Authentication, 'arkaan/authentication'
-  autoload :Campaign      , 'arkaan/campaign'
-  autoload :Campaigns     , 'arkaan/campaigns'
-  autoload :Chatroom      , 'arkaan/chatroom'
-  autoload :Chatrooms     , 'arkaan/chatrooms'
-  autoload :Concerns      , 'arkaan/concerns'
-  autoload :Event         , 'arkaan/event'
-  autoload :Factories     , 'arkaan/factories'
-  autoload :Files         , 'arkaan/files'
-  autoload :Monitoring    , 'arkaan/monitoring'
-  autoload :Notification  , 'arkaan/notification'
-  autoload :OAuth         , 'arkaan/oauth'
-  autoload :Permissions   , 'arkaan/permissions'
-  autoload :Phone         , 'arkaan/phone'
-  autoload :Ruleset       , 'arkaan/ruleset'
-end
+  autoload :Campaign, 'arkaan/campaign'
+  autoload :Campaigns, 'arkaan/campaigns'
+  autoload :Chatroom, 'arkaan/chatroom'
+  autoload :Chatrooms, 'arkaan/chatrooms'
+  autoload :Concerns, 'arkaan/concerns'
+  autoload :Event, 'arkaan/event'
+  autoload :Factories, 'arkaan/factories'
+  autoload :Files, 'arkaan/files'
+  autoload :Monitoring, 'arkaan/monitoring'
+  autoload :Notification, 'arkaan/notification'
+  autoload :OAuth, 'arkaan/oauth'
+  autoload :Permissions, 'arkaan/permissions'
+  autoload :Phone, 'arkaan/phone'
+  autoload :Ruleset, 'arkaan/ruleset'
+end

data/lib/arkaan/account.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   # A user account with all related attributes. It holds credentials and informations about a designated user.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
@@ -8,7 +10,7 @@ module Arkaan
     include Arkaan::Concerns::Enumerable
 
     # @!attribute [rw] username
-    #   @return [String] the nickname the user chose at subscription, must be given, unique, and 6 or more characters long.
+    #   @return [String] the current name identifying the user on the GUI.
     field :username, type: String
     # @!attribute [r] password_digest
     #   @return [String] the password of the user, encrypted with the Blowfish algorithm.
@@ -20,30 +22,31 @@ module Arkaan
     #   @return [String] the first name of the user.
     field :firstname, type: String, default: ''
     # @!attribute [rw] email
-    #   @return [String] the email address of the user, useful to contact them ; it must be given, unique, and have an email format.
+    #   @return [String] the email address of the user, useful to contact them.
     field :email, type: String
     # @!attribute [rw] language
     #   @return [Symbol] the language preferred by this user.
-    enum_field :language, [:en_GB, :fr_FR], default: :fr_FR
+    enum_field :language, %i[en_GB fr_FR], default: :fr_FR
     # @!attribute [rw] gender
     #   @return [Symbol] the way you prefer the application to gender you.
-    enum_field :gender, [:female, :male, :neutral], default: :neutral
+    enum_field :gender, %i[female male neutral], default: :neutral
 
     # @!attribute [w] password
-    #   @return [String] password, in clear, of the user ; do not attempt to get the value, just set it when changing the password.
+    #   @return [String] password, in clear, of the user if you just changed it.
     # @!attribute [w] password_confirmation
-    #   @return [String] the confirmation of the password, do not get, just set it ; it must be the same as the password.
+    #   @return [String] the confirmation of the password, that matches the password itself.
     has_secure_password validations: false
 
     # @!attribute [rw] groups
     #   @return [Array<Arkaan::Permissions::Group>] the groups giving their corresponding rights to the current account.
     has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :accounts
-    
+
     # @!attribute [rw] applications
     #   @return [Array<Arkaan::OAuth::Application] the applications this user has created and owns.
     has_many :applications, class_name: 'Arkaan::OAuth::Application', inverse_of: :creator
     # @!attribute [rw] authorizations
-    #   @return [Array<Arkaan::OAuth::Authorization>] the authorization issued by this account to third-party applications to access its data.
+    #   @return [Array<Arkaan::OAuth::Authorization>] the authorization issued by this account
+    #     to third-party applications to access its data.
     has_many :authorizations, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :account
     # @!attribute [rw] services
     #   @return [Array<Arkaan::Monitoring::Service>] the services created by this user.
@@ -75,26 +78,26 @@ module Arkaan
       notifications.where(read: false)
     end
 
-    # @return [Array<Arkaan::Notification>] the notifications already read, less important to display than the unread ones.
+    # @return [Array<Arkaan::Notification>] the notifications already read byt the user.
     def read_notifications
       notifications.where(read: true)
     end
 
     validates :username,
-      presence: {message: 'required'},
-      length: {minimum: 6, message: 'minlength', if: :username?},
-      uniqueness: {message: 'uniq', if: :username?}
+              presence: { message: 'required' },
+              length: { minimum: 6, message: 'minlength', if: :username? },
+              uniqueness: { message: 'uniq', if: :username? }
 
     validates :email,
-      presence: {message: 'required'},
-      format: {with: /\A[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,}\z/, message: 'pattern', if: :email?},
-      uniqueness: {message: 'uniq', if: :email?}
+              presence: { message: 'required' },
+              format: { with: /\A[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,}\z/, message: 'pattern', if: :email? },
+              uniqueness: { message: 'uniq', if: :email? }
 
     validates :password,
-      presence: {message: 'required', if: ->{ !persisted? || password_digest_changed? }},
-      confirmation: {message: 'confirmation', if: :password_digest_changed?}
+              presence: { message: 'required', if: -> { !persisted? || password_digest_changed? } },
+              confirmation: { message: 'confirmation', if: :password_digest_changed? }
 
     validates :password_confirmation,
-      presence: {message: 'required', if: :password_digest_changed?}
+              presence: { message: 'required', if: :password_digest_changed? }
   end
-end
+end

data/lib/arkaan/authentication.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Arkaan
   # This module holds the logic for user authentication to our frontend.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Authentication
     autoload :Session, 'arkaan/authentication/session'
   end
-end
+end

data/lib/arkaan/authentication/session.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Authentication
     # A session represents the connection of the user on our frontend application. Nobody else than our frontend should
-    # have access to the session or it's content (in particular to the token), instead they shall use the OAuth2.0 protocol.
+    # have access to the session or it's content (in particular to the token), instead they shall use OAuth2.0.
     # A session shall ONLY be created by a premium application (only our frontend applications are premium).
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Session
@@ -9,10 +11,11 @@ module Arkaan
       include Mongoid::Timestamps
 
       # @!attribute [rw] token
-      #   @return [String] the unique token for this session, used to identify it and be sure the user is connected on this application.
+      #   @return [String] the unique token for this session, used to identify it and be sure the user is connected.
       field :token, type: String
       # @!attribute [rw] websocket_id
-      #   @return [String] the ID of the websocket on which the session is connected. It's not an association because instances are embedded.
+      #   @return [String] the ID of the websocket the user is connected to.
+      #     It's not an association because instances are embedded.
       field :websocket_id, type: String, default: ''
 
       # @!attribute [rw] account
@@ -20,9 +23,9 @@ module Arkaan
       belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :sessions
 
       validates :token,
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq', if: :token?},
-        length: {minimum: 10, message: 'minlength', if: :token?}
+                presence: { message: 'required' },
+                uniqueness: { message: 'uniq', if: :token? },
+                length: { minimum: 10, message: 'minlength', if: :token? }
     end
   end
-end
+end

data/lib/arkaan/campaign.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   # A campaign is a gathering of accounts playing on the same interface, and interacting in a common game.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
@@ -12,7 +14,7 @@ module Arkaan
     #   @return [String] a more detailed description, used to give further information about the campaign in general.
     field :description, type: String
     # @!attribute [rw] is_private
-    #   @return [Boolean] TRUE if the campaign can be joined only by being invited by the creator, FALSE if it's publicly displayed and accessible.
+    #   @return [Boolean] TRUE if the campaign can be joined only by being invited by the creator, FALSE if public.
     field :is_private, type: Boolean, default: true
     # @!attribute [rw] tags
     #   @return [Array<String>] an array of tags describing characteristics of this campaign.
@@ -37,11 +39,11 @@ module Arkaan
     belongs_to :ruleset, class_name: 'Arkaan::Ruleset', inverse_of: :campaigns, optional: true
 
     validates :title,
-      presence: {message: 'required'},
-      length: {minimum: 4, message: 'minlength', if: :title?}
+              presence: { message: 'required' },
+              length: { minimum: 4, message: 'minlength', if: :title? }
 
     validates :max_players,
-      numericality: {less_than: 21, message: 'maximum'}
+              numericality: { less_than: 21, message: 'maximum' }
 
     validate :title_unicity
 
@@ -50,13 +52,13 @@ module Arkaan
     # Sets the creator of the campaign. This method is mainly used for backward-compatibility needs.
     # @param account [Arkaan::Account] the account of the creator for this campaign.
     def creator=(account)
-      if !invitations.where(account: account).exists?
-        invitation = Arkaan::Campaigns::Invitation.create(
-          campaign: self,
-          account: account,
-          status: :creator
-        )
-      end
+      return if invitations.where(account: account).exists?
+
+      Arkaan::Campaigns::Invitation.create(
+        campaign: self,
+        account: account,
+        status: :creator
+      )
     end
 
     # Getter for the creator account of this campaign.
@@ -71,24 +73,24 @@ module Arkaan
       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
+      return unless !creator.nil? && title? && same_title_campaign.exists?
+
+      errors.add(:title, 'uniq')
     end
 
     # Validation for the max number of players for a campaign.
     # If there is a max number of players, and the current number of
     # players is above it, or the max number of players is 0, raises an error.
     def max_players_minimum
-      if max_players? && (max_players < players_count || max_players < 1)
-        errors.add(:max_players, 'minimum')
-      end
+      return unless max_players? && (max_players < players_count || max_players < 1)
+
+      errors.add(:max_players, 'minimum')
     end
 
     # @return [Array<Arkaan::Campaigns::Invitation>] the players in this campaign.
     def players
       invitations.to_a.select do |invitation|
-        [:creator, :accepted].include? invitation.enum_status
+        %i[creator accepted].include? invitation.enum_status
       end
     end
 
@@ -105,4 +107,4 @@ module Arkaan
       self.chatroom = Arkaan::Chatrooms::Campaign.new(campaign: self)
     end
   end
-end
+end

data/lib/arkaan/campaigns.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Arkaan
   # The campaigns module is holding the logic for some objects related to campaigns.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Campaigns
     autoload :Invitation, 'arkaan/campaigns/invitation'
-    autoload :Tag       , 'arkaan/campaigns/tag'
+    autoload :Tag, 'arkaan/campaigns/tag'
   end
-end
+end

data/lib/arkaan/campaigns/invitation.rb

@@ -22,8 +22,8 @@ module Arkaan
       # @!attribute [rw] status
       #   @return [Symbol] the current status of the invitation.
       historize enum_field :status,
-        [:pending, :request, :accepted, :refused, :expelled, :left, :master, :creator],
-        default: :pending
+                           %i[pending request accepted refused expelled left master creator],
+                           default: :pending
     end
   end
 end

data/lib/arkaan/chatrooms.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Arkaan
   # The chatrooms modules regroup all classes concerning messages between players.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Chatrooms
-    autoload :Base        , 'arkaan/chatrooms/base'
-    autoload :Campaign    , 'arkaan/chatrooms/campaign'
+    autoload :Base, 'arkaan/chatrooms/base'
+    autoload :Campaign, 'arkaan/chatrooms/campaign'
     autoload :Conversation, 'arkaan/chatrooms/conversation'
-    autoload :Message     , 'arkaan/chatrooms/message'
-    autoload :Membership  , 'arkaan/chatrooms/membership'
+    autoload :Message, 'arkaan/chatrooms/message'
+    autoload :Membership, 'arkaan/chatrooms/membership'
   end
-end
+end

data/lib/arkaan/chatrooms/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Chatrooms
     # The base chatroom class, made to be subclassed in campaign and personal chatrooms.
@@ -11,4 +13,4 @@ module Arkaan
       has_many :messages, class_name: 'Arkaan::Chatrooms::Message', inverse_of: :chatroom
     end
   end
-end
+end

data/lib/arkaan/chatrooms/campaign.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Chatrooms
     # Represents the chatroom embedded in a campaign.
@@ -8,4 +10,4 @@ module Arkaan
       embedded_in :campaign, class_name: 'Arkaan::Campaign', inverse_of: :chatroom
     end
   end
-end
+end

data/lib/arkaan/chatrooms/conversation.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Chatrooms
+    # A conversation is an exchange of messages between several users.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Conversation < Arkaan::Chatrooms::Base
       has_many :memberships, class_name: 'Arkaan::Chatrooms::Membership', inverse_of: :chatroom
     end
   end
-end
+end

data/lib/arkaan/chatrooms/membership.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Chatrooms
+    # A membership is the link between a user and a conversation.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Membership
       include Mongoid::Document
       include Mongoid::Timestamps
       include Arkaan::Concerns::Enumerable
 
-      enum_field :status, [:shown, :hidden], default: :shown
+      enum_field :status, %i[shown hidden], default: :shown
 
       belongs_to :chatroom, class_name: 'Arkaan::Chatrooms::Private', inverse_of: :memberships
 
       belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :memberships
     end
   end
-end
+end

data/lib/arkaan/chatrooms/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Chatrooms
     # This model represents an in-game tchat message sent in the tchat of a campaign.
@@ -8,8 +10,8 @@ module Arkaan
       include Arkaan::Concerns::Enumerable
 
       # @!attribute [rw] type
-      #  @return [Symbol] the type of message (plain text or command) contained in the data, used to parse and display it.
-      enum_field :type, [:text, :command], default: :text
+      #  @return [Symbol] the type of message (plain text or command) contained in the data, used to display it.
+      enum_field :type, %i[text command], default: :text
       # @!attribute [rw] data
       #   @return [Hash] the additional data passed to the message (arguments of the command, or content of the text)
       field :data, type: Hash, default: {}
@@ -28,4 +30,4 @@ module Arkaan
       belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :messages
     end
   end
-end
+end

data/lib/arkaan/concerns.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Arkaan
   # This module holds the shared concerns to include in the desired models.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Concerns
-    autoload :Activable     , 'arkaan/concerns/activable'
+    autoload :Activable, 'arkaan/concerns/activable'
     autoload :Diagnosticable, 'arkaan/concerns/diagnosticable'
-    autoload :Enumerable    , 'arkaan/concerns/enumerable'
-    autoload :Historizable  , 'arkaan/concerns/historizable'
-    autoload :MimeTypable   , 'arkaan/concerns/mime_typable'
-    autoload :Premiumable   , 'arkaan/concerns/premiumable'
-    autoload :Sluggable     , 'arkaan/concerns/sluggable'
-    autoload :Typable       , 'arkaan/concerns/typable'
+    autoload :Enumerable, 'arkaan/concerns/enumerable'
+    autoload :Historizable, 'arkaan/concerns/historizable'
+    autoload :MimeTypable, 'arkaan/concerns/mime_typable'
+    autoload :Premiumable, 'arkaan/concerns/premiumable'
+    autoload :Sluggable, 'arkaan/concerns/sluggable'
+    autoload :Typable, 'arkaan/concerns/typable'
   end
-end
+end

data/lib/arkaan/concerns/activable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Concerns for the objects that can be activated or deactivated, included the corresponding scopes.
@@ -9,10 +11,10 @@ module Arkaan
         # @!attribute [rw] active
         #   @return [Boolean] the active status of the instance, indicating if someone has deactivated it or not.
         field :active, type: Boolean, default: true
-      
-        scope :active  , ->{ where(active: true)  }
-        scope :inactive, ->{ where(active: false) }
+
+        scope :active, -> { where(active: true) }
+        scope :inactive, -> { where(active: false) }
       end
     end
   end
-end
+end