Contents

class RESTFramework::BaseFilter
  def initialize(controller:)
    @controller = controller
  end

  def get_filtered_data(data)
    raise NotImplementedError
  end
end


# A simple filtering backend that supports filtering a recordset based on fields defined on the
# controller class.
class RESTFramework::ModelFilter < RESTFramework::BaseFilter
  # Filter params for keys allowed by the current action's filterset_fields/fields config.
  def _get_filter_params
    fields = @controller.class.filterset_fields || @controller.send(:get_fields)
    return @controller.request.query_parameters.select { |p|
      fields.include?(p.to_sym) || fields.include?(p.to_s)
    }.to_hash.symbolize_keys
  end

  # Filter data according to the request query parameters.
  def get_filtered_data(data)
    filter_params = self._get_filter_params
    unless filter_params.blank?
      return data.where(**filter_params)
    end

    return data
  end
end


# A filter backend which handles ordering of the recordset.
class RESTFramework::ModelOrderingFilter < RESTFramework::BaseFilter
  # Convert ordering string to an ordering configuration.
  def _get_ordering
    return nil unless @controller.class.ordering_query_param

    order_string = @controller.params[@controller.class.ordering_query_param]
    unless order_string.blank?
      return order_string.split(',').map { |field|
        if field[0] == '-'
          [field[1..-1].to_sym, :desc]
        else
          [field.to_sym, :asc]
        end
      }.to_h
    end

    return nil
  end

  # Order data according to the request query parameters.
  def get_filtered_data(data)
    ordering = self._get_ordering
    if ordering && !ordering.empty?
      return data.order(_get_ordering)
    end
    return data
  end
end


# TODO: implement searching within fields rather than exact match filtering (ModelFilter)
# class RESTFramework::ModelSearchFilter < RESTFramework::BaseFilter
# end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rest_framework-0.1.3	lib/rest_framework/filters.rb
rest_framework-0.1.1	lib/rest_framework/filters.rb