builder_links 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aad7804603d689547d35466bb518b5616883f773
+  data.tar.gz: 558b85e8bebd0b58bd84519cb0a2ce9cc275c7cc
+SHA512:
+  metadata.gz: 49cf2f7203ce44e892b33724eb74912a3658dcefa8ba4a51dba1a6e7c0b349042c0a48d198cd400e57c753c34f7330ffa4fed16c2d8d85e9adaf5a87cf7f8388
+  data.tar.gz: 9992e30d93e246e794ea5de1e205b0ab04e6e83c530412be8ebc053b8506f6ba72915060e64617365bb6ac8e83e1c9fd415b512e75564af387d5f26223a864c1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,70 @@
+# BuilderLinks
+
+A ruby gem to generate links automatically based on a text, keywords and urls is given. Useful for example to increase dinamically the internal links in your site and improve SEO metrics.
+
+
+## Installation
+
+Add this line to your Gemfile's application:
+
+```ruby
+gem 'builder_links'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install builder_links
+
+## Configuration
+Use an initializer builder_links.rb
+
+```ruby
+# all parameters based on which allow to find keywords and build the links
+# builder_links will use anchortext to find text and uri to generate the link
+BuilderLinks.setup do |config|
+  config.patterns = [
+    {anchortext: 'google',  uri: 'http://www.google.com'},
+    {anchortext: 'builder links',  uri: 'https://github.com/jsanroman/builder_links'},
+    {anchortext: "I wanted to illuminate the whole earth", uri: 'https://es.wikipedia.org/wiki/Nikola_Tesla'},
+  ]
+
+  # maximum links generated to each call
+  config.total_links = 5
+  # maximum links generated to each pattern given
+  config.links_per_pattern = 1
+end
+```
+
+## Usage
+Call directly to `BuilderLinks.text("")`
+```ruby
+BuilderLinks.text("<p>I wanted to illuminate the whole earth. There is enough electricity to become a second sun.</p>")
+```
+```ruby
+#<p><a href="https://es.wikipedia.org/wiki/Nikola_Tesla">I wanted to illuminate the whole earth</a>. There is enough electricity to become a second sun.</p>
+```
+
+Or you can add `builder_links` to your activerecord model, that will generate a method `builder_links(:field)`
+```ruby
+class Card < ActiveRecord::Base
+  attr_accessible :text, :user_text
+
+  builder_links
+end
+
+# Then you can use builder_links method
+Card.find(1).builder_links(:text)
+Card.find(1).builder_links(:user_text)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/jsanroman/builder_links/fork )
+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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "builder_links"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/builder_links.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'builder_links/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'builder_links'
+  spec.version       = BuilderLinks::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.licenses      = ["MIT"]
+  spec.authors       = ["Javi Sanromán"]
+  spec.email         = ["javisanroman@gmail.com"]
+
+  spec.summary       = %q{A ruby gem to generate links automatically based on a text, keywords and urls is given}
+  spec.description   = %q{A ruby gem to generate links automatically based on a text, keywords and urls is given. Useful for example to increase dinamically the internal links in your site and improve SEO metrics.}
+  spec.homepage      = 'https://github.com/jsanroman/builder_links'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'nokogiri'
+end

data/lib/builder_links/active_record.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+
+module BuilderLinks
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def builder_links
+        define_method 'builder_links' do |arg|
+          return false if arg.blank?
+          return false unless attributes.include?(arg.to_s)
+
+          analize = BuilderLinks::Analize.new(attributes[arg.to_s])
+          analize.run
+        end  
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, BuilderLinks::ActiveRecord)

data/lib/builder_links/analize.rb

@@ -0,0 +1,64 @@
+module BuilderLinks
+  class Analize
+    def initialize(text)
+      @doc = Nokogiri::HTML(text)
+      @analized_text = nil
+    end
+
+    def run
+      return @analized_text unless @analized_text.blank?
+
+      total_links = 0
+      BuilderLinks.patterns.each do |pattern|
+        links_per_pattern = 0
+        @doc.search('p').children.each do |child|
+          break if max_links_generated?(total_links, links_per_pattern)
+
+          if analize_node(child, pattern)
+            links_per_pattern += 1
+            total_links += 1
+          end
+        end
+      end
+
+      @analized_text = @doc.at('body').nil? ? '' : @doc.at('body').inner_html
+    end
+
+    private
+
+    def analize_node(node, pattern)
+      if %('text', 'strong').include?(node.name) && node.children.count < 2
+        replace_text = node.content
+
+        prefix_suffix = pattern[:anchortext].include?(' ') ? '' : ' '
+        result = replace_text.sub!(/(#{prefix_suffix}#{pattern[:anchortext]}#{prefix_suffix})/i,
+                                   '<a href="' + pattern[:uri] + '" title="\1">\1</a>')
+
+        unless result.nil?
+          if node.name == 'text'
+            node.replace replace_text
+          else
+            new_node = @doc.create_element node.name
+            new_node.inner_html = replace_text
+            node.replace new_node
+          end
+
+          return true
+        end
+      end
+
+      false
+    end
+
+    def max_links_generated?(total_links, links_per_pattern)
+      if !BuilderLinks.links_per_pattern.nil? && links_per_pattern >= BuilderLinks.links_per_pattern
+        return true
+      end
+      if !BuilderLinks.total_links.nil? && total_links >= BuilderLinks.total_links
+        return true
+      end
+
+      false
+    end
+  end
+end

data/lib/builder_links/config.rb

@@ -0,0 +1,25 @@
+module BuilderLinks::Config
+  def config
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+    class_variable_set("@@#{name}", value)
+  end
+
+  define_class_method name do
+    class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/builder_links/version.rb

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

data/lib/builder_links.rb

@@ -0,0 +1,33 @@
+require 'builder_links/version'
+require 'builder_links/config'
+require 'builder_links/analize'
+require 'builder_links/active_record'
+
+module BuilderLinks
+  extend Config
+
+  define_setting :patterns
+  define_setting :links_per_pattern
+  define_setting :total_links
+  @patterns = []
+  @patterns.reverse!
+  @links_per_pattern = nil
+  @total_links = nil
+
+  def self.setup(&block)
+    yield self
+  end
+
+  def self.text(text)
+    analize = BuilderLinks::Analize.new(text)
+    analize.run
+  end
+
+  def self.logger
+    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @@logger = logger
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: builder_links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javi Sanromán
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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'
+description: A ruby gem to generate links automatically based on a text, keywords
+  and urls is given. Useful for example to increase dinamically the internal links
+  in your site and improve SEO metrics.
+email:
+- javisanroman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- builder_links.gemspec
+- lib/builder_links.rb
+- lib/builder_links/active_record.rb
+- lib/builder_links/analize.rb
+- lib/builder_links/config.rb
+- lib/builder_links/version.rb
+homepage: https://github.com/jsanroman/builder_links
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem to generate links automatically based on a text, keywords and
+  urls is given
+test_files: []