linkificator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd55f7b84fe5b8cc95452c4233f849cc56fb4b06
+  data.tar.gz: c4761b2b55ed9cc0f54a36f49a976db5f6b7e776
+SHA512:
+  metadata.gz: 2e47037d7c5caa01dfb5bb96176e54d7fc98149435beb72055127ce4c5a20650a872665ad7d2dd77f1d6a9b7ce7487b86af4b9dff68a29486db5801de2591f73
+  data.tar.gz: 10db3e4381d5dddadce0387d8a4ec2c60d2d507d58945b080073e660cfdfa807531e58b4a933413350a3963063eae70ba153bef391cbf93131ae3599461a42af

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/.idea
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in linkificator.gemspec
+gemspec
+
+gem 'actionview', '~>4.1'
+
+group :test do
+  gem 'rspec', '~> 3.1.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 dizer
+
+MIT License
+
+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,102 @@
+# Linkificator
+
+Changes link depending on context
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linkificator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linkificator
+
+## Options
+
+Full list of options:
+
+```ruby
+{
+    context:    {
+        target:      %w(http://example.com.*),   # href url
+        target_not:  %w(http://example.com/a.*),
+        current:     %w(http://example.dev.*),   # Rely on context[:current] field in you app.
+                                                 # Usually current request url.
+        current_not: %w(http://example.dev),
+    },
+    processing: {
+        wrap_noindex: true # Wrap with <noindex> tag
+        data_href:    true # Clear href and put it in base64 to data-href attribute
+        rel_nofollow: true # Adds rel="nofollow" attribute to link tag
+    }
+}
+```
+
+## Example
+
+Lets wrap links to example.com with ```<noindex>``` tag:
+
+Add to your ```application_controller.rb``` linkificator preferences:
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  helper_method :linkificator
+
+  def linkificator
+    require 'linkificator'
+    @linkificator ||= Linkificator.for_conditions([
+      {
+          context:    {target: %w(http://example.com.*)},
+          processing: {wrap_noindex: true}
+      }
+    ])
+  end
+end
+
+```
+
+Now you can define ```seo_link_to``` helper in ```application_helper.rb```:
+
+```ruby
+module ApplicationHelper
+
+  def seo_link_to(*params, &block)
+    linkificator.link_to(
+        *params[0, 1],
+        (params[2] || {}).merge(
+            view_context: self,
+            context: {
+                current: request.original_url
+            }
+        ),
+        &block
+    )
+  end
+end
+
+```
+
+Finally use new helper ```seo_link_to``` like default ```link_to```
+
+```ruby
+seo_link_to('text', 'http://example.com') # => <noindex><a href="http://example.com">text</a></noindex>
+seo_link_to('text', 'http://other.com')   # => <a href="http://other.com">text</a>
+
+```
+
+
+## Contributing
+
+1. Fork itр
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/linkificator.rb

@@ -0,0 +1,11 @@
+require 'linkificator/version'
+require 'linkificator/conditions_storage'
+require 'linkificator/conditions_storage/condition'
+
+module Linkificator
+
+  def for_conditions(conditions)
+    ConditionsStorage.new(conditions)
+  end
+
+end

data/lib/linkificator/conditions_storage.rb

@@ -0,0 +1,30 @@
+require 'base64'
+
+class Linkificator::ConditionsStorage
+
+  attr_reader :conditions
+
+  def initialize(conditions)
+    @conditions = conditions.map { |hash| Condition.new(hash) }
+  end
+
+  def condition_for(options={})
+    @conditions.detect do |condition|
+      condition if condition.match?(options)
+    end
+  end
+
+  def link_to(*params, &block)
+    context = extract_context(params)
+    condition = condition_for(context) || Condition.new
+    condition.link_to(*params, &block)
+  end
+
+private
+
+  def extract_context(params)
+    context = {}
+    context[:target] = params[1] if params[1].is_a?(String)
+    context.merge!((params[2] || {}).delete(:context) || {})
+  end
+end

data/lib/linkificator/conditions_storage/condition.rb

@@ -0,0 +1,72 @@
+class Linkificator::ConditionsStorage::Condition
+  attr_reader :conditions
+
+  def initialize(conditions={})
+    @conditions = conditions
+  end
+
+  def match?(options)
+    [
+        context[:target]      ?  detect_presence(context[:target],      options[:target])  : true,
+        context[:target_not]  ? !detect_presence(context[:target_not],  options[:target])  : true,
+        context[:current]     ?  detect_presence(context[:current],     options[:current]) : true,
+        context[:current_not] ? !detect_presence(context[:current_not], options[:current]) : true,
+    ].all?
+  end
+
+  def link_to(*params, &block)
+    updated_params = params.clone
+
+    view_context = view_context((updated_params[2] || {}).delete(:view_context))
+
+    if processing[:data_href]
+      url               = view_context.url_for(*updated_params[1])
+      updated_params[2] = (updated_params[2] || {}).merge('href' => '#', 'data-href' => Base64.strict_encode64(url))
+    end
+
+    if processing[:rel_nofollow]
+      updated_params[2] = (updated_params[2] || {}).merge(rel: 'nofollow')
+    end
+
+    link = view_context.link_to(*updated_params, &block)
+
+    if processing[:wrap_noindex]
+      view_context.content_tag(:noindex) { link }
+    else
+      link
+    end
+  end
+
+  private
+
+  class ViewContext
+    require 'action_view'
+    include ActionView::Helpers
+    include ActionView::Context
+  end
+
+  def view_context(view_context)
+    view_context || (@view_context ||= ViewContext.new)
+  end
+
+  def detect_presence(pool, element)
+    pool.detect { |target| match_regexp(element, target) }.present?
+  end
+
+  def match_regexp(str, regexp_str)
+    regexp = wrap_regexp(regexp_str)
+    str.to_s.match(regexp)
+  end
+
+  def wrap_regexp(str)
+    /^#{str}$/i
+  end
+
+  def context
+    @context ||= conditions[:context] || {}
+  end
+
+  def processing
+    @processing ||= conditions[:processing] || {}
+  end
+end

data/lib/linkificator/version.rb

@@ -0,0 +1,3 @@
+module Linkificator
+  VERSION = '1.0.0'
+end

data/linkificator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'linkificator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "linkificator"
+  spec.version       = Linkificator::VERSION
+  spec.authors       = ["dizer"]
+  spec.email         = ["dizeru@gmail.com"]
+  spec.summary       = %q{Add link params}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/conditions_storage/condition_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Linkificator::ConditionsStorage::Condition do
+  context 'context section' do
+    context 'target is' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            context: {target: %w(http://example.com/a.*)}
+        )
+      }
+
+      {
+          'http://example.com/a/b' => true,
+          'http://example.com/a/'  => true,
+          'http://example.com/a'   => true,
+          'http://example.com/'    => false
+
+      }.each do |target, expected_result|
+        it "match #{target} is #{expected_result}" do
+          expect(condition.match?(target: target)).to eq(expected_result)
+        end
+      end
+    end
+
+    context 'target_not' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            context: {target_not: %w(http://example.com/a/e/.* http://example.com/a/e2), }
+        )
+      }
+
+      {
+          'http://example.com/a/b'    => true,
+          'http://example.com/a/e/'   => false,
+          'http://example.com/a/e2'   => false,
+          'http://example.com/a/e2/c' => true
+      }.each do |target, expected_result|
+        it "match #{target} is #{expected_result}" do
+          expect(condition.match?(target: target)).to eq(expected_result)
+        end
+      end
+    end
+
+    context 'current is' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            context: {current: %w(http://example.com/a.*)}
+        )
+      }
+
+      {
+          'http://example.com/a/b' => true,
+          'http://example.com/a/'  => true,
+          'http://example.com/a'   => true,
+          'http://example.com/'    => false,
+          'http://example.com/b'   => false
+      }.each do |target, expected_result|
+        it "match #{target} is #{expected_result}" do
+          expect(condition.match?(current: target)).to eq(expected_result)
+        end
+      end
+    end
+
+    context 'current_not' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            context: {current_not: %w(http://example.com/a.*)}
+        )
+      }
+
+      {
+          'http://example.com/a' => false,
+          'http://example.com/'  => true,
+          'http://example.com/b' => true
+      }.each do |target, expected_result|
+        it "match #{target} is #{expected_result}" do
+          expect(condition.match?(current: target)).to eq(expected_result)
+        end
+      end
+    end
+  end
+
+  context 'processing section' do
+    context 'wrap_noindex' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            processing: {wrap_noindex: true}
+        )
+      }
+      it do
+        expect(condition.link_to('text', 'http://example.com')).to eq('<noindex><a href="http://example.com">text</a></noindex>')
+      end
+    end
+
+    context 'data_href' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            processing: {data_href: true}
+        )
+      }
+      it do
+        expect(condition.link_to('text', 'http://example.com')).to eq('<a data-href="aHR0cDovL2V4YW1wbGUuY29t" href="#">text</a>')
+      end
+    end
+
+    context 'rel_nofollow' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            processing: {rel_nofollow: true}
+        )
+      }
+      it do
+        expect(condition.link_to('text', 'http://example.com')).to eq('<a href="http://example.com" rel="nofollow">text</a>')
+      end
+    end
+
+    context 'combined' do
+      let(:condition) {
+        Linkificator::ConditionsStorage::Condition.new(
+            processing: {
+                wrap_noindex: true,
+                data_href:    true,
+                rel_nofollow: true
+            }
+        )
+      }
+      it do
+        expect(condition.link_to('text', 'http://example.com')).to eq('<noindex><a data-href="aHR0cDovL2V4YW1wbGUuY29t" href="#" rel="nofollow">text</a></noindex>')
+      end
+    end
+
+  end
+end

data/spec/conditions_storage_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Linkificator::ConditionsStorage do
+  let(:storage) {
+    Linkificator::ConditionsStorage.new([
+                                            {
+                                                context:    { target: %w(http://example.com/a/.*) },
+                                                processing: { wrap_noindex: true }
+                                            },
+                                            {
+                                                context:    { current: %w(http://example.dev/a/.*) },
+                                                processing: { wrap_noindex: true }
+                                            }
+                                        ])
+  }
+  it 'selects condition' do
+    expect(storage.condition_for(target: 'http://example.com/a/')).to be_instance_of(Linkificator::ConditionsStorage::Condition)
+  end
+
+  context '#link_to' do
+    it 'dont match anything' do
+      expect(storage.link_to('text', 'http://example.com/c')).to   eq('<a href="http://example.com/c">text</a>')
+    end
+    it 'match by target' do
+      expect(storage.link_to('text', 'http://example.com/a/b')).to eq('<noindex><a href="http://example.com/a/b">text</a></noindex>')
+    end
+    it 'match by current' do
+      expect(storage.link_to('text', 'http://example.com/c', context: {current: 'http://example.dev/a/'}))
+          .to eq('<noindex><a href="http://example.com/c">text</a></noindex>')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../../lib/linkificator', __FILE__)
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: linkificator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- dizer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- dizeru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/linkificator.rb
+- lib/linkificator/conditions_storage.rb
+- lib/linkificator/conditions_storage/condition.rb
+- lib/linkificator/version.rb
+- linkificator.gemspec
+- spec/conditions_storage/condition_spec.rb
+- spec/conditions_storage_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Add link params
+test_files:
+- spec/conditions_storage/condition_spec.rb
+- spec/conditions_storage_spec.rb
+- spec/spec_helper.rb