Introduction

Ransack will help you easily add searching to your Rails application, without any additional dependencies.

There are advanced searching solutions around, like ElasticSearch or Algolia. Ransack will do the job for many Rails websites, without the need to run additional infrastructure or work in a different language. With Ransack you do it all with standard Ruby and ERB.

Ready to move beyond the basics? Use advanced features like i18n and extensive configuration options.

Ransack is supported for Rails 8.1, 8.0, 7.2 on Ruby 3.2 and later.

Installation

To install ransack and add it to your Gemfile, run

gem 'ransack'

Bleeding edge

If you would like to use the latest updates not yet published to RubyGems, use the main branch:

gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main'

Documentation

There is extensive documentation on Ransack, built with Jekyll and Just the Docs from the Markdown under docs/ and published as a GitHub Pages site. Alternatively there is AI Generated documentation produced by devin.ai.

This gist has a quick-start cheatsheet, created by @raghubetina

Issue tracker

• Before filing an issue, please read the Contributing Guide.
• File an issue if a bug is caused by Ransack, is new (has not already been reported), and can be reproduced from the information you provide.
• Please consider creating a pull request with a failing test that demonstrates the problem.
• Contributions are welcome. :smiley:
• Please do not use the issue tracker for personal support requests. Stack Overflow or GitHub Discussions is a better place for that where a wider community can help you!

Contributions

To support the project:

• Use Ransack in your apps, and let us know if you encounter anything that's broken or missing. A failing spec to demonstrate the issue is awesome. A pull request with passing tests is even better!
• Before filing an issue or pull request, be sure to read and follow the Contributing Guide.
• Please use Stack Overflow or GitHub Discussions for questions or discussion not directly related to bug reports, pull requests, or documentation improvements.
• Spread the word on social media if Ransack's been useful to you. The more people who are using the project, the quicker we can find and fix bugs!

Contributors

Ransack was created by Ernie Miller and is developed and maintained by:

• Sean Carroll
• Deivid Rodriguez
• Greg Molnar
• A great group of contributors.

• Ransack's logo is designed by Anıl Kılıç.

Alumni Maintainers

• Jon Atack
• Ryan Bigg

This project exists thanks to all the people who contribute.