seo_friendly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8ead4473d9c8e7226c5d09105070a7d2da6e00f
+  data.tar.gz: ce7b8a84efba8f92fbc403a1dc0fe2ff8321eca6
+SHA512:
+  metadata.gz: 034b279d5ac1cc1f79110c1b07f0b0b60826262bcb8c2567cb8ae2f1cf81d6d95f014a5446e122d52716f45951a61b74dcb1b7f1d5e6093d0abed54abc17dd0d
+  data.tar.gz: f83ec0f07cc899190f081f06073a9b0c8a8ee4bce713f784bec9bb2fd7a95e3e0e212b483445f80031e3af77e137078a60f60fb66fa3c2cb31bf4ab31e506dd5

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 buzhenko
+
+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,70 @@
+# SeoFriendly
+
+SeoFriendly gem provides easy way to insert meta information (title, description, keywords) on almost all pages of your application.
+Gem extract meta information for model from it's fields or from any source you specify.
+
+## Installation
+
+```ruby
+gem 'seo_friendly'
+```
+
+For fast gem integration run generator that copy migration files and default source config into your application.
+Gem use monkey patching to add new methods to ActiveRecord and new view helpers.
+
+    $ rails generate seo_friendly:install
+
+## Usage
+
+Create your own seo source class for any model and specify information which will be used to create meta tags.
+Example:
+```ruby
+# seo source class for Page model
+class PageSeoSource < DefaultSeoSource
+
+  # title information will be extracted from title field of Page instance
+  def title
+    instance.title
+  end
+
+  # description will be always constant for Page
+  def description
+    'Awesome pages of my beautiful application'
+  end
+
+  # Page model can have for example tags reference that you can use to generate keywords.
+  def keywords
+    instance.tags.join(' ,')
+  end
+
+end
+```
+
+## Views
+On views you can insert meta tags using helper
+
+```haml
+  = meta_tags(@page) %>
+```
+
+## Model
+To update meta information every time when you update records add to model callback:
+```ruby
+  after_save :update_seo_attributes
+```
+
+## Rake
+If you change model source and want to update seo information for all instances of this model you can use rake task
+
+    $ rake seo_friendly:regenerate[ModelName]
+
+## TODO
+ 2) Add tests
+ 6) WordsSplitter is too slow, replace it with regular expression (change)
+
+
+1. Fork it ( https://github.com/rossmari/seo_friendly/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/seo_friendly/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an application policy as a starting point for your application.

data/lib/generators/seo_friendly/install/install_generator.rb

@@ -0,0 +1,23 @@
+module SeoFriendly
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      # TODO : rename method
+      def copy_default_seo_source
+        template 'default_seo_source.rb', 'app/seo_sources/default_seo_source.rb'
+      end
+
+      def copy_migrations
+        migration_template 'migrations/create_seo_params.rb', 'db/migrate/create_seo_params.rb'
+      end
+
+      def self.next_migration_number(dir)
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+
+    end
+  end
+end

data/lib/generators/seo_friendly/install/templates/default_seo_source.rb

@@ -0,0 +1,31 @@
+class DefaultSeoSource
+  attr_reader :instance
+
+  def initialize(instance)
+    @instance = instance
+
+    @title = title
+    @description = description
+    @keywords = keywords
+  end
+
+  def title
+    instance.title
+  rescue
+    'Default SeoFriendly title'
+  end
+
+  def description
+    instance.description
+  rescue
+    'Default SeoFriendly description'
+  end
+
+  def keywords
+    instance.keywords
+  rescue
+    'Default SeoFriendly keywords'
+  end
+
+end
+

data/lib/generators/seo_friendly/install/templates/migrations/create_seo_params.rb

@@ -0,0 +1,18 @@
+class SeoFriendly < ActiveRecord::Migration
+
+  def change
+    create_table :seo_params do |t|
+      t.string :description
+      t.string :title
+      t.string :keywords
+
+      t.integer :searchable_id
+      t.string  :searchable_type
+
+      t.timestamps null: false
+    end
+
+    add_index :seo_params, [ :searchable_id, :searchable_type ]
+
+  end
+end

data/lib/models/seo_param.rb

@@ -0,0 +1,6 @@
+class SeoParam < ActiveRecord::Base
+
+  # === REFERENCES
+  belongs_to :searchable, polymorphic: true
+
+end

data/lib/railtie.rb

@@ -0,0 +1,10 @@
+require 'seo_friendly'
+require 'rails'
+
+module YourGem
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/rebuild_seo_params.rake'
+    end
+  end
+end

data/lib/seo_friendly.rb

@@ -0,0 +1,19 @@
+require 'action_view'
+require 'seo_friendly/version'
+require 'seo_friendly/seo_searcher'
+require 'seo_friendly/exceptions'
+require 'seo_friendly/renderer/meta_render'
+require 'seo_friendly/view_helper'
+require 'seo_friendly/model_helper'
+require 'active_record'
+require 'models/seo_param'
+
+
+module SeoFriendly
+
+  ActionView::Base.send :include, SeoFriendly::ViewHelper
+  ActiveRecord::Base.send :include, SeoFriendly::ModelHelper
+
+  require 'railtie' if defined?(Rails)
+
+end

data/lib/seo_friendly/constructors/meta_constructors.rb

@@ -0,0 +1,41 @@
+#TODO RENAME TO META CONSTRUCTORS or META parsers
+#TODO: add html escaping for data
+require 'seo_friendly/words_splitter'
+
+module SeoFriendly
+
+  # Recommended title tag length: up to 70 characters, 10 words.
+  class TitleConstructor
+
+    def self.extract(object)
+      WordsSplitter.split(object, 70, 10)
+    end
+
+  end
+
+  class DescriptionConstructor
+
+    OMISSION = '...'
+
+    # Recommended description tag length: up to 160 characters.
+    # In my document maximal words count is 200
+    def self.extract(object)
+      # TODO : remove maximal words count some how
+      description = WordsSplitter.split(object, 200, 100)
+      unless description.end_with?('.')
+        description << OMISSION
+      end
+      return description
+    end
+
+  end
+
+  class KeyWordsConstructor
+
+    def self.extract(object)
+      WordsSplitter.split(object, 255, 20)
+    end
+
+  end
+
+end

data/lib/seo_friendly/data_extractor.rb

@@ -0,0 +1,33 @@
+require 'seo_friendly/constructors/meta_constructors'
+module SeoFriendly
+
+  class DataExtractor
+
+    attr_reader :source, :title, :description, :keywords
+
+    # a little bit of metaprogramming
+    EXTRACTORS = { title: TitleConstructor, description: DescriptionConstructor, keywords: KeyWordsConstructor }
+
+    def initialize(source)
+      @source = source
+      extract_information
+    end
+
+    def seo_attributes
+      { title: title, description: description, keywords: keywords }
+    end
+
+    private
+
+    def extract_information
+      EXTRACTORS.each do |attribute_name, extractor_class|
+        instance_variable_set("@#{attribute_name}", extractor_class.send(:extract, source.send(attribute_name)))
+      end
+    rescue => exception
+      raise ExtractDataFromSourceError.new(source.class.name, exception.message)
+    end
+
+
+  end
+
+end

data/lib/seo_friendly/exceptions.rb

@@ -0,0 +1,51 @@
+module SeoFriendly
+
+  class SourceNotDefinedError < StandardError
+
+    MESSAGE = 'Unable to find seo rule %{policy_name} for %{object} class'
+
+    attr_reader :object
+
+    def initialize(policy, object)
+      super( MESSAGE % { policy_name: policy, object: object} )
+      @object = object
+    end
+
+  end
+
+  class UnknownSeoAttributeError < StandardError
+
+    MESSAGE = 'Unknown seo attribute method \'%{seo_method}\' for field \'%{seo_field}\'.'
+
+    attr_reader :object
+
+    def initialize(seo_field, seo_method)
+      super( MESSAGE % { seo_field: seo_field, seo_method: seo_method } )
+      @object = object
+    end
+
+  end
+
+  class UnknownSeoModeError < StandardError
+
+    MESSAGE = 'Unknown seo mode value %{seo_mode}'
+
+    attr_reader :object
+
+    def initialize(mode)
+      super( MESSAGE % { seo_mode: mode} )
+      @object = object
+    end
+
+  end
+
+  class ExtractDataFromSourceError < StandardError
+    MESSAGE = 'Failed to extract data from source %{source_name}. '
+    attr_reader :object
+    def initialize(source_name, stack_message)
+      super( MESSAGE % { source_name: source_name} << stack_message )
+      @object = object
+    end
+  end
+
+end

data/lib/seo_friendly/model_helper.rb

@@ -0,0 +1,12 @@
+require 'seo_friendly/seo_updater'
+module SeoFriendly
+
+  module ModelHelper
+
+    def update_seo_attributes
+      SeoUpdater.new(self).update
+    end
+
+  end
+
+end

data/lib/seo_friendly/renderer/meta_render.rb

@@ -0,0 +1,15 @@
+module SeoFriendly
+
+  class MetaRenderer
+
+    def self.render(container, context)
+      tags = ''
+      tags << context.content_tag(:meta, nil, content: container.title, name: 'title')
+      tags << context.content_tag(:meta, nil, content: container.description, name: 'description')
+      tags << context.content_tag(:meta, nil, content: container.keywords, name: 'keywords')
+      context.raw(tags)
+    end
+
+  end
+
+end

data/lib/seo_friendly/seo_creator.rb

@@ -0,0 +1,13 @@
+require 'seo_friendly/source_searcher'
+require 'seo_friendly/data_extractor'
+require 'seo_friendly/seo_params_processor'
+
+module SeoFriendly
+  class SeoCreator < SeoParamsProcessor
+
+    def create
+      SeoParam.create(extracted_seo_attributes.merge(searchable: instance))
+    end
+
+  end
+end

data/lib/seo_friendly/seo_params_processor.rb

@@ -0,0 +1,28 @@
+require 'seo_friendly/source_searcher'
+require 'seo_friendly/data_extractor'
+
+module SeoFriendly
+  class SeoParamsProcessor
+
+    attr_reader :instance, :raw_data_source, :extracted_seo_attributes
+
+    def initialize(instance)
+      @instance = instance
+      @raw_data_source = create_data_source
+      @extracted_seo_attributes = extract_seo_attributes
+    end
+
+    private
+
+    def create_data_source
+      source_class = SourceSearcher.new(instance).find_source
+      source_class.new(instance)
+    end
+
+    def extract_seo_attributes
+      extractor = DataExtractor.new(raw_data_source)
+      extractor.seo_attributes
+    end
+
+  end
+end

data/lib/seo_friendly/seo_searcher.rb

@@ -0,0 +1,19 @@
+require 'seo_friendly/seo_creator'
+module SeoFriendly
+
+  class SeoSearcher
+
+    attr_reader :id, :type
+
+    def initialize(searchable_id, searchable_type)
+      @id = searchable_id
+      @type = searchable_type
+    end
+
+    def search
+      SeoParam.where(searchable_type: type, searchable_id: id).first
+    end
+
+  end
+
+end

data/lib/seo_friendly/seo_updater.rb

@@ -0,0 +1,14 @@
+require 'seo_friendly/source_searcher'
+require 'seo_friendly/data_extractor'
+require 'seo_friendly/seo_params_processor'
+
+module SeoFriendly
+  class SeoUpdater < SeoParamsProcessor
+
+    def update
+      seo_record = SeoSearcher.new(instance.id, instance.class.name).search
+      seo_record.update_attributes(extracted_seo_attributes)
+    end
+
+  end
+end

data/lib/seo_friendly/source_searcher.rb

@@ -0,0 +1,39 @@
+module SeoFriendly
+  class SourceSearcher
+
+    attr_reader :object
+
+    def initialize(model)
+      @object = model
+    end
+
+    def find_source
+      source or raise SourceNotDefinedError.new(find, object)
+    end
+
+    private
+
+    def source
+      klass = find
+      klass = klass.constantize if klass.is_a?(String)
+      klass
+    rescue NameError
+      nil
+    end
+
+    def find
+      klass = if object.respond_to?(:model_name)
+        object.model_name
+      elsif object.class.respond_to?(:model_name)
+        object.class.model_name
+      elsif object.is_a?(Class)
+        object
+      elsif object.is_a?(Symbol)
+        object.to_s.classify
+      else
+        object.class
+      end
+      "#{klass}SeoSource"
+    end
+  end
+end

data/lib/seo_friendly/version.rb

@@ -0,0 +1,3 @@
+module SeoFriendly
+  VERSION = "0.0.1"
+end

data/lib/seo_friendly/view_helper.rb

@@ -0,0 +1,19 @@
+require 'seo_friendly/seo_searcher'
+require 'seo_friendly/seo_creator'
+
+module SeoFriendly
+
+  module ViewHelper
+
+    def meta_tags(instance)
+      container = SeoSearcher.new(instance.id, instance.class.name).search || SeoCreator.new(instance).create
+      MetaRenderer.render(container, self)
+    end
+
+    def meta_container(instance)
+      SeoSearcher.new(instance.id, instance.class.name).search || SeoCreator.new(instance).create
+    end
+
+  end
+
+end

data/lib/seo_friendly/words_splitter.rb

@@ -0,0 +1,26 @@
+module SeoFriendly
+  class WordsSplitter
+
+    def self.split(object, maximal_length, maximal_words_count)
+      if object.length <= maximal_length && words_count(object) <= maximal_words_count
+        return object
+      else
+        object = reduce_string(object)
+        split(object, maximal_length, maximal_words_count)
+      end
+    end
+
+    private
+
+    def self.words_count(object)
+      object.split.count
+    end
+
+    def self.reduce_string(object)
+      array = object.split
+      array.delete(array.last)
+      array.join(' ')
+    end
+
+  end
+end

data/lib/tasks/rebuild_seo_params.rake

@@ -0,0 +1,20 @@
+namespace :seo_friendly do
+
+  desc 'Regenerate seo params for chosen model'
+  task :regenerate, [:model_name] => :environment do |t, args|
+
+    unless args[:model_name]
+      abort('WARNING! Set model name parametr to execute this rake task')
+    end
+
+    model = args[:model_name].capitalize.constantize
+
+    model.find_each do |instance|
+
+      instance.update_seo_attributes
+      puts "Update seo attributes for #{instance.class.name} with ID #{instance.id}"
+    end
+
+  end
+
+end

data/seo_friendly.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_friendly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seo_friendly"
+  spec.version       = SeoFriendly::VERSION
+  spec.authors       = ["buzhenko"]
+  spec.email         = ["roman-bujenko@yandex.ru"]
+  spec.summary       = %q{Seo }
+  spec.description   = %q{Seo}
+  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"
+  spec.add_development_dependency "activerecord", "~> 4.2.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: seo_friendly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- buzhenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Seo
+email:
+- roman-bujenko@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/seo_friendly/install/USAGE
+- lib/generators/seo_friendly/install/install_generator.rb
+- lib/generators/seo_friendly/install/templates/default_seo_source.rb
+- lib/generators/seo_friendly/install/templates/migrations/create_seo_params.rb
+- lib/models/seo_param.rb
+- lib/railtie.rb
+- lib/seo_friendly.rb
+- lib/seo_friendly/constructors/meta_constructors.rb
+- lib/seo_friendly/data_extractor.rb
+- lib/seo_friendly/exceptions.rb
+- lib/seo_friendly/model_helper.rb
+- lib/seo_friendly/renderer/meta_render.rb
+- lib/seo_friendly/seo_creator.rb
+- lib/seo_friendly/seo_params_processor.rb
+- lib/seo_friendly/seo_searcher.rb
+- lib/seo_friendly/seo_updater.rb
+- lib/seo_friendly/source_searcher.rb
+- lib/seo_friendly/version.rb
+- lib/seo_friendly/view_helper.rb
+- lib/seo_friendly/words_splitter.rb
+- lib/tasks/rebuild_seo_params.rake
+- seo_friendly.gemspec
+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.5
+signing_key: 
+specification_version: 4
+summary: Seo
+test_files: []