smartlinks 0.1.0

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# VIM tmp files
+*.swp
+*.swo
+~*

data/.rspec

@@ -0,0 +1 @@
+--color --tty

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smartlink.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    smartlinks (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  smartlinks!

data/README.md

@@ -0,0 +1,46 @@
+# SmartLinks
+
+Gem for linkifying text
+
+## Installation
+
+Just as usual. If you're using bundler - just this to your Gemfile:
+
+    gem 'smartlinks'
+
+And then execute:
+
+    bundle install
+
+Or install it yourself:
+
+    gem install smartlinks
+
+## Usage
+
+This gem is very simple. You have only one method, that you need. For example:
+
+```ruby
+    text = "@sqrel and @troyanryller just made a cool gem!"
+
+    Smartlinks.linkify text
+```
+
+That's it! Now you have linkified text:
+
+    <a href="https://twitter.com/sqrel">@sqrel</a> and <a href="https://twitter.com/troyanryller">@troyanryller</a> just made a cool gem!
+
+By default, gem interprets @user and #hash as twitter user and hashtag, but you can explicitly define domain to user and hashtag:
+
+    Smartlinks.linkify text, account: "http://example.com/%s", hashtag: "http://example.com/search/%s"
+
+`%s` will be replaced to username or hash
+
+Also you can define additional links params, for example:
+
+    Smartlinks.linkify text, params: { class: "some-link-class", rel: "nofollow" }
+
+## Credits
+
+* Vasilij Melnychuk ([@SqREL](https://twitter.com/sqrel))
+* Igor Petruh ([@Troyanryller](https://twitter.com/troyanryller))

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/smartlinks/base.rb

@@ -0,0 +1,11 @@
+module Smartlinks
+
+  def self.linkify(text, attrs={})
+    linkificator = Linkificator.new text, attrs
+
+    # NOTE: Order matters!
+    [:email, :link, :account, :hashtag].each { |method| linkificator.send method }
+
+    linkificator.text
+  end
+end

data/lib/smartlinks/linkificator.rb

@@ -0,0 +1,67 @@
+module Smartlinks
+  class Linkificator
+
+    attr_reader :text
+
+    # ---------- Regex patterns ----------
+    PAT_LINK = %r{
+      (?: ((?:ed2k|ftp|http|https|irc|news|gopher|nntp|telnet|webcal|xmpp|callto|feed|svn|urn|aim|rsync|tag|ssh|sftp|rtsp|afs):)// | www\. )
+      [^\s<]+
+    }x
+    PAT_EMAIL = %r{
+      [a-z0-9!#$\%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$\%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?
+    }x
+    PAT_ACCOUNT = %r{(^|\s)@(\w+)}
+    PAT_HASH = %r{#(\w+)}
+    # ------------------------------------
+
+    def initialize(text, attrs={})
+      @text = text
+      @attrs = attrs
+    end
+
+    def email
+      @text.gsub! PAT_EMAIL do |email|
+        "<a href=\"mailto:#{email}\">#{email}</a>"
+      end
+    end
+
+    def link
+      @text.gsub! PAT_LINK do |url|
+        if @attrs[:params]
+          params = @attrs[:params].map{|k, v| " #{k}=\"#{v}\""}.join''
+          "<a href=\"#{url}\"#{params}>#{url}</a>"
+        else
+          "<a href=\"#{url}\">#{url}</a>"
+        end
+      end
+    end
+
+    def account
+      @text.gsub!(PAT_ACCOUNT) do
+        space, account = $~[1], $~[2]
+
+        if @attrs[:account]
+          url = @attrs[:account].sub "%s", account
+          "#{space}<a href=\"#{url}\">@#{account}</a>"
+        else
+          "#{space}<a href=\"https://twitter.com/#{account}\">@#{account}</a>"
+        end
+      end
+    end
+
+    def hashtag
+      @text.gsub!(PAT_HASH) do
+        hashtag = $~[1]
+
+        if @attrs[:hashtag]
+          url = @attrs[:hashtag].sub "%s", hashtag
+          "<a href=\"#{url}\">##{hashtag}</a>"
+        else
+          "<a href=\"https://twitter.com/search?q=%23#{hashtag}&src=hash\">##{hashtag}</a>"
+        end
+      end
+    end
+
+  end
+end

data/lib/smartlinks/version.rb

@@ -0,0 +1,3 @@
+module Smartlinks
+  VERSION = "0.1.0"
+end

data/lib/smartlinks.rb

@@ -0,0 +1,5 @@
+require 'smartlinks/linkificator'
+require 'smartlinks/base'
+
+module Smartlinks
+end

data/smartlinks.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smartlinks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "smartlinks"
+  gem.version       = Smartlinks::VERSION
+  gem.authors       = ["Vasilij Melnychuck", "Igor Petruh"]
+  gem.email         = ["isqrel@gmail.com", "pro100igor@gmail.com"]
+  gem.description   = %q{ Gem for linkfying your text }
+  gem.summary       = %q{ Smartlinks converts your palin-text urls, twitter-like accounts and hashtag links to html a tags }
+  gem.homepage      = "https://github.com/SqREL/smartlinks"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  ['rspec'].each do |dep|
+    gem.add_development_dependency(dep)
+  end
+end

data/spec/lib/smartlinks/smartlinks_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Smartlinks do
+
+  it "modifies http url" do
+    text, result = data "http"
+    Smartlinks.linkify(text).should eql(result)
+  end
+  it "modifies https url" do
+    text, result = data "https"
+    Smartlinks.linkify(text).should eql(result)
+  end
+  it "modifies ftp url" do
+    text, result = data "ftp"
+    Smartlinks.linkify(text).should eql(result)
+  end
+  it "modifies http url" do
+    text, result = data "http"
+    Smartlinks.linkify(text).should eql(result)
+  end
+
+  it "do not modifyes if allready link" do
+    text = "Allready <a href=\"http://google.com\">linkifyed</a> url"
+    Smartlinks.linkify(text).should eql(text)
+  end
+
+  it "modifyes plaintext mail account to link" do
+    text = "Reply to admin@test.com and check user@gmail.com account"
+    result = "Reply to <a href=\"mailto:admin@test.com\">admin@test.com</a> and check <a href=\"mailto:user@gmail.com\">user@gmail.com</a> account"
+    Smartlinks.linkify(text).should eql(result)
+  end
+
+  it "creates twitter links" do
+    text = "@sqrel, check out @dht twitter"
+    result = "<a href=\"https://twitter.com/sqrel\">@sqrel</a>, check out <a href=\"https://twitter.com/dht\">@dht</a> twitter"
+    Smartlinks.linkify(text).should eql(result)
+  end
+
+  it "creates twitter-like links with custom domain" do
+    text = "@sqrel, check out @dht account"
+    result = "<a href=\"http://test.com/sqrel\">@sqrel</a>, check out <a href=\"http://test.com/dht\">@dht</a> account"
+    Smartlinks.linkify(text, account: "http://test.com/%s").should eql(result)
+  end
+
+  it "creates twitter hash links" do
+    text = "#dude, check out #rails framework"
+    result = "<a href=\"https://twitter.com/search?q=%23dude&src=hash\">#dude</a>, check out <a href=\"https://twitter.com/search?q=%23rails&src=hash\">#rails</a> framework"
+    Smartlinks.linkify(text).should eql(result)
+  end
+
+  it "creates twitter-like links with custom domain" do
+    text = "#dude, check out #rails framework"
+    result = "<a href=\"http://example.com/dude?src=hash\">#dude</a>, check out <a href=\"http://example.com/rails?src=hash\">#rails</a> framework"
+    Smartlinks.linkify(text, hashtag: "http://example.com/%s?src=hash").should eql(result)
+  end
+
+  it "converts url to link with some link params" do
+    text = "http://example.com/3 Word http://lorem.com/id/1 seperator http://test.com/foo/bar Foo"
+    result = "<a href=\"http://example.com/3\" class=\"main\" rel=\"nofollow\">http://example.com/3</a> Word <a href=\"http://lorem.com/id/1\" class=\"main\" rel=\"nofollow\">http://lorem.com/id/1</a> seperator <a href=\"http://test.com/foo/bar\" class=\"main\" rel=\"nofollow\">http://test.com/foo/bar</a> Foo"
+    Smartlinks.linkify(text, params: { class: "main", rel: "nofollow" }).should eql(result)
+  end
+
+  private
+    def data(protocol)
+      text = "#{protocol}://example.com/3 Word #{protocol}://lorem.com/id/1 seperator #{protocol}://test.com/foo/bar Foo"
+      result = "<a href=\"#{protocol}://example.com/3\">#{protocol}://example.com/3</a> Word <a href=\"#{protocol}://lorem.com/id/1\">#{protocol}://lorem.com/id/1</a> seperator <a href=\"#{protocol}://test.com/foo/bar\">#{protocol}://test.com/foo/bar</a> Foo"
+      [text, result]
+    end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'smartlinks'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include RSpec::Matchers
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: smartlinks
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Vasilij Melnychuck
+- Igor Petruh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Gem for linkfying your text '
+email:
+- isqrel@gmail.com
+- pro100igor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/smartlinks.rb
+- lib/smartlinks/base.rb
+- lib/smartlinks/linkificator.rb
+- lib/smartlinks/version.rb
+- smartlinks.gemspec
+- spec/lib/smartlinks/smartlinks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SqREL/smartlinks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Smartlinks converts your palin-text urls, twitter-like accounts and hashtag
+  links to html a tags
+test_files:
+- spec/lib/smartlinks/smartlinks_spec.rb
+- spec/spec_helper.rb