linkhum 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDZmOTk1OTg3ZjU2MzYxMTc2ZTA1ZDM1YjM4NmI2NWJlYzdkMWUyYQ==
+  data.tar.gz: !binary |-
+    MmFjMWJlOTk3YjM5MGEyOTkzNWE2Y2E5NzYwZTFmM2U1Yjc5MjQwNw==
+SHA512:
+  metadata.gz: !binary |-
+    ZGE1YTI2MzFmY2E3OGY4OTJkNTg2Mjk5YzI3ZTFjZDAzNmFkNmI0MTMyMzVh
+    MTJjMjgzZGU0MjYxMjZiNWRkYTZmYjYzOGVhY2U1ZmU0NWU4MzI3ZjQ5YzIx
+    MjI1MTU4ZTM4NTAyMjc1N2Y3MzU2NGE2NGQzZGFhNjdlOTZkYjI=
+  data.tar.gz: !binary |-
+    NzcwZjRmNDcwYTc4OTVjNTY4OTY2NTQ5OTg3NWIwZjZhOGU5MWFkOTExNGVm
+    MThkNDAzYmFlMjRkYTkwNWNiMWE0MTk3NWY1NzBmM2U4NGQ5NjY0ODA2MmFi
+    NGRjMGFkNzM0ZjY2NjU3NzRhZDNkMjEwNzYyMWI5YmZkYWJiYjY=

data/.dokaz

@@ -0,0 +1 @@
+--require ./spec/dokaz_helper

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-15 Victor 'Zverok' Shepelev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,191 @@
+# LinkHum
+
+**LinkHum** (aka "Links Humana") is URL auto-linker for user-entered texts.
+It tries hard to do the most reasonable thing even in complex cases.
+
+It will be useful for sites with plain-text user input
+
+Features:
+* auto-links URL;
+* very accurate detection of punctiations inside and outside of URL;
+* excessive tests set for complex (yet real-life) texts with URLs;
+* customizable behavior.
+
+**NB**: the original algo was written by [squadette](https://github.com/squadette)
+and the test cases provided by users of _some secret social network_.
+Just gemifying this (on behalf of original author).
+
+## Install
+
+```
+[sudo] gem install linkhum
+```
+
+Or in your Gemfile
+
+```ruby
+gem 'linkhum'
+```
+
+And then
+
+```
+bundle install
+```
+
+## Usage
+
+As simple as:
+
+```ruby
+LinkHum.urlify("Please look at http://github.com/zverok/linkhum, it's awesome!")
+# => 'Please look at <a href="http://github.com/zverok/linkhum">http://github.com/zverok/linkhum</a>, it's awesome!'
+```
+
+## Showcase
+
+```ruby
+# Doesn't touch punctuations outside:
+LinkHum.urlify('http://slashdot.org, or http://lwn.net? They say, "just http://google.com"')
+# => "<a href='http://slashdot.org'>http://slashdot.org</a>, or <a href='http://lwn.net'>http://lwn.net</a>? They say, \"just <a href='http://google.com'>http://google.com</a>\""
+
+# But processes it inside:
+LinkHum.urlify('Watch this: https://www.youtube.com/watch?v=Q9Dv4Hmf_O8')
+# => "Watch this: <a href='https://www.youtube.com/watch?v=Q9Dv4Hmf_O8'>https://www.youtube.com/watch?v=Q9Dv4Hmf_O8</a>"
+
+# Understands parentheses:
+LinkHum.urlify("It's a movie: https://en.wikipedia.org/wiki/Hours_(2013_film) It's just parens: (https://www.youtube.com/watch?v=Q9Dv4Hmf_O8)")
+# => "It's a movie: <a href='https://en.wikipedia.org/wiki/Hours_(2013_film)'>https://en.wikipedia.org/wiki/Hours_(2013_film)</a> It's just parens: (<a href='https://www.youtube.com/watch?v=Q9Dv4Hmf_O8'>https://www.youtube.com/watch?v=Q9Dv4Hmf_O8</a>)"
+
+# URL shortening:
+LinkHum.urlify("It's too long: http://www.booking.com/searchresults.ru.html?sid=28c7356c8d0fb6d81de3a45eff97e0fe;dcid=4;bb_asr=2&class_interval=1&csflt=%7B%7D&dest_id=-2167973&dest_type=city&group_adults=2&group_children=0&idf=1&label_click=undef&no_rooms=1&offset=0&review_score_group=empty&score_min=0&si=ai%2Cco%2Cci%2Cre%2Cdi&src=index&ss=Lisbon%2C%20Lisbon%20Region%2C%20Portugal&ss_raw=Lisbon&ssb=empty")
+# => "It's too long: <a href='http://www.booking.com/searchresults.ru.html?sid=28c7356c8d0fb6d81de3a45eff97e0fe;dcid=4;bb_asr=2&class_interval=1&csflt=%7B%7D&dest_id=-2167973&dest_type=city&group_adults=2&group_children=0&idf=1&label_click=undef&no_rooms=1&offset=0&review_score_group=empty&score_min=0&si=ai,co,ci,re,di&src=index&ss=Lisbon,%20Lisbon%20Region,%20Portugal&ss_raw=Lisbon&ssb=empty'>http://www.booking.com/searchresults.ru.html?sid=28c7356c8d0f...</a>"
+
+# It's customizable:
+LinkHum.urlify(
+  "It's too long: http://www.booking.com/searchresults.ru.html?sid=28c7356c8d0fb6d81de3a45eff97e0fe;dcid=4;bb_asr=2&class_interval=1&csflt=%7B%7D&dest_id=-2167973&dest_type=city&group_adults=2&group_children=0&idf=1&label_click=undef&no_rooms=1&offset=0&review_score_group=empty&score_min=0&si=ai%2Cco%2Cci%2Cre%2Cdi&src=index&ss=Lisbon%2C%20Lisbon%20Region%2C%20Portugal&ss_raw=Lisbon&ssb=empty",
+  max_length: 20)
+# =>
+
+# International domains and Non-ASCII paths:
+LinkHum.urlify("Domain: http://www.詹姆斯.com/, and path: https://ru.wikipedia.org/wiki/Эффект_Даннинга_—_Крюгера")
+# => "Domain: <a href='http://www.詹姆斯.com/'>http://www.詹姆斯.com/</a>, and path: <a href='https://ru.wikipedia.org/wiki/%D0%AD%D1%84%D1%84%D0%B5%D0%BA%D1%82_%D0%94%D0%B0%D0%BD%D0%BD%D0%B8%D0%BD%D0%B3%D0%B0_%E2%80%94_%D0%9A%D1%80%D1%8E%D0%B3%D0%B5%D1%80%D0%B0'>https://ru.wikipedia.org/wiki/Эффект_Даннинга_—_Крюгера</a>"
+
+# Look, ma, no XSS!
+LinkHum.urlify('http://example.com/foo?">here.</a><script>window.alert("wow");</script>')
+# => "<a href='http://example.com/foo?%22%3Ehere.%3C/a%3E%3Cscript%3Ewindow.alert(%22wow%22);%3C/script%3E'>http://example.com/foo?\">here.</a><script>window.alert(\"wow\")...</a>"
+```
+
+## Customization
+
+### On the fly
+
+Custom URL params:
+
+```ruby
+LinkHum.urlify("http://oursite.com/posts/12345 has been mentioned at http://cnn.com"){
+  |uri|
+  uri.host == 'oursite.com' ? {} : {target: '_blank'}
+}
+# => "<a href='http://oursite.com/posts/12345'>http://oursite.com/posts/12345</a> has been mentioned at <a href='http://cnn.com' target='_blank'>http://cnn.com</a>"
+```
+
+Provided block should receive an instance of `Addressable::URI` and
+return hash of additional link attributes. You can use it for opening
+foreign links in new tab, or for styling them different (Wikipedia-style),
+or to provide special icons for links to Youtube, Wikipedia and Google...
+Up to you
+
+### Define your own LinkHum
+
+```ruby
+class MyLinks < LinkHum
+  def link_attrs(uri)
+    {target: '_blank'} unless uri.host == 'oursite.com'
+  end
+end
+
+MyLinks.urlify("http://oursite.com/posts/12345 has been mentioned at http://cnn.com")
+# => "<a href='http://oursite.com/posts/12345'>http://oursite.com/posts/12345</a> has been mentioned at <a href='http://cnn.com' target='_blank'>http://cnn.com</a>"
+```
+
+You can also define special strings, which should also became URLs on your
+site:
+
+```ruby
+class MyLinks < LinkHum
+  special /@(\S+)\b/ do |username|
+    "http://oursite/users/#{username}"
+  end
+end
+
+MyLinks.urlify("Hey, @jude!")
+# => "Hey, <a href='http://oursite/users/jude'>@jude</a>!"
+
+# nil or false means no replacements:
+class MyLinks < LinkHum
+  special /@(\S+)\b/ do |username|
+    "http://oursite/users/#{username}" if User.where(name: username).exists?
+  end
+end
+
+MyLinks.urlify("So, our @dude and @unknownguy walk into a bar...")
+# => "So, our <a href='http://oursite/users/dude'>@dude</a> and @unknownguy walk into a bar..."
+```
+
+Some `special` gotchas:
+* for now, only one `special` per class is supported (an attempt to define
+  additional one will show warningn);
+* it passes to the block values by the same logic as `String#scan` does:
+
+```ruby
+class AllSymbols < LinkHum
+  special /@\S+\b/ do |username|
+    p username
+    nil
+  end
+end
+AllSymbols.urlify('@dude')
+# Receives "@dude"
+
+class SelectedPart < LinkHum
+  special /@(\S+)\b/ do |username|
+    p username
+    nil
+  end
+end
+SelectedPart.urlify('@dude')
+# Receives "dude"
+
+class SeveralArgs < LinkHum
+  special(/@(\S+)_(\S+)\b/) do |first, second|
+    p first, second
+    nil
+  end
+end
+SeveralArgs.urlify('@cool_dude')
+# Receives "cool", "dude"
+```
+
+## Credits
+
+* [squadette](https://github.com/squadette) -- author of original code;
+* users of _some secret social network_ -- testing and advicing;
+* [zverok](https://github.com/zverok) -- gemifying, documenting and
+  writing specs.
+
+## Contributing
+
+Just usual fork-change-pull request process.
+
+### Development
+
+* Don't forget to use `rspec` after any changes made (and specify them,
+  of course!)
+* It's preferred to use `bundle exec dokaz` to check if README written
+  correctly and `bundle exec dokaz -fshow` to check what exactly code
+  from README will output.
+
+## License
+
+MIT

data/lib/linkhum.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+require 'addressable/uri'
+require 'cgi'
+
+class LinkHum
+  class << self
+    NOOP = ->(*){}
+    
+    def urlify(text, options = {}, &block)
+      new(text).urlify(options.merge(link_processor: block))
+    end
+
+    def special(pattern = nil, &block)
+      return @special unless pattern
+
+      @special and
+        puts("Warning: redefining #{self}.special from #{caller.first}")
+
+      @special = [pattern, block]
+    end
+  end
+
+  PROTOCOLS = '(?:https?|ftp)'
+  SPLIT_PATTERN = %r{(#{PROTOCOLS}://\p{^Space}+)}i
+
+  MAX_DISPLAY_LENGTH = 64
+
+  def initialize(text)
+    @text = text
+    @components = @text.split(SPLIT_PATTERN)
+  end
+
+  def urlify(options = {})
+    @components.map{|str|
+      SPLIT_PATTERN =~ str ? process_url(str, options) : process_text(str)
+    }.join
+  end
+
+  private
+
+  def process_url(str, options)
+    url, punct = str.scan(%r{\A(#{PROTOCOLS}://.+?)(\p{Punct}*)\Z}i).flatten
+    return str unless url
+
+    if punct[0] == '/' || (punct[0] == ')' && url.include?('('))
+      url << punct.slice!(0)
+    end
+    
+    make_link(url, options) + punct
+  end
+
+  def process_text(str)
+    str = CGI.escapeHTML(str)
+    
+    pattern, block = self.class.special
+
+    if pattern
+      str.gsub(pattern){|s|
+        if (u = block.call(*arguments(pattern, s)))
+          "<a href='#{screen_feet(u)}'>#{s}</a>"
+        else
+          s
+        end
+      }
+    else
+      str
+    end
+  end
+
+  def arguments(pattern, string)
+    m = pattern.match(string)
+    m.captures.empty? ? m[0] : m.captures
+  end
+
+  def make_link(url, options)
+    uri = Addressable::URI.parse(url) rescue nil
+    return url unless uri
+
+    canonical = Addressable::URI.normalized_encode(uri) rescue uri
+
+    display_length = options.fetch(:max_length, MAX_DISPLAY_LENGTH)
+    "<a href='#{screen_feet(canonical)}'#{make_attrs(uri, options)}>"\
+      "#{truncate(CGI.escapeHTML(url), display_length)}</a>"
+  end
+
+  def make_attrs(uri, options)
+    block = options[:link_processor] || method(:link_attrs)
+    attrs = block.call(uri) || {}
+    return '' if attrs.empty?
+    ' ' + attrs.map{|n, v| "#{n}='#{v}'"}.join(' ')
+  end
+
+  def link_attrs(*)
+  end
+
+  # TIL that ' (single quote) is in fact "feet mark"
+  def screen_feet(url)
+    url.gsub("'", '%27')
+  end
+
+  # stolen from activesupport/lib/active_support/core_ext/string/filters.rb
+  # then simplified
+  def truncate(string, truncate_at)
+    return string.dup if !truncate_at || string.length <= truncate_at
+
+    omission = '...'
+    stop = truncate_at - omission.length
+
+    "#{string[0, stop]}#{omission}"
+  end
+end

data/linkhum.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name     = 'linkhum'
+  s.version  = '0.0.1'
+  s.authors  = ['Alexey Makhotkin', 'Victor Shepelev']
+  s.email    = 'zverok.offline@gmail.com'
+  s.homepage = 'https://github.com/zverok/linkhum'
+
+  s.summary = 'Humane link urlifier'
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ /^(?:
+    spec\/.*
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    |\.travis.yml
+    )$/x
+  end
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'addressable'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rspec-its', '~> 1'
+  s.add_development_dependency 'nokogiri'
+  s.add_development_dependency 'rubocop'
+  #s.add_development_dependency 'dokaz'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: linkhum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexey Makhotkin
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .dokaz
+- LICENSE.txt
+- README.md
+- lib/linkhum.rb
+- linkhum.gemspec
+homepage: https://github.com/zverok/linkhum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Humane link urlifier
+test_files: []
+has_rdoc: