KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #ai-agent #developer-tools #claude-code #codex #deepseek-harness #ai-agents #react #mcp #rust

rails_autolink

★ 618 Open GitHub ↗

The auto_link function from Rails

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# rails_autolink

- http://github.com/tenderlove/rails_autolink

## Description

This is an extraction of the `auto_link` method from rails.  The `auto_link`
method was removed from Rails in version Rails 3.1.  This gem is meant to
bridge the gap for people migrating.

## Features

By default auto_link returns sanitized html_safe strings. This behaviour can
be overridden by setting the `:sanitize` option to false (thus making it
insecure if you don't have the content under control).

## Install

Add this line to your application's Gemfile:

```ruby
gem 'rails_autolink'
```

And then execute:

```bash
$ bundle install
```

## Synopsis

### Basic Usage

```ruby
require 'rails_autolink'

auto_link("Go to http://www.rubyonrails.org and say hello to david@loudthinking.com")
# => "Go to <a href=\"http://www.rubyonrails.org\">http://www.rubyonrails.org</a> and
#     say hello to <a href=\"mailto:david@loudthinking.com\">david@loudthinking.com</a>"
```

### Convert Only URLs  to Links

```ruby
auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :link => :urls)
# => "Visit <a href=\"http://www.loudthinking.com/\">http://www.loudthinking.com/</a>
#     or e-mail david@loudthinking.com"
```

### Convert Only Email Addresses to Links

```ruby
auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :link => :email_addresses)
# => "Visit http://www.loudthinking.com/ or e-mail <a href=\"mailto:david@loudthinking.com\">david@loudthinking.com</a>"
```

### Generate Links Without Sanitizing HTML Tags

```ruby
## By default, HTML tags are sanitized to protect from malicious code
auto_link("Go to http://www.rubyonrails.org <script>Malicious code!</script>")
# => "Go to <a href=\"http://www.rubyonrails.org\">http://www.rubyonrails.org</a> "

## Use the :sanitize => false option to prevent sanitization
auto_link("Go to http://www.rubyonrails.org <script>alert('Script!')</script>", :sanitize => false)
# => "Go to <a href=\"http://www.rubyonrails.org\">http://www.rubyonrails.org</a> <script>alert('Script!')</script>"
```

### Customize Links and Shorten Text

```ruby
post_body = "Welcome to my new blog at http://www.myblog.com/.  Please e-mail me at me@email.com."
auto_link(post_body, :html => { :target => '_blank' }) do |text|
  truncate(text, :length => 15)
end
# => "Welcome to my new blog at <a href=\"http://www.myblog.com/\" target=\"_blank\">http://www.m...</a>.
```

## Requirements

- `rails` > `3.1`

rails_autolink

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README