dkubb/axiom

# encoding: utf-8

module Axiom
  class Relation
    module Operation

      # A class representing a grouped relation
      class Group < Relation
        include Unary
        include Equalizer.new(:operand, :attribute)

        # The grouped attribute
        #
        # @return [Attribute::Relation]
        #
        # @api private
        attr_reader :attribute

        # Initialize a grouped relation
        #
        # @param [Relation] operand
        # @param [#to_sym] name
        # @param [Enumerable<Axiom::Attribute>] attributes
        #
        # @return [undefined]
        #
        # @api private
        def initialize(operand, name, attributes)
          super(operand)
          inner      = header.project(attributes)
          @outer     = header - inner
          @attribute = Attribute::Relation.new(name, header: inner)
          @header    = @outer.extend(attribute)
        end

        # Iterate over each tuple in the set
        #
        # @example
        #   grouped = Group.new(operand, name, attributes)
        #   grouped.each { |tuple| ... }
        #
        # @yield [tuple]
        #
        # @yieldparam [Tuple] tuple
        #   each tuple in the set
        #
        # @return [self]
        #
        # @api public
        def each
          return to_enum unless block_given?
          build_index.each do |outer_tuple, inner_tuples|
            inner_relation = attribute.new_relation(inner_tuples)
            yield outer_tuple.extend(header, [inner_relation])
          end
          self
        end

      private

        # Build an index using every tuple in the operand
        #
        # @return [Index]
        #
        # @api private
        def build_index
          Index.new(@outer, @attribute.header).merge(operand)
        end

        module Methods

          # Return a grouped relation
          #
          # @example
          #   grouped = relation.group(location: [:latitude, :longitude])
          #
          # @param [Hash{#to_sym => Enumerable<Axiom::Attribute>] grouping
          #
          # @return [Group]
          #
          # @api public
          def group(grouping)
            grouping.reduce(self) do |operation, pair|
              Group.new(operation, *pair)
            end
          end

        end # module Methods

        Relation.class_eval { include Methods }

      end # class Group
    end # module Operation
  end # class Relation
end # module Axiom