Contents

# frozen_string_literal: true

# This concern is used to provide abstract ordering based on `params[:sort]`
module Orderable
  extend ActiveSupport::Concern
  SORT_ORDER = { '+' => :asc, '-' => :desc }.freeze

  # A list of the param names that can be used for ordering the model list
  def ordering_params(params)
    # For example it retrieves a list of orders in descending order of total_value.
    # Within a specific total_value, older orders are ordered first
    #
    # GET /orders?sort=-total_value,created_at
    # ordering_params(params) # => { total_value: :desc, created_at: :asc }
    #
    # Usage:
    # Order.order(ordering_params(params))
    ordering = {}
    params[:sort]&.delete(' ').try(:split, ',').try(:each) do |attr|
      parsed_attr = parse_attr attr
      if model.attribute_names.include?(parsed_attr)
        ordering[parsed_attr] = SORT_ORDER[parse_sign attr]
      end
    end
    ordering
  end

  private

  # Parsing of attributes to avoid empty starts in case browser passes "+" as " "
  def parse_attr(attr)
    return attr.gsub(/^\ (.*)/, '\1') if attr.starts_with?(' ')
    return attr[1..-1] unless attr.match(/\A[+-]/).nil?
    attr
  end

  # Ordering sign parse, which separates
  def parse_sign(attr)
    attr.match(/\A[+-]/).nil? ? '+': attr.slice!(0)
  end

  # Gets class of the resource of the current request
  def model
    (params[:nested] || params[:resource] || controller_name).classify.constantize
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
apicasso-0.7.3	app/controllers/concerns/orderable.rb
apicasso-0.7.2	app/controllers/concerns/orderable.rb
apicasso-0.7.1	app/controllers/concerns/orderable.rb
apicasso-0.7.0	app/controllers/concerns/orderable.rb
apicasso-0.6.8	app/controllers/concerns/orderable.rb
apicasso-0.6.7	app/controllers/concerns/orderable.rb
apicasso-0.6.6	app/controllers/concerns/orderable.rb