Nexter
What is Nexter ? A misspelled tv show or a killer feature ? Not sure but it wraps your ActiveRecord model with an ordered scope and consistently cuts out the next and previous records. It also works with associations & nested columns : Book.order("books.genre, authors.name, published_at desc")
Installation (RUBY 2)
gem 'nexter'
# (edge) gem 'nexter', git: 'https://github.com/charly/nexter'
Bare Usage
@books = Book.includes(:author).bestsellers.
order("genre", "authors.name", "published_at desc")
nexter = Nexter.wrap( @books, @books.find(params[:id]) )
nexter.previous
nexter.next
Rails Usage
It helps you cycle consistentely through each record of any filtered collection instead of helplessly hit the back button of your browser to find the next item of your search. It plays well with gem which keeps the state of an ActiveRelation
like siphon, ransack & others.
New way
With the new view helper nexter
no need to inject previous/next in the ActiveRecord model.
However there's an assumptions : the formobject responds to result
and returns an activerelation (like ransack does)
class BookController
before_filter :resource, except: :index
def resource
@book_search ||= BookSearch.new(params[:book_search])
@book ||= Book.includes([:author]).find(params[:id])
end
end
<%- nexter @book, @book_search do |b| %>
<%= link_to "previous", b.path([:edit, :admin, (b.previous || @book)]) %>
<%= link_to "collection", b.path([:admin, Book]) %>
<%= link_to "next", b.path([:edit, :admin, (b.next || @book)])
Old way (still applies but verbose)
class Book
def nexter=(relation)
@nexter = Nexter.wrap(relation, self)
end
def next
@nexter.next || self
end
def previous
@nexter.previous || self
end
end
class BookController
before_filter :resource, except: :index
def resource
@book_search = BookSearch.new(params[:book_search])
@book ||= Book.includes([:author]).find(params[:id]).tap do |book|
book.nexter = siphon(Book.scoped).scope(@book_search)
end
end
end
<%= link_to "previous", book_path(@book.previous, book_search: params[:book_search]) %>
<%= link_to "collection", book_path(book_search: params[:book_search]) %>
<%= link_to "next", book_path(@book.next, book_search: params[:book_search])
TODO
- (feature) group/havings logic
- (test) viewhelper
- (docs) How it works
- (feature) Joins ?
- (docs) previous/next through ctrl (not preloaded) x (fix) for nil values you need a reorder with default delimiter
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request