Sha256: 8e5d8d4dd8b8fad3fcc9fb8cedd38aad736a3309d47768555a759d2f5c64b4a2

Contents?: true

Size: 1.47 KB

Versions: 4

Compression:

Stored size: 1.47 KB

Contents

# frozen_string_literal: true

module Bridgetown
  module Prioritizable
    module ClassMethods
      # @!method priorities
      #   @return [Hash<Symbol, Object>]

      # Get or set the priority of this class. When called without an
      # argument it returns the priority. When an argument is given, it will
      # set the priority.
      #
      # @param priority [Symbol] new priority (optional)
      #   Valid options are: `:lowest`, `:low`, `:normal`, `:high`, `:highest`
      # @return [Symbol]
      def priority(priority = nil)
        @priority ||= nil
        @priority = priority if priority && priorities.key?(priority)
        @priority || :normal
      end

      # Spaceship is priority [higher -> lower]
      #
      # @param other [Class] The class to be compared.
      # @return [Integer] -1, 0, 1.
      def <=>(other)
        priorities[other.priority] <=> priorities[priority]
      end

      # Return either this class' priorities or the superclass which has them (if any)
      def priorities
        return @priorities if @priorities

        superclass.priorities if superclass.respond_to?(:priorities)
      end

      def priorities=(val)
        @priorities = val
      end
    end

    def self.included(klass)
      klass.extend ClassMethods
    end

    # Spaceship is priority [higher -> lower]
    #
    # @param other [object] The object to be compared.
    # @return [Integer] -1, 0, 1.
    def <=>(other)
      self.class <=> other.class
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
bridgetown-core-2.0.0.beta4 lib/bridgetown-core/concerns/prioritizable.rb
bridgetown-core-2.0.0.beta3 lib/bridgetown-core/concerns/prioritizable.rb
bridgetown-core-2.0.0.beta2 lib/bridgetown-core/concerns/prioritizable.rb
bridgetown-core-2.0.0.beta1 lib/bridgetown-core/concerns/prioritizable.rb