Project

anchored

0.02
No release in over 3 years
Low commit activity in last 3 years
Ruby auto linker based on rails_autolink. It wraps links in text with HTML anchors.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 5.10
~> 12.0
 Project Readme

Gem Version Build Status

Anchored

Ruby auto-linking of only URLs, with no HTML sanitization.

Forked from https://github.com/tenderlove/rails_autolink.

Install

Add to your Gemfile:

gem "anchored"

Or:

$ gem install anchored

Usage

Pass-through

Anchored::Linker.auto_link("text")
# => "text"

Wrap URLs in anchors:

Anchored::Linker.auto_link("hello www.example.com.")
# => "hello <a href='http://www.example.com'>www.example.com</a>."

Set anchor attributes. Alter the link text with a block:

text = "Welcome to http://www.example.com/."
Anchored::Linker.auto_link(text, target: "_blank") do |text|
  text[0...12] + "..."
end
# => "Welcome to <a href=\"http://www.example.com/\" target=\"_blank\">http://exampl...</a>."

Remove the target attribute when a URL matches a domain:

text = "Hello http://www.example.com/."
Anchored::Linker.auto_link(text, target: "_blank", domain: "example.com")
# => "Hello <a href=\"http://www.example.com/\">http://example.com</a>."

Anchored does not sanitize html. Be sure to use something else for that.

Differences from rails_autolink

  • No HTML sanitization
  • No email auto-linking
  • No dependencies on rails
  • Dropped support for uncommon protocols (gopher, etc)
  • Option to remove target attribute when URL matches a domain

Development

Run bin/setup to install dependencies. Then, run rake test to run the tests.

You can also run bin/console for an irb prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/neighborland/anchored. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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