no_follow_external_links 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eb73dd6e22036ed4575558e8faa975c07c7c1db
-  data.tar.gz: e59ac01af1393f9611c17eff980c0a54db749de2
+  metadata.gz: b7650233c1d858b784e9ed8ca97b3cbec2cc2ee8
+  data.tar.gz: ee78a404b057dfc275e3504cbdaf3e2070e15d79
 SHA512:
-  metadata.gz: 138790c7ec0aa7d3048462d08646fc36dfa0aeda1ad07b1ed03c93951c2bd3736199927607d6d4a00ac1d36e434de540d4db0b834e7b26a69d3cc82980c9e5a0
-  data.tar.gz: 773e90b0f5469abd738d62225919913aee857423fb00ce53b4a6d1c097717d62251f0c9149d67d9f2e427bcab4dc413c199aa79b27eca00578730a09fe19399a
+  metadata.gz: 3295784e00e2ef54acdea54684fe4369c5166574add9c101289fe547e63a1d1f0bb66f50ca6a94221cd98177d8975f6cfe5f401002c73a6dc92731056f9c684c
+  data.tar.gz: e6a6c407bf1398c52e4b4c9546e8bebe245a3a5ca40656de9c691ceef11f726544f5007ea983f1963b8d8e46c53007aa152e9742bcb9f78a200d20a927e3fa0f

data/README.md

@@ -1,8 +1,16 @@
 # NoFollowExternalLinks
-Short description and motivation.
+Links that point to external urls are recommended to include a rel=nofollow property to make sure the crawler bots do not follow the content of external resources as your own.
+This plugin makes it easy to implement that for all existing links on a Rails application.
 
 ## Usage
-How to use my plugin.
+This plugin will automatically add a nofollow rel property to all the external links you create using Rails `link_to` method
+If you need to add an exception for instance for your own personal blog within a subdomain just add an intializer with the following:
+
+```
+NoFollowExternalLinks.configure do |config|
+  config.excluded_urls = %w{https://blog.mydomain.com/}
+end
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/config/initializers/no_follow_external_links.rb

@@ -1,15 +1,29 @@
+require 'byebug'
+
+NoFollowExternalLinks.configure do |config|
+  config.excluded_urls = []
+end
+
 Rails.configuration.to_prepare do
   ApplicationHelper.class_eval do
     def link_to(name, options = {}, html_options = {})
-      html_options.merge!(rel: :nofollow) unless internal_url? options
+      html_options.merge!(rel: :nofollow) if add_nofollow? options
       super(name, options, html_options)
     end
 
     private
 
-    def internal_url?(url)
-      return true unless self.respond_to? :root_url
-      url.try(:first) == '/' || url.try(:include?, root_url)
+    def add_nofollow?(url)
+      external_url?(url) && excluded_url?(url)
+    end
+
+    def excluded_url?(url)
+      !NoFollowExternalLinks.configuration.excluded_urls.include?(url)
+    end
+
+    def external_url?(url)
+      return false unless self.respond_to? :root_url
+      url.try(:first) != '/' && !url.try(:include?, root_url)
     end
   end
 end

data/lib/no_follow_external_links.rb

@@ -1,5 +1,13 @@
 require "no_follow_external_links/engine"
+require "no_follow_external_links/configuration"
 
 module NoFollowExternalLinks
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
 end

data/lib/no_follow_external_links/configuration.rb

@@ -0,0 +1,9 @@
+module NoFollowExternalLinks
+  class Configuration
+    attr_accessor :excluded_urls
+
+    def initialize
+      @excluded_urls = []
+    end
+  end
+end

data/lib/no_follow_external_links/version.rb

@@ -1,3 +1,3 @@
 module NoFollowExternalLinks
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/dummy/app/views/cars/index.html.erb

@@ -1,3 +1,4 @@
 <%=link_to 'Internal cars', car_path('example'), id: 'car_internal_link'%>
 <%=link_to 'Internal cars full url', car_url('example'), id: 'car_internal_url_ink'%>
 <%=link_to 'External cars', 'https://www.cars.com/', id: 'car_external_link'%>
+<%=link_to 'External cars but excluded', 'https://www.mycars.com/', id: 'car_external_excluded_link'%>

data/spec/feature/external_links_with_exception_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+feature 'Add no follow attribute to external links' do
+  before do
+    NoFollowExternalLinks.configure do |config|
+      config.excluded_urls = %w{https://www.mycars.com/}
+    end
+    visit root_path
+  end
+
+  it 'should show the external link' do
+    expect(page).to have_selector :link_or_button, 'External cars but excluded'
+  end
+
+  it 'adds a nofollow rel to external link links' do
+    expect(find('a#car_external_link')['rel']).to eq('nofollow')
+  end
+
+  it 'does not add a nofollow rel to external excluded links' do
+    expect(find('a#car_external_excluded_link')['rel']).not_to be
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: no_follow_external_links
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Pablo Gonzaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-19 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,6 +157,7 @@ files:
 - config/initializers/no_follow_external_links.rb
 - config/routes.rb
 - lib/no_follow_external_links.rb
+- lib/no_follow_external_links/configuration.rb
 - lib/no_follow_external_links/engine.rb
 - lib/no_follow_external_links/version.rb
 - lib/tasks/no_follow_external_links_tasks.rake
@@ -263,6 +264,7 @@ files:
 - spec/dummy/tmp/cache/assets/sprockets/v3.0/x7/x7PYh8DJvPykcEqpVab2vcY9-GFz-3cqtoMlRAu94Uc.cache
 - spec/dummy/tmp/cache/assets/sprockets/v3.0/yT/yTBgOVdriipCfu0f-gBdtxY7YwyFmTyw8XmeYbxRYRI.cache
 - spec/feature/external_links_spec.rb
+- spec/feature/external_links_with_exception_spec.rb
 - spec/feature/internal_links_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pgonzaga2012/no_follow_external_links
@@ -393,5 +395,6 @@ test_files:
 - spec/dummy/tmp/cache/assets/sprockets/v3.0/yT/yTBgOVdriipCfu0f-gBdtxY7YwyFmTyw8XmeYbxRYRI.cache
 - spec/dummy/tmp/cache/assets/sprockets/v3.0/Zl/Zlabymek1OchThl--EYnug-w71BxsUbsswgwbbi3X4w.cache
 - spec/feature/external_links_spec.rb
+- spec/feature/external_links_with_exception_spec.rb
 - spec/feature/internal_links_spec.rb
 - spec/spec_helper.rb