zombie_battleground-api 0.1.0 → 0.2.0

data/lib/zombie_battleground/api/responses/get_match_response.rb

@@ -9,29 +9,61 @@ require 'zombie_battleground/api/responses/response_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Response validator for GetMatch
-    class GetMatchResponse
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::ResponseHelper
+    class Responses
+      ##
+      # Response validator for GetMatch
+      class GetMatchResponse
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Responses::ResponseHelper
 
-      attr_reader :match
+        ##
+        # @!attribute [r] match
+        # the match
+        #
+        # @return [ZombieBattleground::Api::Models::Match]
+        #
+        # @example
+        #   response.match #=> ZombieBattleground::Api::Models::Match
+        #
+        # @api public
+        attr_reader :match
 
-      validate :match_is_a_match
+        validate :match_is_a_match
 
-      def initialize(response)
-        handle_errors(response)
+        ##
+        # Creates a new GetMatchResponse
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [ZombieBattleground::Api::GetMatchResponse]
+        #
+        # @example
+        #   response = ZombieBattleground::Api::GetMatchResponse.new(faraday_response)
+        #   # => ZombieBattleground::Api::GetMatchResponse
+        #
+        # @api public
+        def initialize(response)
+          handle_errors(response)
 
-        @match = ZombieBattleground::Api::Match.new(JSON.parse(response.body))
-      end
+          @match = ZombieBattleground::Api::Models::Match.new(JSON.parse(response.body))
+        end
+
+        private
 
-      def match_is_a_match
-        return if @match.is_a?(ZombieBattleground::Api::Match) &&
-                  @match.valid? &&
-                  @match.errors.size.zero?
+        ##
+        # Validator for match attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def match_is_a_match
+          return if @match.is_a?(ZombieBattleground::Api::Models::Match) &&
+                    @match.valid? &&
+                    @match.errors.size.zero?
 
-        errors.add(:match, 'match must be a Match')
+          errors.add(:match, 'match must be a Match')
+        end
       end
     end
   end

data/lib/zombie_battleground/api/responses/get_matches_response.rb

@@ -9,44 +9,114 @@ require 'zombie_battleground/api/responses/response_helper'
 
 module ZombieBattleground
   class Api
-    ##
-    # Response validator for GetMatches
-    class GetMatchesResponse
-      include ActiveModel::Validations
-      include ZombieBattleground::Api::ValidationHelper
-      include ZombieBattleground::Api::ResponseHelper
-
-      attr_reader :total, :page, :limit, :matches
-
-      validate :total_is_a_non_negative_integer
-      validate :page_is_a_non_negative_integer
-      validate :limit_is_a_non_negative_integer
-      validate :matches_is_an_array_of_match
-
-      def initialize(response)
-        handle_errors(response)
-
-        JSON.parse(response.body).each do |key, value|
-          if key == 'matches'
-            instance_variable_set("@#{key}".to_sym, value.map { |match| ZombieBattleground::Api::Match.new(match) })
-          else
-            instance_variable_set("@#{key}".to_sym, value)
+    class Responses
+      ##
+      # Response validator for GetMatches
+      class GetMatchesResponse
+        include ActiveModel::Validations
+        include ZombieBattleground::Api::ValidationHelper
+        include ZombieBattleground::Api::Responses::ResponseHelper
+
+        ##
+        # @!attribute [r] total
+        # the total number of results available
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.total #=> 1505
+        #
+        # @api public
+        attr_reader :total
+
+        ##
+        # @!attribute [r] page
+        # the page number of the results
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.page #=> 1
+        #
+        # @api public
+        attr_reader :page
+
+        ##
+        # @!attribute [r] limit
+        # the limit of results for the page
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.limit #=> 100
+        #
+        # @api public
+        attr_reader :limit
+
+        ##
+        # @!attribute [r] matches
+        # the matches found for the page and limit
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Match>]
+        #
+        # @example
+        #   response.matches #=> [ZombieBattleground::Api::Models::Match]
+        #
+        # @api public
+        attr_reader :matches
+
+        validate :total_is_a_non_negative_integer
+        validate :page_is_a_non_negative_integer
+        validate :limit_is_a_non_negative_integer
+        validate :matches_is_an_array_of_match
+
+        ##
+        # Creates a new GetMatchesResponse
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [ZombieBattleground::Api::GetMatchesResponse]
+        #
+        # @example
+        #   response = ZombieBattleground::Api::GetMatchesResponse.new(faraday_response)
+        #   # => ZombieBattleground::Api::GetMatchesResponse
+        #
+        # @api public
+        def initialize(response)
+          handle_errors(response)
+
+          JSON.parse(response.body).each do |key, value|
+            if key == 'matches'
+              instance_variable_set(
+                "@#{key}".to_sym, value.map { |match| ZombieBattleground::Api::Models::Match.new(match) }
+              )
+            else
+              instance_variable_set("@#{key}".to_sym, value)
+            end
           end
         end
-      end
 
-      def matches_is_an_array_of_match
-        unless @matches.is_a?(Array)
-          errors.add(:matches, 'Matchs must be an array')
-          return
-        end
+        private
 
-        @matches.each do |match|
-          next if match.is_a?(ZombieBattleground::Api::Match) &&
-                  match.valid? &&
-                  match.errors.size.zero?
+        ##
+        # Validator for matches attribute
+        #
+        # @return [void]
+        #
+        # @api private
+        def matches_is_an_array_of_match
+          unless @matches.is_a?(Array)
+            errors.add(:matches, 'Matchs must be an array')
+            return
+          end
+
+          @matches.each do |match|
+            next if match.is_a?(ZombieBattleground::Api::Models::Match) &&
+                    match.valid? &&
+                    match.errors.size.zero?
 
-          errors.add(:matches, 'matches must be an array of Match')
+            errors.add(:matches, 'matches must be an array of Match')
+          end
         end
       end
     end

data/lib/zombie_battleground/api/responses/response_helper.rb

@@ -4,24 +4,40 @@ require 'zombie_battleground/api/errors'
 
 module ZombieBattleground
   class Api
-    ##
-    # Provides generic methods for response validator classes
-    module ResponseHelper
-      def handle_errors(response)
-        return if response.status == 200
+    class Responses
+      ##
+      # Provides generic methods for response validator classes
+      module ResponseHelper
+        private
 
-        case response.status
-        when 404
-          raise ZombieBattleground::Api::Errors::NotFound, response.body
-        when 503
-          raise ZombieBattleground::Api::Errors::ServiceUnavailable, response.body
-        when 400..499
-          raise ZombieBattleground::Api::Errors::BadRequest, response.body
-        when 500..599
-          raise ZombieBattleground::Api::Errors::InternalServerError, response.body
-        end
+        ##
+        # Raises errors as needed from the response status code
+        #
+        # @param response [Faraday::Response] Faraday response from endpoint
+        #
+        # @return [void]
+        #
+        # @raise [ZombieBattleground::Api::Errors::NotFound, ZombieBattleground::Api::Errors::ServiceUnavailable,
+        #         ZombieBattleground::Api::Errors::BadRequest, ZombieBattleground::Api::Errors::InternalServerError,
+        #         ZombieBattleground::Api::Errors::UnknownResponse]
+        #
+        # @api private
+        def handle_errors(response)
+          return if response.status == 200
+
+          case response.status
+          when 404
+            raise ZombieBattleground::Api::Errors::NotFound, response.body
+          when 503
+            raise ZombieBattleground::Api::Errors::ServiceUnavailable, response.body
+          when 400..499
+            raise ZombieBattleground::Api::Errors::BadRequest, response.body
+          when 500..599
+            raise ZombieBattleground::Api::Errors::InternalServerError, response.body
+          end
 
-        raise ZombieBattleground::Api::Errors::UnknownResponse, response.body
+          raise ZombieBattleground::Api::Errors::UnknownResponse, response.body
+        end
       end
     end
   end

data/lib/zombie_battleground/api/validation_helper.rb

@@ -5,12 +5,35 @@ module ZombieBattleground
     ##
     # Validation helpers for sanitizing inputs and ouputs
     module ValidationHelper
+      private
+
+      ##
+      # Appends an error to the model if the value is not the expected class
+      #
+      # @param target [Symbol]
+      # @param value [Object]
+      # @param nullable [Boolean]
+      # @param klass [Class]
+      #
+      # @return [void]
+      #
+      # @api private
       def value_is_a_class(target:, value:, nullable:, klass:)
         return if (nullable && value.nil?) || value.is_a?(klass)
 
         errors.add(target, "#{target} must be a #{klass}")
       end
 
+      ##
+      # Appends an error to the model if the value is not String
+      #
+      # @param target [Symbol]
+      # @param value [Object]
+      # @param nullable [Boolean]
+      #
+      # @return [void]
+      #
+      # @api private
       def value_is_a_string(target:, value:, nullable: true)
         value_is_a_class(
           target: target,
@@ -20,6 +43,16 @@ module ZombieBattleground
         )
       end
 
+      ##
+      # Appends an error to the model if the value is not Time
+      #
+      # @param target [Symbol]
+      # @param value [Object]
+      # @param nullable [Boolean]
+      #
+      # @return [void]
+      #
+      # @api private
       def value_is_a_time(target:, value:, nullable: true)
         value_is_a_class(
           target: target,
@@ -29,6 +62,16 @@ module ZombieBattleground
         )
       end
 
+      ##
+      # Appends an error to the model if the value is not Integer
+      #
+      # @param target [Symbol]
+      # @param value [Object]
+      # @param nullable [Boolean]
+      #
+      # @return [void]
+      #
+      # @api private
       def value_is_an_integer(target:, value:, nullable: true)
         value_is_a_class(
           target: target,
@@ -38,6 +81,16 @@ module ZombieBattleground
         )
       end
 
+      ##
+      # Appends an error to the model if the value is a negative Integer
+      #
+      # @param target [Symbol]
+      # @param value [Object]
+      # @param nullable [Boolean]
+      #
+      # @return [void]
+      #
+      # @api private
       def value_is_a_non_negative_integer(target:, value:, nullable: true)
         value_is_an_integer(target: target, value: value, nullable: nullable)
         return unless errors.messages.empty?
@@ -47,298 +100,742 @@ module ZombieBattleground
         errors.add(target, "#{target} must be not negative")
       end
 
+      ##
+      # Appends an error to the model if id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :id, value: id)
       end
 
+      ##
+      # Appends an error to the model if id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :id, value: id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if user_id is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def user_id_is_a_string
         value_is_a_string(target: :user_id, value: user_id)
       end
 
+      ##
+      # Appends an error to the model if user_id is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def user_id_is_a_string_and_not_null
         value_is_a_string(target: :user_id, value: user_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if deck_id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def deck_id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :deck_id, value: deck_id)
       end
 
+      ##
+      # Appends an error to the model if deck_id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def deck_id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :deck_id, value: deck_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if name is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def name_is_a_string
         value_is_a_string(target: :name, value: name)
       end
 
+      ##
+      # Appends an error to the model if name is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def name_is_a_string_and_not_null
         value_is_a_string(target: :name, value: name, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if hero_id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def hero_id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :hero_id, value: hero_id)
       end
 
+      ##
+      # Appends an error to the model if hero_id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def hero_id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :hero_id, value: hero_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if primary_skill_id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def primary_skill_id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :primary_skill_id, value: primary_skill_id)
       end
 
+      ##
+      # Appends an error to the model if primary_skill_id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def primary_skill_id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :primary_skill_id, value: primary_skill_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if secondary_skill_id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def secondary_skill_id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :secondary_skill_id, value: secondary_skill_id)
       end
 
+      ##
+      # Appends an error to the model if secondary_skill_id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def secondary_skill_id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :secondary_skill_id, value: secondary_skill_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if version is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def version_is_a_string
         value_is_a_string(target: :version, value: version)
       end
 
+      ##
+      # Appends an error to the model if version is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def version_is_a_string_and_not_null
         value_is_a_string(target: :version, value: version, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if total is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def total_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :total, value: total)
       end
 
+      ##
+      # Appends an error to the model if total is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def total_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :total, value: total, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if page is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def page_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :page, value: page)
       end
 
+      ##
+      # Appends an error to the model if page is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def page_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :page, value: page, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if limit is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def limit_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :limit, value: limit)
       end
 
+      ##
+      # Appends an error to the model if limit is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def limit_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :limit, value: limit, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if card_name is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def card_name_is_a_string
         value_is_a_string(target: :card_name, value: card_name)
       end
 
+      ##
+      # Appends an error to the model if card_name is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def card_name_is_a_string_and_not_null
         value_is_a_string(target: :card_name, value: card_name, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if amount is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def amount_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :amount, value: amount)
       end
 
+      ##
+      # Appends an error to the model if amount is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def amount_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :amount, value: amount, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if sender_address is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def sender_address_is_a_string
         value_is_a_string(target: :sender_address, value: sender_address)
       end
 
+      ##
+      # Appends an error to the model if sender_address is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def sender_address_is_a_string_and_not_null
         value_is_a_string(target: :sender_address, value: sender_address, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if created_at is not a Time
+      #
+      # @return [void]
+      #
+      # @api private
       def created_at_is_a_time
         value_is_a_time(target: :created_at, value: created_at)
       end
 
+      ##
+      # Appends an error to the model if created_at is not a Time or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def created_at_is_a_time_and_not_null
         value_is_a_time(target: :created_at, value: created_at, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if updated_at is not a Time
+      #
+      # @return [void]
+      #
+      # @api private
       def updated_at_is_a_time
         value_is_a_time(target: :updated_at, value: updated_at)
       end
 
+      ##
+      # Appends an error to the model if updated_at is not a Time or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def updated_at_is_a_time_and_not_null
         value_is_a_time(target: :updated_at, value: updated_at, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if block_height is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def block_height_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :block_height, value: block_height)
       end
 
+      ##
+      # Appends an error to the model if block_height is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def block_height_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :block_height, value: block_height, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if player1_id is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def player1_id_is_a_string
         value_is_a_string(target: :player1_id, value: player1_id)
       end
 
+      ##
+      # Appends an error to the model if player1_id is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def player1_id_is_a_string_and_not_null
         value_is_a_string(target: :player1_id, value: player1_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if player2_id is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def player2_id_is_a_string
         value_is_a_string(target: :player2_id, value: player2_id)
       end
 
+      ##
+      # Appends an error to the model if player2_id is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def player2_id_is_a_string_and_not_null
         value_is_a_string(target: :player2_id, value: player2_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if player1_deck_id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def player1_deck_id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :player1_deck_id, value: player1_deck_id)
       end
 
+      ##
+      # Appends an error to the model if player1_deck_id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def player1_deck_id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :player1_deck_id, value: player1_deck_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if player2_deck_id is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def player2_deck_id_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :player2_deck_id, value: player2_deck_id)
       end
 
+      ##
+      # Appends an error to the model if player2_deck_id is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def player2_deck_id_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :player2_deck_id, value: player2_deck_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if random_seed is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def random_seed_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :random_seed, value: random_seed)
       end
 
+      ##
+      # Appends an error to the model if random_seed is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def random_seed_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :random_seed, value: random_seed, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if status is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def status_is_a_string
         value_is_a_string(target: :status, value: status)
       end
 
+      ##
+      # Appends an error to the model if status is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def status_is_a_string_and_not_null
         value_is_a_string(target: :status, value: status, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if winner_id is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def winner_id_is_a_string
         value_is_a_string(target: :winner_id, value: winner_id)
       end
 
+      ##
+      # Appends an error to the model if winner_id is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def winner_id_is_a_string_and_not_null
         value_is_a_string(target: :winner_id, value: winner_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if mould_id is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def mould_id_is_a_string
         value_is_a_string(target: :mould_id, value: mould_id)
       end
 
+      ##
+      # Appends an error to the model if mould_id is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def mould_id_is_a_string_and_not_null
         value_is_a_string(target: :mould_id, value: mould_id, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if kind is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def kind_is_a_string
         value_is_a_string(target: :kind, value: kind)
       end
 
+      ##
+      # Appends an error to the model if kind is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def kind_is_a_string_and_not_null
         value_is_a_string(target: :kind, value: kind, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if set is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def set_is_a_string
         value_is_a_string(target: :set, value: set)
       end
 
+      ##
+      # Appends an error to the model if set is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def set_is_a_string_and_not_null
         value_is_a_string(target: :set, value: set, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if description is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def description_is_a_string
         value_is_a_string(target: :description, value: description)
       end
 
+      ##
+      # Appends an error to the model if description is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def description_is_a_string_and_not_null
         value_is_a_string(target: :description, value: description, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if rank is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def rank_is_a_string
         value_is_a_string(target: :rank, value: rank)
       end
 
+      ##
+      # Appends an error to the model if rank is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def rank_is_a_string_and_not_null
         value_is_a_string(target: :rank, value: rank, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if type is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def type_is_a_string
         value_is_a_string(target: :type, value: type)
       end
 
+      ##
+      # Appends an error to the model if type is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def type_is_a_string_and_not_null
         value_is_a_string(target: :type, value: type, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if rarity is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def rarity_is_a_string
         value_is_a_string(target: :rarity, value: rarity)
       end
 
+      ##
+      # Appends an error to the model if rarity is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def rarity_is_a_string_and_not_null
         value_is_a_string(target: :rarity, value: rarity, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if frame is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def frame_is_a_string
         value_is_a_string(target: :frame, value: frame)
       end
 
+      ##
+      # Appends an error to the model if frame is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def frame_is_a_string_and_not_null
         value_is_a_string(target: :frame, value: frame, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if damage is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def damage_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :damage, value: damage)
       end
 
+      ##
+      # Appends an error to the model if damage is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def damage_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :damage, value: damage, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if health is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def health_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :health, value: health)
       end
 
+      ##
+      # Appends an error to the model if health is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def health_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :health, value: health, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if cost is a negative Integer
+      #
+      # @return [void]
+      #
+      # @api private
       def cost_is_a_non_negative_integer
         value_is_a_non_negative_integer(target: :cost, value: cost)
       end
 
+      ##
+      # Appends an error to the model if cost is a negative Integer or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def cost_is_a_non_negative_integer_and_not_null
         value_is_a_non_negative_integer(target: :cost, value: cost, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if ability is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def ability_is_a_string
         value_is_a_string(target: :ability, value: ability)
       end
 
+      ##
+      # Appends an error to the model if ability is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def ability_is_a_string_and_not_null
         value_is_a_string(target: :ability, value: ability, nullable: false)
       end
 
+      ##
+      # Appends an error to the model if image_url is not a String
+      #
+      # @return [void]
+      #
+      # @api private
       def image_url_is_a_string
         value_is_a_string(target: :image_url, value: image_url)
       end
 
+      ##
+      # Appends an error to the model if image_url is not a String or nil
+      #
+      # @return [void]
+      #
+      # @api private
       def image_url_is_a_string_and_not_null
         value_is_a_string(target: :image_url, value: image_url, nullable: false)
       end