Class: Parse::GroupedResult

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/parse/query.rb

Overview

Wrapper class for grouped results that provides sorting capabilities. Allows sorting grouped results by keys (group names) or values (aggregation results) in ascending or descending order.

Instance Method Summary collapse

Constructor Details

#initialize(results, operation = nil) ⇒ GroupedResult

Returns a new instance of GroupedResult.

Parameters:

  • results (Hash) —

    the grouped results hash

  • operation (String, nil) (defaults to: nil) —

    the aggregation operation (e.g. "count", "sum", "average", "min", "max", "list")



6814
6815
6816
6817
 
# File 'lib/parse/query.rb', line 6814

def initialize(results, operation = nil)
  @results = results
  @operation = operation
end

Instance Method Details

#each(&block) ⇒ Object

Iterate over each key-value pair



6826
6827
6828
 
# File 'lib/parse/query.rb', line 6826

def each(&block)
  @results.each(&block)
end

#sort_by_key_asc ⇒ Array<Array>

Sort by keys (group names) in ascending order

Returns:

  • (Array<Array>) —

    array of [key, value] pairs sorted by key ascending



6832
6833
6834
 
# File 'lib/parse/query.rb', line 6832

def sort_by_key_asc
  @results.sort_by { |k, v| k }
end

#sort_by_key_desc ⇒ Array<Array>

Sort by keys (group names) in descending order

Returns:

  • (Array<Array>) —

    array of [key, value] pairs sorted by key descending



6838
6839
6840
 
# File 'lib/parse/query.rb', line 6838

def sort_by_key_desc
  @results.sort_by { |k, v| k }.reverse
end

#sort_by_value_asc ⇒ Array<Array>

Sort by values (aggregation results) in ascending order

Returns:

  • (Array<Array>) —

    array of [key, value] pairs sorted by value ascending



6844
6845
6846
 
# File 'lib/parse/query.rb', line 6844

def sort_by_value_asc
  @results.sort_by { |k, v| v }
end

#sort_by_value_desc ⇒ Array<Array>

Sort by values (aggregation results) in descending order

Returns:

  • (Array<Array>) —

    array of [key, value] pairs sorted by value descending



6850
6851
6852
 
# File 'lib/parse/query.rb', line 6850

def sort_by_value_desc
  @results.sort_by { |k, v| v }.reverse
end

#to_h ⇒ Hash

Return the raw hash results

Returns:

  • (Hash) —

    the grouped results



6821
6822
6823
 
# File 'lib/parse/query.rb', line 6821

def to_h
  @results
end

#to_sorted_hash(sorted_pairs) ⇒ Hash

Convert sorted results back to a hash

Parameters:

  • sorted_pairs (Array<Array>) —

    array of [key, value] pairs

Returns:

  • (Hash) —

    sorted results as hash



6857
6858
6859
 
# File 'lib/parse/query.rb', line 6857

def to_sorted_hash(sorted_pairs)
  sorted_pairs.to_h
end

#to_table(format: :ascii, headers: nil) ⇒ String

Convert grouped results to a formatted table.

Examples:

Document.group_by(:category, sortable: true).count.to_table
Document.group_by(:category).sum(:file_size).to_table(headers: ["Category", "Total Size"])

Parameters:

  • format (Symbol) (defaults to: :ascii) —

    output format (:ascii, :csv, :json)

  • headers (Array<String>, nil) (defaults to: nil) —

    custom headers; if nil, defaults to ["Group", ] where the second header reflects the aggregation operation (e.g. "Average" for avg/average, "Sum" for sum, "Min"/"Max" for min/max, "Items" for list, "Count" otherwise).

Returns:

  • (String) —

    formatted table



6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
 
# File 'lib/parse/query.rb', line 6870

def to_table(format: :ascii, headers: nil)
  headers ||= ["Group", default_value_header]
  pairs = @results.to_a

  # Build table data
  table_data = {
    headers: headers,
    rows: pairs.map { |key, value| [format_group_key(key), format_group_value(value)] },
  }

  # Format based on requested format
  case format
  when :ascii
    format_grouped_ascii_table(table_data)
  when :csv
    format_grouped_csv_table(table_data)
  when :json
    format_grouped_json_table(table_data)
  else
    raise ArgumentError, "Unsupported format: #{format}. Use :ascii, :csv, or :json"
  end
end