dkubb/axiom

# encoding: utf-8

module Axiom
  class Relation
    module Operation

      # A class representing a reverse sorted relation
      class Reverse < Sorted

        # Instantiate a new Reverse relation
        #
        # @example
        #   reverse = Reverse.new(operand)
        #
        # @param [Relation] operand
        #
        # @return [Reverse]
        #
        # @api public
        def self.new(operand)
          assert_sorted_operand(operand)
          super(operand, operand.directions.reverse)
        end

        # Assert the operand is sorted
        #
        # @param [Relation] operand
        #
        # @return [undefined]
        #
        # @raise [SortededRelationRequiredError]
        #   raise if the operand is unsorted
        #
        # @api private
        def self.assert_sorted_operand(operand)
          if operand.header.size != operand.directions.size
            fail SortededRelationRequiredError, 'can only reverse a sorted operand'
          end
        end

        private_class_method :assert_sorted_operand

        # Iterate over each tuple in the set
        #
        # @example
        #   reverse = Reverse.new(operand)
        #   reverse.each { |tuple| ... }
        #
        # @yield [tuple]
        #
        # @yieldparam [Tuple] tuple
        #   each tuple in the set
        #
        # @return [self]
        #
        # @api public
        def each
          return to_enum unless block_given?
          operand.reverse_each { |tuple| yield tuple }
          self
        end

        module Methods

          # Return the reversed relation
          #
          # @example
          #   reverse = relation.reverse
          #
          # @param [Relation] other
          #
          # @return [Reverse]
          #
          # @api public
          def reverse
            Reverse.new(self)
          end

        end # module Methods

        Relation.class_eval { include Methods }

      end # class Limit
    end # module Operation
  end # class Relation
end # module Axiom