activerecord-hackery/ransack
Ransack
Ransack is an object-based search library for Active Record models that provides a form-driven framework for building database queries. It generates query conditions from user input through a configurable predicate system, allowing developers to filter records using simple or advanced criteria without writing SQL or relying on external dependencies.
The library distinguishes itself through its predicate-based query construction, where search methods are dynamically generated from model attribute names and predicate suffixes at runtime. It wraps search parameters into a dedicated form object that encapsulates query logic, sorting, and pagination state, while implementing sorting as named scopes that translate sort parameters into ordered SQL clauses. Ransack also supports internationalization, localizing predicate names and form labels through a translation layer that maps internal keys to locale strings.
The system enables building complex search interfaces by combining multiple predicates with logical operators, supporting association-based filtering and advanced conditions like matchers and sorting. Search behavior can be customized globally through a centralized configuration system that defines available predicates, default sorting, and attribute matching rules.
Documentation and configuration are handled through a configuration-driven predicate registry that maps operator names to SQL fragments, with setup available through standard Ruby gem installation and Active Record integration.
Features
- Search DSLs - Provides an object-based search DSL for building complex database queries with Active Record models.
- Active Record Search Forms - Create search forms for database models using simple predicates to filter records without writing queries.
- Cross-Model Search - Provides a form-driven search framework for querying Active Record models across multiple tables.
- Database Record Querying - Implements a query builder for retrieving database records with filters, sorting, and pagination.
- Database Search Integration - Ships a search interface that executes queries against database records without external dependencies.
- Runtime Attribute Mappings - Dynamically generates search methods from model attribute names and predicate suffixes at runtime.
- Predicate-Based Query Combinators - Enables building complex queries by combining predicates with logical operators and sorting.
- Predicate-Based Query DSLs - Builds database queries by chaining named predicate methods that map to SQL conditions through a configurable registry.
- Form-Driven Query Builders - Provides a form-driven framework for building complex search interfaces with multiple predicates.
- Search Predicate Registries - Defines available search predicates in a central configuration that maps operator names to SQL fragments.
- Search Method Generators - Dynamically generates search methods from model attribute names and predicate suffixes at runtime.
- Search - Wraps search parameters into a dedicated object that encapsulates query logic, sorting, and pagination state.
- Database Predicate Builders - Provides a query builder that combines multiple search predicates with logical operators for database filtering.
- Database Query Sort Scopes - Implements sorting as named scopes that translate sort parameters into ordered SQL clauses.
- Database Query Form Models - Wraps search parameters into form objects that generate database query conditions from user input.
- Search Form Objects - Wraps search parameters into a dedicated object that encapsulates query logic, sorting, and pagination state.
- Search Predicate Combinators - Combines multiple search predicates with logical operators to build complex database queries.
- Query-Generating Form Frameworks - Provides a form-driven framework that generates database query conditions from user input.
- Search Predicate Configurations - Customize search predicates, sorting, and attribute matching through configuration and language settings.
- Scope-Based Sort Translations - Implements sorting as named scopes that translate sort parameters into ordered SQL clauses.
- Localized Search Predicate Tools - Ships a search tool with localized predicates and labels for building multilingual search interfaces.
- Search Form Label Localizations - Localizes search form labels and predicates through an internationalization layer for multilingual interfaces.
- Predicate Label Localizations - Ships a translation layer that localizes search predicate names and form labels for multilingual interfaces.
- Search - Object-based search interface.
- Search Engines - Advanced search form builder for ActiveRecord.
