arkaan 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931a5d11dc8f40aa987d3960f2a8e16dc66ec04c6f1a442ecc31f3bbc08431fa
-  data.tar.gz: a425f9550df833b6221daa379b57d1ecaa54d428a253de887dffc9845ba59d88
+  metadata.gz: e70b9b135c0ac5b57d31e26c224937b2ed9ca69bd902f10f2cc4f7c2bddd339f
+  data.tar.gz: 61b68c995672ff514cecf8c022a30e9231c05e9f5ed55b468e17fe528068d3a6
 SHA512:
-  metadata.gz: e7263f342e7821a773574f5bdc98fa35e6d931bc1b2223941be1c5ac790dbf83d3063561ff82f4f0bf345e14ba30391ba22640225efe23e33b90b7bff04a8f0f
-  data.tar.gz: decf9dc3d4431fd1c8fd84f557dcb2f46ba8f7674add35b947ef167fb69cfc198fd1a1c0c47e8020d71b02f1e24d8b28ef721ecaad2accfd6428e1b00fbdac60
+  metadata.gz: 94729cac55877bb9da88d9d4a7824ff99158480fe16afe1e2eee6f4732e64039ddce67fbbcef74b6f943c88b1e1ea0b88e6568955e58d22541d6c8b6365a1047
+  data.tar.gz: 0b83a9933b47a4c47285c50bcb9aa87288e0a449068d3ae17b901497148d8998fd71a13bcfc1ecff40466df10b810ddc0b5ada68d72f1d329a465d9c49a7bd9a

data/lib/arkaan/campaign.rb

@@ -72,14 +72,33 @@ module Arkaan
       end
     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
     end
 
+    # @return [Array<Arkaan::Campaigns::Invitation>] the players in this campaign.
+    def players
+      invitations.where(enum_status: :accepted)
+    end
+
+    # @return [Integer] the number of players in this campaign.
     def players_count
-      invitations.where(enum_status: :accepted).count
+      players.count
+    end
+
+    # @return [Array<Arkaan::Campaigns::Character>] a flattened list of characters for this campaign.
+    def characters
+      players.map(&:characters).flatten
+    end
+
+    # @return [Array<Arkaan::Campaigns::Files::Document>] the document of this campaign as a flattened array.
+    def documents
+      invitations.map(&:documents).flatten
     end
   end
 end

data/lib/arkaan/campaigns.rb

@@ -2,6 +2,7 @@ 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 :Character , 'arkaan/campaigns/character'
     autoload :Files     , 'arkaan/campaigns/files'
     autoload :Invitation, 'arkaan/campaigns/invitation'
     autoload :Message   , 'arkaan/campaigns/message'

data/lib/arkaan/campaigns/character.rb

@@ -0,0 +1,52 @@
+module Arkaan
+  module Campaigns
+    # A character sheet represents a character played by a player in a campaign.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Character
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Arkaan::Concerns::MimeTypable
+      include Arkaan::Campaigns::Files::Concerns::Nameable
+
+      # @!attribute [rw] selected
+      #   @return [Boolean] TRUE if the sheet is currently selected by the player, FALSE otherwise.
+      field :selected, type: Boolean, default: false
+      # @!attribute [rw] mime_type
+      #   @return [String] the mime_type of the character sheet, MUST be an authorized MIME type for
+      #     the ruleset the campaign is set to be in.
+      mime_type :available_mime_types
+
+      # @!attribute [rw] invitation
+      #   @return [Arkaan::Campaigns::Invitation] the invitation of the player playing this character.
+      belongs_to :invitation, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :characters
+
+      # Returns the player linked to this character.
+      # @return [Arkaan::Account] the account of the player incarnating this character.
+      def player
+        invitation.account
+      end
+
+      # Method used to dinamically determine what MIME types are allowed for this character sheet
+      # If the campaign this character is in has no ruleset, every MIME type is allowed.
+      # @return [Array<String>] the available MIME type for the campaign linked to this character.
+      def available_mime_types
+        invitation.campaign.ruleset.mime_types
+      end
+
+      def campaign
+        invitation.campaign
+      end
+
+      # Puts the selected flag to TRUE for this character and to FALSE for all the
+      # other characters for the same player in the same campaign.
+      def select!
+        invitation.characters.each do |character|
+          character.update_attribute(:selected, false)
+          character.save!
+        end
+        update_attribute(:selected, true)
+        save!
+      end
+    end
+  end
+end

data/lib/arkaan/campaigns/files.rb

@@ -1,11 +1,9 @@
 module Arkaan
   module Campaigns
     module Files
-      autoload :Base      , 'arkaan/campaigns/files/base'
       autoload :Character , 'arkaan/campaigns/files/character'
       autoload :Concerns  , 'arkaan/campaigns/files/concerns'
       autoload :Document  , 'arkaan/campaigns/files/document'
-      autoload :Note      , 'arkaan/campaigns/files/note'
       autoload :Permission, 'arkaan/campaigns/files/permission'
     end
   end

data/lib/arkaan/campaigns/files/concerns/nameable.rb

@@ -11,51 +11,6 @@ module Arkaan
             field :name, type: String
 
             validates :name, presence: {message: 'required'}
-
-            validate :name_unicity
-
-            # Checks if the name is unique in the campaign, and if it is not then modifies it.
-            # The modifications are the same than in a windows or UNIX system :
-            # - if the name exists as it is given, the system adds the suffix "(1)" to it.
-            # - if the name with the suffix still exists, the system tries to increment it until an available name is found.
-            # - the found name is then afected to the name of the current file.
-            def name_unicity
-              if !campaign.nil? && !self[:name].nil?
-                if exists_in_campaign(self[:name])
-                  suffix = 1
-                  while exists_in_campaign(merge_suffix(suffix))
-                    suffix = suffix + 1
-                  end
-                  self[:name] = merge_suffix(suffix)
-                end
-              end
-            end
-
-            # Merges the given suffix with the name correctly.
-            # @param suffix [String] the suffix to append between perenthesis at the end of the file name, but before the extension.
-            # @return [String] the complete name for the file, with the suffix correctly appended.
-            def merge_suffix(suffix)
-              return "#{raw_name} (#{suffix}).#{extension}"
-            end
-
-            # Checks if the given name already exists for a file in the campaign.
-            # @param tmp_name [String] the name to check the existence of in the campaign.
-            # @return [Boolean] TRUE if the file exists in the campaign, FALSE otherwise.
-            def exists_in_campaign(tmp_name)
-              campaign.files.where(name: tmp_name, :id.ne => id).exists?
-            end
-
-            # Returns the file name without the extension for the current file.
-            # @return [String] the name of the file without the extension.
-            def raw_name
-              return self[:name].gsub(".#{extension}", '')
-            end
-
-            # Returns the extension of the file, without the dot.
-            # @return [String] the text representation for this file extension, without the leading dot.
-            def extension
-              return self[:name].split('.').last
-            end
           end
         end
       end

data/lib/arkaan/campaigns/files/document.rb

@@ -1,17 +1,63 @@
 module Arkaan
   module Campaigns
     module Files
-      # Representation of a file, allowing us to retrieve it on AWS by its filename and linked campaign ID.
+      # A document is any piece of data added by a user to a campaign. It can either be a direct text note, or an uploaded document for example.
       # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Document < Arkaan::Campaigns::Files::Base
+      class Document
+        include Mongoid::Document
+        include Mongoid::Timestamps
         include Arkaan::Concerns::MimeTypable
         include Arkaan::Campaigns::Files::Concerns::Nameable
-
+        
         # @!attribute [rw] size
-        #   @return [Integer] the size of the file in bytes.
+        #   @return [Integer] the size of the document in bytes.
         field :size, type: Integer, default: 0
 
         mime_type ['image/*', 'text/plain']
+
+        # @!attribute [rw] permission
+        #   @return [Arkaan::Campaigns::Permission] the permissions granted to the different users of the campaign concerning this document.
+        has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Permission', inverse_of: :document
+
+        # Custom setter for the creator of the document so that it can be used as a normal field.
+        # @param invitation [Arkaan::Campaigns::Invitation] the invitation of the player creating this document.
+        def creator=(invitation)
+          if !permissions.where(invitation: invitation).exists?
+            Arkaan::Campaigns::Files::Permission.create(enum_level: :creator, document: self, invitation: invitation)
+          end
+        end
+
+        # Custom getter for the creator of the campaign.
+        # @return [Arkaan::Account] the account of the player that created this document.
+        def creator
+          return permissions.where(enum_level: :creator).first.invitation.account
+        end
+
+        # Checks if an account is allowed to access this document, accounts must have one of the following characteristics to read a document :
+        # - Be the creator of the document
+        # - Be the game master of the campaign in which the document is declared
+        # - Have been granted the permission to access the document
+        #
+        # @param account [Arkaan::Account] the account trying to access the document.
+        # @return [Boolean] TRUE if this account has the right to access the document, FALSe otherwise.
+        def is_allowed?(account)
+          return true if campaign.creator.id == account.id
+          return true if creator.id == account.id
+          return true if has_permission?(account)
+          return false
+        end
+
+        # Checks if the account has the permission to access the designated document.
+        # @param account [Arkaan::Account] the account to check the existence of a permission for.
+        # @return [Boolean] TRUE if the account has a permission to access this document, FALSE otherwise.
+        def has_permission?(account)
+          invitation = campaign.invitations.where(account: account).first
+          return !invitation.nil? && permissions.where(invitation: invitation).exists?
+        end
+
+        def campaign
+          permissions.first.invitation.campaign rescue nil
+        end
       end
     end
   end

data/lib/arkaan/campaigns/files/permission.rb

@@ -19,7 +19,7 @@ module Arkaan
         belongs_to :invitation, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :permissions
         # @!attribute [rw] file
         #   @return [Arkaan::Campaigns::Files::Document] the file on which the permissions are granted.
-        belongs_to :file, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :permissions
+        belongs_to :document, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :permissions
       end
     end
   end

data/lib/arkaan/campaigns/invitation.rb

@@ -20,16 +20,26 @@ module Arkaan
 
       # @!attribute [rw] files
       #   @return [Array<Arkaan::Campaigns::Files::Document>] the files uploaded in this campaign by the user linked to this invitation.
-      has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :invitation
+      has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Permission', inverse_of: :invitation
       # @!attribute [rw] characters
-      #   @return [Array<Arkaan::Campaigns::Files::Character>] the character sheets for this player.
-      has_many :characters, class_name: 'Arkaan::Campaigns::Files::Character', inverse_of: :invitation
+      #   @return [Array<Arkaan::Campaigns::Character>] the character sheets for this player.
+      has_many :characters, class_name: 'Arkaan::Campaigns::Character', inverse_of: :invitation
 
       # Gets the currently selected character in a convenient way.
       # @return [Arkaan::Campaigns::Files::Character] the character currently selected by the player.
       def character
         characters.where(selected: true).first
       end
+
+      def documents
+        permissions.map(&:document)
+      end
+
+      def has_file?(filename)
+        return permissions.map(&:document).map(&:name).any? do |name|
+          name == filename
+        end
+      end
     end
   end
 end

data/lib/arkaan/utils/controllers/base.rb

@@ -204,8 +204,10 @@ module Arkaan
           handle_arkaan_exception(exception)
         end
 
-        error StandardError do |exception|
-          custom_error(500, 'system_error.unknown_field.unknown_error')
+        if ENV['RACK_ENV'] != 'test'
+          error StandardError do |exception|
+            custom_error(500, 'system_error.unknown_field.unknown_error')
+          end
         end
       end
     end

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-09 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -302,13 +302,11 @@ files:
 - lib/arkaan/authentication/session.rb
 - lib/arkaan/campaign.rb
 - lib/arkaan/campaigns.rb
+- lib/arkaan/campaigns/character.rb
 - lib/arkaan/campaigns/files.rb
-- lib/arkaan/campaigns/files/base.rb
-- lib/arkaan/campaigns/files/character.rb
 - lib/arkaan/campaigns/files/concerns.rb
 - lib/arkaan/campaigns/files/concerns/nameable.rb
 - lib/arkaan/campaigns/files/document.rb
-- lib/arkaan/campaigns/files/note.rb
 - lib/arkaan/campaigns/files/permission.rb
 - lib/arkaan/campaigns/invitation.rb
 - lib/arkaan/campaigns/message.rb

data/lib/arkaan/campaigns/files/base.rb

@@ -1,56 +0,0 @@
-module Arkaan
-  module Campaigns
-    module Files
-      # A document is any piece of data added by a user to a campaign. It can either be a direct text note, or an uploaded file for example.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Base
-        include Mongoid::Document
-        include Mongoid::Timestamps
-
-        # @!attribute [rw] permission
-        #   @return [Arkaan::Campaigns::Permission] the permissions granted to the different users of the campaign concerning this file.
-        has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Permission', inverse_of: :file
-
-        # @!attribute [rw] campaign
-        #   @return [Arkaan::Campaign] the campaign in which this file was uploaded.
-        belongs_to :campaign, class_name: 'Arkaan::Campaign', inverse_of: :files
-
-        # Custom setter for the creator of the file so that it can be used as a normal field.
-        # @param invitation [Arkaan::Campaigns::Invitation] the invitation of the player creating this file.
-        def creator=(invitation)
-          if !permissions.where(invitation: invitation).exists?
-            Arkaan::Campaigns::Files::Permission.create(enum_level: :creator, file: self, invitation: invitation)
-          end
-        end
-
-        # Custom getter for the creator of the campaign.
-        # @return [Arkaan::Account] the account of the player that created this file.
-        def creator
-          return permissions.where(enum_level: :creator).first.invitation.account
-        end
-
-        # Checks if an account is allowed to access this file, accounts must have one of the following characteristics to read a file :
-        # - Be the creator of the file
-        # - Be the game master of the campaign in which the file is declared
-        # - Have been granted the permission to access the file
-        #
-        # @param account [Arkaan::Account] the account trying to access the file.
-        # @return [Boolean] TRUE if this account has the right to access the file, FALSe otherwise.
-        def is_allowed?(account)
-          return true if campaign.creator.id == account.id
-          return true if creator.id == account.id
-          return true if has_permission?(account)
-          return false
-        end
-
-        # Checks if the account has the permission to access the designated file.
-        # @param account [Arkaan::Account] the account to check the existence of a permission for.
-        # @return [Boolean] TRUE if the account has a permission to access this file, FALSE otherwise.
-        def has_permission?(account)
-          invitation = campaign.invitations.where(account: account).first
-          return !invitation.nil? && permissions.where(invitation: invitation).exists?
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/campaigns/files/character.rb

@@ -1,48 +0,0 @@
-module Arkaan
-  module Campaigns
-    module Files
-      # A character sheet represents a character played by a player in a campaign.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Character < Arkaan::Campaigns::Files::Base
-        include Arkaan::Campaigns::Files::Concerns::Nameable
-        include Arkaan::Concerns::MimeTypable
-
-        # @!attribute [rw] selected
-        #   @return [Boolean] TRUE if the sheet is currently selected by the player, FALSE otherwise.
-        field :selected, type: Boolean, default: false
-        # @!attribute [rw] mime_type
-        #   @return [String] the mime_type of the character sheet, MUST be an authorized MIME type for
-        #     the ruleset the campaign is set to be in.
-        mime_type :available_mime_types
-
-        # @!attribute [rw] invitation
-        #   @return [Arkaan::Campaigns::Invitation] the invitation of the player playing this character.
-        belongs_to :invitation, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :characters
-
-        # Returns the player linked to this character.
-        # @return [Arkaan::Account] the account of the player incarnating this character.
-        def player
-          invitation.account
-        end
-
-        # Method used to dinamically determine what MIME types are allowed for this character sheet
-        # If the campaign this character is in has no ruleset, every MIME type is allowed.
-        # @return [Array<String>] the available MIME type for the campaign linked to this character.
-        def available_mime_types
-          invitation.campaign.ruleset.mime_types
-        end
-
-        # Puts the selected flag to TRUE for this character and to FALSE for all the
-        # other characters for the same player in the same campaign.
-        def select!
-          invitation.characters.each do |character|
-            character.update_attribute(:selected, false)
-            character.save!
-          end
-          update_attribute(:selected, true)
-          save!
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/campaigns/files/note.rb

@@ -1,9 +0,0 @@
-module Arkaan
-  module Campaigns
-    module Files
-      class Note < Arkaan::Campaigns::Files::Base
-        field :content, type: String, default: ''
-      end
-    end
-  end
-end