dobtco / filterer Goto Github PK

Will need to be a major version change.

The cost of filterer is probably negligible, but still.

I wanted to be able to filter what my API returns and I used filterer to do this. I was surprised to see that there was a limit of 10. I was able to find the code in filterer that does this and it does not seem like it can be overriden. Is my use case of the Filterer gem valid? Or should it not be used for an API?

Ruby 2.6.0 was released this week, and introduces Enumerator::Chain and Enumerable#filter.

The filterer gem already implements the chain and filter methods on an ActiveRecord collection.

On older rubies (<2.6) everything works fine;

# Ruby 2.5.x
> User.where('1=1').chain
=> [#<User:0x00007fe8bbf5f9c3 ... etc as expected.

However, on new rubies (>2.6.0) we see the following problem;

# Ruby 2.6.0
> User.where('1=1').chain
=> #<Enumerator::Chain: ...>

It seems the simplest solution is to rename or avoid the .chain and .filter methods in this gem.

Thoughts?

I like the way filterer makes it easy to pass params and get the result without having a bunch of ifs. However, I don't always use it for an API -- sometimes I use it in some service object to allow fellow developers pass in options that are in turn used in the filterer object. The problem is that I don't want pagination for this. Is there a way to use filterer without pagination?

I want to create a filterer that only returns results from all fields match. For example, let's say I want to get the results of only the records that both match the age and rank. If only age is given, it will return nothing. If only rank is given, it will return nothing.

I had thought of setting defaults to {age: nil, rank: nil} (yes, this will only work if neither of those fields can be nil), but noticed that present_params checks for values that are present?. This would also disallow people from searching for values that match "" (blank).

What issues would removing present_params cause? I did a cursory search in the git history but couldn't find the reason that method is there.

This happens because per_page, when given in the params, is a string. I have a branch that fixes it here. I didn't create a pull request because there's no "0_4_x" branch to merge it into. Note: this branch is from v0.4.2. I took a quick look at master and I think master is susceptible to this issue too.

The Filterer::ActiveRecord module defines the class methods filter and chain on ActiveRecord::Base.

The filter_without_pagination method is not defined, however.

Is there a deliberate reason for this, or would it make sense to add this?

I could then call (for example)

@users.filter_without_pagination({})