arkaan 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e70b9b135c0ac5b57d31e26c224937b2ed9ca69bd902f10f2cc4f7c2bddd339f
-  data.tar.gz: 61b68c995672ff514cecf8c022a30e9231c05e9f5ed55b468e17fe528068d3a6
+  metadata.gz: c3f79b8da492a5bfaf83581bd87a361d6037294f185ce6c2f2287f1d2a65b0e7
+  data.tar.gz: fc6f180aff359447096bbda6b5b7014c0b87de9f448d536024eac852a8581954
 SHA512:
-  metadata.gz: 94729cac55877bb9da88d9d4a7824ff99158480fe16afe1e2eee6f4732e64039ddce67fbbcef74b6f943c88b1e1ea0b88e6568955e58d22541d6c8b6365a1047
-  data.tar.gz: 0b83a9933b47a4c47285c50bcb9aa87288e0a449068d3ae17b901497148d8998fd71a13bcfc1ecff40466df10b810ddc0b5ada68d72f1d329a465d9c49a7bd9a
+  metadata.gz: 6dfb33ab03f87d8a8b8dadffa1c3ed4111924eb23c3cfb97863a3cfa104cae4f98ff4167b3c2aef0d88456db78d04ea13dad69c3e046aadf3e04259e3c4ec2ee
+  data.tar.gz: 99db55a4ae62a79d4c5aaab2f3922b30db0455aafa3083255ebd6be60f912c473c8d1445183b8d803b6bd4fba0ce7f501b3dfb5e5f0c77c69fc7c1df84db104c

data/lib/arkaan.rb

@@ -25,6 +25,5 @@ module Arkaan
   autoload :Permissions   , 'arkaan/permissions'
   autoload :Phone         , 'arkaan/phone'
   autoload :Ruleset       , 'arkaan/ruleset'
-  autoload :Rulesets      , 'arkaan/rulesets'
   autoload :Utils         , 'arkaan/utils'
 end

data/lib/arkaan/campaigns/character.rb

@@ -5,16 +5,16 @@ module Arkaan
     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] data
+      #   @return [Hash] the heart of the Arkaan::Campaigns::Character class, the polymorphic
+      #     data representing all the fields of a character sheet are validated using the validator
+      #     of the associated plugin, and created/updated with the corresponding form.
+      field :data, type: Hash, default: {}
 
       # @!attribute [rw] invitation
       #   @return [Arkaan::Campaigns::Invitation] the invitation of the player playing this character.
@@ -26,13 +26,6 @@ module Arkaan
         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

data/lib/arkaan/ruleset.rb

@@ -18,15 +18,9 @@ module Arkaan
     # @!attribute [rw] creator
     #   @return [Arkaan::Account] the account of the user creating this ruleset.
     belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :rulesets
-    # @!attribute [rw] blueprints
-    #   @return [Arr  ay<Arkaan::Rulesets::Blueprint>] the blueprints created inside this ruleset, see the class itself to know what it is.
-    has_many :blueprints, class_name: 'Arkaan::Rulesets::Blueprint', inverse_of: :ruleset
     # @!attribute [rw] campaigns
     #   @return [Array<Arkaan::Campaign>] the campaigns using this set of rules.
     has_many :campaigns, class_name: 'Arkaan::Campaign', inverse_of: :ruleset
-    # @!attribute [rw] sheet
-    #   @return [Arkaan::Rulesets::Sheet] the character sheet template for this set of rules.
-    has_one :sheet, class_name: 'Arkaan::Rulesets::Sheet', inverse_of: :ruleset
 
     validates :name,
       presence: {message: 'required'},

data/lib/arkaan/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -350,16 +350,6 @@ files:
 - lib/arkaan/permissions/right.rb
 - lib/arkaan/phone.rb
 - lib/arkaan/ruleset.rb
-- lib/arkaan/rulesets.rb
-- lib/arkaan/rulesets/blueprint.rb
-- lib/arkaan/rulesets/field.rb
-- lib/arkaan/rulesets/fields.rb
-- lib/arkaan/rulesets/fields/gauge.rb
-- lib/arkaan/rulesets/fields/integer.rb
-- lib/arkaan/rulesets/sheet.rb
-- lib/arkaan/rulesets/sheets.rb
-- lib/arkaan/rulesets/sheets/attribute.rb
-- lib/arkaan/rulesets/sheets/category.rb
 - lib/arkaan/specs.rb
 - lib/arkaan/utils.rb
 - lib/arkaan/utils/controllers.rb

data/lib/arkaan/rulesets.rb

@@ -1,13 +0,0 @@
-module Arkaan
-  # The rulesets module holds all the logic for components present inside a ruleset.
-  # @author Vincent Courtois <courtois.vincent@outlook.com>
-  module Rulesets
-    autoload :Blueprint, 'arkaan/rulesets/blueprint'
-    autoload :Field    , 'arkaan/rulesets/field'
-    autoload :Fields   , 'arkaan/rulesets/fields'
-    autoload :Gauge    , 'arkaan/rulesets/gauge'
-    autoload :Integer  , 'arkaan/rulesets/integer'
-    autoload :Sheet    , 'arkaan/rulesets/sheet'
-    autoload :Sheets   , 'arkaan/rulesets/sheets'
-  end
-end

data/lib/arkaan/rulesets/blueprint.rb

@@ -1,34 +0,0 @@
-module Arkaan
-  module Rulesets
-    # A blueprint defines what a type of entity contains.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Blueprint
-      include Mongoid::Document
-      include Mongoid::Timestamps
-
-      # @!attribute [rw] name
-      #   @return [String] the name of this type of entity in the ruleset.
-      field :name, type: String
-
-      # @!attribute [rw] ruleset
-      #   @return [Arkaan::Ruleset] the ruleset to which this blueprint belongs.
-      belongs_to :ruleset, class_name: 'Arkaan::Ruleset', inverse_of: :blueprints
-      # @!attribute [rw] _fields
-      #   @return [Array<Arkaan::Rulesets::Field>] the field composing the attributes of this blueprint.
-      embeds_many :_fields, class_name: 'Arkaan::Rulesets::Field', inverse_of: :blueprint
-
-      validates :name,
-        presence: {message: 'required'},
-        length: {minimum: 4, message: 'minlength', if: :name?}
-
-      validate :name_unicity
-
-      def name_unicity
-        has_duplicate = ruleset.blueprints.where(:_id.ne => _id, name: name).exists?
-        if !ruleset.nil? && name? && has_duplicate
-          errors.add(:name, 'uniq')
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/rulesets/field.rb

@@ -1,71 +0,0 @@
-module Arkaan
-  module Rulesets
-    # A field is an attribute of a blueprint, with a type and a name.
-    # It does not have a defined value as it will be given in the instance of the blueprint.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Field
-      include Mongoid::Document
-      include Mongoid::Timestamps
-      include Arkaan::Concerns::Enumerable
-
-      # @!attribute [rw] name
-      #   @return [String] the name of the field is comparable to the name of a variable.
-      field :name, type: String
-      # @!attribute [rw] data
-      #   @return [Hash] the additional data, mainly constraints and needed values, for the field.
-      field :data, type: Hash, default: {}
-
-      # @!attribute [rw] blueprint
-      #   @return [Arkaan::Rulesets::Blueprint] the blueprint in which the field belongs.
-      embedded_in :blueprint, class_name: 'Arkaan::Rulesets::Blueprint', inverse_of: :_fields
-
-      validates :name,
-        presence: {message: 'required'},
-        length: {minimum: 4, message: 'minlength', if: :name?},
-        format: {with: /\A[a-zA-Z_]*\z/, message: 'pattern', if: :name?}
-
-      validate :name_unicity
-
-      validate :options_validity
-
-      # Getter for the type of the field, returning simply the last element of the type for simpler use.
-      # @return [Symbol] the name of the type of the field (eq :Integer or :Gauge)
-      def type
-        return _type.split('::').last.to_sym
-      end
-
-      # Default options for this type of field, specialize it in the subclasses.
-      # @return [Hash] a hash with the default value for all options you want default values on.
-      def default_options
-        return {}
-      end
-
-      # Setter for the additional datas, merging it with the default options for the current type.
-      # @param new_data [Hash] the additional data to add to this field.
-      def data=(new_data)
-        self[:data] = default_options.merge(new_data)
-      end
-
-      def name_unicity
-        has_duplicate = blueprint._fields.where(:_id.ne => _id, name: name).exists?
-        if name? && blueprint && has_duplicate
-          errors.add(:name, 'uniq')
-        end
-      end
-
-      def options_validity
-        send(:validate_options) rescue true
-      end
-
-      # Checks the corresponding option key against the given data type. All types can be used.
-      # @param key [String] the name of the key in the options you want to check the type of.
-      # @param required_type [String] the exact name of the class you want to check the option against.
-      def check_type(key, required_type)
-        parsed_type = Object.const_get("::#{required_type}")
-        if !errors.messages.has_key?(:data) && data[key.to_sym] && !data[key.to_sym].is_a?(parsed_type)
-          errors.add(:data, "#{key.to_s}|type")
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/rulesets/fields.rb

@@ -1,10 +0,0 @@
-module Arkaan
-  module Rulesets
-    # This module holds all the classes for the different fields types in the blueprints.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Fields
-      autoload :Gauge  , 'arkaan/rulesets/fields/gauge'
-      autoload :Integer, 'arkaan/rulesets/fields/integer'
-    end
-  end
-end

data/lib/arkaan/rulesets/fields/gauge.rb

@@ -1,20 +0,0 @@
-module Arkaan
-  module Rulesets
-    module Fields
-      # A gauge is composed of a max value, and a min value, and when instanciated has a current value that can't go above max or below min.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Gauge < Arkaan::Rulesets::Field
-        def default_options
-          return {initial: 0, max: 100, min: 0, show: true}
-        end
-
-        def validate_options
-          check_type(:initial, 'Integer')
-          check_type(:max, 'Integer')
-          check_type(:min, 'Integer')
-          check_type(:show, 'Boolean')
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/rulesets/fields/integer.rb

@@ -1,14 +0,0 @@
-module Arkaan
-  module Rulesets
-    module Fields
-      # An integer field can have a minimum and maximum value.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Integer < Arkaan::Rulesets::Field
-        def validate_options
-          check_type(:max, 'Integer')
-          check_type(:min, 'Integer')
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/rulesets/sheet.rb

@@ -1,28 +0,0 @@
-module Arkaan
-  module Rulesets
-    # A character sheet is the templating to parse and transform an uploaded
-    # XML file into a readable character sheet we can display on the interface.
-    # The main way to do it is to create attributes sorted into categories (optional)
-    # and to link each of these attributes to a XPath selector in the XML sheet
-    # the game master uploaded and linked to the player.
-    #
-    # This way we can just rebuild a JSON object with the categories and fields
-    # defined in the sheet, extracted from the XML sheet of the character.
-    #
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Sheet
-      include Mongoid::Document
-      include Mongoid::Timestamps
-
-      # @!attribute [rw] ruleset
-      #   @return [Arkaan::Ruleset] the set of rules this sheet corresponds to.
-      belongs_to :ruleset, class_name: 'Arkaan::Ruleset', inverse_of: :sheet
-      # @!attribute [rw] creator
-      #   @return [Arkaan::Account] the account of the creator of the sheet.
-      belongs_to :creator, class_name: 'Arkaan::Account'
-      # @!attribute [rw] categories
-      #   @return [Array<Arkaan::Rulesets::Sheets::Category>] the categories declared in this sheet.
-      embeds_many :categories, class_name: 'Arkaan::Rulesets::Sheets::Category', inverse_of: :sheet
-    end
-  end
-end

data/lib/arkaan/rulesets/sheets.rb

@@ -1,10 +0,0 @@
-module Arkaan
-  module Rulesets
-    # This module regroups the entities embedded in a character sheet template.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Sheets
-      autoload :Attribute, 'arkaan/rulesets/sheets/attribute'
-      autoload :Category , 'arkaan/rulesets/sheets/category'
-    end
-  end
-end

data/lib/arkaan/rulesets/sheets/attribute.rb

@@ -1,40 +0,0 @@
-module Arkaan
-  module Rulesets
-    module Sheets
-      class Attribute
-        include Mongoid::Document
-        include Mongoid::Timestamps
-        include Arkaan::Concerns::Enumerable
-
-        # @!attribute [rw] name
-        #   @return [String] the name of the attribute in the character sheet.
-        #     This name is then used in the translation files as a key to retrieve it.
-        field :name, type: String, default: ''
-        # @!attribute [rw] default
-        #   @return [Object] the default value for this attribute. Not typed so it
-        #     can be any type of value (mainly integer, strings or datetimes)
-        field :default
-        # @!attribute [rw] xpath
-        #   @return [String] the path to find this attribute in the XML sheet uploaded.
-        field :xpath, type: String
-
-        # @!attribute [rw] category
-        #   @return [Arkaan::Rulesets::Sheets::Category] the category the attribute is in.
-        embedded_in :category, class_name: 'Arkaan::Rulesets::Sheets::Category', inverse_of: :attrs
-
-        validates :name,
-          presence: {message: 'required'},
-          format: {with: /\A[a-zA-Z_]*\z/, message: 'pattern', if: :name?}
-
-        validate :name_unicity
-        
-        def name_unicity
-          has_duplicate = category.attrs.where(:_id.ne => _id, name: name).exists?
-          if name? && category && has_duplicate
-            errors.add(:name, 'uniq')
-          end
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/rulesets/sheets/category.rb

@@ -1,25 +0,0 @@
-module Arkaan
-  module Rulesets
-    module Sheets
-      # A category is just a semantic group of attributes having the same function
-      # or sharing some semantic proximity (eg. all characteristics or skills).
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Category
-        include Mongoid::Document
-        include Mongoid::Timestamps
-
-        # @!attribute [rw] name
-        #   @return [String] the name of the category you're creating.
-        field :name, type: String, default: ''
-
-        # @!attribute [rw] sheet
-        #   @return [Arkaan::Rulesets::Sheet] the sheet template the category is embedded in; 
-        embedded_in :sheet, class_name: 'Arkaan::Rulesets::Sheet', inverse_of: :categories
-
-        # @!attribute [rw] attributes
-        #   @return [Array<Arkaan::Rulesets::Sheets::Attribute>] the attributes linked to this category.
-        embeds_many :attrs, class_name: 'Arkaan::Rulesets::Sheets::Attribute', inverse_of: :category
-      end
-    end
-  end
-end