verbal_expressions
A Ruby library that helps construct complex regular expressions using a fluent, readable API.
What is verbal_expressions?
VerbalExpressions is a Ruby library that simplifies the creation and maintenance of complex regular expressions. It provides a fluent, chainable API that replaces cryptic regex syntax with descriptive method names, making patterns more readable and easier to debug. It solves the problem of unreadable and error-prone regex patterns by offering an intuitive, English-like interface.
Ruby developers who need to write, maintain, or understand regular expressions for tasks like validation, parsing, or text transformation. It's especially useful for those who find traditional regex syntax difficult to read or debug.
Developers choose VerbalExpressions because it dramatically improves regex readability and maintainability without sacrificing power. Its fluent API integrates seamlessly with Ruby's regex ecosystem, offering a pragmatic alternative to writing cryptic patterns from scratch.
Overview
Make difficult regular expressions easy! Ruby port of the awesome VerbalExpressions repo - https://github.com/jehna/VerbalExpressions
Use Cases
Best For
- Building readable URL validation patterns
- Creating maintainable text parsing logic
- Teaching regular expressions with clear syntax
- Refactoring complex regex into understandable code
- Implementing named capture groups for data extraction
- Writing regex that teammates can easily understand
Not Ideal For
- Performance-critical applications where raw regex execution speed is paramount
- Projects requiring advanced regex modifiers (e.g., multiline or encoding options) not yet ported from JavaScript
- Simple, one-off regex patterns where library setup overhead outweighs benefits
- Teams already proficient with raw regex syntax and prioritizing minimal dependencies
Pros & Cons
Pros
Methods like start_of_line, find, and maybe can be naturally chained to build expressions, as demonstrated in the URL validation example, making regex construction intuitive.
Replaces cryptic symbols with plain English names (e.g., anything_but for negated character classes), which simplifies understanding and debugging, per the README's philosophy.
Offers begin_capture/end_capture or capture blocks for named groups, easing data extraction as shown in the 'goals' example where match['goals'] returns 5.
Generates standard Regexp objects compatible with match, =~, and gsub, allowing drop-in usage without learning new APIs, evidenced by the replacement example.
Cons
The README admits missing modifier code and has issues with reserved words (e.g., 'or' aliased to 'alternatively'), limiting access to some regex capabilities and causing awkward syntax.
Relies on the JavaScript wiki for documentation, which may not cover Ruby-specific nuances or updates, and the Ruby repo lacks comprehensive guides, as noted in the API section.
The abstraction layer to generate regex patterns could introduce slight runtime overhead compared to directly using compiled regex literals, especially in tight loops or high-volume text processing.
Frequently Asked Questions
Related Projects
regexp-examplesGenerate strings that match a given regular expression
fuzzy-string-matchfuzzy string matching library for ruby
re2Ruby bindings to RE2, a "fast, safe, thread-friendly alternative to backtracking regular expression engines like those used in PCRE, Perl, and Python".
CommonRegexRubyFind a lot of kinds of common information in a string. CommonRegex port for Ruby
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.