https://github.com/rubymonolith/superlink
A more powerful path and url generator for Rails
https://github.com/rubymonolith/superlink
Last synced: 5 months ago
JSON representation
A more powerful path and url generator for Rails
- Host: GitHub
- URL: https://github.com/rubymonolith/superlink
- Owner: rubymonolith
- License: mit
- Created: 2025-03-14T22:16:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-28T17:37:51.000Z (about 1 year ago)
- Last Synced: 2026-01-13T22:37:21.250Z (5 months ago)
- Language: Ruby
- Size: 21.5 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Superlink
Superlink tames the verbosity of Rails' `link_to`, `*_path`, and `*_url` helpers by providing a more concise, readable, and extensible alternative.
For example, a link that deletes a user from a Rails admin panel might look like this:
```erb
<%= link_to "Delete #{@user.name}", admin_user_path(@user), data_turbo_method: "delete" %>
```
With Superlink, the same link can be written as:
```erb
<%= delete(@user, &:name) %>
```
Assuming the controller has been scoped to the `admin` namespace:
```ruby
class Admin::UsersController < ApplicationController
def url = Admin::Links.new(request.url)
end
```
Superlink helpers are Ruby objects, which means you can extend them, add your own helper methods, and customize them way beyond Rails url helper methods. In Rails, they live in the `app/links` folder:
```
$ tree ./app/links
├── application_link.rb
├── admin_link.rb
```
These Ruby objects make scoping and testing URL generators more sane.
```ruby
# app/links/admin_link.rb
class Admin::Link < ApplicationLink
# Slap an `admin` prefix in front of the route.
def url
root.join(:admin, super)
end
# Deal with a model that doesn't map directly to a resource within the `admin` namespace. This example would end up with a URL like `/admin/invitation/1` if
# called via `url(@project_invitation)`.
def model_segments(model)
case model
when ProjectInvitation
:invitation
else
super
end
end
end
```
## Installation
Install the gem and add to the application's Gemfile by executing:
```bash
bundle add superlink
```
Then reboot your Rails server.
## Usage
Superlink is still under active development! When its finished, usage instructions will be included here. 🤠
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/superlink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/superlink/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Superlink project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/superlink/blob/main/CODE_OF_CONDUCT.md).