Contents

module Kadmin
  class Finder
    # @return [Kadmin::Pager] the pager to use (if any)
    attr_reader :pager

    # @return [Array<Kadmin::Finder::Filter>] array of filters applied to the finder
    attr_reader :filters

    # @return [ActiveRecord::Relation] the base relation to find items from
    attr_reader :scope

    # Simple filter structure
    Filter = Struct.new(:column, :value)

    # @param [ActiveRecord::Relation] scope base relation to page/filter on
    def initialize(scope)
      @scope = scope
      @pager = nil
      @filters = {}
      @results = nil
    end

    # @param [String] name the filter name (should be unique)
    # @param [String, Array<String>] column the column(s) name to filter on
    # @param [String, Array<String>] value the value or values to look for (OR'd)
    def filter(name:, column:, value:)
      if column.present? && !@filters.key?(name)
        @filters[name] = Kadmin::Finder::Filter.new(column, value)
        if value.present?
          @scope = @scope.where("#{@scope.table_name}.`#{column}` LIKE ?", value.tr('*', '%'))
          @pager&.total = @scope.count
        end
      end

      return self
    end

    # @param [Integer] offset optional; offset/index for the current page
    # @param [Integer] size optional; size of a page
    # @return [Kadmin::Finder] itself
    def paginate(offset: nil, size: nil)
      offset = offset.to_i
      size = size.to_i

      if size.positive? && offset >= 0
        @pager = Kadmin::Pager.new(size: size, offset: offset)
      end

      return self
    end

    # @return [ActiveRecord::Relation] the filtered (and optionally paginated) results
    def results
      return @results ||= begin
        results = @scope
        results = @pager.page(results) unless @pager.nil?
        results
      end
    end

    def find!
      @results = nil
      return results
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
kadmin-0.3.2	lib/kadmin/finder.rb