dkubb/axiom

# encoding: utf-8

module Axiom
  class Attribute

    # A mixin for attributes that have comparable objects
    module Comparable
      include Function::Predicate::GreaterThan::Methods,
              Function::Predicate::GreaterThanOrEqualTo::Methods,
              Function::Predicate::LessThan::Methods,
              Function::Predicate::LessThanOrEqualTo::Methods

      # Sort the attribute in ascending order
      #
      # @example
      #   ascending = attribute.asc
      #
      # @return [Axiom::Relation::Operation::Sorted::Ascending]
      #
      # @api public
      def asc
        Axiom::Relation::Operation::Sorted::Ascending.new(self)
      end

      # Sort the attribute in descending order
      #
      # @example
      #   descending = attribute.desc
      #
      # @return [Axiom::Relation::Operation::Sorted::Descending]
      #
      # @api public
      def desc
        Axiom::Relation::Operation::Sorted::Descending.new(self)
      end

      # The range for the objects
      #
      # @return [Range]
      #
      # @api public
      def range
        type.range
      end

    end # module Comparable
  end # class Attribute
end # module Axiom