linkable 0.0.1 → 1.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81b0239ae53b8cd795d5f25e4e2ace7b1f06537f
-  data.tar.gz: bccf09fdf068767d4ec986e2595ceeb706a99989
+  metadata.gz: 59e22e738ea584602d03fa10479b11338c1c2c49
+  data.tar.gz: 37a8d7aff2aa8383cca8d488f80f8e164c8d8a31
 SHA512:
-  metadata.gz: da70d07c680fcc9177bbbd02f2ae90ae352bf796d503c1f0eb7b11622e01ce546bc87004e6a5df394ed366ae5666cb8258a0a18d98072975ac6180fe78b97d34
-  data.tar.gz: 90e1cdd6b824bccdcbc5c16f058b769a9518fda3c77592c958000aaf627aa05db3e1a98c690cbe43c29860cf27a79b60ece3aaf73656a9b87f954715ab7d895c
+  metadata.gz: ec5db28f2b7163e4914bed6a2214f0f2ee6775e8fcf1b7495b8094355cbda99a756aa084fe0adc03b3f9d6e115a5eea429fe0aa24e570378fffa988693ac0b39
+  data.tar.gz: 4abdb2b826dfef24f96609bb499663a8b6c0e30745f598daf1fd111d5ff1f0a3211699d8b3674ae971851c04dece1acfefec2c758c0d517eca67a711a5d4a511

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 1.0.0
+### Breaking Changes
+- URLs now return instances of URI::Generic instead of String
+
+### Features
+- Manipulate urls in strings using blocks with `String#replace_urls`
+- Automatically replace urls in strings with link tags using `String#link`
+
+## 0.0.1
+- Initial release

data/README.md

@@ -3,12 +3,29 @@ Parsing libraries been getting outdated as the web evolve. Linkable takes a scal
 
 ## Usage
 
+#### Require the library
 ```ruby
 require "linkable"
+```
+
+#### List all urls in a string
+```ruby
+text = "Have you heard that github.com/zeeraw/linkable will detect your proprietary://special.snowflake.domain domain."
+text.urls
+# => [#<URI::Generic URL:github.com/zeeraw/linkable>, #<URI::Generic proprietary://special.snowflake.domain>]
+```
 
-string = "Have you heard that github.com/zeeraw/linkable will detect your proprietary://special.snowflake.domain domain."
-string.urls
-# => ["github.com/zeeraw/linkable", "proprietary://special.snowflake.domain"]
+#### Replace urls with link tags
+```ruby
+"Follow me on twitter http://twitter.com/zeeraw".link
+# => "Follow me on twitter <a href='http://twitter.com/zeeraw'>http://twitter.com/zeeraw</a>"
+```
+
+#### Replace urls manually
+```ruby
+text = "Follow me on twitter http://twitter.com/zeeraw"
+text.replace_urls { |url| "<a href=#{ url }> @#{ url.path[1..-1] }</a>" }
+# => "Follow me on twitter <a href='http://twitter.com/zeeraw'>@zeeraw</a>"
 ```
 
 ## Installation

data/lib/linkable.rb

@@ -1,10 +1,31 @@
 require "linkable/version"
 require "linkable/expression"
+require "uri"
 
 module Linkable
 
+  LINK_URI = Proc.new { |uri| "<a href='#{ uri }'>#{ uri }</a>" }.freeze
+
   def urls
-    self.scan(Linkable::EXPRESSION).map(&:first)
+    self.scan(Linkable::EXPRESSION).map(&:first).map { |uri| URI::parse uri }
+  end
+
+  def replace_urls(&blk)
+    return unless block_given?
+    self.gsub(Linkable::EXPRESSION) { |uri| blk.call URI::parse uri }
+  end
+
+  def replace_urls!(&blk)
+    return unless block_given?
+    self.gsub!(Linkable::EXPRESSION) { |uri| blk.call URI::parse uri }
+  end
+
+  def link
+    self.gsub(Linkable::EXPRESSION, &LINK_URI)
+  end
+
+  def link!
+    self.gsub!(Linkable::EXPRESSION, &LINK_URI)
   end
 
 end

data/lib/linkable/version.rb

@@ -1,3 +1,3 @@
 module Linkable
-  VERSION = "0.0.1"
+  VERSION = "1.0.0.pre1"
 end

data/spec/linkable_spec.rb

@@ -13,52 +13,100 @@ RSpec.describe Linkable do
     Schema relative URLs are pretty common these days, if you need it, we got it #{ schema_relative }
 
     And for the grand finale is when you put another domain in the query params #{ url_in_query_parameters } WOW!"
+
+    While something like #{ underscored } is not matched due to underscores.
   ) }
 
   describe "String#urls" do
 
     subject(:urls) { text.urls }
 
-    let(:domain) { "www.domain.com" }
+    let(:domain) { URI::parse "www.google.com" }
     it "parses domain" do
       expect(urls).to include domain
     end
 
-    let(:apex_domain) { "domain.com?foo=bar" }
+    let(:apex_domain) { URI::parse "loopia.se?foo=bar" }
     it "parses apex domain" do
       expect(urls).to include apex_domain
     end
 
-    let(:subdomain) { "sub.domain.com" }
+    let(:subdomain) { URI::parse "api.github.com" }
     it "parses subdomain" do
       expect(urls).to include subdomain
     end
 
-    let(:multiple_subdomains) { "second.sub.doma.in/foo/bar?baz=biz" }
+    let(:multiple_subdomains) { URI::parse "site.stage.internal.net/path/to?my=variable" }
     it "parses multiple subdomains" do
       expect(urls).to include multiple_subdomains
     end
 
-    let(:complex_hostname) { "domain.w1th-d4shes-4nd-numbe.rs" }
+    let(:complex_hostname) { URI::parse "14m.t00-c00l-4-sch00l.ninja" }
     it "parses complex hostnames" do
       expect(urls).to include complex_hostname
     end
 
-    let(:custom_schema) { "protocol://with.domain.com?queries=too" }
+    let(:custom_schema) { URI::parse "winzip://with.domain.com?queries=too" }
     it "parses custom schema" do
       expect(urls).to include custom_schema
     end
 
-    let(:schema_relative) { "//with.domain.com?queries=too" }
+    let(:schema_relative) { URI::parse "//with.domain.com?queries=too" }
     it "parses schema relative" do
       expect(urls).to include schema_relative
     end
 
-    let(:url_in_query_parameters) { "domain.w1th-d4shes-4nd-numbe.rs/foobar?is=http://www.another-domain.com" }
+    let(:url_in_query_parameters) { URI::parse "domain.w1th-d4shes-4nd-numbe.rs/foobar?is=http://www.another-domain.com" }
     it "parses domain in query parameters" do
       expect(urls).to include url_in_query_parameters
     end
 
+    let(:underscored) { URI::parse "try.under_score.app" }
+    it "parses underscores" do
+      expect(urls).to include underscored
+    end
+  end
+
+  describe "String#replace_urls" do
+    let(:text) { "Please follow me on twitter http://twitter.com/zeeraw" }
+    subject(:replaced) { text.replace_urls { |url| "<a href='#{ url }'>@#{ url.path[1..-1] }</a>" } }
+    it "converts urls with block" do
+      expect(replaced).to include "<a href='http://twitter.com/zeeraw'>@zeeraw</a>"
+    end
+    it "duplicates the string" do
+      expect(text.link.object_id).to_not match text.object_id
+    end
+  end
+
+  describe "String#replace_urls!" do
+    let(:text) { "Please follow me on twitter http://twitter.com/zeeraw" }
+    subject(:replaced) { text.replace_urls! { |url| "<a href='#{ url }'>@#{ url.path[1..-1] }</a>" } }
+    it "converts urls with block" do
+      expect(replaced).to include "<a href='http://twitter.com/zeeraw'>@zeeraw</a>"
+    end
+    it "manipulates the string" do
+      expect(text.link!.object_id).to match text.object_id
+    end
+  end
+
+  describe "String#link" do
+    let(:text) { "Please follow me on twitter http://twitter.com/zeeraw" }
+    it "converts urls to html links" do
+      expect(text.link).to match "Please follow me on twitter <a href='http://twitter.com/zeeraw'>http://twitter.com/zeeraw</a>"
+    end
+    it "duplicates the string" do
+      expect(text.link.object_id).to_not match text.object_id
+    end
+  end
+
+  describe "String#link!" do
+    let(:text) { "Please follow me on twitter http://twitter.com/zeeraw" }
+    it "converts urls to html links" do
+      expect(text.link!).to match "Please follow me on twitter <a href='http://twitter.com/zeeraw'>http://twitter.com/zeeraw</a>"
+    end
+    it "manipulates the string" do
+      expect(text.link!.object_id).to match text.object_id
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linkable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - Philip Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2014-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -101,9 +102,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2