comments

git-svn-id: https://dev.finn.de/svn/cockpit/branches/reporting_merge@1099 7926756e-e54e-46e6-9721-ed318f58905e

app/models/cost_query/group_by/ruby_aggregation.rb

@@ -4,11 +4,19 @@ module CostQuery::GroupBy
       false
     end
 
+    ##
+    # @return [CostQuery::Result] aggregation
     def result
+      # sub results, have fields
+      # i.e. grouping by foo, bar
       data = child.result.group_by do |entry|
+        # index for group is a hash
+        # i.e. { :foo => 10, :bar => 20 }
         group_fields.inject({}) { |hash, key| hash.merge key => entry.fields[key] }
       end
+      # map group back to array, all fields with same key get grouped into one list
       list = data.keys.map { |fields| CostQuery::Result.new data[fields], fields }
+      # create a single result from that list
       CostQuery::Result.new list
     end
   end

app/models/cost_query/walker.rb

@@ -1,41 +1,42 @@
 class CostQuery::Walker
   def initialize(query)
+    @query = query
   end
 
-  ##
+  # ##
-  # Fields which the walker recognizes as a group. Unknown fields or
+  # # Fields which the walker recognizes as a group. Unknown fields or
-  # fields which are not given (but appear in the result) will be ignored.
+  # # fields which are not given (accepts_propertybut appear in the result) will be ignored.
-  #
+  # #
-  # @overload follow_groups
+  # # @overload follow_groups
-  #   Reads the fields the walker recognizes as groups.
+  # #   Reads the fields the walker recognizes as groups.
-  #   @return [Array<#to_s>] fields
+  # #   @return [Array<#to_s>] fields
-  # @overload follow_groups(fields)
+  # # @overload follow_groups(fields)
-  #   Sets the fields which are recognized as groups by the walker.
+  # #   Sets the fields which are recognized as groups by the walker.
-  #   @param [Array<String, Symbol>] fields Field which are recognized as groups by the walker.
+  # #   @param [Array<String, Symbol>] fields Field which are recognized as groups by the walker.
-  def follow_groups(fields = nil)
+  # def follow_groups(fields = nil)
-    @fields ||= []
+  #   @fields ||= []
-    @fields = fields if fields
+  #   @fields = fields if fields
-    @fields
+  #   @fields
-  end
+  # end
-
+  # 
-  ##
+  # ##
-  # Defines which parameter wil be given to the block when doing the walk.
+  # # Defines which parameter wil be given to the block when doing the walk.
-  #
+  # #
-  # @param [Block] The block, which gets the result and returns the parameter the walk-block needs.
+  # # @param [Block] The block, which gets the result and returns the parameter the walk-block needs.
-  def walk_param_from(&block)
+  # def walk_param_from(&block)
-    @walk_param = block || { |result| result } # maybe this should be an empty array later.
+  #   @walk_param = block || { |result| result } # maybe this should be an empty array later.
-  end
+  # end
-
+  # 
-  ##
+  # ##
-  # Walks on the result and evaluates the block for each result as if we have nested group_by's.
+  # # Walks on the result and evaluates the block for each result as if we have nested group_by's.
-  # The given block will get the parameter defined in @see CostQuery::Walker#walk_param_from
+  # # The given block will get the parameter defined in @see CostQuery::Walker#walk_param_from
-  def walk_on(&block)
+  # def walk_on(&block)
-    #walking on sunshine!
+  #   #walking on sunshine!
-    result.recursive_each_with_level 0 false do | level, current_result |
+  #   result.recursive_each_with_level 0 false do | level, current_result |
-      to_aggregate = @fields
+  #     to_aggregate = @fields
-      if r.fields.any? to_aggregate
+  #     if r.fields.any? to_aggregate
-        to_aggregate
+  #       to_aggregate
-      end
+  #     end
-    end
+  #   end
-  end
+  # end
 end