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:

<%= link_to "Delete #{@user.name}", admin_user_path(@user), data_turbo_method: "delete" %>

With Superlink, the same link can be written as:

<%= delete(@user, &:name) %>

Assuming the controller has been scoped to the admin namespace:

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.

# 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

Install the gem and add to the application's Gemfile by executing:

bundle add superlink

Then reboot your Rails server.

Superlink is still under active development! When its finished, usage instructions will be included here. 🤠

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.

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.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Superlink project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.